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

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

当然，除了代码规范性还有代码安全性条规，涉及数据库、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.根据业务需要合理灵活使用设计模式，提高代码的可读性和维护性

 

目前项目中的代码，说实话看的是真难受。

开发人员水平参差不齐，估计也都没有受过代码规范性方面的训练，首先从形式上就感觉很不规范。

当我听到方彬说，他之前在招商银行的时候，就写了一个方法，居然在审查了一下午，就是审查代码的规范性。对此，我非常震惊！我个人认为，这一点做的非常好！

之前，我也要求自己代码要注意规范性，但是没有经过专门的训练，所以在实际工作的过程中，规范性还是做不到。

所以就专门开一个新的博客分类，来专门训练自己的代码规范性。

以《阿里巴巴Java开发手册》指导，通过阅读真实项目代码，找出其中的代码规范性问题，然后加以改正，形成博客，来训练自己的代码规范性。

 

2018年真是忙碌的一年，忙着毕业，忙着找工作，好久都没写过博客。前几天看别人的文章后亲身体会到了代码规范性的重要性。

 俗话说说的再好不如做的好，下面是自身写的几行代码，大家可以体会一下每种风格的感觉，就会体会到规范性的重要性



上面第一种是最直接的方法，直接用if...else...来判断，方便直接



上面第二种是使用switch来判断，比较直观 



最后面这种就比较简洁，代码规范性，也是我目前约束自己本身的一种风格，常量使用大写并用下划线连接，方法尽量做到尽早Return, 判断方法避免使用符号等去判断

安装
wget -c http://static.phpmd.org/php/latest/phpmd.phar
mv phpmd.phar /usr/bin/phpmd
chmod +x /usr/bin/phpmd


使用：
# phpmd 代码路径 报告格式 规则xml文件  并使用 > 命令将问题报告输出到文件
eg:

phpmd /Library/WebServer/Documents/php/app/ html codesize,unusedcode,naming > ~/Desktop/res.html



#使用选项
zjs:php jun$ phpmd
Mandatory arguments:
1) A php source code filename or directory. Can be a comma-separated string
2) A report format
3) A ruleset filename or a comma-separated string of rulesetfilenames




Available formats: xml, text, html.
Available rulesets: cleancode, codesize, controversial, design, naming, unusedcode.




Optional arguments that may be put after the mandatory arguments:
--minimumpriority: rule priority threshold; rules with lower priority than this will not be used
--reportfile: send report output to a file; default to STDOUT
--suffixes: comma-separated string of valid source code filename extensions, e.g. php,phtml
--exclude: comma-separated string of patterns that are used to ignore directories
--strict: also report those nodes with a @SuppressWarnings annotation
--ignore-violations-on-exit: will exit with a zero code, even if any violations are found