罗罗编程学习记录
本页内容 展开查看

06.5.3.11 Gii 代码生成与模块化

所属:全栈开发面试题库 / 06 后端框架与工程实践 / 06.5 PHP 后端 / 06.5.3 Yii

06.5.3.11-001 Gii 在 Yii 中承担什么角色?

一句话结论

Gii 是开发期代码生成器模块,按表结构与配置脚手架生成模型、控制器、视图、搜索模型等骨架代码;它不是运行时依赖,生成产物进入代码库后由开发者维护,生产环境应关闭或严格限制访问。

概念解释

Gii 通过 Web 页面或控制台入口选择生成器、填写参数,渲染模板产出 PHP 文件。它解决样板代码重复问题:CRUD 列表、表单、详情视图与基础控制器动作。生成代码是起点而非终稿,业务逻辑、校验规则与视图定制需要人工补充。

原理流程

  1. 应用配置注册 Gii 模块并限定访问来源。
  2. 开发者选择生成器(Model、CRUD、Controller 等)。
  3. 填写表名、命名空间、基类等参数。
  4. 生成器渲染模板预览文件,确认后写入磁盘。
  5. 开发者在生成骨架上补充业务代码。

代码或图示

// 配置片段(示意)
'modules' => [
    'gii' => [
        'class' => 'yii\gii\Module',
        'allowedIPs' => ['127.0.0.1', '::1'],
    ],
],

常见误区

  • 把 Gii 当成运行时组件:生成完成后代码不依赖 Gii 模块即可运行。
  • 生成后不再审阅代码:脚手架可能暴露全部字段,需按安全边界裁剪。

追问

  • Gii 有控制台入口吗?答:部分生成器支持命令行调用,具体命令与参数以当前安装的 gii 扩展为准,待确认。
  • 生产环境为什么要关 Gii?答:开放生成器可被利用探测表结构与写入文件,即使有 IP 限制也应在生产移除模块注册。

06.5.3.11-002 Gii 提供哪些常用生成器?

一句话结论

常用生成器包括 Model(AR 模型)、CRUD(控制器+视图+搜索模型)、Controller(空控制器骨架)、Form(表单模型)、Module(模块骨架)、Search Model、Fixture 等;具体可用清单随 gii 扩展版本变化。

概念解释

Model 生成器读表结构生成属性注释、规则提示与关联;CRUD 生成器基于模型产出索引、创建、更新、详情视图与控制器;Controller 只生成动作骨架;Module 生成模块目录与类;Search Model 封装列表过滤查询。生成器可通过模板目录扩展自定义产物。

原理流程

  1. 选择生成器后填写目标类名、表名、命名空间。
  2. 生成器读取数据库元数据(Model/CRUD 场景)。
  3. 套用对应模板生成文件预览。
  4. 确认后写入目标目录。

代码或图示

常用生成器对照
Model       —— ActiveRecord 类、规则提示、关联
CRUD        —— 控制器 + 视图 + SearchModel
Controller  —— 空控制器与动作占位
Form        —— 继承 Model 的表单类
Module      —— 模块目录结构与 Module 类

常见误区

  • 用 CRUD 生成器直接面向对外接口:脚手架视图与字段暴露需按 API 边界改造。
  • 混淆 Model 生成器的规则提示与最终规则:生成内容是结构参考,必填/类型规则需人工核对数据库约束与业务。

追问

  • Search Model 与普通模型区别?答:SearchModel 承载列表过滤条件,复用 Query 构造筛选,不直接代表一行记录。
  • 生成器能否产出迁移?答:迁移通常手写或由表结构反向参考;Gii 不以迁移生成为主职责,具体能力以扩展为准。

06.5.3.11-003 Gii 模块如何配置与限制访问?

一句话结论

Gii 作为模块注册在 modules 配置中,通过 allowedIPs 限定可访问来源;开发环境启用,测试/生产环境不注册模块或仅允许内网受控地址,避免未授权访问生成器页面。

概念解释

