Java代码的整洁之道——手记

一、命名方式

类名首字母应该大写，方法名首字母小写，采用驼峰命名法。字符串常量，则采用全大写的方式，单词之间采用下划线“_”连接。

注：Java包package名则例外，全部采用小写，即使采用了单词组合，单词连接处也是小写。

例如：
类名：TestService
方法名：getStudentById
常量名：STUDENT_NAME

二、对象与类的设计

1、创建功能类或bean对象时，建议采用“经典形式”，包含以下方法：‘

equals() 
hashCode() 
toString() 
clone()（implement Cloneable） 
implement Serializable

2、方法的设计，应将其设计为功能简洁的，行为单一的方法，主要作用：方便代码的复用及增加代码的阅读性。

3、类的设计，尽量使其功能单一，只为解决特定的某一个问题。

4、让一切都尽可能的私有（private）化，保护程序的隐私与安全性。在多线程中隐私很重要，只有private字段在非同步的环境中使用能受到保护。

5、在现成类的基础上创建新类，尽量使用新建来构建对象，使用继承会增加该类的复杂度。

三、开发注意事项

1、警惕分析瘫痪，在分析需求时，首先应该提前了解整个项目的的状况或者当前开发功能的整体状况，然后再去考虑细节问题。在把握全局的基础上去思考细节，可以快速认识自己未知的一些因素，防止细节逻辑考虑的时候陷入死循环。

2、警惕过早的优化，在开发过程中，首先最重要的是实现功能，使它运行起来，再考虑优化运行效率。只有必须这样做，而且经过证实某部分代码存在性能瓶颈时，才应该进行优化。除非使用专门的工具分析，否则很有可能是在浪费自己的时间。

3、代码的阅读性，也是一个双向的过程，可分为机器阅读性和人为阅读性，机器阅读性越高代码执行效率则越高，随之存在潜在问题，则是代码的人为阅读性降低。两者之间需要开发人员去找到其中的平衡点。

4、代码阅读的时间比代码编写的时间多很多。所以编写注释和细致的解释以及一些示例往往是具有不可估量的价值。无论是对于自己和后来的人，都是非常重要的。切记，不要被“不写注释，刻意增加代码复杂度来提升自我存在价值！”的思维所误导，真正的自我价值提升是需要自己不断的学习和积累来进行的。不积跬步无以至千里，不积小流无以成江河。望共勉！！！

5、开发过程中，切记多点开发，勤思多记。尽可能的分解功能，自我制定个人的开发计划，合理安排时间分步开发，使用测试工具进行接口及方法的测试， 保证每一个步骤的正确性，降低后续排查测试的难度与重复编写同一业务逻辑。