Yii2 Gii 自定義代碼生成模板完整配置指南

為什麼需要自定義 Gii 模板？

Yii2 內建 Gii 代碼生成器極大提升開發效率，但官方預設模板僅為通用示例，無法滿足項目特定的編碼規範、基類繼承、註釋風格、權限控制等業務需求。自定義模板讓生成代碼「開箱即用」，減少重複修改成本。

核心步驟

1. 複製官方預設模板
   源路徑：vendor/yiisoft/yii2-gii/generators/crud/default
   複製到項目自定義目錄，如：@app/giitemplate/crud/default
2. 配置 Gii 模組註冊自定義模板
   在 config/main-local.php 或對應環境配置中：

$config['modules']['gii'] = [
    'class' => 'yii\gii\Module',
    'allowedIPs' => ['127.0.0.1', '::1'],
    'generators' => [
        'crud' => [
            'class' => 'yii\gii\generators\crud\Generator',
            'templates' => [
                'myCrud' => '@app/giitemplate/crud/default', // 模板名 => 路徑
            ],
        ],
    ],
];

3. 使用自定義模板
   打開 Gii CRUD 生成器頁面，Code Template 下拉框會出現 myCrud 選項，選中即可使用自定義模板生成代碼。

模板可定制化要點

• 控制器基類、命名空間、導入語句
• Model 搜索類、驗證規則、屬性標籤生成邏輯
• 視圖文件：_form.php、index.php、view.php、_search.php 結構與樣式類
• GridView 欄位、ActionColumn 按鈕、導出/批量操作擴展
• 統一註釋塊、代碼風格（縮進、引號、類型提示）

最佳實踐建議

1. 將自定義模板納入版本控制，團隊共享統一風格
2. 結合項目代碼規範文檔，將規範落地為模板邏輯
3. 定期同步官方模板更新（如安全修復、新特性支援）並合併到自定義版本
4. 為不同業務模塊（如後台管理、API、前台）維護差異化模板集

掌握 Gii 模板定制，能讓團隊在「生成代碼」階段就產出符合項目標準的高質量代碼，是 Yii2 工程化的關鍵一環。