PHP 变量命名技巧

PHP 变量命名技巧

基本命名规范

// ✅ 正确示例
$userName = 'John';        // 驼峰式：变量和函数
$user_name = 'John';       // 下划线式：常用于数据库字段
$isLoggedIn = true;        // 布尔变量用 is/has/can 开头
$userCount = 10;           // 数量用 count/total/num 
// ❌ 错误示例
$username = 'John';        // 全部小写，不易读
$USERNAME = 'John';        // 全大写，通常用于常量
$userName123 = 'John';     // 无意义的数字后缀

语义化命名技巧

// ✅ 好的命名
$userProfile             // 用户资料，而非 $data
$productPrice            // 商品价格，而非 $price1
$cartItemsCount          // 购物车商品数量
$isActiveUser            // 是否活跃用户
$getUserInfo             // 获取用户信息的方法
$userList / $userArray   // 数组类型，明确表明是集合
// ❌ 差的命名
$array1                  // 无意义
$temp                    // 临时变量，但含义不明
$data                    // 太笼统
$flag                    // 不知道代表什么标志

类型提示命名

// 变量类型暗示
$strName           // string 类型
$intAge            // integer 类型
$arrItems          // array 类型
$objUser           // object 类型
$boolEnabled       // boolean 类型
$floatPrice        // float/double 类型
// 或者更简洁的写法
$name = 'John';    // 通过值类型推断，不需要前缀
$age = 25;
$items = [];
$user = new User();
// 集合类型明示
$userList = [];          // 列表
$userMap = [];           // 映射/字典
$userCollection = [];    // 集合

上下文相关命名

// 方法内局部变量简短化
function calculateTotal($items) {
    $total = 0;           // 局部变量可以简短
    $count = count($items);
    foreach ($items as $item) {
        $total += $item->price;
    }
    return $total;
}
// 循环变量命名
foreach ($users as $user) {       // 单数形式
    echo $user->name;
}
for ($i = 0; $i < 10; $i++) {    // 简单循环用 i, j, k
    // ...
}

特殊场景命名

// 静态变量
private static $instance = null;        // 单例模式
private static $connection = null;      // 连接实例
// 全局变量（尽量避免）
$GLOBALS['app_config'] = [];           // 使用大写区分
// 常量
const MAX_FILE_SIZE = 1024000;         // 全部大写+下划线
define('API_VERSION', '1.0');
// 属性
class User {
    private $firstName;
    protected $lastName;
    public $email;
    // getter/setter 命名
    public function getFirstName() { return $this->firstName; }
    public function setFirstName($name) { $this->firstName = $name; }
}

命名模式总结

实用技巧示例

class ShoppingCart {
    // 有意义的属性名
    private $items = [];
    private $totalPrice = 0;
    private $itemCount = 0;
    private $isDiscounted = false;
    // 明确的动作命名
    public function addItem($item) {}
    public function removeItem($itemId) {}
    public function calculateTotal() {}
    public function applyDiscount($percent) {}
    // 状态查询方法
    public function isEmpty() {}
    public function hasItems() {}
    public function getCount() {}
}
// 使用示例
$cart = new ShoppingCart();
$cart->addItem($product);
$totalAmount = $cart->calculateTotal();

命名检查清单

// 命名前问自己：
1. 这个名字是否准确描述其用途？
2. 是否能通过名字推断出类型？
3. 是否与其他变量区分度高？
4. 是否符合团队/项目规范？
5. 是否便于搜索和替换？
// 好命名的特征：
$totalRevenue          // 明确是什么
$userAuthentication   // 明确功能
$isOrderConfirmed     // 明确状态
$productsByCategory   // 明确数据结构

1. 使用有意义的名称 - 命名要表达意图
2. 保持一致性 - 整个项目采用统一风格
3. 避免缩写 - 除非是显而易见的通用缩写
4. 考虑作用域 - 局部变量可简短，全局需要详细
5. 遵循框架规范 - 如 Laravel/ThinkPHP 有各自规范

好的变量命名是代码质量的重要组成部分,它可以：

• 减少代码注释的需求
• 提高代码可读性
• 降低维护成本
• 便于团队协作