这款开源的代码质量检测工具很强大

红太狼 2021-09-08 22:06 371阅读 0赞

来源：github.com/ice-lab/iceworks/tree/master/

好的代码一定是整洁的，并且能够帮助阅读的人快速理解和定位。好的代码可以加快应用的开发迭代速度，不必花过多的时间来修复 bug 和完善代码。

好的代码不但能够使得新的项目成员更容易加入项目，同时方便项目组成员快速做好 Back up。好的代码便于促进团队间交流合作提升开发效率。

## 代码质量评价标准 ##

有编码经验的人对代码都有一定的“鉴赏力”，能够凭感觉给出代码好坏的主观评价。但是这种凭感觉的方式太过个性随意，所谓仁者见仁智者见智，很难达成共识，那有没有一种公认的标准来鉴定代码质量呢？

答案是有的。这里简单分享当下较常用的评价标准，其中包括：编码规范、可读性、可维护性、重复度及可测试性。

编码规范主要包含是否遵守了最佳实践和团队编码规范，是否包含可能出问题的代码，以及可能存在安全的漏洞。编码规范有助于提高团队内协助的效率以及代码的可维护性。

可读性Code Review 是一个很好的测验代码可读性的手段。如果你的同事可以轻松地读懂你写的代码，那说明你的代码可读性很好；反之则说明你的代码可读性有待提高了。遵守编码规范也能让我们写出可读性更好的代码。

可维护性代码的可维护性是由很多因素协同作用的结果。代码的可读性好、简洁、可扩展性好，就会使得代码易维护；更细化地讲，如果代码分层清晰、模块化好、高内聚低耦合、遵从基于接口而非实现编程的设计原则等等，那就可能意味着代码易维护。除此之外，代码的易维护性还跟项目代码量的多少、业务的复杂程度、利用到的技术的复杂程度、文档是否全面等诸多因素有关。

重复度遵守 Don’t Repeat Yourself 原则，尽量减少重复代码的编写，复用已有的代码。对项目定期进行代码重复度检测是一个很有意义的事，可以帮助开发人员发现冗余代码，进行代码抽象和重构。重复的代码一旦出错，意味着加倍的工作量和持续的不可控。如果代码中有大量的重复代码，就要考虑将重复的代码提取出来，封装成公共的方法或者组件。

可测试性代码可测试性的好坏，同样可以反应代码质量的好坏。代码的可测试性差，比较难写单元测试，那基本上就能说明代码设计得有问题。

除此之外还有很多代码质量评价标准。我们需要一些取舍，选取部分大家有共识的规则定义团队好的代码标准。

## 代码质量维度 ##

当前版本通过 @iceworks/doctor 从 5 个维度对代码进行评分：

![b7ba2c92a8982f392c6cfa0af87283d7.png][]

*  **最佳实践：** 通过 @iceworks/eslint-plugin-best-practices 分析项目，提出符合当前工程特征（对 ice 和 Rax项目友好）的最佳实践及阻塞问题发布卡口，帮助开发者优化项目性能，避免潜在 bug 。
 *  **安全实践：** 通过 @iceworks/eslint-plugin-security-practices 扫码代码检测工程中可能存在的安全风险，包含 url 、敏感成词、明文账密信息及 npm 包证书检测，降低项目安全风险，守卫项目安全。
 *  **阿里代码规范：** 这一维度主要反馈开发人员对于 eslint-config-ali 阿里开发规约的遵守程度。
 *  **可维护度：** 通过 typhonjs-escomplex 对文件进行扫码，得出每个文件的可维护度，可读性及复杂度评分。针对得分较差的文件可以进行深度分析帮助开发者更好的重构复杂代码。
 *  **重复度：** 通过 jscpd 计算重复出现的代码区块占比，计算出 clone 分数。并逐一列举重复的代码，方便开发者快速定位重复代码，将其封装成公共的方法或者组件。

根据上述 5 个维度通过加权平均的方式计算项目质量分，并根据木桶效应，在计算得分的过程中加大了最低分的权重，得出最终项目质量评分。

## 项目地址 ##

github地址：https://github.com/ice-lab/iceworks/tree/master/

--------------------

推荐阅读

*1. *[GitHub 上有什么好玩的项目？][GitHub]

2. [Linux 运维必备 150 个命令汇总][Linux _ 150]

*3.** *[SpringSecurity + JWT 实现单点登录][SpringSecurity _ JWT]

*4. *[100 道 Linux 常见面试题][100 _ Linux]

![6b1771d20065f70593ddb2e8dac56894.png][]

[b7ba2c92a8982f392c6cfa0af87283d7.png]: /images/20210730/90ab66059f624b7f8f9ca054dff27caa.png
[GitHub]: http://mp.weixin.qq.com/s?__biz=MzUxNjg4NDEzNA%3D%3D&chksm=f9a2286fced5a1794eb9a73d0be7c2e16eaceabf3a0420647c40cb4202bd116d9a15dd57c008&idx=1&mid=2247498662&scene=21&sn=0087c4f3b79ba3420e917e9b42d45eda#wechat_redirect
[Linux _ 150]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e3f10f979b606a9915aea543e34da632e6af092d65f0a071845e2c079cf6fe7077bf2315c&idx=2&mid=2247518355&scene=21&sn=23c5bc3477a0185b517840b8318fb166#wechat_redirect
[SpringSecurity _ JWT]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e35bdf979bcabbb75366e1bad32bdbf8f41d1dc80b8be6e39225bd708913ce2c93472f2fc&idx=1&mid=2247516734&scene=21&sn=966d166d3052f10b9310ff4014733669#wechat_redirect
[100 _ Linux]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e367bf979bf6dec769decc0194bb36de4caeae7947671aba1852fe6bac8e5dab7d20916a5&idx=1&mid=2247516664&scene=21&sn=0dae1a8cf99c4bde8fd8c9c197769009#wechat_redirect
[6b1771d20065f70593ddb2e8dac56894.png]: /images/20210730/ee8e48d32b8e4edda9b1ca851cb94ea3.png