@alanwang-merit/meritdata-platform-skill-package 1.0.9 → 1.0.11

package/skills/meritdata-platform-2nd-dev-check/references/rules-checklist.md

@@ -1,250 +0,0 @@
-# 9 条规则清单（2nd-dev-check）
-
-> 9 条规则逐条检查项与检测方法。
-
----
-
-## data-boundary（4 条）
-
-### §1.1 不映射 PF_ 平台表
-
-**规则**：二开业务库**不得**映射 `PF_` 前缀平台表。
-
-**检测**：
-
-```bash
-# 1. @TableName 注解
-grep -rE '@TableName\("PF_' src/main/java/
-
-# 2. CREATE TABLE 包含 PF_
-grep -rE 'CREATE TABLE PF_' src/main/resources/
-
-# 3. 跨库 JOIN
-grep -rE 'JOIN\s+PF_' src/main/resources/mapper/
-
-# 4. @Column 映射 PF_ 字段
-grep -rE '@Column\("PF_' src/main/java/
-```
-
-**通过条件**：以上 4 个命令**均无输出**。
-
-**修复**：改用 Feign Client 访问平台表。
-
-### §1.2 不分页循环逐条 Feign
-
-**规则**：循环内不得逐条调用 Feign Client。
-
-**检测**：
-
-```bash
-# 检测 for + feignClient.method() 模式
-grep -rE 'for\s*\(.*\)\s*{[^}]*feignClient\.\w+\(' src/main/java/ \
-  | grep -v 'test/'
-```
-
-**AST 高级检测**：
-
-```python
-# 检测三层嵌套循环 + Feign
-for (Page p : pages) {
-    for (Data d : p.getData()) {
-        feignClient.method(d.getId());  # N+1
-    }
-}
-```
-
-**通过条件**：检测无输出。
-
-**修复**：批量装配：`feignClient.listByIds(ids)` + 内存 join。
-
-### §1.3 不复制平台 Entity
-
-**规则**：二开代码不得 `import` 平台 Entity。
-
-**检测**：
-
-```bash
-grep -r 'import com.meritdata.cloud.platform.entity' src/main/java/com/example/
-
-# 也包括同包私有引用
-grep -r 'com.meritdata.cloud.platform.entity' src/main/java/com/example/ | grep import
-```
-
-**例外**：同 JVM 部署 + 明确引入 `cloud-system-manage-module`。
-
-**通过条件**：无 import。
-
-**修复**：用 DTO 转换 / Feign 接收。
-
-### §1.4 不掩盖平台故障
-
-**规则**：Feign 失败**不得**用空集合掩盖。
-
-**检测**：
-
-```bash
-# catch + emptyList
-grep -rn 'catch.*Exception.*emptyList\|catch.*Exception.*Collections.empty' src/main/java/ \
-  | grep -v 'test/'
-
-# 空 catch 块
-grep -rE 'catch\s*\([^)]+\)\s*{\s*}' src/main/java/ \
-  | grep -v 'test/'
-```
-
-**通过条件**：无输出。
-
-**修复**：显式 `throw new ServiceException(...)`。
-
----
-
-## domain-model（3 条）
-
-### §2.1 表/字段小写蛇形
-
-**规则**：二开业务表/字段必须小写蛇形，以 `t_` 开头。
-
-**检测**：
-
-```bash
-# 大写表名
-grep -rE 'CREATE TABLE [A-Z]' src/main/resources/
-
-# @TableName 大写
-grep -rE '@TableName\("[A-Z]' src/main/java/
-
-# @Column 字段名大写
-grep -rE '@Column\("[A-Z]' src/main/java/
-```
-
-**通过条件**：无输出。
-
-**修复**：表名 `t_order`、字段 `order_no`、实体类 `Order`（驼峰）+ `@Column("order_no")` 显式映射。
-
-### §2.2 不用名称做关联
-
-**规则**：不得用姓名/组织名做关联键。
-
-**检测**：
-
-```bash
-# SQL JOIN/WHERE 含 _name 关联
-grep -rE 'WHERE.*_[a-z]+_name\s*=|ON.*\.[a-z]+_name\s*=' src/main/resources/mapper/
-
-# Java @Query 含 name 关联
-grep -rE '@Query.*WHERE.*_name\s*=' src/main/java/
-```
-
-**通过条件**：无输出。
-
-**修复**：用 `*_user_id` / `*_dept_id` 稳定 ID。
-
-### §2.3 跨服务禁外键
-
-**规则**：跨服务禁止数据库外键。
-
-**检测**：
-
-```bash
-# ALTER TABLE ... FOREIGN KEY ... REFERENCES
-grep -rE 'FOREIGN KEY.*REFERENCES\s+\w+\.\w+' src/main/resources/ \
-  | grep -v 'local_schema'
-```
-
-**通过条件**：无输出。
-
-**修复**：应用层维护一致性（ID 引用 + 服务编排）。
-
----
-
-## code-spec（2 条）
-
-### §3.1 软删除穿透校验
-
-**规则**：软删除实体的唯一性校验**必须**走 `findXxxIncludingDeleted`。
-
-**检测**：
-
-```bash
-# 软删除实体 + JPQL 唯一性校验
-grep -rE '@SQLDelete' src/main/java/ > soft_delete_files.txt
-grep -rE 'findBy[A-Z]\w*No\b' src/main/java/ > find_no_files.txt
-# 求交集：同时含 @SQLDelete 和 findByXxxNo 的文件
-
-# 缺少 *IncludingDeleted 对应方法
-grep -rE 'findXxxIncludingDeleted' src/main/java/ > including_deleted.txt
-```
-
-**通过条件**：
-
-- 同时使用 `findByXxxNo` 和 `findXxxIncludingDeleted`
-- `findXxxIncludingDeleted` 是 `nativeQuery = true`
-- 唯一性校验用 `findXxxIncludingDeleted`
-
-**修复**：见 `code-dev-rules.md §八`。
-
-### §3.2 敏感信息不打印
-
-**规则**：日志**不得**包含 password / token / keytab。
-
-**检测**：
-
-```bash
-# 日志含敏感字段
-grep -rE 'log\.(info|debug|warn|error).*password|log\..*token|log\..*keytab' src/main/java/ \
-  | grep -v 'test/'
-
-# 硬编码密钥
-grep -rE '(password|secret|apiKey|token)\s*=\s*"[a-zA-Z0-9]{8,}"' src/main/java/ \
-  | grep -v 'test/'
-```
-
-**通过条件**：无输出。
-
-**修复**：
-
-- 日志用 `@LogMask` 自动脱敏
-- 密钥从 Nacos 配置：`@NacosValue(value = "${app.secret-key}")`
-
----
-
-## 检测脚本汇总
-
-```bash
-#!/bin/bash
-# run.sh
-
-EXIT_CODE=0
-
-run_check() {
-    local name=$1
-    local cmd=$2
-    echo "[$name]"
-    if eval "$cmd"; then
-        echo "✅ 通过"
-    else
-        echo "❌ 失败"
-        EXIT_CODE=1
-    fi
-    echo ""
-}
-
-run_check "§1.1 PF_ 平台表" "! grep -rE '@TableName\(\"PF_' src/main/java/"
-run_check "§1.2 循环 Feign" "! grep -rE 'for\\s*\\(.*\\)\\s*{[^}]*feignClient\\.\\w+\\(' src/main/java/"
-run_check "§1.3 平台 Entity" "! grep -r 'import com.meritdata.cloud.platform.entity' src/main/java/com/example/"
-run_check "§1.4 空集合掩盖" "! grep -rn 'catch.*Exception.*emptyList' src/main/java/ | grep -v test/"
-run_check "§2.1 大写表名" "! grep -rE '@TableName\\(\"[A-Z]' src/main/java/"
-run_check "§2.2 名称关联" "! grep -rE 'WHERE.*_[a-z]+_name\\s*=' src/main/resources/mapper/"
-run_check "§2.3 跨服务外键" "! grep -rE 'FOREIGN KEY.*REFERENCES\\s+\\w+\\.\\w+' src/main/resources/ | grep -v local_schema"
-run_check "§3.1 软删除穿透" "[ -f rules/soft-delete.txt ] && grep -q IncludingDeleted rules/soft-delete.txt"
-run_check "§3.2 敏感信息" "! grep -rE 'log\\..*password' src/main/java/ | grep -v test/"
-
-exit $EXIT_CODE
-```
-
-## 关联阅读
-
-- [guide.md](guide.md) — 扫描指南
-- [ci-integration.md](ci-integration.md) — CI 集成
-- [rules/meritdata-platform-data-boundary.md](../../../rules/meritdata-platform-data-boundary.md)
-- [SKILL.md](../SKILL.md)