allowedIPs 支持 IP 段与通配写法;模块还可配置模板路径、生成器开关。访问控制只解决“谁能打开页面”,不替代代码审计;生产环境最稳妥的做法是从配置中移除 gii 模块,而不是依赖 IP 白名单。

原理流程

  1. 配置 modules.gii 指定模块类与访问限制。
  2. 请求进入 gii 模块时校验来源 IP。
  3. 通过后展示生成器列表与表单。
  4. 生成文件写入项目目录(依赖目录写权限)。

代码或图示

'modules' => [
    'gii' => [
        'class' => 'yii\gii\Module',
        'allowedIPs' => ['127.0.0.1', '::1', '192.168.0.*'],
    ],
],

常见误区

  • 生产保留 gii 只改 IP:代理转发后来源识别可能失真,应直接移除模块。
  • 给项目目录全局写权限配合 Gii:最小权限原则,仅开发机需要写入。

追问

  • 模块路由如何访问?答:模块 ID 进入路由前缀,Web 入口下形如 ?r=gii 或按 pretty URL 规则解析;具体路径以应用 urlManager 配置为准。
  • 如何按环境切换配置?答:主配置注册开发模块,本地/环境覆盖配置在非开发环境移除;配置分层见 06.5.3.11-012。

06.5.3.11-004 Model 生成器有哪些关键选项?

一句话结论

Model 生成器按表名生成 AR 类,选项覆盖命名空间、模型类名、基类、是否生成关联、属性标签生成、i18n 开关与表前缀处理;生成结果仍需人工核对规则与敏感字段。

概念解释

表名可使用 {{%表名}} 占位或物理表名;生成器读取列类型生成属性注释与基础规则提示;关联生成依据外键关系。基类默认 AR 基类,项目可统一替换为自定义基础模型。enableI18N 控制标签是否走翻译消息源。

原理流程

  1. 输入表名与目标命名空间。
  2. Schema 层读取列、主键、外键元数据。
  3. 模板生成类文件:tableName()、属性注释、rules() 提示、attributeLabels()、关联方法。
  4. 开发者裁剪字段、补全规则与归属校验。

代码或图示

// 生成的 AR 骨架片段(示意,实际以生成器输出为准)
class Article extends \yii\db\ActiveRecord
{
    public static function tableName()
    {
        return '{{%article}}';
    }

    public function rules()
    {
        return [
            [['title', 'status'], 'required'],
            ['status', 'integer'],
        ];
    }
}

常见误区

  • 直接相信生成的 rules():数据库可空不等于业务必填,规则需按表单场景调整。
  • 把生成模型包含全部列对外返回:敏感列应在序列化/API 输出层排除。

追问

  • 表前缀如何在生成时处理?答:配置 db 组件 tablePrefix,生成器按占位写法产出;具体选项名以当前 gii 版本为准,待确认。
  • 基类统一替换有什么好处?答:项目公共行为、时间戳自动填充、软删除可放自定义基类,生成器指定基类后集中复用。

06.5.3.11-005 CRUD 生成器如何配置控制器、视图与搜索模型?

一句话结论

CRUD 生成器基于模型类产出控制器、一套视图与可选 SearchModel,可配置控制器类名与命名空间、视图路径、基控制器、搜索模型类;生成后按业务裁剪动作、字段与权限校验。

概念解释

生成的控制器包含 index/view/create/update/delete 基础动作;index 配合 SearchModel 与分页数据提供者;视图含列表、表单、详情与操作按钮。生成器选项还可控制是否使用布局、是否生成国际化标签。脚手架默认不挂 RBAC 细粒度权限,需人工补鉴权。

原理流程

  1. 选择模型类与控制器命名空间。
  2. 生成器读取模型属性与关联。
  3. 产出控制器、SearchModel、视图文件预览。
  4. 写入后补充权限、校验、字段过滤与业务事务。

代码或图示

CRUD 产物结构(示意)
controllers/ArticleController.php
models/search/ArticleSearch.php
views/article/index.php
views/article/_form.php
views/article/view.php

