PHP代码规范 · 深度实践指南

从〈PSR-1〉到〈PSR-12〉,结合网民最常搜索的Composer、Laravel规范与安全实践。

⚙️ PSR标准族 · 现代PHP基石

① PSR-1 基本编码

PHP文件必须只使用 和 标签。类名必须使用大驼峰,方法名使用小驼峰。文件编码UTF-8无BOM。

② PSR-4 自动加载

命名空间前缀对应基础目录,完全替代传统include。例如 `App\Controller` 映射至 `src/Controller/`。

③ PSR-12 扩展风格

每行字符不超过120个,缩进4空格,控制结构必须使用花括号。`elseif` 不分开写。

〈命名规范〉实战手册

类名:UserController、OrderRepository · 大驼峰
方法/函数:getUserById()、calculateTotal() · 小驼峰
常量:MAX_RETRY_COUNT、API_VERSION · 全大写+下划线
变量:$userName、$totalPrice · 小驼峰,避免单字母

☆ 接口建议以`Interface`后缀,抽象类以`Abstract`前缀,例如 `PaymentInterface`。

📌 网友们还关心

📦 Composer 依赖规范

使用 composer.json 定义依赖,`require` 区块精确版本。遵循语义化版本:`^1.2` 允许次版本更新。`composer.lock` 必须提交至版本库。

  • 〈PSR-4〉自动加载映射:`"App\\": "src/"`
  • 脚本钩子:`post-install-cmd` 用于缓存清理
  • 私有包使用`repositories`指向VCS

热点 网民常搜:Composer内存不足?使用 `COMPOSER_MEMORY_LIMIT=-1`。

🔷 Laravel 编码规范

控制器保持瘦身,业务逻辑放入Service层或Action类。Eloquent模型避免直接查询作用域外数据。

  1. 路由使用RESTful资源控制器
  2. 请求验证使用FormRequest,而非控制器内验证
  3. Blade模板避免复杂PHP逻辑,使用`@include`和组件

〈网友关注〉Laravel项目务必使用 `.env` 管理配置,禁止硬编码密钥。

🛡️ PHP安全编码规范

SQL注入:必须使用PDO预处理或ORM参数绑定。输出转义使用`htmlspecialchars()`。

〈文件上传〉严格验证MIME类型与扩展名,存储目录禁止执行权限。

☆ 密码哈希:`password_hash()` 与 `password_verify()`,禁止MD5/SHA1。

⚡ 性能与规范平衡

开启Opcache,避免在循环中执行重复查询。使用严格比较`===`减少类型转换开销。

〈自动加载优化〉`composer dump-autoload -o` 生成优化类映射。

网友经验:合理使用缓存(Redis/文件),减少数据库连接次数。

📋 Composer 与 自动加载细则

每个PHP项目必须包含清晰的 `composer.json`。`autoload` 区块定义PSR-4映射,`autoload-dev` 用于测试。使用 `classmap` 作为补充。

☆ 示例:{"autoload":{"psr-4":{"Acme\\":"src/"}}}

🏗️ Laravel 项目结构规范

目录结构遵循默认约定,但业务复杂时引入 `Actions` 或 `Services` 目录。中间件用于横切关注点,如日志与权限。

🔐 PHP安全深度实践

除了SQL注入,XSS跨站脚本需对输出转义。使用CSP头限制资源加载。CSRF令牌在框架中默认开启。

☆ 文件包含漏洞:避免使用用户输入作为路径,使用白名单。

◈ 注释规范

使用PHPDoc标注@param、@return。复杂业务逻辑需解释“为什么”而非“做什么”。

◈ 错误处理

生产环境关闭display_errors,使用日志记录。自定义异常类继承\Exception。

◈ 代码复用

Trait避免过度使用,优先组合。接口隔离原则保证小而专一。

◈ 测试规范

PHPUnit测试类与源文件结构对应,方法以test开头或@test注解。

🗓️ PSR规范演进时间线

2012 · PSR-1 & PSR-2 确立基础风格
2014 · PSR-4 自动加载标准发布
2016 · PSR-6 缓存 & PSR-7 HTTP消息
2019 · PSR-12 扩展编码风格取代PSR-2
2023+ · PSR-15 请求处理器 & PSR-17 工厂

🔍 网友们还关心 · PHP代码审查清单

常用工具:PHP_CodeSniffer、PHPStan、Psalm。

※ 持续集成中建议加入代码风格检查步骤,确保团队规范统一。