PHP PSR：PSR-ASIC编码标准

深入理解PHP PSR：PSR-1基本编码规范

PHP标准推荐（PSR）是由PHP框架互操作性小组制定的PHP规范，旨在规范PHP编程实践，提升代码可读性和互操作性。 PSR-1作为基本编码规范，奠定了PHP项目代码风格的基础。

PSR-1核心要点：

1. 编码规范：所有PHP文件必须使用无BOM的UTF-8编码。BOM（字节顺序标记）可能会导致一些问题，因此必须避免。

   立即学习“PHP免费学习笔记（深入）”；

   <code class="php">// 正确示例
   <?php echo "hello, world!"; ?>
   
   // 错误示例（包含BOM）
   // ... (BOM here) ... <?php echo "hello, world!"; ?></code>

2. 文件结构：每个PHP文件应只声明符号（类、函数、常量）或产生副作用（例如，输出数据或修改HTTP头），两者不能同时存在。

   

   Mokker AI

   AI产品图添加背景

   下载

   <code class="php">// 正确示例（game.php 只声明类）
   <?php
   class Game {
       public function start() {
           echo "Game started!";
       }
   }
   ?>
   
   // 正确示例（start.php 只产生副作用）
   <?php
   require 'game.php';
   $game = new Game();
   $game->start();
   ?>
   
   // 错误示例（混合声明和副作用）
   <?php
   class Game {
       public function start() {
           echo "Game started!";
       }
   }
   $game = new Game(); // 副作用
   $game->start(); // 副作用
   ?></code>

3. 命名规范：命名空间和类名必须遵循PSR-4规范，使用StudlyCaps（帕斯卡命名法）。

   <code class="php">// 正确示例
   namespace Library\Games;
   
   class ChessGame {
       public function play() {
           echo "Game started!";
       }
   }
   
   // 错误示例（使用snake_case或小写）
   namespace library_games; // 错误
   class chess_game { // 错误
       public function play() {
           echo "Game started!";
       }
   }</code>

4. 类常量：类常量必须使用大写字母，并用下划线分隔单词。

   <code class="php">// 正确示例
   class Game {
       const MAX_PLAYERS = 4;
   }
   
   // 错误示例（小写或驼峰命名法）
   class Game {
       const maxplayers = 4; // 错误
   }</code>

5. 方法和函数命名：方法和函数名必须使用驼峰命名法。

   <code class="php">// 正确示例
   function getGameStatus() {
       return "running";
   }
   
   class Game {
       public function startGame() {
           echo "started!";
       }
   }
   
   // 错误示例（使用snake_case或帕斯卡命名法）
   function get_game_status() { // 错误
       return "Running";
   }
   
   class Game {
       public function StartGame() { // 错误
           echo "Started!";
       }
   }</code>

PSR-1总结：

PSR-1 为PHP代码风格提供了基本指导，确保代码的一致性和可读性，从而提高代码的可维护性和协作效率。 遵守PSR-1规范是编写高质量PHP代码的关键步骤。