SuperAPI AI 工具集

code-quality

编程与开发

查看项目

更新于 10-16 08:05

技能介绍

用途:对 Java 代码进行系统性审查,把整洁代码原则、API 设计与 Java 最佳实践结合起来。适用触发场景包括“review this code”“code review”“check this PR”“refactor”“clean this code”“review API”“check endpoints”“REST review”,以及合并 PR 或发布 API 变更之前。

审查方式分三步:快速扫描理解意图与范围;按类别过检查清单;最后按严重程度(严重→次要→良好)汇总发现。

主要能力与检查项:整洁代码原则(DRY、KISS、YAGNI);API 契约审查,含 HTTP 动词语义与幂等性、URL 路径版本化、响应状态码、避免直接暴露 JPA 实体而使用 DTO;Java 检查清单,含空值安全(Optional、提前返回、@Nullable/@NonNull)、异常处理(禁止空 catch、过宽捕获、丢失堆栈、传播原异常原因)、资源管理(try-with-resources)、事务边界(多步写操作需 @Transactional)、命名约定;性能检查(N+1 查询、全量加载、分页)。

输出格式:按组件或功能命名,分为严重问题、重要改进、代码坏味、值得肯定的良好实践。严重级别中严重指安全、数据丢失、崩溃风险,必须合并前修复;重要指性能、可维护性、正确性问题;代码坏味为风格与复杂度等小问题;良好用于正向反馈。

限制:该技能聚焦 Java 与 REST API 场景;资料未提供安装命令、价格、平台支持范围或与其他工具的集成方式,暂未提供。