如何提高PHP代码的质量?第一部分 自动化工具

女主宣言

说实话,在代码质量方面,PHP的压力非常大。通过阅读本系列文章,您将了解如何提高PHP代码的质量。

PS:丰富的一线技术、多元化的表现形式,尽在“HULK一线技术杂谈”,点关注哦!

说实话,在代码质量方面,PHP的压力非常大。通过阅读本系列文章,您将了解如何提高PHP代码的质量。

我们可以将此归咎于许多原因,但这肯定不仅仅是因为PHP生态系统缺乏适当的测试工具。在本文中,我想向您展示一个简单的设置,用于项目的基本质量测试。 我不会详述任何特定的工具,而是专注于设定测试环境。

本文中有一个演示代码可以在GitHub上找到:https://github.com/mkosiedowski/php-testing-demo 如果你对这篇文章中的例子有任何问题,可以参考。

1

必备条件

我假设您熟悉PHP 7.1语法,您可以使用Composer和PSR-4来进行自动加载和PSR-1&PSR-2的编码标准。在我的示例中,vendor的二进制文件被安装到 ./bin 目录。

2

构建工具

我们将使用一些不同的测试工具,所以最好有一些能用一个脚本来运行它们的东西。 PHING为我们提供了解决此问题的绝佳解决方案。 PHing与Apache Ant相似,可以使用XML配置轻松自动执行任务。 我们可以通过运行以下命令来安装它:

然后,在项目的根目录中创建一些基本的build.xml文件。

在接下来的步骤中,我们将添加一些由PHing运行的目标。

3

静态代码分析

我为了提高代码质量,您可以做的第一件事就是设置静态代码分析器。他们会在没有真正运行的情况下阅读你的错误代码。这就像在几秒钟内由一个机器人完成了一个代码审查一样。很酷,不是吗?

4

代码风格

当使用正确的样式编写时,您的代码更容易维护。每个人都知道(如果你不这样做,你至少应该开始阅读Robert C. Martin的“Clean Code”),但仍然有很多团队在遵守他们达成的标准方面存在问题。我们可以用phpcs - PHP代码嗅探来自动化这个任务,有没有很神奇。

我们可以通过运行以下命令来安装:

然后添加一个在build.xml中运行它的目标。你的build.xml现在应该是这样的:

现在您可以运行 ./bin/phing了,phpc将自动检查您是否在PSR-1和PSR-2编码标准上有任何错误。

许多框架,比如Symfony,定义了它们自己的代码风格规则,我们也可以自动检查这些规则。比如:如果您使用的是Symfony框架,请检查https://github.com/leaphub/phpcs-symfony2标准,以了解如何使用phpcs检查Symfony的标准。

错误格式的文件的示例输出:

在代码评审期间,不再浪费时间检查编码标准,从现在开始,它将自动实现!

5

复制/粘贴检测器

重复的代码是不好的,每个人都知道。有时我们错误地创建了这样的代码,我们从来没有注意到它。有时我们这样做是因为我们懒惰。最好是配备一个工具,它可以在构建时提示这个问题。PHPCPD - PHP复制/粘贴检测器。

通过运行以下命令来安装它:

然后将目标添加到build.xml:

在vendor目录上运行的重复代码检查的示例输出:

6

想要真正深入的代码分析?

如果你从头开始你的项目,你应该看看Phan - 它是一个非常强大的代码分析器,它会让你的代码变得漂亮。在https://github.com/phan/phan上查看。安装非常简单 - 只需安装php-ast扩展(在Ubuntu中,您可以尝试运行sudo apt-get install php-ast)并运行:

然后创建一个配置文件 .phan/config.php 内容为:

在build.xml文件中也创建phan目标:

现在,您可以运行您的代码分析,如果您犯了错误(例如……为类属性声明错误的phpdoc类型),您应该看到这样的消息:

Phan很神奇 - 它读取你的整个代码并对它执行多次检查,包括将phpdoc声明与实际使用变量、方法、类等进行比较,你可以查看https://github.com/phan/phan#features的所有特征列表。

总结

现在,您的项目中有三个完全自动化的工具,可以保护您的代码的质量。您所需要做的就是手动运行 ./bin/phing,或者将其附加到您的git-hook或持续集成中。您的代码将被检查编码标准、重复和正式错误。这些检查应该会导致更可靠的运行时,并且花费在代码审查上的时间更少。

HULK一线技术杂谈

由360云平台团队打造的技术分享公众号,内容涉及云计算、数据库、大数据、监控、泛前端、自动化测试等众多技术领域,通过夯实的技术积累和丰富的一线实战经验,为你带来最有料的技术分享

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20180830A0OR4D00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券