如何告别重复的PHP代码编写？krlove/code-generator助你实现代码自动化生成

PHPz

发布时间：2025-09-04 16:28:37

443人浏览过

来源于php中文网

原创

可以通过一下地址学习composer：学习地址

告别重复劳动：我的PHP代码生成之旅

你有没有遇到过这样的情况？项目里需要大量的dto（数据传输对象）、实体类或者api响应模型。这些类通常结构相似，包含着一堆属性（properties）、getter/setter方法，可能还有一些简单的构造函数和phpdoc注释。每次从数据库表或者api文档生成这些类时，你是不是都得手动创建文件、逐个定义属性、方法，还要小心翼翼地加上各种类型提示和phpdoc注释？

对我来说，这简直是开发过程中最枯燥、最耗时也最容易出错的环节。特别是当一个项目有几十个甚至上百个这样的类，每个类又有几十个字段时，那种感觉就像在无尽的复制粘贴中挣扎。改一个字段名，可能要牵连好几个文件；调整一个类型，又得小心翼翼地检查所有相关代码。我一直在想，如果能有一种方法，可以自动化地生成这些重复性的代码该多好？

Composer与

krlove/code-generator

：我的救星

就在我为这些重复劳动感到头疼时，Composer 和一个神奇的库——

krlove/code-generator

帮我彻底解决了这个问题。

Composer，作为PHP的依赖管理工具，它的强大之处在于能让我们轻松地集成各种优秀的开源库到项目中。而

krlove/code-generator

，正是这样一个专门用于生成PHP代码的工具，尤其擅长生成PHP类文件。

它的核心思想是：你可以通过编程的方式，像搭积木一样构建一个PHP类的各个组成部分，然后让它帮你把这些组件“渲染”成完整的PHP代码。

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

如何使用

krlove/code-generator

解决问题？

首先，通过Composer将其安装到你的开发环境中（注意，它通常只在开发环境使用，所以我们加上

--dev

）：

composer require krlove/code-generator --dev

安装完成后，你就可以开始“组装”你的PHP类了。

krlove/code-generator

提供了一系列模型（Model）来代表PHP代码中的各种元素，比如：

Loomi

全球首个AI社媒内容多智能体系统

下载

```
ClassModel
```
：代表整个PHP类。
```
NamespaceModel
```
：定义命名空间。
```
ClassNameModel
```
：定义类名，包括继承和实现的接口。
```
UseClassModel
```
：添加
```
use
```
语句。
```
PropertyModel
```
：定义类的属性（包括可见性、默认值、PHPDoc等）。
```
MethodModel
```
：定义类的方法（包括可见性、参数、方法体、PHPDoc等）。
```
ConstantModel
```
：定义类常量。
```
DocBlockModel
```
：为类、属性、方法添加PHPDoc注释。
```
VirtualPropertyModel
```
和
```
VirtualMethodModel
```
：用于在PHPDoc中声明“魔术”属性和方法。

我们来看一个简化的例子，假设我们要根据一个数据库表结构，动态生成一个User实体类：

<?php

require 'vendor/autoload.php';

use KrloveCodeGeneratorModelArgumentModel;
use KrloveCodeGeneratorModelClassModel;
use KrloveCodeGeneratorModelDocBlockModel;
use KrloveCodeGeneratorModelMethodModel;
use KrloveCodeGeneratorModelNamespaceModel;
use KrloveCodeGeneratorModelPropertyModel;

// 模拟从数据库获取的字段信息
$fields = [
    ['name' => 'id', 'type' => 'int', 'default' => null, 'comment' => '用户ID'],
    ['name' => 'username', 'type' => 'string', 'default' => '', 'comment' => '用户名'],
    ['name' => 'email', 'type' => 'string', 'default' => '', 'comment' => '用户邮箱'],
    ['name' => 'createdAt', 'type' => '\DateTimeImmutable', 'default' => 'new \DateTimeImmutable()', 'comment' => '创建时间'],
];

$phpClass = new ClassModel();
$phpClass->setNamespace(new NamespaceModel('App\Model')); // 设置命名空间
$phpClass->setName('User'); // 设置类名

// 添加属性和对应的getter方法
foreach ($fields as $field) {
    $property = new PropertyModel($field['name'], 'private');
    $property->setDocBlock(new DocBlockModel('@var ' . $field['type'] . ' ' . $field['comment']));
    if ($field['default'] !== null) {
        $property->setDefaultValue($field['default']);
    }
    $phpClass->addProperty($property);

    // 添加getter方法
    $methodName = 'get' . ucfirst($field['name']);
    $methodBody = 'return $this->' . $field['name'] . ';';
    $method = new MethodModel($methodName, 'public', $methodBody);
    $method->setDocBlock(new DocBlockModel('@return ' . $field['type']));
    $phpClass->addMethod($method);
}

// 最后，调用 render() 方法，它就会将你构建的模型转化为标准的PHP代码字符串
echo $phpClass->render();

输出结果大致会是这样：

<?php

namespace AppModel;

class User
{
    /**
     * @var int 用户ID
     */
    private $id;

    /**
     * @var string 用户名
     */
    private $username = '';

    /**
     * @var string 用户邮箱
     */
    private $email = '';

    /**
     * @var DateTimeImmutable 创建时间
     */
    private $createdAt = new DateTimeImmutable();

    public function getId(): int
    {
        return $this->id;
    }

    public function getUsername(): string
    {
        return $this->username;
    }

    public function getEmail(): string
    {
        return $this->email;
    }

    public function getCreatedAt(): DateTimeImmutable
    {
        return $this->createdAt;
    }
}

通过这种方式，我们只需要定义好数据的结构，就可以自动化地生成一个完整且符合规范的PHP类。这比手动敲代码要快得多，也准确得多！