欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

浅谈如何提高PHP代码的质量

程序员文章站 2022-06-16 10:28:37
概述我们可以将此归咎于许多原因,但这肯定不仅仅是因为 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 配置轻松自动执行任务。 我们可以通过运行以下命令来安装它:

$ php composer.phar require --dev phing/phing

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

<?xml version="1.0" encoding="utf-8"?><project name="myproject" default="run"></project>

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

3 静态代码分析

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

4 代码风格

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

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

$ php composer.phar require --dev squizlabs/php_codesniffer

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

<?xml version="1.0" encoding="utf-8"?><project name="myproject" default="run">    <target name="phpcs" description="check code style with php_codesniffer">        <exec executable="bin/phpcs" passthru="true" checkreturn="true">            <arg line="--standard=psr1,psr2 -extensions=php src"/>        </exec>    </target>    <target name="run" depends="phpcs"/></project>

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

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

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

myproject > phpcs: file: /home/maciej/workspace/php-testing/src/domain/price.php-------------------------------------------------------------------------found 1 error affecting 1 line-------------------------------------------------------------------------28 | error | method name "price::get_value" is not in camel caps format-------------------------------------------------------------------------time: 67ms; memory: 6mb

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

5 复制 / 粘贴检测器

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

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

$ php composer.phar require --dev sebastian/phpcpd

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

 <target name="phpcpd" description="generate pmd-cpd.xml using phpcpd">    <exec executable="bin/phpcpd" passthru="true">        <arg line="src"/>    </exec></target>...<target name="run" depends="phpcs,phpcpd"/>

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

phpcpd 4.0.0 by sebastian bergmann. found 74 clones with 2929 duplicated lines in 97 files: - /home/maciej/workspace/php-testing/vendor/phpspec/phpspec/src/phpspec/matcher/triggermatcher.php:81-102 /home/maciej/workspace/php-testing/vendor/phpspec/phpspec/src/phpspec/matcher/triggermatcher.php:114-135 - /home/maciej/workspace/php-testing/vendor/squizlabs/php_codesniffer/src/reports/full.php:81-114 /home/maciej/workspace/php-testing/vendor/squizlabs/php_codesniffer/src/reports/code.php:162-195 (...)

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

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

$ php composer.phar require --dev phan/phan

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

<?phpreturn [    'target_php_version' => '7.1',    'directory_list' => [        'src',        'vendor/symfony/console',    ],    "exclude_analysis_directory_list" => [        'vendor/'    ],]; 

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

<target name="phan" description="check code with phan">   <exec executable="bin/phan" passthru="true" checkreturn="true"/></target>...<target name="run" depends="phpcs,phpcpd,phan"/>

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

myproject > phan: src/domain/pricecomparator.php:17 phantypemismatchproperty assigning \domain\priceconverter to property but \domain\pricecomparator::priceconverter is intsrc/domain/pricecomparator.php:35 phannonclassmethodcall call to method convert on non-class type int

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

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

以上就是浅谈如何提高php代码的质量的详细内容,更多关于如何提高php代码的质量的资料请关注其它相关文章!

相关标签: php 代码质量