package/skills/meritdata-platform-backend-deploy/SKILL.md

@@ -1,45 +0,0 @@
----
-name: meritdata-platform-backend-deploy
-description: |
-  后端部署。Docker 镜像 / Kubernetes 部署 / 滚动发布 / 灰度 / 健康检查 / 配置注入 / 日志收集。
-  触发场景：后端服务上线部署 / 配置 K8s Deployment / 配置健康检查 / 灰度发布 / 自动扩缩容。
-  何时不用：前端部署 → 用 meritdata-platform-frontend-deploy；CI/CD 流水线 → 用 cicd skill。
-metadata:
-  version: "1.0.0"
-  author: petroleum+rd
-  source: petroleum+rd
-  date_added: "2026-09-07"
-  last_modified: "2026-09-07"
-  risk: high
-  layer: L3
-  sub-layer: L3-C
-  stack: java
-allowed-tools: Read, Grep, Glob, Bash
----
-
-# 后端部署（backend-deploy）
-
-## 触发
-- 后端服务打包成 Docker 镜像
-- Kubernetes Deployment 配置
-- 滚动发布 / 蓝绿部署 / 灰度
-- 健康检查 / 探活配置
-- 配置注入（ConfigMap / Secret）
-- 日志收集 / 监控接入
-
-## 不触发
-- 前端部署 → 用 `meritdata-platform-frontend-deploy`
-- 业务代码 → 用开发 skill
-- 数据库变更 → 用 DBMigration skill
-
-## 前置约束
-- 镜像必须**多阶段构建**，基础镜像用官方 JDK
-- 健康检查**必须**配置（readinessProbe / livenessProbe）
-- 敏感配置**禁止**明文 → 用 Secret
-- 资源限制**必须**配置（CPU / Memory）
-
-## 路由
-- Docker + K8s 部署 → [references/guide.md](references/guide.md)
-- 灰度 / 滚动 / 蓝绿 → [references/release-strategies.md](references/release-strategies.md)
-- 健康检查 / 监控 / 日志 → [references/health-monitor-log.md](references/health-monitor-log.md)
-- [SKILL.md](../SKILL.md)

