代码规范性

对于初学者来说，一开始把功能做出来就可以了，但随着年限增加，学习代码的规范性，可以提高代码的可读性和可维护性，便于后来者更快的入手项目，通过基本的代码规范也能够避免一些不应出现的问题，比如：空异常、类型转换异常等，就可以从源头上预防。

还有学习代码的设计规则，提高抽象能力和代码的解耦能力，

当然，除了代码规范性还有代码安全性条规，涉及数据库、web和Java安全，防止外部的恶意攻击。

目前先整理了代码规范性，安全性还有待学习。

 

一、代码规范性

1.空格间隔

“=”赋值，循环判断（if/for/while）等地方使用

2.集合判空

用Collection.isEmpty()，不用Collection.size()

3.日志打印

Private static final Logger LOG = Logger.getLog(类.class);

4.判空

变量 == null，空统一放右边

5.常量判断，常量放前面

常量.equal(变量)，避免空异常

6.类型转换

通过instanceof判断，再做类型转换，避免类型转换异常

7.tab键问题

代码对齐，将Tab键用空格替代，1Tab=4空格

8.方法名不要太长，参数不超过5个

9.避免字符串多次拼接

可用String.format(“%s%s”, s1, s2)或者StringBuffer的append()方法

10.魔鬼数字

通过常量来定义魔鬼数字，提高可读性

 

二、代码设计

1.方法命名和方法注释，让人快速明白方法的作用。避免看代码的人，再捋清代码逻辑。

2.将类按照功能来封装，不要多个不相关功能混杂再一起。

3.Extract提炼和抽象代码

4.遵循单一职责原则（代码6大设计原则）

5.根据业务需要合理灵活使用设计模式，提高代码的可读性和维护性