@rdmind/rdmind 0.0.9-alpha.1 → 0.0.9-alpha.2

package/.knowledge/.ext/coding/mybatis-standards.md

@@ -0,0 +1,407 @@
+# MyBatis代码生成规范
+
+## 文件位置规范
+
+### 文件生成位置
+
+- `{Entity}Mapper.xml` → `infrastructure/resources/mapper/`
+- `{Entity}Mapper.java` → `infrastructure/mapper/`
+- `{Entity}DO.java` → `infrastructure/model/`
+
+### 目录结构示例
+
+```
+infrastructure/
+├── src/
+│   ├── main/
+│   │   ├── java/
+│   │   │   └── com/
+│   │   │       └── xiaohongshu/
+│   │   │           └── sns/
+│   │   │               └── demo/
+│   │   │                   └── infrastructure/
+│   │   │                       ├── mapper/          ← Mapper.java
+│   │   │                       └── model/           ← DO.java
+│   │   └── resources/
+│   │       └── mapper/                              ← Mapper.xml
+```
+
+---
+
+## Mapper.java规范
+
+### 强制要求
+
+1. **注解标注**：必须使用 `@Mapper` 和 `@Repository` 注解
+2. **方法命名**：使用业务语义命名，如 `findBy{Field}`、`selectBy{Field}`
+3. **参数类型**：使用DO对象或基本类型，避免使用Map等不明确类型
+
+### 代码示例
+
+```java
+@Mapper
+@Repository
+public interface CircleMapper {
+
+    /**
+     * 根据ID查询圈子
+     */
+    CircleDO findById(Long id);
+
+    /**
+     * 根据名称查询圈子
+     */
+    CircleDO findByName(String name);
+
+    /**
+     * 根据状态查询圈子列表
+     */
+    List<CircleDO> findByStatus(Integer status);
+
+    /**
+     * 插入圈子
+     */
+    int insert(CircleDO circle);
+
+    /**
+     * 更新圈子
+     */
+    int updateById(CircleDO circle);
+
+    /**
+     * 根据ID删除圈子
+     */
+    int deleteById(Long id);
+
+    /**
+     * 统计圈子数量
+     */
+    int count();
+
+    /**
+     * 根据状态统计圈子数量
+     */
+    int countByStatus(Integer status);
+}
+```
+
+### 方法命名规范
+
+- **基础CRUD**：`findById`、`insert`、`updateById`、`deleteById`
+- **业务查询**：`findBy{Field}`、`findBy{Field}And{Field}`、`findBy{Field}Like`
+- **分页查询**：`findBy{Field}AndPage`、`findByPage`
+- **统计查询**：`count`、`countBy{Field}`、`existsBy{Field}`
+- **批量操作**：`findBy{Field}s`、`deleteBy{Field}s`
+
+---
+
+## Mapper.xml规范
+
+### 强制要求
+
+1. **结果映射**：定义 `BaseResultMap` 覆盖全量字段，显式指定 `jdbcType`
+2. **字段列表**：定义 `Base_Column_List`，查询通过 `<include refid="Base_Column_List"/>` 引用
+3. **插入操作**：使用 `useGeneratedKeys="true" keyProperty="id"`
+4. **查询条件**：使用 `<where>` + `<if>` 构造条件，防止全表扫描
+5. **禁用`select *`**：必须显式引用字段列表
+
+### 代码示例
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
+<mapper namespace="com.xiaohongshu.sns.demo.infrastructure.mapper.CircleMapper">
+
+    <!-- 结果映射 -->
+    <resultMap id="BaseResultMap" type="com.xiaohongshu.sns.demo.infrastructure.model.CircleDO">
+        <id column="id" jdbcType="BIGINT" property="id"/>
+        <result column="name" jdbcType="VARCHAR" property="name"/>
+        <result column="description" jdbcType="VARCHAR" property="description"/>
+        <result column="status" jdbcType="TINYINT" property="status"/>
+        <result column="create_time" jdbcType="TIMESTAMP" property="createTime"/>
+        <result column="update_time" jdbcType="TIMESTAMP" property="updateTime"/>
+    </resultMap>
+
+    <!-- 字段列表 -->
+    <sql id="Base_Column_List">
+        id, name, description, status, create_time, update_time
+    </sql>
+
+    <!-- 根据ID查询 -->
+    <select id="findById" parameterType="java.lang.Long" resultMap="BaseResultMap">
+        SELECT
+        <include refid="Base_Column_List"/>
+        FROM circle
+        WHERE id = #{id,jdbcType=BIGINT}
+    </select>
+
+    <!-- 根据名称查询 -->
+    <select id="findByName" parameterType="java.lang.String" resultMap="BaseResultMap">
+        SELECT
+        <include refid="Base_Column_List"/>
+        FROM circle
+        WHERE name = #{name,jdbcType=VARCHAR}
+    </select>
+
+    <!-- 根据状态查询列表 -->
+    <select id="findByStatus" parameterType="java.lang.Integer" resultMap="BaseResultMap">
+        SELECT
+        <include refid="Base_Column_List"/>
+        FROM circle
+        WHERE status = #{status,jdbcType=TINYINT}
+    </select>
+
+    <!-- 插入 -->
+    <insert id="insert" parameterType="com.xiaohongshu.sns.demo.infrastructure.model.CircleDO" useGeneratedKeys="true" keyProperty="id">
+        INSERT INTO circle (name, description, status, create_time, update_time)
+        VALUES (#{name,jdbcType=VARCHAR}, #{description,jdbcType=VARCHAR}, #{status,jdbcType=TINYINT},
+                #{createTime,jdbcType=TIMESTAMP}, #{updateTime,jdbcType=TIMESTAMP})
+    </insert>
+
+    <!-- 更新 -->
+    <update id="updateById" parameterType="com.xiaohongshu.sns.demo.infrastructure.model.CircleDO">
+        UPDATE circle
+        <set>
+            <if test="name != null">
+                name = #{name,jdbcType=VARCHAR},
+            </if>
+            <if test="description != null">
+                description = #{description,jdbcType=VARCHAR},
+            </if>
+            <if test="status != null">
+                status = #{status,jdbcType=TINYINT},
+            </if>
+            update_time = #{updateTime,jdbcType=TIMESTAMP}
+        </set>
+        WHERE id = #{id,jdbcType=BIGINT}
+    </update>
+
+    <!-- 删除 -->
+    <delete id="deleteById" parameterType="java.lang.Long">
+        DELETE FROM circle
+        WHERE id = #{id,jdbcType=BIGINT}
+    </delete>
+
+    <!-- 统计数量 -->
+    <select id="count" resultType="java.lang.Integer">
+        SELECT COUNT(1) FROM circle
+    </select>
+
+    <!-- 根据状态统计数量 -->
+    <select id="countByStatus" parameterType="java.lang.Integer" resultType="java.lang.Integer">
+        SELECT COUNT(1) FROM circle
+        WHERE status = #{status,jdbcType=TINYINT}
+    </select>
+
+</mapper>
+```
+
+### 关键规范说明
+
+#### 结果映射规范
+
+- 必须定义 `BaseResultMap` 覆盖全量字段
+- 显式指定 `jdbcType` 和 `property`
+- 主键使用 `<id>` 标签，其他字段使用 `<result>` 标签
+
+#### 字段列表规范
+
+- 定义 `Base_Column_List` 包含所有字段
+- 查询时通过 `<include refid="Base_Column_List"/>` 引用
+- 禁止使用 `SELECT *`
+
+#### 插入操作规范
+
+- 使用 `useGeneratedKeys="true" keyProperty="id"`
+- 显式指定字段列表
+- 为每个参数指定 `jdbcType`
+
+#### 更新操作规范
+
+- 使用 `<set>` 和 `<if>` 构造动态更新
+- 自动更新 `update_time` 字段
+- 避免更新空值
+
+---
+
+## DO规范
+
+### 强制要求
+
+1. **字段对应**：字段与表结构严格对应
+2. **中文注释**：必须带中文注释，来源于表字段注释
+3. **Lombok注解**：必须使用 `@Data`、`@AllArgsConstructor`、`@NoArgsConstructor`
+
+### 代码示例
+
+```java
+package com.xiaohongshu.sns.demo.infrastructure.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import java.time.LocalDateTime;
+
+/**
+ * 圈子数据对象
+ */
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class CircleDO {
+
+    /**
+     * 主键ID
+     */
+    private Long id;
+
+    /**
+     * 圈子名称
+     */
+    private String name;
+
+    /**
+     * 圈子描述
+     */
+    private String description;
+
+    /**
+     * 圈子状态：0-禁用，1-启用
+     */
+    private Integer status;
+
+    /**
+     * 创建时间
+     */
+    private LocalDateTime createTime;
+
+    /**
+     * 更新时间
+     */
+    private LocalDateTime updateTime;
+}
+```
+
+### 字段类型映射
+
+| 数据库类型   | Java类型        | 说明           |
+| ------------ | --------------- | -------------- |
+| **BIGINT**   | `Long`          | 主键ID、外键ID |
+| **VARCHAR**  | `String`        | 字符串字段     |
+| **TEXT**     | `String`        | 长文本字段     |
+| **TINYINT**  | `Integer`       | 状态字段       |
+| **INT**      | `Integer`       | 整数字段       |
+| **DECIMAL**  | `BigDecimal`    | 金额字段       |
+| **DATETIME** | `LocalDateTime` | 时间字段       |
+| **DATE**     | `LocalDate`     | 日期字段       |
+
+---
+
+## 常见MyBatis错误
+
+### 缺少注解错误
+
+❌ **错误**：Mapper接口缺少必要的注解  
+✅ **正确**：必须使用@Mapper和@Repository注解
+
+**解决方案**：
+
+```java
+❌ 错误示例：
+public interface CircleMapper { // 错误：缺少注解
+    CircleDO findById(Long id);
+}
+
+✅ 正确示例：
+@Mapper
+@Repository
+public interface CircleMapper { // 正确：包含必要注解
+    CircleDO findById(Long id);
+}
+```
+
+### 使用select \*错误
+
+❌ **错误**：在Mapper.xml中使用SELECT \*  
+✅ **正确**：必须显式引用字段列表
+
+**解决方案**：
+
+```xml
+❌ 错误示例：
+<select id="findById" resultMap="BaseResultMap">
+    SELECT * FROM circle WHERE id = #{id}  <!-- 错误：使用SELECT * -->
+</select>
+
+✅ 正确示例：
+<select id="findById" resultMap="BaseResultMap">
+    SELECT
+    <include refid="Base_Column_List"/>  <!-- 正确：引用字段列表 -->
+    FROM circle WHERE id = #{id}
+</select>
+```
+
+### 缺少jdbcType错误
+
+❌ **错误**：参数缺少jdbcType指定  
+✅ **正确**：必须为每个参数指定jdbcType
+
+**解决方案**：
+
+```xml
+❌ 错误示例：
+<select id="findById" resultMap="BaseResultMap">
+    SELECT * FROM circle WHERE id = #{id}  <!-- 错误：缺少jdbcType -->
+</select>
+
+✅ 正确示例：
+<select id="findById" resultMap="BaseResultMap">
+    SELECT
+    <include refid="Base_Column_List"/>
+    FROM circle WHERE id = #{id,jdbcType=BIGINT}  <!-- 正确：指定jdbcType -->
+</select>
+```
+
+### 缺少useGeneratedKeys错误
+
+❌ **错误**：插入操作缺少useGeneratedKeys配置  
+✅ **正确**：必须配置useGeneratedKeys和keyProperty
+
+**解决方案**：
+
+```xml
+❌ 错误示例：
+<insert id="insert" parameterType="CircleDO">
+    INSERT INTO circle (name, description) VALUES (#{name}, #{description})  <!-- 错误：缺少useGeneratedKeys -->
+</insert>
+
+✅ 正确示例：
+<insert id="insert" parameterType="CircleDO" useGeneratedKeys="true" keyProperty="id">  <!-- 正确：配置useGeneratedKeys -->
+    INSERT INTO circle (name, description) VALUES (#{name,jdbcType=VARCHAR}, #{description,jdbcType=VARCHAR})
+</insert>
+```
+
+---
+
+## 质量检查清单
+
+### MyBatis代码检查
+
+- [ ] Mapper.java是否使用了@Mapper和@Repository注解？
+- [ ] 方法命名是否遵循了业务语义规范？
+- [ ] 是否避免了使用Map等不明确类型？
+- [ ] Mapper.xml是否定义了BaseResultMap？
+- [ ] 是否定义了Base_Column_List？
+- [ ] 是否避免了使用SELECT \*？
+- [ ] 是否为每个参数指定了jdbcType？
+- [ ] 插入操作是否配置了useGeneratedKeys？
+- [ ] 更新操作是否使用了动态SQL？
+- [ ] DO类是否使用了Lombok注解？
+- [ ] 字段类型是否与数据库类型对应？
+- [ ] 是否添加了必要的中文注释？
+
+### 数据库规范检查
+
+- [ ] 是否生成了完整的MyBatis映射文件？
+- [ ] 是否包含了必要的注释和校验？
+- [ ] 是否实现了领域对象与DO的双向转换？

package/.knowledge/.ext/coding/sql-standards.md

@@ -0,0 +1,263 @@
+# SQL建表规范
+
+## 基本要求
+
+在 `infra` 模块的 `resources/sql` 目录中，依据业务描述生成对应的 `.sql` 建表文件。
+
+---
+
+## 标准字段
+
+### 必须包含的字段
+
+```sql
+id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+update_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间'
+```
+
+### 字段说明
+
+- **id**：主键ID，使用BIGINT UNSIGNED AUTO_INCREMENT
+- **create_time**：创建时间，自动设置为当前时间
+- **update_time**：更新时间，自动更新为当前时间
+
+---
+
+## 字段规范
+
+### 字段定义规则
+
+- **非空约束**：除自增主键或业务确需可空字段外，字段应尽量声明 `NOT NULL`
+- **默认值**：数值`0`、字符串`''`、布尔`TINYINT(1) DEFAULT 0`
+- **索引约束**：**禁止**在字段定义中直接添加PRIMARY KEY、UNIQUE、INDEX等约束
+- **字段定义**：字段定义只包含数据类型、非空约束、默认值和注释
+
+### 字段类型规范
+
+| 数据类型            | 使用场景       | 示例                                                      |
+| ------------------- | -------------- | --------------------------------------------------------- |
+| **BIGINT UNSIGNED** | 主键ID、外键ID | `id BIGINT UNSIGNED AUTO_INCREMENT`                       |
+| **VARCHAR(n)**      | 字符串字段     | `name VARCHAR(100) NOT NULL`                              |
+| **TEXT**            | 长文本字段     | `description TEXT`                                        |
+| **TINYINT(1)**      | 布尔字段       | `status TINYINT(1) NOT NULL DEFAULT 0`                    |
+| **INT**             | 整数字段       | `count INT NOT NULL DEFAULT 0`                            |
+| **DECIMAL(p,s)**    | 金额字段       | `amount DECIMAL(10,2) NOT NULL DEFAULT 0.00`              |
+| **DATETIME**        | 时间字段       | `create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP` |
+
+---
+
+## 索引定义规范
+
+### 强制要求
+
+**重要：所有索引必须在建表语句末尾单独定义，不得在字段上直接约束**
+
+### 索引定义位置
+
+```sql
+CREATE TABLE {table_name} (
+    -- 字段定义（不包含索引约束）
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称',
+    status TINYINT(1) NOT NULL DEFAULT 0 COMMENT '状态',
+    create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+    update_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
+
+    -- 索引定义（单独在末尾定义）
+    PRIMARY KEY (id),
+    UNIQUE KEY uk_name (name),
+    KEY idx_status (status),
+    KEY idx_create_time (create_time)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='表注释';
+```
+
+### 索引命名规范
+
+- **主键索引**：`PRIMARY KEY (id)` - 不命名
+- **唯一索引**：`UNIQUE KEY uk_{field_name} ({field_name})`
+- **普通索引**：`KEY idx_{field_name} ({field_name})`
+- **复合索引**：`KEY idx_{field1}_{field2} ({field1}, {field2})`
+- **外键索引**：`KEY idx_{field_name} ({field_name})`
+
+### 索引创建策略
+
+基于常用查询和性能因素，考虑创建以下索引：
+
+1. **主键索引**：必须创建，通常为id字段
+2. **唯一索引**：业务唯一字段（如用户名、邮箱、手机号等）
+3. **查询索引**：高频查询字段（如状态、类型、创建时间等）
+4. **排序索引**：经常用于排序的字段（如创建时间、更新时间等）
+5. **复合索引**：多字段组合查询（如状态+类型+时间范围等）
+6. **外键索引**：关联查询字段（如用户ID、分类ID等）
+
+### 索引性能考虑
+
+- **选择性**：优先为选择性高的字段创建索引
+- **查询模式**：根据实际查询SQL创建合适的索引
+- **更新频率**：避免为频繁更新的字段创建过多索引
+- **索引数量**：单表索引数量控制在5个以内
+- **复合索引顺序**：遵循最左前缀原则
+
+---
+
+## 技术标准
+
+### 数据库标准
+
+- 遵循 MySQL 5.7 语法
+- 统一使用 InnoDB 存储引擎
+- 统一使用 utf8mb4 字符集
+- 统一使用 utf8mb4_general_ci 排序规则
+
+### 建表语句模板
+
+```sql
+CREATE TABLE {table_name} (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    -- 业务字段定义
+    name VARCHAR(100) NOT NULL COMMENT '名称',
+    status TINYINT(1) NOT NULL DEFAULT 0 COMMENT '状态',
+    create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+    update_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
+
+    -- 索引定义
+    PRIMARY KEY (id),
+    UNIQUE KEY uk_name (name),
+    KEY idx_status (status),
+    KEY idx_create_time (create_time)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='表注释';
+```
+
+---
+
+## 常见SQL错误
+
+### 索引定义错误
+
+❌ **错误**：在字段定义中直接添加索引约束  
+✅ **正确**：在建表语句末尾单独定义索引
+
+**解决方案**：
+
+```sql
+❌ 错误示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY, -- 错误：在字段上直接约束
+    name VARCHAR(100) NOT NULL UNIQUE,             -- 错误：在字段上直接约束
+    status TINYINT(1) NOT NULL DEFAULT 0
+);
+
+✅ 正确示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称',
+    status TINYINT(1) NOT NULL DEFAULT 0 COMMENT '状态',
+    create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+    update_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
+
+    PRIMARY KEY (id),
+    UNIQUE KEY uk_name (name),
+    KEY idx_status (status)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='圈子表';
+```
+
+### 缺少标准字段错误
+
+❌ **错误**：缺少create_time和update_time字段  
+✅ **正确**：必须包含标准字段
+
+**解决方案**：
+
+```sql
+❌ 错误示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称'
+    -- 缺少create_time和update_time字段
+);
+
+✅ 正确示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称',
+    create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+    update_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间'
+);
+```
+
+### 索引命名错误
+
+❌ **错误**：索引命名不规范  
+✅ **正确**：遵循索引命名规范
+
+**解决方案**：
+
+```sql
+❌ 错误示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称',
+    status TINYINT(1) NOT NULL DEFAULT 0 COMMENT '状态',
+
+    PRIMARY KEY (id),
+    UNIQUE KEY name_unique (name),    -- 错误：命名不规范
+    KEY status_index (status)         -- 错误：命名不规范
+);
+
+✅ 正确示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称',
+    status TINYINT(1) NOT NULL DEFAULT 0 COMMENT '状态',
+
+    PRIMARY KEY (id),
+    UNIQUE KEY uk_name (name),        -- 正确：遵循命名规范
+    KEY idx_status (status)           -- 正确：遵循命名规范
+);
+```
+
+### 字符集错误
+
+❌ **错误**：使用错误的字符集或存储引擎  
+✅ **正确**：使用标准的技术配置
+
+**解决方案**：
+
+```sql
+❌ 错误示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称'
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='圈子表'; -- 错误：使用MyISAM和utf8
+
+✅ 正确示例：
+CREATE TABLE circle (
+    id BIGINT UNSIGNED AUTO_INCREMENT COMMENT '主键ID',
+    name VARCHAR(100) NOT NULL COMMENT '名称'
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='圈子表'; -- 正确：使用InnoDB和utf8mb4
+```
+
+---
+
+## 质量检查清单
+
+### SQL建表检查
+
+- [ ] 是否包含了标准字段（id、create_time、update_time）？
+- [ ] 是否在字段定义中避免了索引约束？
+- [ ] 是否在建表语句末尾单独定义了索引？
+- [ ] 是否遵循了索引命名规范？
+- [ ] 是否使用了正确的数据类型？
+- [ ] 是否设置了合适的默认值？
+- [ ] 是否使用了InnoDB存储引擎？
+- [ ] 是否使用了utf8mb4字符集？
+- [ ] 是否添加了必要的注释？
+- [ ] 是否考虑了索引性能？
+
+### 数据库规范检查
+
+- [ ] 是否遵循了MySQL 5.7语法？
+- [ ] 是否使用了InnoDB存储引擎？
+- [ ] 是否使用了utf8mb4字符集？
+- [ ] 是否使用了utf8mb4_general_ci排序规则？