企业级 IRIS ObjectScript 代码审查方案,含批量处理、自定义规则与报告导出。
IRIS代码格式化专业版是一项面向实际任务的技能,主要用于专业版新增;单文件审查;
Markdown/HTML 结构化报告;SQL 检查;SQL 格式 + 性能检查;基础陷阱检查;深度安全审计;复杂度 + 重复度分析;单文件格式化;
批量格式化 + 自动修正;执行能力模块操作,处理用户输入并返回结。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
| 能力模块 | 免费版 | 专业版新增 |
|---|---|---|
| 代码审查 | 单文件审查 | 批量多文件/多类审查 |
| 规范规则 | 内置固定规则 | 自定义规则 + 团队配置 |
| 报告输出 | 文本报告 | 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
IRIS 代码审查报告
IRIS 代码审查报告
| 审查时间 | (根据实际场景填充) |
|---|---|
| 审查范围 | 全维度 |
| 文件数量 | (根据实际场景填充) |
| 问题总数 | (根据实际场景填充) |
| 序号 | 严重程度 | 文件 | 行号 | 问题描述 | 规范依据 |
|---|---|---|---|---|---|
| (根据实际场景填充) | (根据实际场景填充) | (根据实际场景填充) | (根据实际场景填充) | 相关说明 | (根据实际场景填充) |
// 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命令测试网络连通性,检查防火墙和代理设置连接后重新执行命令,参考国内替代方案 |
| 依赖项 | 类型 | 是否必需 | 获取方式 |
|---|---|---|---|
| InterSystems IRIS | 运行时 | 推荐 | InterSystems 官方获取 |
| Git | 命令行工具 | 推荐 | 系统包管理器安装 |
| YAML 解析器 | 工具 | 可选 | 系统包管理器安装 |
| LLM API | API | 必需 | 由 Agent 内置 LLM 提供 |
# 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使用说明中的格式要求,参考示例章节 |
| 执行结果与预期不符 | 指令描述不够明确或上下文不足 | 提供更详细的指令描述,补充必要的上下文信息 |
| 命令执行失败 | 运行环境不满足要求或权限不足 | 确认运行环境符合依赖说明中的要求;检查命令权限设置 |
策略: 1. 先生成完整审查报告,评估违规规模 2. 按严重程度排序,优先修复 critical 级别 3. 使用批量格式化处理格式类问题 4. 命名和结构问题分批重构 5. 新代码必须完全合规,老代码逐步改进
# 自定义规则会覆盖同名的内置规则
# 使用 extends 继承基础规则后,用 overrides 覆盖
extends: "default"
overrides:
format:
max_method_lines: 40 # 覆盖默认的 50
# 在规则配置中设置排除 excludes: - "**/legacy/**" # 排除 legacy 目录 - "**/*_old.cls" # 排除旧文件 - "**/test/**" # 排除测试代码
# .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:
## 已知限制
- 每次请求仅处理单一任务,不支持批量并发
-
- 和网络环境
相关专题
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.3万人学习
共49课时 | 82.7万人学习
最新文章