在PHP开发中，良好的命名规范是代码可读性、可维护性和团队协作的基石。一个混乱的命名风格会让代码迅速变得难以理解和维护，而一套统一的规则则能让你的代码清晰如散文。本文将为你提供一份实用的PHP命名指南，涵盖变量、函数、类等核心元素的命名规则。

1. 通用基本原则

在深入具体规则前，先了解两个放之四海而皆准的原则：

  • 清晰表达意图：名称应明确表示其用途。$d 和 $daysSinceCreation，后者无需注释也能让人一目了然。

  • 保持一致性：在整个项目甚至整个团队中，坚持使用同一种命名风格。如果选择了“驼峰式”，就应始终如一。

2. 变量与函数（方法）命名

变量和函数是代码中最常见的元素，它们的命名应遵循蛇形命名法或驼峰命名法。

  • 推荐风格：蛇形命名法：这是PHP社区，尤其是框架（如Laravel, Symfony）中最为推崇的风格。它使用小写字母，单词之间用下划线 _ 分隔。
// 变量
$user_name = 'John Doe';
$is_logged_in = true;
$total_item_count = 42;

// 函数
function get_user_profile($user_id) {
    // ...
}

function calculate_total_price($items) {
    // ...
}

// 类方法
class UserController {
    publicfunction update_profile() {
        // ...
    }
}
  • 可选风格：驼峰命名法：如果你的团队或项目历史中习惯于此，驼峰命名法也是可接受的。变量和函数名首字母小写，后续每个单词首字母大写。
// 变量
$userName = 'John Doe';
$isLoggedIn = true;

// 函数
function getUserProfile($userId) {
    // ...
}

实用建议：

  • 对于布尔值变量，使用 is_, has_, can_ 等前缀，如 $is_valid, $has_permission。

  • 函数名通常以动词开头，描述其执行的操作，如 create_order(), validate_email()。

3. 类与接口命名

类、接口、Traits和枚举的命名应采用帕斯卡命名法。此规则在PHP社区中几乎毫无争议。

  • 规则：每个单词的首字母都大写，不使用下划线。
// 类
class UserProfile {
    // ...
}

class DatabaseConnection {
    // ...
}

// 接口
interface LoggerInterface {
    // ...
}

// Trait
trait LoggableTrait {
    // ...
}

// 枚举 (PHP 8.1+)
enum OrderStatus {
    case PENDING;
    case PAID;
    case SHIPPED;
}

注意：在PSR-1标准中，建议为接口加上 Interface 后缀（如 LoggerInterface），为Trait加上 Trait 后缀（如 LoggableTrait）。这虽然不是强制要求，但能极大提升代码的清晰度。

4. 常量命名

常量，包括类常量和全局常量，应使用全大写蛇形命名法。

  • 规则：所有字母大写，单词之间用下划线分隔。
// 全局常量
define('APP_VERSION', '1.0.0');
define('MAX_LOGIN_ATTEMPTS', 5);

// 类常量
class MathUtility {
    public const PI = 3.14159;
    public const DEFAULT_PAGINATION_LIMIT = 25;
}

5. 避免使用的命名

  • 单字母变量：除了在简短的循环计数器（如 $i, $j）中，应避免使用。

  • 无意义的数据类型缩写：如 $strName, $arrItems。变量名应表达“是什么”，而不是“什么类型”。

  • 拼音与英文混杂：坚持使用一种语言，强烈推荐使用准确的英文单词。

6. 遵循行业标准：PSR

PHP框架互操作性小组（PHP-FIG）制定了一系列编码标准，即PSR。遵循PSR能让你的代码与主流框架和社区保持一致。

  • PSR-1：基础编码标准 规定了类名必须使用帕斯卡命名法，类常量必须使用大写蛇形命名法，方法名必须使用驼峰命名法。

  • PSR-12：扩展编码风格指南 这是对PSR-1和PSR-2的扩展和继承，是目前最详细的编码风格指南。它明确规定了文件、命名空间、类、方法、控制结构等的格式。

总结

一套好的命名规则是专业PHP开发者的标志。记住以下要点，你的代码质量将立竿见影地提升：

  • 变量/函数：首选蛇形命名法（$user_name, get_user_data）。

  • 类/接口：必须使用帕斯卡命名法（UserController, LoggerInterface）。

  • 常量：必须使用全大写蛇形命名法（MAX_SIZE, STATUS_ACTIVE）。

  • 核心：追求清晰达意，保持团队一致，并尽量遵循PSR标准。

将这些规则付诸实践，你写出的将不仅仅是能运行的代码，更是清晰、优雅、经得起时间考验的作品。

本文转自：https://mp.weixin.qq.com/s/0rGEwgd6xIUr8d5M-rMqIA