在我工作的这些年中，经常有人问我是否阅读过罗伯特-马丁的《代码整洁》这本书。当时我不知道书的具体内容，但是后来却成为了每个开发人员的“必读”书籍。
结构清晰
在开始编码时，请思考清楚你自己的程序，如：类，方法（函数）、结构等。
在使用包名来管理类时，尽量避免在一个包中添加大多的类，除非这些类与其包的含义相符合。
考虑的越清楚编写代码就越容易，否则，在将来你不得不重构你的代码。
命名规范
你可能会说命名这件事情很明显，而且每个人都知道，对类、方法和变量进行良好的命名非常的重要。
是的，但是请你时刻记住。
你始终要记住将RspValidator.java更改为ResponseValidator.java，将print()更改为printResponse()来精确的表达你的意图。
我希望我们永远不要在程序中看到诸如：String asd这样的命名规范。
为您的代码找到正常的名称或单词有助于编写大量的注释更直接。
虽然，好的命名规范比编写大量的注释更有效，但是在一些特殊的情况下可以采用注释来说明。
通常情况下，注释用来解释业务案例或对维护该案例的开发人员说明其重要的事情。
不要忘记Java中通常采用驼峰命名的方式，类名称以大写字母开头。
解决特定的问题
如果你有一个类命名为ResponseValidator.java，请确保它仅负责响应验证，不包括与其无关的职责。
如果要添加额外的功能，请创建一个新的类并为它命一个有意义的名字。
如果你的方法只需要解决一个特定的问题，尽量避免编写一个大型方法，因为其它开发人员可能会很难阅读。
正确的做法应该是将其分解成一些命名规范的方法，这样做有助于更加容易的测试它们。
方法参数合理
避免在方法中使用过多的参数，因为参数过多会直接影响代码的阅读，如下所示：
private addUserInformation(String name, String street, String houseNumber, String city, String country).
重构后的代码如下所示：
private addUserInformation(String name, Address userAddress).
冗余代码
如果两个方法中存在重复的代码，你必须考虑将其提取出第三个方法或单独的类进行处理，然后在方法中使用提取出来的方法来取代它们。
也许有开发人员说，在同一个方法中便于阅读，但在我看来用更少或没有重复的代码更方便于维护及避免错误的产生。
当然，一些好的IDE工具可以使用重构工具将其提取到一个新的方法中。
硬编码
有时候我们因为工作忙或赶项目进度，匆匆忙忙的对某些内容进硬编码，但是硬编码却带来了很多麻烦，如：维护难、容易导致错误。
对于这种情况，建议采用常量、泛型、配置文件进行有效的管理，如:.yml或.properties.
日志记录
对于API接口来说，好的日志记录可以帮助我们在任何人不熟悉代码的情况下即时的发现问题，因为有些API是公司内部其它的开发人员编写的。
好的日志记录，可以帮助我们快速的找到问题并解决问题。
网友评论