常见误区

  • 生成控制器直接上线:未加权限校验、未处理删除前业务检查。
  • 视图暴露全部列:列表与详情应按业务选择字段,敏感信息不进脚手架页面。

追问

  • 生成的删除动作如何补安全?答:补权限检查、关联存在性判断与事务处理;危险操作考虑 POST/动词限制(参见 06.5.3.5-008)。
  • SearchModel 的查询如何定制?答:在 search() 方法中按业务条件组装 Query,分页与排序由数据提供者处理。

06.5.3.11-006 如何定制 Gii 模板?改造边界在哪里?

一句话结论

Gii 模板按生成器目录放置视图模板文件,可在配置中指定自定义模板路径覆盖默认模板;模板改的是“生成代码的样子”,生成后写入的业务代码不受模板再次影响,重新生成前需区分模板层与产物层。

概念解释

默认模板随 gii 扩展提供,项目可复制默认模板到自定义目录,调整类注释、命名规范、基类引用与视图片段。模板定制适合团队统一代码风格;业务个性应落在生成产物或公共基类中,而不是为每个场景改模板。

原理流程

  1. 复制默认模板目录到项目自定义位置。
  2. 修改模板文件中的占位片段。
  3. Gii 配置 templates 指向自定义目录。
  4. 生成器按新模板渲染产物。

代码或图示

// 模板配置片段(示意,配置键以当前 gii 版本为准,待确认)
'gii' => [
    'generators' => [
        'model' => ['template' => '@app/gii-templates/model'],
    ],
],

常见误区

  • 在生成产物里改风格后又重新生成:手工修改被模板覆盖,应把通用改动上移到模板或基类。
  • 模板内嵌业务分支:模板只解决结构重复,业务条件留在产物代码中。

追问

  • 模板与继承基类如何分工?答:结构、注释、公共方法引用放模板;可复用行为放基类;页面个性放视图与控制器产物。
  • 升级 gii 后模板要核对什么?答:默认模板变更点、生成器选项名与类签名,避免自定义模板引用已移除的占位变量。

06.5.3.11-007 生成代码与手写代码的边界如何维护?

一句话结论

脚手架产物中,可重新生成的结构部分遵循模板,不可重新生成的业务部分沉淀到服务层、基类或独立文件;需要再次生成时先确认哪些文件会被覆盖,避免手工修改丢失。

概念解释

建议把业务逻辑从控制器/AR 产物中抽出到 Service;生成器只重建控制器、视图骨架。对生成文件做的手工修改要记录:重新生成前备份或改为模板/基类承载。团队约定哪些目录允许 Gii 写入,哪些文件只手写。

原理流程

  1. 生成骨架后先做分层:控制器薄、服务层厚。
  2. 公共能力进基类/行为,页面个性进视图。
  3. 标注可能被重新生成的文件。
  4. 再次生成前对比模板与产物差异,保留手工业务改动。

代码或图示

分层建议
控制器产物 —— 参数接收、校验调用、响应装配
Service   —— 业务规则、事务、跨模型协调
基类/行为 —— 公共生命周期与复用逻辑
视图产物 —— 页面展示,按业务裁剪字段

常见误区

  • 在生成控制器里堆业务:下次生成或重构时难以迁移。
  • 所有模型都用 Gii 生成后不改:安全字段、规则与权限仍是人工责任。

追问

  • 生成的模型关联能否直接用?答:外键清晰的关联可参考生成结果,命名与加载策略需按查询场景核对(参见 06.5.3.7)。
  • 团队如何统一生成规范?答:在模板与基类中固化命名、基类、注释风格;新成员按既有产物结构补充业务。

06.5.3.11-008 模块(Module)类的基本结构是什么?

一句话结论

模块继承 yii\base\Module,持有控制器命名空间、视图路径与子模块配置;init() 做模块自身初始化,模块通过应用 modules 注册后形成可复用的功能单元。

概念解释