package/skills/meritdata-platform-backend-deploy/references/guide.md

@@ -1,255 +0,0 @@
-# 后端部署基础指南（backend-deploy）
-
-> Docker 镜像 / Kubernetes 部署 / 配置注入。
-
----
-
-## 1. Docker 镜像
-
-### 1.1 多阶段构建
-
-```dockerfile
-# 第一阶段：构建
-FROM maven:3.9-eclipse-temurin-17 AS builder
-WORKDIR /build
-COPY pom.xml .
-RUN mvn dependency:go-offline -B
-COPY src ./src
-RUN mvn package -DskipTests -B
-
-# 第二阶段：运行
-FROM eclipse-temurin:17-jre-alpine
-WORKDIR /app
-
-# 时区
-RUN apk add --no-cache tzdata && \
-    cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && \
-    echo "Asia/Shanghai" > /etc/timezone
-
-# 复制 jar
-COPY --from=builder /build/target/your-service.jar /app/app.jar
-
-# JVM 参数
-ENV JAVA_OPTS="-XX:+UseG1GC -XX:MaxRAMPercentage=75.0 -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp/heapdump.hprof"
-
-EXPOSE 8080
-
-ENTRYPOINT ["sh", "-c", "exec java $JAVA_OPTS -jar /app/app.jar"]
-```
-
-### 1.2 镜像优化
-
-| 优化点 | 效果 |
-|--------|------|
-| 多阶段构建 | 镜像小（无 Maven）|
-| JRE 而非 JDK | 镜像小 |
-| Alpine 基础镜像 | 镜像小 |
-| 合并 RUN | 层数少 |
-| 时区 | 日志时间正确 |
-
-## 2. Kubernetes 部署
-
-### 2.1 Deployment
-
-```yaml
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: your-service
-  namespace: meritdata
-spec:
-  replicas: 3
-  selector:
-    matchLabels:
-      app: your-service
-  template:
-    metadata:
-      labels:
-        app: your-service
-    spec:
-      containers:
-        - name: your-service
-          image: registry.example.com/your-service:v1.2.3
-          ports:
-            - containerPort: 8080
-          env:
-            - name: SPRING_PROFILES_ACTIVE
-              value: prod
-            - name: NACOS_SERVER
-              valueFrom:
-                configMapKeyRef:
-                  name: your-service-config
-                  key: nacos.server
-            - name: DB_PASSWORD
-              valueFrom:
-                secretKeyRef:
-                  name: your-service-secret
-                  key: db-password
-          resources:
-            requests:
-              cpu: 500m
-              memory: 1Gi
-            limits:
-              cpu: 2000m
-              memory: 4Gi
-          readinessProbe:
-            httpGet:
-              path: /actuator/health/readiness
-              port: 8080
-            initialDelaySeconds: 30
-            periodSeconds: 10
-          livenessProbe:
-            httpGet:
-              path: /actuator/health/liveness
-              port: 8080
-            initialDelaySeconds: 60
-            periodSeconds: 20
-```
-
-### 2.2 Service
-
-```yaml
-apiVersion: v1
-kind: Service
-metadata:
-  name: your-service
-  namespace: meritdata
-spec:
-  selector:
-    app: your-service
-  ports:
-    - port: 80
-      targetPort: 8080
-  type: ClusterIP
-```
-
-### 2.3 Ingress
-
-```yaml
-apiVersion: networking.k8s.io/v1
-kind: Ingress
-metadata:
-  name: your-service
-  namespace: meritdata
-  annotations:
-    nginx.ingress.kubernetes.io/proxy-body-size: "50m"
-spec:
-  rules:
-    - host: api.example.com
-      http:
-        paths:
-          - path: /api/your-service
-            pathType: Prefix
-            backend:
-              service:
-                name: your-service
-                port:
-                  number: 80
-```
-
-## 3. 配置管理
-
-### 3.1 ConfigMap
-
-```yaml
-apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: your-service-config
-  namespace: meritdata
-data:
-  nacos.server: nacos.example.com:8848
-  log.level: INFO
-  app.timeout: "30"
-```
-
-### 3.2 Secret
-
-```yaml
-apiVersion: v1
-kind: Secret
-metadata:
-  name: your-service-secret
-  namespace: meritdata
-type: Opaque
-stringData:
-  db-password: your-encrypted-password
-  api-key: your-api-key
-```
-
-⚠️ Secret 默认 base64 编码，**不是加密**。生产用 [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets) 或 [External Secrets Operator](https://external-secrets.io/)。
-
-### 3.3 Nacos 集成（推荐）
-
-详见 [nacos-config encryption](../meritdata-platform-nacos-config/references/encryption.md)。
-
-```yaml
-env:
-  - name: SPRING_CLOUD_NACOS_CONFIG_SERVER_ADDR
-    value: nacos.example.com:8848
-  - name: SPRING_CLOUD_NACOS_CONFIG_NAMESPACE
-    value: prod
-```
-
-## 4. 资源限制
-
-```yaml
-resources:
-  requests:
-    cpu: 500m       # 0.5 核
-    memory: 1Gi
-  limits:
-    cpu: 2000m      # 2 核
-    memory: 4Gi
-```
-
-**必须**设置 requests（K8s 调度用）和 limits（防 OOM 影响其他容器）。
-
-## 5. ❌ 反模式
-
-### 5.1 ❌ 单阶段 Docker 构建
-
-```dockerfile
-# ❌ 错：JDK + Maven 都在镜像里
-FROM maven:3.9-jdk-17
-COPY . .
-RUN mvn package
-CMD java -jar target/app.jar
-```
-
-✅ 多阶段构建。
-
-### 5.2 ❌ 明文 Secret
-
-```yaml
-# ❌ 错
-data:
-  db-password: bXlwYXNz   # "mypass" 明文 base64
-```
-
-✅ 用 Sealed Secrets / External Secrets / Vault。
-
-### 5.3 ❌ 无健康检查
-
-```yaml
-# ❌ 错：没 readinessProbe
-# 启动慢的服务 → 流量打过来 → 502
-```
-
-✅ 必须配 readinessProbe + livenessProbe。
-
-### 5.4 ❌ 无资源限制
-
-```yaml
-# ❌ 错
-resources: {}   # 没限制
-# → 一个容器 OOM → 影响整个节点
-```
-
-✅ 显式设置 requests + limits。
-
-## 6. 关联阅读
-
-- [release-strategies.md](release-strategies.md) — 灰度 / 滚动 / 蓝绿
-- [health-monitor-log.md](health-monitor-log.md) — 健康检查 + 监控 + 日志
-- [SKILL.md](../SKILL.md)