PHPMD简介

团队在使用php-cs-fixer 代码格式自动式化工具之后,在格式,代码错误等方面带来了很大便利,不过在命名,代码质量,代码复杂度,缺少一些检查,在网上搜索后,发现PHPMD 一个PHP代码静态分析工具.

安装

官方网站 github
你可以直接到下载页面封装好的 phar 包：phpmd.phar

unix:

1. wget http://static.phpmd.org/php/latest/phpmd.phar -O phpmd.phar

2. chmod a+x phpmd.phar

3. mv phpmd.phar /usr/local/bin/phpmd.phar

windows

1. 下载phpmd.phar

2. 把phpmd.phar 放入php目录,然后把php安装目录加入系统PATH变量

composer

composer global require phpmd/phpmd

使用

1. /usr/local/bin/phpmd.phar

3. Mandatory arguments:

4. 1) A php source code filename or directory. Can be a comma-separated string

5. 2) A report format

6. 3) A ruleset filename or a comma-separated string of rulesetfilenames

8. Available formats: xml, text, html.

9. Available rulesets: cleancode, codesize, controversial, design, naming, unusedcode.

11. Optional arguments that may be put after the mandatory arguments:

12. --minimumpriority: rule priority threshold; rules with lower priority than this will not be used

13. --reportfile: send report output to a file; default to STDOUT

14. --suffixes: comma-separated string of valid source code filename extensions, e.g. php,phtml

15. --exclude: comma-separated string of patterns that are used to ignore directories

16. --strict: also report those nodes with a @SuppressWarnings annotation

17. --ignore-violations-on-exit: will exit with a zero code, even if any violations are found

发现命令行有三个参数

1. # phpmd 源代码路径 报告的格式 规则列表

2. # 源代码路径 支持

3. 一个文件 /path/to/file

4. 一个目录 /path/to/source

5. # 报告的格式 支持

6. xml:以XML格式输出；

7. text:简单的文本格式；

8. html:输出到单个的html；

9. # 规则列表 支持

10. phpmd_ruleset.xml 文件格式

11. codesize,unusedcode,naming 单个命令集合

12. # 附加参数

13. --exclude - 忽略的目录，以逗号分隔多个目录。

14. # 例子

15. phpmd /path/to/source html ./phpmd_ruleset.xml

规则集合列表：rules

1. Clean Code Rules: 强化代码整洁度的规则集。

2. Code Size Rules: 代码尺寸规则集.

3. Controversial Rules: 有争议的代码规则.

4. Design Rules: 软件设计的相关问题规则集.

5. Naming Rules: 名称太长，规则太短，等等规则集.

6. Unused Code Rules: 找到未使用的代码的规则集.

更多规则 中文参考手册

具体实例

一般在团队开发项目中,需要根据团队规范制定不同的规则文件,所以在项目根目录添加一个 phpmd.xml 规则文件后,之后自动部署的时候会运行脚本检查项目中的php代码。 下面是phpmd.xml一个例子

1. <?xml version="1.0"?>

2. <ruleset name="customer/php"

3. xmlns="http://pmd.sf.net/ruleset/1.0.0"

4. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

5. xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"

6. xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"

7. >

8. <rule ref="rulesets/codesize.xml/TooManyFields" />

9. <!--- 一个类中不能有太多fields字段,默认值15 -->

10. <rule ref="rulesets/codesize.xml/NPathComplexity" />

11. <!--- 一个方法中NPath复杂性,默认值200 -->

12. <rule ref="rulesets/codesize.xml/ExcessiveMethodLength" />

13. <!--- 相同的方法执行同一功能,默认值100 -->

14. <rule ref="rulesets/codesize.xml/ExcessiveClassLength" />

15. <!--- 一个类的最大行数,默认值1000 -->

16. <rule ref="rulesets/codesize.xml/TooManyMethods" />

17. <!--- 一个类的最大方法数,默认值25 -->

18. <rule ref="rulesets/controversial.xml/CamelCaseClassName" />

19. <!--- 以驼峰式命名类 -->

20. <rule ref="rulesets/controversial.xml/CamelCaseParameterName" />

21. <!--- 以驼峰式命名参数名字 -->

22. <rule ref="rulesets/controversial.xml/CamelCaseVariableName" />

23. <!--- 以驼峰式命名变量名字 -->

24. <rule ref="rulesets/design.xml/DevelopmentCodeFragment" />

25. <!-- 代码中不要有var_dump(), print_r()等这种调试输出结构 -->

26. <rule ref="rulesets/design.xml/EvalExpression" />

27. <!-- 代码中不要有eval()这种结构 -->

28. <rule ref="rulesets/design.xml/GotoStatement" />

29. <!-- 代码中不要有goto这种结构 -->

30. <rule ref="rulesets/naming.xml/BooleanGetMethodName" />

31. <!-- 返回值为布尔型而以'getX()'格式命名的方法改写成'isX()' 或者 'hasX()'-->

32. <rule ref="rulesets/naming.xml/ConstantNamingConventions" />

33. <!-- 类/接口常量必须用大写字母定义-->

34. <rule ref="rulesets/unusedcode.xml/UnusedLocalVariable" />

35. <!-- 存在已声明或赋值的局部变量，但是却未使用-->

36. <rule ref="rulesets/unusedcode.xml/UnusedPrivateField" />

37. <!-- 存在已声明或赋值的局部变量，但是却未使用-->

38. </ruleset>

phpmd.phar ./application html ./phpmd.xml --exclude application/cache,vendor > phpmd.html

编辑器插件

参考文档

PHPMD官网
phpmd中文手册
面向对象5个基本原则 phpmd-extension

转载于:https://my.oschina.net/2688/blog/909269