模块是应用内自包含的一组控制器、视图、模型与配置。模块类可定义 controllerNamespace、viewPath、layout 等;init() 在模块实例化后执行,用于注册事件、加载配置或初始化组件。模块可嵌套子模块,形成层级路由。

原理流程

  1. 定义模块类继承 Module,设置命名空间与路径。
  2. 应用配置在 modules 注册模块 ID 与类。
  3. 请求路由命中模块前缀时实例化模块。
  4. 模块 init() 完成初始化,再解析其下控制器动作。

代码或图示

namespace app\modules\admin;

class Module extends \yii\base\Module
{
    public $controllerNamespace = 'app\modules\admin\controllers';

    public function init()
    {
        parent::init();
        // 模块级初始化:事件、配置读取等
    }
}

常见误区

  • 在模块构造函数里读请求:初始化阶段请求上下文可能尚未就绪,请求相关逻辑放在动作或生命周期钩子中。
  • 模块类直接 new 其他模块:模块实例由应用装配,跨模块协作走组件/服务。

追问

  • 模块 id 如何使用?答:路由以模块 ID 为前缀,如 admin/default/index;模块 ID 在应用 modules 键中声明。
  • 模块视图路径默认在哪里?答:默认按模块目录下 views 解析,可通过 viewPath 覆盖;具体默认规则以当前版本为准。

06.5.3.11-009 模块如何注册、如何进入 bootstrap 与路由前缀?

一句话结论

模块在应用 modules 配置中按 ID 注册类与参数;需要在请求处理前初始化的模块加入 bootstrap;路由以模块 ID 作为前缀解析控制器与动作。

概念解释

普通模块按需在路由命中时实例化;bootstrap 中的模块在应用引导阶段提前创建,适合需要注册事件、挂载全局行为或提供控制台命令的模块。模块可带配置参数,注册时传数组覆盖模块公共属性。

原理流程

  1. modules 声明模块 ID、类与配置参数。
  2. 可选:模块 ID 加入 bootstrap 列表提前初始化。
  3. urlManager 把路由首段匹配到模块 ID。
  4. 模块解析剩余路径到控制器动作。

代码或图示

'modules' => [
    'admin' => [
        'class' => 'app\modules\admin\Module',
        'layout' => 'admin-main',
    ],
],
'bootstrap' => ['admin'],

常见误区

  • 所有模块都进 bootstrap:无谓提前实例化,增加引导开销。
  • 路由前缀与模块 ID 不一致:解析不到模块,404 或落到默认控制器。

追问

  • 模块如何提供自己的控制台命令?答:在模块初始化或控制台配置中注册命令控制器;具体命令注册方式以当前版本控制台应用文档为准,待确认。
  • 子模块如何嵌套?答:在父模块 modules 配置中继续注册子模块,路由层级随之加深。

06.5.3.11-010 模块控制器与视图的命名空间如何解析?

一句话结论

模块控制器按 controllerNamespace 解析类名,视图按模块 viewPath 或目录约定查找;控制器类名后缀 Controller,动作方法名前缀 action,与路由段对应。

概念解释

路由 admin/user/index 解析为模块 admin 下 UserController::actionIndex()。视图文件在模块 views/user/index.php;模块视图可调用布局与共享视图。命名空间遵循 PSR-4 自动加载,目录与命名空间一致。

原理流程

  1. 路由拆分为模块段、控制器段、动作段。
  2. 模块提供控制器命名空间。
  3. 拼接控制器类名并实例化。
  4. 动作渲染时按控制器 ID 与视图 ID 定位视图文件。

代码或图示

路由:admin/user/index
模块:app\modules\admin
控制器:app\modules\admin\controllers\UserController
视图:modules/admin/views/user/index.php

常见误区

  • 控制器命名空间遗漏模块前缀:类被全局控制器目录抢先解析。
  • 视图放到应用共享目录却从模块渲染:路径解析不到,需明确 viewPath 或引用共享路径。

