企业级 IRIS ObjectScript 代码审查方案,含批量处理、自定义规则与报告导出。
IRIS代码格式化专业版
功能概述
IRIS代码格式化专业版是一项面向实际任务的技能,主要用于专业版新增;单文件审查;
核心要点
- 批量多文件/多类审查;
- 内置固定规则;
- 自定义规则 + 团队配置;
使用与执行
Markdown/HTML 结构化报告;SQL 检查;SQL 格式 + 性能检查;基础陷阱检查;深度安全审计;复杂度 + 重复度分析;单文件格式化;
结果检查与注意事项
批量格式化 + 自动修正;执行能力模块操作,处理用户输入并返回结。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
IRIS代码格式化专业版
核心能力
| 能力模块 | 免费版 | 专业版新增 |
|---|---|---|
| 代码审查 | 单文件审查 | 批量多文件/多类审查 |
| 规范规则 | 内置固定规则 | 自定义规则 + 团队配置 |
| 报告输出 | 文本报告 | Markdown/HTML 结构化报告 |
| SQL 检查 | 基础格式 | SQL 格式 + 性能检查 |
| 陷阱分析 | 基础陷阱检查 | 深度安全审计 |
| 代码度量 | - | 复杂度 + 重复度分析 |
| 格式化 | 单文件格式化 | 批量格式化 + 自动修正 |
能力模块
执行能力模块操作,处理用户输入并返回结果。
输入: 用户提供能力模块所需的参数和指令。
输出: 返回能力模块的处理结果。
- 执行
能力模块操作,处理输入数据并返回结果 - 验证执行结果,确认输出符合预期格式
- 参考
能力模块相关配置参数进行设置
代码审查
执行代码审查操作,处理用户输入并返回结果。
输入: 用户提供代码审查所需的参数和指令。
输出: 返回代码审查的处理结果。
- 执行
代码审查操作,处理输入数据并返回结果 - 验证执行结果,确认输出符合预期格式
- 参考
代码审查相关配置参数进行设置
规范规则
执行规范规则操作,处理用户输入并返回结果。
输入: 用户提供规范规则所需的参数和指令。
输出: 返回规范规则的处理结果。
- 执行
规范规则操作,处理输入数据并返回结果 - 验证执行结果,确认输出符合预期格式
- 参考
规范规则相关配置参数进行设置
能力覆盖范围
本skill还覆盖以下能力场景: 企业级、IRIS、ObjectScript、代码审查方案、含批量处理、自定义规则与报告、面向企业级、开发团队的、代码审查与治理工、核心能力、批量代码审查与格、自定义规范规则与、团队级配置、结构化审查报告导、格式规范与性能检、Trap、深度分析与安全审、代码复杂度与重复。这些能力在上述核心功能中均有对应处理逻辑。
适用场景
- 不适用: 需要人工判断的复杂决策场景
场景一:批量代码审查
团队需要对整个模块的代码进行批量审查。
#!/bin/bash
# scripts/batch-iris-review.sh - 批量审查 IRIS 代码
MODULE_DIR=$1
REPORT_FILE="iris-review-report-$(date +%Y%m%d).md"
echo "# IRIS 代码审查报告" > "$REPORT_FILE"
echo "**审查时间**: $(date)" >> "$REPORT_FILE"
echo "**审查范围**: $MODULE_DIR" >> "$REPORT_FILE"
echo "" >> "$REPORT_FILE"
# 统计文件数
FILE_COUNT=$(find "$MODULE_DIR" -name "*.cls" -o -name "*.mac" -o -name "*.inc" | wc -l)
echo "**文件数量**: $FILE_COUNT" >> "$REPORT_FILE"
echo "" >> "$REPORT_FILE"
echo "=== 开始批量审查 $FILE_COUNT 个文件 ==="
# 批量审查
TOTAL_ISSUES=0
CRITICAL_COUNT=0
WARNING_COUNT=0
find "$MODULE_DIR" -name "*.cls" -o -name "*.mac" | while read file; do
echo "审查: $file"
# 检查命名规范
ISSUES=$(grep -n "yonghu|dingdan|zhifu" "$file" | wc -l)
if [ "$ISSUES" -gt 0 ]; then
echo "- [严重] $file: 发现拼音命名" >> "$REPORT_FILE"
fi
# 检查锁规范
LOCK_ISSUES=$(grep -n "l +^" "$file" | grep -v ":3|:5|:10" | wc -l)
if [ "$LOCK_ISSUES" -gt 0 ]; then
echo "- [警告] $file: 锁未设置超时" >> "$REPORT_FILE"
fi
# 检查事务规范
TS_COUNT=$(grep -c "tsb" "$file")
TC_COUNT=$(grep -c "tcb" "$file")
TRO_COUNT=$(grep -c "trob" "$file")
if [ "$TS_COUNT" -ne "$((TC_COUNT + TRO_COUNT))" ]; then
echo "- [严重] $file: 事务不闭合 (ts:$TS_COUNT tc:$TC_COUNT tro:$TRO_COUNT)" >> "$REPORT_FILE"
fi
# 检查后置表达式格式
POSTFIX_ISSUES=$(grep -n ") && (|) || (" "$file" | wc -l)
if [ "$POSTFIX_ISSUES" -gt 0 ]; then
echo "- [严重] $file: 后置表达式格式错误(括号与&&间有空格)" >> "$REPORT_FILE"
fi
done
echo "" >> "$REPORT_FILE"
echo "## 审查完成" >> "$REPORT_FILE"
echo "详细报告: $REPORT_FILE"
场景二:自定义规范规则配置
团队需要根据项目特点自定义规范规则。
# .iris-rules.yml - 自定义规范规则配置
rules:
# 命名规范
naming:
variable_case: lowerCamelCase
method_case: UpperCamelCase
constant_case: UPPER_SNAKE
max_variable_length: 31
max_method_length: 30
forbidden_prefixes: ["is", "arr", "str"]
required_boolean_suffix: "Flag"
# 锁规范
lock:
require_timeout: true
default_timeout: 3
require_paired: true
forbid_table_global_lock: true
require_subscript: true
# 事务规范
transaction:
require_closure: true
forbid_cross_method: true
require_blank_line: true
max_distance: 20 # ts/tc/tro 之间最大行数
# 格式规范
format:
indent: "tab"
space_around_operator: true
command_case: "lower"
use_abbreviation: true
full_spell_commands: ["for", "while", "if", "elseif", "else", "continue"]
max_line_length: 120
max_method_lines: 50
# SQL 规范
sql:
fields_per_line: 5
indent_after_newline: 3
comma_at_end: true
command_case: "lower"
# 陷阱规范
trap:
require_error_handler: true
default_trap_name: "Error"
require_zt_reset: true
require_tl_check: true
require_lock_release: true
# 严重程度映射
severity:
naming_pinyin: critical
naming_case: warning
lock_no_timeout: critical
lock_unpaired: critical
transaction_unclosed: critical
format_spacing: minor
format_abbreviation: warning
postfix_format: critical
场景三:代码复杂度分析
团队需要分析代码的复杂度和重复度,识别需要重构的代码。
#!/bin/bash
# scripts/iris-complexity.sh - 代码复杂度分析
TARGET=$1
echo "=== IRIS 代码复杂度分析 ==="
echo "目标: $TARGET"
echo ""
# 方法行数统计
echo "## 方法行数统计(超过 50 行需重构)"
echo "| 文件 | 方法 | 行数 | 状态 |"
echo "| --- | --- | --- | --- |"
find "$TARGET" -name "*.cls" | while read file; do
# 提取方法及其行数
awk '
/ClassMethod|Method/ {
method_name = $0
method_start = NR
}
/^}/ {
if (method_name != "") {
lines = NR - method_start
if (lines > 50) {
status = "需重构"
} else if (lines > 30) {
status = "建议优化"
} else {
status = "正常"
}
if (lines > 30) {
printf "| %s | %s | %d | %s |n", FILENAME, method_name, lines, status
}
method_name = ""
}
}
' "$file"
done
echo ""
echo "## 重复代码检测"
# 查找重复的代码块(5 行以上相同)
find "$TARGET" -name "*.cls" -exec cat {} ; |
awk 'BEGIN{block=""} {
block = block $0 "n"
if (NF == 0) {
if (length(block) > 100) {
print block
}
block = ""
}
}' | sort | uniq -d | head -10
使用流程
HTML 报告模板
IRIS 代码审查报告
IRIS 代码审查报告
| 审查时间 | (根据实际场景填充) |
|---|---|
| 审查范围 | 全维度 |
| 文件数量 | (根据实际场景填充) |
| 问题总数 | (根据实际场景填充) |
问题详情
| 序号 | 严重程度 | 文件 | 行号 | 问题描述 | 规范依据 |
|---|---|---|---|---|---|
| (根据实际场景填充) | (根据实际场景填充) | (根据实际场景填充) | (根据实际场景填充) | 相关说明 | (根据实际场景填充) |
SQL 格式规范检查
// SQL 格式规范
// 1. 每行 5 个字段
// 2. 换行后 3 个 Tab 缩进
// 3. 逗号在行末
// 4. 每行不超过 120 字符
// 5. SQL 命令统一小写
// 正确格式
&sql(
select id, name, age, email, phone
into :id, :name, :age, :email, :phone
from user_table
where id = :userId
)
// 错误格式
&sql(SELECT ID,NAME,AGE,EMAIL,PHONE,ADDRESS,STATUS FROM USER_TABLE WHERE ID=:userId)
// 问题:字段过多、命令大写、单行过长
命令参数说明
-rules: 命令参数,用于指定操作选项-align: 命令参数,用于指定操作选项-family: 命令参数,用于指定操作选项-iris-standards: 命令参数,用于指定操作选项-weight: 命令参数,用于指定操作选项
结果处理: 执行完成后,查看输出结果确认操作状态。成功时输出包含处理摘要和结果数据;失败时根据错误信息排查问题,参考错误处理章节获取恢复步骤。
命令参数说明
-collapse: 命令参数,用于指定操作选项-ne: 命令参数,用于指定操作选项-color: 命令参数,用于指定操作选项-complexity: 命令参数,用于指定操作选项-serif: 命令参数,用于指定操作选项
输入格式
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| content | string | 是 | 相关说明 |
| content | string | 否 | 相关说明, 默认: 全部维度 |
| strict_level | string | 否 | 审查严格度, 可选: strict/normal/loose, 默认: normal |
输出格式
{
"success": true,
"data": {
"overall_grade": "A",
"total_score": 92,
"max_score": 100,
"summary": "处理完成",
"details": [
{
"item": "代码风格",
"status": "pass",
"score": 95,
"comment": "符合规范"
},
{
"item": "安全合规",
"status": "warn",
"score": 80,
"comment": "符合规范"
}
],
"improvements": [
{
"priority": "high",
"suggestion": "建议优化",
"expected_gain": "+5分"
},
{
"priority": "medium",
"suggestion": "建议优化",
"expected_gain": "+3分"
}
]
},
"error": null
}
异常处理
- 边界输入处理: 空输入返回提示信息, 超长输入自动截断
- 降级策略: 异常时返回默认值, 确保流程不中断
| 错误场景 | 原因 | 处理方式 |
|---|---|---|
| 配置错误 | 参数缺失或格式错误 | 检查依赖说明中的配置要求 |
| 运行时错误 | 运行环境不满足 | 确认运行环境符合依赖说明 |
| 网络错误 | 连接超时或不可达 | 执行ping命令测试网络连通性,检查防火墙和代理设置连接后执行ping命令测试网络连通性,检查防火墙和代理设置连接后重新执行命令,参考国内替代方案 |
依赖说明
运行环境
- Agent 平台: 支持读取 SKILL.md 的任意 AI Agent(Claude Code / Cursor / Codex / Gemini CLI 等)
- 操作系统: Windows / macOS / Linux
- IRIS/Cache 版本: 建议 2018 及以上
- CI/CD 平台: GitLab CI / GitHub Actions / Jenkins 等
依赖说明
| 依赖项 | 类型 | 是否必需 | 获取方式 |
|---|---|---|---|
| InterSystems IRIS | 运行时 | 推荐 | InterSystems 官方获取 |
| Git | 命令行工具 | 推荐 | 系统包管理器安装 |
| YAML 解析器 | 工具 | 可选 | 系统包管理器安装 |
| LLM API | API | 必需 | 由 Agent 内置 LLM 提供 |
API Key 配置
- 本工具为纯 Markdown 指令驱动,无需额外 API Key
- IRIS 服务器连接需要配置访问凭据
- CI/CD 集成需要在平台配置对应的访问令牌
可用性分类
- 分类: MD+EXEC(Markdown 指令 + 命令行执行)
- 说明: 通过自然语言指令驱动 Agent 执行批量代码审查与格式化,专业版功能依赖命令行脚本和 CI/CD 平台
案例展示
审查规则配置文件
# team-iris-standards.yml
version: "2.0"
team: "后端开发组"
updated: "2026-07-18"
# 继承基础规则
extends: "default"
# 团队自定义覆盖
overrides:
naming:
# 团队特有前缀要求
service_prefix: "Svc"
controller_prefix: "Ctrl"
dao_prefix: "DAO"
format:
# 团队约定的方法最大行数
max_method_lines: 40 # 比默认 50 更严格
sql:
# 禁止在循环内写 SQL
forbid_sql_in_loop: true
# 必须使用参数化查询
require_parameterized: true
# 排除规则
excludes:
- "**/test/**"
- "**/legacy/**"
- "**/*.inc" # include 文件单独审查
# 报告配置
report:
format: ["markdown", "html"]
output_dir: "reports/"
include_source: true
max_suggestions: 5
错误处理
| 错误场景 | 原因 | 处理方式 |
|---|---|---|
| LLM响应超时或无响应 | 网络延迟或模型负载过高 | 执行ping命令测试网络连通性,检查防火墙和代理设置连接,执行ping命令测试网络连通性,检查防火墙和代理设置连接后重新执行命令请求;确认Agent平台LLM服务正常 |
| 输入内容格式不正确 | 用户输入不符合skill预期格式 | 检查输入是否符合skill使用说明中的格式要求,参考示例章节 |
| 执行结果与预期不符 | 指令描述不够明确或上下文不足 | 提供更详细的指令描述,补充必要的上下文信息 |
| 命令执行失败 | 运行环境不满足要求或权限不足 | 确认运行环境符合依赖说明中的要求;检查命令权限设置 |
常见问题
Q1:如何处理遗留代码的大量违规?
策略: 1. 先生成完整审查报告,评估违规规模 2. 按严重程度排序,优先修复 critical 级别 3. 使用批量格式化处理格式类问题 4. 命名和结构问题分批重构 5. 新代码必须完全合规,老代码逐步改进
Q2:自定义规则和内置规则冲突怎么办?
# 自定义规则会覆盖同名的内置规则
# 使用 extends 继承基础规则后,用 overrides 覆盖
extends: "default"
overrides:
format:
max_method_lines: 40 # 覆盖默认的 50
Q3:如何排除特定文件不被审查?
# 在规则配置中设置排除 excludes: - "**/legacy/**" # 排除 legacy 目录 - "**/*_old.cls" # 排除旧文件 - "**/test/**" # 排除测试代码
Q4:如何将审查集成到 CI/CD?
# .gitlab-ci.yml
iris-code-review:
stage: quality
script:
- ./scripts/batch-iris-review.sh src/
- |
CRITICAL_COUNT=$(grep -c "[严重]" iris-review-report-*.md)
if [ "$CRITICAL_COUNT" -gt 0 ]; then
echo "发现 $CRITICAL_COUNT 个严重问题,阻止合并"
exit 1
fi
artifacts:
reports:
## 已知限制
- 每次请求仅处理单一任务,不支持批量并发
-
- 和网络环境
热门AI工具
相关专题
本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。
0
2026.11.20
本专题整理Navicat入门教程,从认识软件界面到开展数据库操作,介绍初次使用需要了解的知识和方法。内容兼顾连接配置、数据管理及日常使用中的疑问,方便用户按学习进度查阅,为后续实践和独立操作打好基础。
0
2026.11.20
从确认数据库信息到建立可用连接,本专题串联Navicat连接数据库的相关知识和操作方法。既有初次配置时需要了解的基础内容,也有连接后的检查思路,方便用户按实际需求查阅教程,逐步熟悉数据库连接的设置流程。
0
2026.11.20
本专题汇总PHP8.6数组与数据处理教程,涵盖CSV读取和导出、引用遍历删除、array_filter回调模式、配置键名冲突、pathinfo文件名校验、GMP大整数进制转换及UTF-8正则筛选,说明升级兼容变化、输入范围和失败处理方法。
0
2026.11.20
本专题汇总PHP8.6升级迁移与弃用接口改造教程,涵盖反射调用、对象属性赋值、标识符更名、构造函数与__debugInfo调整,以及插件类名检查、常量导出、ArrayIterator排序、SPL和DTO查询参数转换,帮助梳理弃用提示并完成代码兼容改造。
0
2026.11.20
本专题汇总PHP8.6正式版安装部署与FPM运维教程,涵盖Linux并存安装、独立ini配置、扩展重新编译、Nginx切换与回滚、FPM状态监控和慢日志排查,以及环境变量、请求超时、OPcache刷新和预加载配置。
0
2026.11.20
Nginx HTTP/2漏洞该怎么修复?本专题围绕CVE-2026-123007,介绍安全版本升级、模块兼容检查和配置恢复方法,以及日志排查、权限设置等后续加固操作,方便你按实际部署情况查找对应教程。
0
2026.11.20
本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。
0
2026.11.17
本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。
0
2026.11.17
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 162万人学习
共6课时 | 54.8万人学习
最新文章