PHP 代码评审的 10 个提示

jopen 8年前

本文只代表排名前10的地区,当你接到一个关于PHP项目代码审核的任务,第二天,一个PHP高级开发者问我从哪里考虑审核PHP web 应用相关的任务.大家集体讨论,并提出列表.有趣的是,除了少数,大部分也适用于其他程序语言编写的应用.如果我在本文中有所疏漏, 欢迎读者朋友们指出书中存在的问题,并提出指导性意见,不胜感谢。

在这篇文章中提到的以下的关键点:

  1. 业务功能

  2. 框架相关的编码指南

  3. 面向对象原则

  4. PHP-规范标准

  5. 编程方式的最佳实践

  6. 设计模式

  7. 代码覆盖率

  8. 安全性

  9. 异常处理

  10. 集成模式

在进入细节之前,我不得不提到我认为以下8参数(ISO 25000 SQUARE标准)想出不同的代码复审标准覆盖代码质量的方方面面。

  • 功能适用性

  • 可维护性

  • 可用性

  • 安全性

  • 有效性

  • 可靠性

  • 可移植性

  • 兼容性

坚持业务功能

首先,重要的是尝试,看看是否你可以验证和验证如果代码交付所需的业务功能。这可 能需要你跟业务分析师交流和让自己清晰这些业务功能。对于遗留项目,对于业务分析师,这是很难抓住。然而,对于正在进行中的项目,它更加简单了。检查业务 功能实际上也适用于其他编程语言除了PHP。


框架相关的编码指南

如下所示的几个框架可以用于创建基于PHP的web应用程序。你可能会想如果这些代码可以按照特定的框架编写达到编码规范并且最好的情况下能作为框架制定的部分。

面向对象的原则

这一条同样也适用于其他编程语言。你可能会想检查PHP代码是否违反了一下几条面向对象原则,并且能够发现指出代码以及适当的对代码进行一些重构。

  • 单一功能、开闭原则、里氏替换、接口隔离以及依赖反转

  • 不要写重复代码

  • 适可而止原则

  • 迪米特法则即“最少知识原则”

PHP-specific标准

你可能想要方便的PHP编程语言标准和最佳实践和评审代码列表。

编程方面的最佳实践

然后,有些领域使用的数据结构,麦凯布代码复杂性,您愿意考虑,同时审查代码对编程方面的最佳实践。这也适用于其他编程语言。

使用设计模式

这儿有一些PHP设计模式,可以通过一个标准的方式来改善你的代码结构。从您可能想要查看代码的角度来看,建议可以应用适当的设计模式,。我发现这种像样的页面足够提及几个设计模式应用于PHP。

代码覆盖率

这是标准的代码评审练习和一个可能想检查底层代码的代码覆盖率和强调重要的编写单元测试。这也适用于其他编程语言。

安全性

截止到今天,安全性是一个重要的领域,需要从业务连续性和声誉的角度来看,考虑在做代码审查的安全重要性。你可能想强调使用PHP OWASP library应用在那些基于PHP的应用级安全的应用程序们。你可能也想用PHP security cheat sheet来处理。

异常处理

这是非常重要的方面,考虑到了应用程序的可靠性。这可能是个好主意,对于查看异常/错误处理机制/实践中使用的代码并且给予适当地建议。这也同样的适用于其他的编程语言。

集成模式/协议  

你可能希望确定用于应用程序和审查依附于标准的设计/代码规范的集成标准/协议。你可能希望检查应用程序特地暴露出来作为将来共同集成应用程序的其他应用程序请求的API。这同样适用于其他的编程语言。