追问

  • 模块控制器能否继承应用基控制器?答:可以,继承关系与命名空间独立;建议模块控制器继承项目公共基类以复用过滤器与响应装配。
  • 视图别名如何写?答:模块内用相对视图名;跨模块引用通过别名或视图路径显式指定,避免硬编码相对层级。

06.5.3.11-011 模块间依赖与共享服务如何组织?

一句话结论

模块间不直接 new 对方内部类,共享能力通过应用组件、服务定位器或 DI 容器中的服务暴露;模块只依赖稳定接口,内部实现可替换,避免模块双向耦合。

概念解释

跨模块协作典型场景:订单模块需要用户模块提供的资料。正确做法是定义接口与服务装配到容器,订单模块依赖接口;用户模块实现接口注册绑定。模块表结构与领域规则保持自治,跨模块关联由服务层聚合,不依赖物理外键(参见 06.5.3.9-011)。

原理流程

  1. 抽取跨模块稳定接口(领域服务/查询服务)。
  2. 实现模块在容器/应用组件中注册绑定。
  3. 消费模块通过容器或服务定位器获取接口实例。
  4. 实现更换或隔离测试时替换绑定。

代码或图示

// 示意:消费模块通过容器取服务(具体容器 API 见 06.5.3.2)
$userService = Yii::$container->get(UserServiceInterface::class);
$profile = $userService->findProfile($userId);

常见误区

  • 模块 A 直接实例化模块 B 的 AR 或控制器:内部结构变化即破坏 A。
  • 模块间互相读写对方表:边界失控,无法独立升级与替换。

追问

  • 共享数据如何避免重复查询?答:服务层聚合结果并在必要时走缓存;不暴露内部表结构给消费模块。
  • 测试中如何隔离模块依赖?答:容器绑定接口的 mock 实现,参见 06.5.3.15-004 的测试替换思路。

06.5.3.11-012 配置如何分层与合并?

一句话结论

配置按公共主配置、环境覆盖配置、参数文件分层组织,加载时按顺序数组合并;公共结构进主配置,环境差异(本地/测试/生产)进覆盖文件,可调整项进 params,避免一份配置硬编码多环境值。

概念解释

典型结构:main.php 公共组件与模块注册,main-local.php 本地数据库与密钥覆盖,params.php 业务参数。合并使用数组合并助手,后者覆盖前者;敏感值不入库进代码仓库。模块级配置可在模块类或注册数组中补充。

原理流程

  1. 入口加载主配置。
  2. 合并环境覆盖配置。
  3. 合并参数文件。
  4. 应用实例按最终配置装配组件与模块。

代码或图示

// 入口配置合并片段(示意)
$config = yii\helpers\ArrayHelper::merge(
    require __DIR__ . '/config/main.php',
    require __DIR__ . '/config/main-local.php',
    require __DIR__ . '/config/params.php'
);

常见误区

  • 多层配置用普通 array_merge 覆盖嵌套键:嵌套数组被整体替换,应使用框架数组合并助手。
  • 环境变量硬写在主配置:本地与生产配置互相污染。

追问

  • 模块自己的配置放哪里?答:模块注册数组传参,或模块 init() 读取参数文件;模块配置不污染主应用全局。
  • 配置合并顺序重要吗?答:重要,覆盖方向为后加载覆盖先加载;敏感覆盖应在最外层。

06.5.3.11-013 别名(alias)机制如何使用?

一句话结论

别名把目录路径与 URL 前缀抽象为 @名称 形式,组件、视图、资源与配置通过别名定位文件;setAlias 注册别名,getAlias 解析为实际路径,代码不硬编码目录层级。

概念解释

内置别名包括 @app(应用根)、@webroot(Web 目录)、@web(Web 基础 URL)、@vendor(Composer 目录)等,模块与扩展可注册自己的别名。别名可嵌套引用,路径解析时逐级展开。代码中通过 Yii::getAlias() 取得真实路径,避免依赖调用者当前工作目录。

