/check - 后端代码规范检查

作为代码规范检查助手，自动检测项目代码是否符合 RuoYi-Vue-Plus 后端规范。

检查范围

支持三种检查模式：

1. 全量检查：/check - 检查所有代码
2. 模块检查：/check system - 检查指定模块
3. 文件检查：/check XxxServiceImpl.java - 检查指定文件

---

检查清单总览

检查项	级别	说明
包名规范	🔴 严重	必须是 org.dromara.*
完整类型引用	🔴 严重	禁止内联全限定名，必须 import
API 路径规范	🔴 严重	Controller 方法路径必须规范
权限注解检查	🟡 警告	必须使用 @SaCheckPermission
Service 接口	🟡 警告	Service 接口必须有标准方法声明
Entity 基类	🟡 警告	业务实体应继承 TenantEntity
BO 映射注解	🟡 警告	必须使用 @AutoMapper
对象转换	🟡 警告	必须用 MapstructUtils，禁止 BeanUtil
Mapper 继承	🟢 建议	必须继承 BaseMapperPlus
Map 传递数据	🟢 建议	禁止用 Map 封装业务数据

---

检查详情

1. 包名规范 [🔴 严重]

# 检查错误包名
Grep pattern: "package com\.ruoyi\." path: ruoyi-modules/ output_mode: files_with_matches
Grep pattern: "import com\.ruoyi\." path: ruoyi-modules/ output_mode: files_with_matches

// ❌ 错误
package com.ruoyi.system.service;
import com.ruoyi.common.core.domain.R;

// ✅ 正确
package org.dromara.system.service;
import org.dromara.common.core.domain.R;

2. 完整类型引用 [🔴 严重]

# 检查完整类型引用
Grep pattern: "org\.dromara\.[a-z]+\.[A-Z][a-zA-Z]+\s" path: ruoyi-modules/ glob: "*.java" output_mode: content

// ❌ 错误
public org.dromara.common.core.domain.R<XxxVo> getXxx(Long id) { ... }

// ✅ 正确
import org.dromara.common.core.domain.R;
public R<XxxVo> getXxx(Long id) { ... }

3. API 路径规范 [🔴 严重]

# 检查 Controller 方法的路径规范
Grep pattern: "@(GetMapping|PostMapping|PutMapping|DeleteMapping)\(" path: ruoyi-modules/ glob: "*Controller.java" output_mode: content -C 1

规范要求：

操作	HTTP 方法	路径格式	示例
分页查询	GET	/list 或 / 空路径	@GetMapping("/list")
获取详情	GET	/{id}	@GetMapping("/{id}")
新增	POST	/ 空路径	@PostMapping
修改	PUT	/ 空路径	@PutMapping
删除	DELETE	/{ids}	@DeleteMapping("/{ids}")
导出	POST	/export	@PostMapping("/export")

// ❌ 错误（路径不规范）
@GetMapping("/queryList")  // 应该用 /list
@PostMapping("/add")       // POST 应该不加路径
@PutMapping("/update")     // PUT 应该不加路径

// ✅ 正确
@GetMapping("/list")
@PostMapping
@PutMapping
@DeleteMapping("/{ids}")

4. 权限注解检查 [🟡 警告]

# 检查 Controller 是否使用权限注解
Grep pattern: "@SaCheckPermission" path: ruoyi-modules/ glob: "*Controller.java" output_mode: files_with_matches
Grep pattern: "public.*\(.*\)\s*\{" path: ruoyi-modules/ glob: "*Controller.java" output_mode: content -B 1

规范要求：Controller 的所有公开接口都必须添加 @SaCheckPermission 注解

// ❌ 错误（缺少权限注解）
@GetMapping("/list")
public TableDataInfo<XxxVo> list(XxxBo bo, PageQuery pageQuery) {
    return service.queryPageList(bo, pageQuery);
}

// ✅ 正确
@SaCheckPermission("xxx:list")
@GetMapping("/list")
public TableDataInfo<XxxVo> list(XxxBo bo, PageQuery pageQuery) {
    return service.queryPageList(bo, pageQuery);
}

5. Service 接口 [🟡 警告]

# 检查 Service 接口是否声明标准方法
Grep pattern: "public interface I.*Service" path: ruoyi-modules/ glob: "*Service.java" output_mode: files_with_matches

规范要求：Service 接口必须声明以下标准方法

// ✅ 正确
public interface IXxxService {
    XxxVo queryById(Long id);
    TableDataInfo<XxxVo> queryPageList(XxxBo bo, PageQuery pageQuery);
    List<XxxVo> queryList(XxxBo bo);
    Boolean insertByBo(XxxBo bo);
    Boolean updateByBo(XxxBo bo);
    Boolean deleteByIds(Collection<Long> ids);
}

6. Entity 基类 [🟡 警告]

# 检查业务实体是否继承 TenantEntity
Grep pattern: "extends TenantEntity" path: ruoyi-modules/ glob: "*.java" output_mode: files_with_matches
Grep pattern: "extends BaseEntity" path: ruoyi-modules/ glob: "*.java" output_mode: files_with_matches

