如何在 Kiro 中通过 Steering 文件落实团队开发规范-数据库建表设计规范什么是 SteeringSteering 是 Kiro 提供的规范注入机制。你把规范写成 Markdown 文件放在.kiro/steering/目录下Kiro 在对话中会自动读取并遵守这些规范相当于给 AI 配了一份团队开发手册。文件存放位置级别路径适用范围工作区级团队共享.kiro/steering/*.md当前项目可提交到 Git用户级个人偏好~/.kiro/steering/*.md所有项目通用注博客https://blog.csdn.net/badao_liumang_qizhi三种触发模式通过文件顶部的 front-matter 控制何时加载1. 始终加载auto每次对话都会生效适合最核心的通用规范。--- inclusion: auto --- # Java 编码规范 - 类名 PascalCase - 方法名 camelCase - 数据库字段 snake_case ...2. 文件匹配时加载fileMatch当对话中涉及匹配的文件时自动加载按需触发不浪费上下文。--- inclusion: fileMatch fileMatchPattern: **/*.sql --- # 数据库表结构设计规范 - 所有表必须包含 BaseEntity 的 5 个基类字段 - 主键使用 int unsigned AUTO_INCREMENT ...常见 pattern 示例**/*.sql— 操作 SQL 文件时触发**/entity/**/*.java— 编辑 Entity 类时触发**/controller/**— 编辑 Controller 时触发Dockerfile— 编辑 Dockerfile 时触发3. 手动引用manual需要用户在聊天中用#手动引入适合偶尔才用到的操作手册。--- inclusion: manual --- # JAR 包反编译流程 ...使用时在聊天输入框输入#选择该文件即可加载。实际示例数据库设计规范场景项目所有 Entity 继承 BaseEntity但 AI 生成建表 DDL 时容易漏掉基类字段。解决创建.kiro/steering/database-design-standard.md--- inclusion: fileMatch fileMatchPattern: **/*.sql --- # 数据库表结构设计规范 ## BaseEntity 基类字段建表必须包含 | 字段名 | 类型 | 说明 | |--------|------|------| | id | int(11) unsigned NOT NULL AUTO_INCREMENT | 主键 | | version | int(11) unsigned NOT NULL | 乐观锁 | | create_user_id | int(11) unsigned NOT NULL | 创建人id | | update_user_id | int(11) unsigned NOT NULL | 更新人id | | create_time | datetime NOT NULL | 创建时间 | | update_time | datetime NOT NULL | 更新时间 | ## 表结构模板 sql CREATE TABLE xxx ( id int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT 主键id, -- 业务字段 -- version int(11) unsigned NOT NULL COMMENT 乐观锁, create_user_id int(11) unsigned NOT NULL COMMENT 创建人id, update_user_id int(11) unsigned NOT NULL COMMENT 更新人id, create_time datetime NOT NULL COMMENT 创建时间, update_time datetime NOT NULL COMMENT 更新时间, PRIMARY KEY (id) ) ENGINEInnoDB DEFAULT CHARSETutf8 COMMENT表注释; 效果下次生成 DDL 时Kiro 自动读到这个规范不会再遗漏基类字段。更多适用场景场景fileMatchPattern规范内容API 设计规范**/api/**/*.java接口命名、返回值包装、Swagger注解DTO 规范**/dto/**/*.java字段命名、序列化注解、校验注解测试规范**/*Test.java测试方法命名、Mock 规则、断言风格部署配置**/docker-compose*.yml端口分配、环境变量、网络配置Git 规范auto分支命名、commit message 格式引用外部文件Steering 中可以通过特殊语法引用项目中其他文件作为规范补充# API 设计规范 接口定义需遵循以下 OpenAPI 规范 #[[file:doc/openapi.yaml]]这样 OpenAPI spec 会被加载到上下文中AI 生成 Controller 代码时会自动对齐接口定义。小结规范写成 Markdown → 放入.kiro/steering/选择合适的inclusion模式控制加载时机提交到 Git 与团队共享核心思路把只存在于人脑中的规范变成AI 能自动读取的文档一次配置持续生效。
如何在 Kiro 中通过 Steering 文件落实团队开发规范-数据库建表设计规范什么是 SteeringSteering 是 Kiro 提供的规范注入机制。你把规范写成 Markdown 文件放在.kiro/steering/目录下Kiro 在对话中会自动读取并遵守这些规范相当于给 AI 配了一份团队开发手册。文件存放位置级别路径适用范围工作区级团队共享.kiro/steering/*.md当前项目可提交到 Git用户级个人偏好~/.kiro/steering/*.md所有项目通用注博客https://blog.csdn.net/badao_liumang_qizhi三种触发模式通过文件顶部的 front-matter 控制何时加载1. 始终加载auto每次对话都会生效适合最核心的通用规范。--- inclusion: auto --- # Java 编码规范 - 类名 PascalCase - 方法名 camelCase - 数据库字段 snake_case ...2. 文件匹配时加载fileMatch当对话中涉及匹配的文件时自动加载按需触发不浪费上下文。--- inclusion: fileMatch fileMatchPattern: **/*.sql --- # 数据库表结构设计规范 - 所有表必须包含 BaseEntity 的 5 个基类字段 - 主键使用 int unsigned AUTO_INCREMENT ...常见 pattern 示例**/*.sql— 操作 SQL 文件时触发**/entity/**/*.java— 编辑 Entity 类时触发**/controller/**— 编辑 Controller 时触发Dockerfile— 编辑 Dockerfile 时触发3. 手动引用manual需要用户在聊天中用#手动引入适合偶尔才用到的操作手册。--- inclusion: manual --- # JAR 包反编译流程 ...使用时在聊天输入框输入#选择该文件即可加载。实际示例数据库设计规范场景项目所有 Entity 继承 BaseEntity但 AI 生成建表 DDL 时容易漏掉基类字段。解决创建.kiro/steering/database-design-standard.md--- inclusion: fileMatch fileMatchPattern: **/*.sql --- # 数据库表结构设计规范 ## BaseEntity 基类字段建表必须包含 | 字段名 | 类型 | 说明 | |--------|------|------| | id | int(11) unsigned NOT NULL AUTO_INCREMENT | 主键 | | version | int(11) unsigned NOT NULL | 乐观锁 | | create_user_id | int(11) unsigned NOT NULL | 创建人id | | update_user_id | int(11) unsigned NOT NULL | 更新人id | | create_time | datetime NOT NULL | 创建时间 | | update_time | datetime NOT NULL | 更新时间 | ## 表结构模板 sql CREATE TABLE xxx ( id int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT 主键id, -- 业务字段 -- version int(11) unsigned NOT NULL COMMENT 乐观锁, create_user_id int(11) unsigned NOT NULL COMMENT 创建人id, update_user_id int(11) unsigned NOT NULL COMMENT 更新人id, create_time datetime NOT NULL COMMENT 创建时间, update_time datetime NOT NULL COMMENT 更新时间, PRIMARY KEY (id) ) ENGINEInnoDB DEFAULT CHARSETutf8 COMMENT表注释; 效果下次生成 DDL 时Kiro 自动读到这个规范不会再遗漏基类字段。更多适用场景场景fileMatchPattern规范内容API 设计规范**/api/**/*.java接口命名、返回值包装、Swagger注解DTO 规范**/dto/**/*.java字段命名、序列化注解、校验注解测试规范**/*Test.java测试方法命名、Mock 规则、断言风格部署配置**/docker-compose*.yml端口分配、环境变量、网络配置Git 规范auto分支命名、commit message 格式引用外部文件Steering 中可以通过特殊语法引用项目中其他文件作为规范补充# API 设计规范 接口定义需遵循以下 OpenAPI 规范 #[[file:doc/openapi.yaml]]这样 OpenAPI spec 会被加载到上下文中AI 生成 Controller 代码时会自动对齐接口定义。小结规范写成 Markdown → 放入.kiro/steering/选择合适的inclusion模式控制加载时机提交到 Git 与团队共享核心思路把只存在于人脑中的规范变成AI 能自动读取的文档一次配置持续生效。