原理流程

  1. 应用引导阶段注册基础别名。
  2. 模块/扩展在初始化时注册自身别名。
  3. 代码以 @app/modules/... 形式引用路径。
  4. getAlias() 按别名表解析为文件系统路径。

代码或图示

Yii::setAlias('@example', '@app/modules/example');
$path = Yii::getAlias('@example/views');

常见误区

  • 在代码中写相对路径拼接目录:调用目录变化后路径失效。
  • 别名循环引用或覆盖内置别名:定位行为难以预测,自定义别名用独立名称。

追问

  • 别名能表示 URL 吗?答:可以,@web 一类别名指向 URL 前缀;文件路径别名与 URL 别名用途不同,不可混用解析。
  • 扩展如何自带别名?答:扩展在入口或引导逻辑中 setAlias;具体约定按扩展文档,待确认。

06.5.3.11-014 前后台多入口/多应用如何组织?

一句话结论

较大项目按 Web 入口拆分前后台应用(advanced 模板思路):各自入口脚本、配置与路由,共享同一套核心代码与模块;单应用内也可用模块区分前后台,但需隔离布局、鉴权与视图资源。

概念解释

多应用结构中,后台管理与前台面向不同用户群,入口、默认路由、布局与鉴权策略不同;公共模型、服务与模块放在共享目录。单应用模块方案通过模块前缀区分,配置与组件复用同一 Application。选择取决于团队规模与发布边界,不是技术上的强制要求。

原理流程

  1. 划分入口:前台与后台各自 index.php。
  2. 分别加载对应配置与参数。
  3. 共享代码走命名空间与别名。
  4. 鉴权、布局、资源在各应用/模块内独立配置。

代码或图示

多应用目录示意
web/front/index.php    —— 前台入口
web/admin/index.php    —— 后台入口
common/                —— 共享模型与服务
modules/               —— 可复用功能模块

常见误区

  • 前后台共用同一套控制器动作:鉴权与视图差异被硬条件分支打乱。
  • 后台入口暴露在前台域名下:路由与访问控制需按部署结构隔离。

追问

  • 多应用共享数据库连接配置吗?答:连接参数可来自共享配置覆盖文件;连接实例在各应用内独立创建。
  • 模块能否被两个应用复用?答:可以,模块类与视图放共享目录,各应用注册同一模块 ID。

06.5.3.11-015 模块视图与主题覆盖是什么关系?

一句话结论

模块视图是模块自带的页面模板;主题通过 pathMap 把默认视图路径映射到主题目录,可在不改模块源码的情况下替换视图;模块私有视图与主题覆盖范围需明确约定。

概念解释

主题组件配置路径映射,渲染视图时先查主题覆盖路径,再回退默认视图。模块视图可被主题整体或局部覆盖;跨模块共享片段放布局或小部件。主题覆盖优先级与查找顺序以当前视图组件实现为准,待确认。

原理流程

  1. 配置主题 pathMap 把默认目录映射到主题目录。
  2. 控制器/小部件请求渲染视图。
  3. 视图组件按映射查找主题文件,存在则使用。
  4. 不存在则回退模块/默认视图。

代码或图示

'components' => [
    'view' => [
        'theme' => [
            'pathMap' => ['@app/views' => '@app/themes/default'],
        ],
    ],
],

常见误区

  • 主题直接复制模块源码目录:升级模块时覆盖关系混乱。
  • 依赖主题覆盖修改业务逻辑:主题只换展示,行为改动应在模块/服务层。

追问

  • 主题覆盖小部件视图吗?答:小部件自带视图也受路径映射影响,具体查找顺序以视图组件文档为准。
  • 多主题如何切换?答:按应用配置或运行时条件更换 view 组件主题配置;切换需保证视图文件齐备。

06.5.3.11-016 3.0 模块化与装配方式与 2.x 有何对照?

一句话结论

3.0 以 Composer 包与容器装配为组织核心,不再依赖全局模块树;功能单元作为包/服务注册到容器与路由中间件链,模块概念弱化,边界由接口、路由组与配置定义;具体包与目录约定以 3.0 应用模板为准。