// ⚠️ 普通实体（非多租户）
public class SysNotice extends BaseEntity { }

// ✅ 业务实体（多租户）
public class XxxEntity extends TenantEntity { }

7. BO 映射注解 [🟡 警告]

# 检查 BO 是否使用 @AutoMapper
Grep pattern: "@AutoMapper" path: ruoyi-modules/ glob: "*Bo.java" output_mode: files_with_matches

// ❌ 错误
public class XxxBo extends BaseEntity { }

// ✅ 正确
@AutoMapper(target = Xxx.class, reverseConvertGenerate = false)
public class XxxBo extends BaseEntity { }

8. 对象转换 [🟡 警告]

# 检查是否使用 BeanUtil
Grep pattern: "BeanUtil\.copy" path: ruoyi-modules/ output_mode: files_with_matches
Grep pattern: "BeanUtils\.copy" path: ruoyi-modules/ output_mode: files_with_matches

// ❌ 错误
BeanUtil.copyProperties(bo, entity);
BeanUtils.copyProperties(source, target);

// ✅ 正确
XxxVo vo = MapstructUtils.convert(entity, XxxVo.class);
List<XxxVo> voList = MapstructUtils.convert(entityList, XxxVo.class);

9. Mapper 继承 [🟢 建议]

Grep pattern: "extends BaseMapperPlus" path: ruoyi-modules/ output_mode: files_with_matches

// ✅ 正确
public interface XxxMapper extends BaseMapperPlus<Xxx, XxxVo> { }

10. Map 传递数据 [🟢 建议]

Grep pattern: "Map<String,\s*Object>" path: ruoyi-modules/ glob: "*Service*.java" output_mode: files_with_matches

// ❌ 错误
public Map<String, Object> getXxx(Long id) {
    Map<String, Object> result = new HashMap<>();
    result.put("id", entity.getId());
    return result;
}

// ✅ 正确（创建 VO 类）
public XxxVo getXxx(Long id) {
    return MapstructUtils.convert(entity, XxxVo.class);
}

---

输出格式

# 🔍 代码规范检查报告

**检查时间**：YYYY-MM-DD HH:mm
**检查范围**：[全量 / 模块名 / 文件名]

---

## 📋 检查结果汇总

| 类别 | 通过 | 警告 | 错误 |
|------|------|------|------|
| 后端 Java | X | X | X |

---

## 🔴 严重问题（必须修复）

### 1. [问题类型]

**文件**：`path/to/file.java:42`
**问题**：包名使用了 com.ruoyi
**代码**：
\```java
package com.ruoyi.system.service;
\```
**修复**：
\```java
package org.dromara.system.service;
\```

---

## 🟡 警告问题（建议修复）

### 1. [问题类型]
...

---

## 🟢 建议优化

### 1. [优化建议]
...

---

## ✅ 检查通过项

- [x] 包名规范
- [x] 对象转换
- ...

---

检查优先级

开发完成后必查（阻塞提交）

1. 包名是否是 org.dromara.*
2. 是否有完整类型引用（内联全限定名）
3. API 路径是否规范
4. 对象转换是否使用 MapstructUtils
5. 权限注解是否完整

代码审查建议查

1. Service 接口是否有标准方法声明
2. BO 是否有 @AutoMapper
3. Entity 是否继承正确的基类
4. Mapper 是否继承 BaseMapperPlus
5. 是否有冗余的 Map 传递

---

快速修复指南

包名错误修复

# 查找所有错误包名
Grep pattern: "package com\.ruoyi\." path: ruoyi-modules/ output_mode: files_with_matches

批量替换：com.ruoyi → org.dromara

API 路径修复

错误写法	正确写法	说明
@GetMapping("/queryList")	@GetMapping("/list")	列表查询统一用 /list
@PostMapping("/add")	@PostMapping	POST 新增不加路径
@PutMapping("/update")	@PutMapping	PUT 修改不加路径
@GetMapping	@GetMapping("/{id}")	单条查询必须加 ID 参数

权限注解修复

// 快速修复模板
@SaCheckPermission("模块:功能:操作")
@GetMapping("/list")
public TableDataInfo<XxxVo> list(...) { ... }

// 权限标识符格式
// system:notice:list       - 系统模块的通知管理-列表权限
// demo:xxx:add             - demo 模块的 xxx 功能-新增权限
// 模块:功能:操作            - [模块]:[功能]:[操作]

对象转换修复

替换前	替换后
BeanUtil.copyProperties(a, b)	MapstructUtils.convert(a, B.class)
BeanUtils.copyProperties(a, b)	MapstructUtils.convert(a, B.class)
new HashMap<>() (传递业务数据)	创建专属 VO 类

---

参考

• 正确后端代码：ruoyi-system/.../controller/system/SysNoticeController.java
• 正确 Service 代码：ruoyi-system/.../service/impl/SysNoticeServiceImpl.java