PHP代码规范与静态分析实战

前言

在团队协作中，统一的代码规范和自动化的静态分析能极大降低沟通成本、提前发现潜在缺陷。本文将以实际项目为例，详解如何整合PHP_CodeSniffer与PHPStan，建立可落地的质量守护体系。

一、代码规范：PSR-12

PSR-12是PHP社区推荐的编码风格规范，是PSR-2的扩展。遵守它能保证代码风格一致，便于团队协作。

下面是一个违反规范的示例：

// 不符合PSR-12示例
function test($a,$b=null){
if($a===true){
return 'yes';}else{return 'no';}
}

修复后的规范代码：

// 符合PSR-12
function test($a, $b = null)
{
    if ($a === true) {
        return 'yes';
    } else {
        return 'no';
    }
}

二、PHP_CodeSniffer

PHP_CodeSniffer是静态代码规范检测工具，能自动检查并修复大部分风格问题。

安装

composer require --dev squizlabs/php_codesniffer

配置

在项目根目录创建phpcs.xml：

<?xml version="1.0"?>
<ruleset name="Project">
    <file>src</file>
    <rule ref="PSR12" />
</ruleset>

运行

vendor/bin/phpcs --standard=phpcs.xml

自动修复：

vendor/bin/phpcbf --standard=phpcs.xml

三、PHPStan：静态类型分析

PHPStan能在不运行代码的情况下发现类型错误、未定义变量等问题。

安装

composer require --dev phpstan/phpstan

配置

创建phpstan.neon：

parameters:
    level: 5
    paths:
        - src

运行

vendor/bin/phpstan analyse

示例错误代码：

function divide(int $a, int $b): int
{
    return $a / $b; // 返回float，类型错误
}

PHPStan会提示：Function divide() should return int but returns float。

四、集成到工作流

将检测集成到Git预提交钩子或CI流水线，确保每次提交都经过检查。

示例.git/hooks/pre-commit：

#!/bin/sh
vendor/bin/phpcs --standard=phpcs.xml --colors
if [ $? -ne 0 ]; then
    echo "代码规范检查未通过，请先修复。"
    exit 1
fi
vendor/bin/phpstan analyse --no-progress
if [ $? -ne 0 ]; then
    echo "静态分析发现错误，请先修复。"
    exit 1
fi

总结

通过PHP_CodeSniffer和PHPStan的组合，我们实现了代码风格统一与类型安全的双重保障。在实际项目中，建议将检查工具集成到CI/CD流程中，形成自动化质量门禁，有效减少人为失误，提高代码质量。