概念解释

2.x 的 modules 注册、模块 init() 与前缀路由在 3.0 中被包化组织、路由定义与显式 DI 替代。可复用能力打包为独立包,应用模板负责注册中间件、路由组与服务。迁移时模块类需重构为服务/控制器组织方式,不能照搬 2.x 模块树。

原理流程

  1. 盘点 2.x 模块边界与对外依赖。
  2. 按 3.0 包类型拆分:控制器、服务、配置、视图。
  3. 在容器定义与路由配置中注册。
  4. 验证跨模块服务通过接口注入。

代码或图示

2.x:modules 注册 + 模块类 init + 前缀路由
3.0:Composer 包 + 容器定义 + 路由组/中间件装配(具体待确认)

常见误区

  • 把 2.x Module 类直接搬到 3.0:生命周期与注册机制已变。
  • 保留模块内静态定位器访问:3.0 倾向显式注入,全局访问是待消除的技术债。

追问

  • 3.0 是否完全没有模块概念?答:应用模板可能仍提供分组约定,但框架核心以包和容器为中心;具体形态以官方模板为准,待确认。
  • 模块迁移时哪些可复用?答:领域服务、视图片段与数据模型可保留;模块注册方式、事件挂载与控制器基类需要重写。

06.5.3.11-017 SearchModel 在列表场景中承担什么职责?

一句话结论

SearchModel 封装列表页的过滤条件与 Query 组装,继承模型做输入校验,search() 返回配置好分页/排序的数据提供者;它把表单过滤与数据访问从控制器中分离出来。

概念解释

SearchModel 属性对应可过滤字段,规则约束输入类型;search($params) 把安全属性拼到 Query 条件中。数据提供者(如 ActiveDataProvider)负责分页、排序与结果装配。复杂关联过滤在 search() 内 join 或子查询实现。

原理流程

  1. 控制器把请求参数加载进 SearchModel。
  2. 调用 search() 组装 Query。
  3. 返回 DataProvider 给视图小部件展示。
  4. 视图分页与排序回写查询条件。

代码或图示

public function search($params)
{
    $query = Article::find();
    $provider = new ActiveDataProvider(['query' => $query]);
    if (!$this->validate()) {
        return $provider;
    }
    $query->andFilterWhere(['status' => $this->status])
          ->andFilterWhere(['like', 'title', $this->keyword]);
    return $provider;
}

常见误区

  • 在控制器里直接拼列表条件:多个入口无法复用过滤规则。
  • SearchModel 未校验输入直接进 Query:非法值进入条件数组,应先收敛类型。

追问

  • 关联表过滤怎么做?答:search() 内 join 关联表并加条件,注意去重与索引;具体 join 写法参见 06.5.3.7-013。
  • 排序字段如何白名单化?答:DataProvider 排序配置限定允许排序的属性,避免任意字段排序注入。

06.5.3.11-018 生产环境如何关闭与限制 Gii?

一句话结论

生产配置不注册 gii 模块;预发/内网环境启用时用 allowedIPs 限制来源,并限制生成目录写权限;代码库中不保留开发期生成器配置与本地模板依赖。

概念解释

关闭方式:从 modules 移除 gii 注册,或按环境配置在非开发阶段不加载 gii 覆盖。保留模块但限制 IP 属于次优方案:代理环境下来源识别可能被绕过。生成器所需目录写权限在生产文件系统上也应收紧。

原理流程

  1. 主配置按环境条件判断是否注册 gii。
  2. 生产环境配置文件不含 gii 模块。
  3. Web 服务器对项目目录不开放写入。
  4. 部署检查确认 gii 路由不可访问。

代码或图示

环境策略
开发环境:注册 gii,允许本机/内网 IP
预发环境:按需注册,严格 IP 白名单 + 审计
生产环境:移除 gii 模块注册,目录只读

