Yii框架中的Gii代码生成器深度解析

何媚京

于 2025-06-08 09:19:53 发布

阅读量744

点赞数 12

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00459/article/details/148508564

Yii框架中的Gii代码生成器深度解析

yii Yii PHP Framework 1.1.x 项目地址: https://gitcode.com/gh_mirrors/yi/yii

概述

Yii框架从1.1.2版本开始引入了一个基于Web的代码生成工具Gii，它取代了之前基于命令行的yiic shell生成工具。Gii作为Yii开发者的得力助手，能够显著提高开发效率，通过自动化生成常见的代码结构，让开发者可以专注于业务逻辑的实现。

Gii的基本使用

配置Gii模块

Gii以模块形式存在，需要先在Yii应用中配置启用。典型的配置如下：

return array(
    'modules'=>array(
        'gii'=>array(
            'class'=>'system.gii.GiiModule',
            'password'=>'设置你的访问密码',
            // 'ipFilters'=>array('127.0.0.1','192.168.1.*'),
            // 'newFileMode'=>0666,
            // 'newDirMode'=>0777,
        ),
    ),
);

关键配置项说明：

password：访问Gii界面所需的密码，必须设置
ipFilters：IP过滤，默认只允许本地访问
newFileMode/newDirMode：生成文件和目录的权限设置

安全提示：Gii作为开发工具，应当仅在内网或开发环境中使用，生产环境务必禁用。

访问Gii界面

配置完成后，可以通过以下URL访问Gii：

http://your-host/path/to/index.php?r=gii

如果使用path格式的URL，需要在urlManager组件中添加相应规则：

'urlManager'=>array(
    'urlFormat'=>'path',
    'rules'=>array(
        'gii'=>'gii',
        'gii/<controller:\w+>'=>'gii/<controller>',
        'gii/<controller:\w+>/<action:\w+>'=>'gii/<controller>/<action>',
        ...其他规则...
    ),
)

使用Gii生成代码

Gii提供了多种代码生成器，包括模型生成器、控制器生成器、表单生成器等。基本使用流程如下：

选择需要的生成器类型
填写生成参数（如模型类名、表名等）
预览生成的代码
确认无误后执行生成
检查生成日志

特别提醒：模型生成后，务必检查rules()方法中的验证规则，数据库结构往往不能完全反映实际业务验证需求。

Gii的高级定制

代码模板定制

Gii允许开发者自定义代码生成模板，这是最常见的扩展方式。以模型生成器为例，定制步骤如下：

创建模板目录：protected/gii/model/templates/compact
复制默认模板：将framework/gii/generators/model/templates/default/model.php复制到新目录
修改模板内容

例如，我们可以修改模型模板，使生成的attributeLabels()方法支持国际化：

public function attributeLabels()
{
    return array(
<?php foreach($labels as $name=>$label): ?>
        <?php echo "'$name' => Yii::t('application', '$label'),\n"; ?>
<?php endforeach; ?>
    );
}

创建自定义生成器

当内置生成器无法满足需求时，我们可以创建全新的代码生成器。下面以创建一个Widget生成器为例说明完整流程。

1. 目录结构

创建以下目录和文件：

protected/gii/widget/
    WidgetGenerator.php    // 生成器控制器
    WidgetCode.php        // 代码生成模型
    views/
        index.php         // 输入表单视图
    templates/
        default/
            widget.php    // 代码模板

2. WidgetGenerator.php

生成器控制器非常简单：

class WidgetGenerator extends CCodeGenerator
{
    public $codeModel='application.gii.widget.WidgetCode';
}

3. WidgetCode.php

代码生成模型包含核心逻辑：

class WidgetCode extends CCodeModel
{
    public $className;
    
    public function rules()
    {
        return array_merge(parent::rules(), array(
            array('className', 'required'),
            array('className', 'match', 'pattern'=>'/^\w+$/'),
        ));
    }
    
    public function prepare()
    {
        $path=Yii::getPathOfAlias('application.components.' . $this->className).'.php';
        $code=$this->render($this->templatepath.'/widget.php');
        $this->files[]=new CCodeFile($path, $code);
    }
}

4. views/index.php

生成器输入表单视图：

<h1>Widget Generator</h1>
<?php $form=$this->beginWidget('CCodeForm', array('model'=>$model)); ?>
    <div class="row">
        <?php echo $form->labelEx($model,'className'); ?>
        <?php echo $form->textField($model,'className',array('size'=>65)); ?>
        <div class="tooltip">Widget class name must only contain word characters.</div>
        <?php echo $form->error($model,'className'); ?>
    </div>
<?php $this->endWidget(); ?>

5. templates/default/widget.php

Widget类代码模板：

<?php echo '<?php'; ?>

class <?php echo $this->className; ?> extends CWidget
{
    public function run()
    {
        // 在此实现你的Widget逻辑
    }
}

生成器搜索路径

Gii通过generatorPaths属性确定生成器的搜索位置。要使用自定义生成器，需要配置：

'modules'=>array(
    'gii'=>array(
        'class'=>'system.gii.GiiModule',
        'generatorPaths'=>array(
            'application.gii',   // 添加自定义生成器路径
        ),
    ),
),

当存在同名生成器时，先找到的生成器会被优先使用。