常见误区

  • 依赖前端隐藏 Gii 入口:直接请求生成器路由仍可访问。
  • 生产保留 gii 扩展包以便“应急生成”:攻击面大于收益,需要时在隔离环境生成后提交代码。

追问

  • 如何确认线上未暴露 Gii?答:直接访问 gii 路由确认 404/不可达,并检查配置文件未注册模块。
  • 生成器需要写哪些目录?答:模型、控制器、视图目录;按团队生成规范限定可写范围。

06.5.3.11-019 生成代码的命名与项目规范如何统一?

一句话结论

通过模板、基类与生成器选项统一命名空间、类后缀、基类引用与注释风格;项目约定在 AGENTS/README 或团队规范中固化,新生成产物与既有代码保持一致。

概念解释

规范覆盖:目录与类命名、控制器/模型/视图分层位置、基础类继承、时间戳字段处理、标签与 i18n 开关。Gii 模板承载通用结构,基类承载公共行为;评审时检查生成产物是否符合分层与安全约定。

原理流程

  1. 团队确定目录命名、基类与注释规范。
  2. 自定义 Gii 模板固化规范片段。
  3. 生成产物继承项目基类。
  4. 代码评审核对字段、规则与权限。

代码或图示

规范落地位置
命名空间/目录   —— 模板 + PSR-4 约定
公共行为/基类    —— 自定义基类与行为
视图结构        —— Gii 视图模板
业务规则/权限   —— 生成后人工补充

常见误区

  • 规范只写在文档里不进模板:每个生成产物仍需手工纠偏。
  • 不同模块混用不同基类:公共行为无法集中维护。

追问

  • 新增团队成员如何上手生成规范?答:参考既有产物与模板注释,按分层约定补充业务;模板变更需团队评审。
  • 命名规范冲突时以什么为准?答:以项目 AGENTS.md/规范文档为准,模板与代码对齐文档。

06.5.3.11-020 模块化与脚手架章节有哪些高频踩坑与检查清单?

一句话结论

高频问题集中在:Gii 生产暴露、生成代码不加权限、模块直接跨模块 new、配置嵌套覆盖错误、别名硬编码路径;交付前按“模块边界清晰、服务接口化、配置分层、别名定位、生产关 Gii、产物过安全裁剪”逐项检查。

概念解释

检查清单覆盖:模块注册与初始化时机、控制器命名空间解析、跨模块依赖走接口、配置合并方向、别名替换硬编码路径、模板与产物分层、Gii 环境开关、SearchModel 输入校验、视图主题覆盖关系。涉及 3.0 包名与配置键标注待确认并对照官方模板。

原理流程

  1. 核对模块目录、命名空间与路由前缀一致。
  2. 检查跨模块调用是否经过服务/容器接口。
  3. 审阅配置分层与环境覆盖是否安全。
  4. 确认代码路径全部走别名,无硬编码目录。
  5. 生产配置移除 Gii,生成产物补鉴权与字段裁剪。

代码或图示

模块化自检
[ ] 模块 id、控制器命名空间、视图路径一致
[ ] 跨模块依赖通过接口/服务,不直接 new 内部类
[ ] 配置分层合并,敏感值不入库
[ ] 文件定位使用别名,无相对路径拼接
[ ] 公共能力进基类/行为,业务进服务层
[ ] 生产环境不注册 Gii 模块
[ ] 生成控制器已补权限与事务
[ ] SearchModel 输入先校验再组装 Query

常见误区

  • 把模块化当成目录划分:边界、依赖与装配方式不清晰,等于多了一层路径。
  • 过度模块化:简单项目拆出大量模块增加路由与配置成本,模块粒度按复用与独立演进需要决定。

追问

  • 模块拆分粒度怎么判断?答:看是否独立发布/复用、是否有独立鉴权与视图;强耦合的功能先放同一模块内部组织。
  • 3.0 迁移时模块如何先行解耦?答:先把跨模块直接依赖改为接口服务,再拆包注册;接口稳定后替换实现与装配方式风险更低。