Jeecg Onlreport

JeecgBoot Online 报表 AI 自动生成器

将自然语言描述的报表需求，转换为 Online 报表配置，并通过 API 自动创建/编辑/查询。

重要：本 skill 处理「Online 报表」（SQL 驱动的只读数据报表），不涉及 Online 表单（cgform）或设计器表单（desform）。

核心能力

Step 0: 收集凭证

每次操作前必须收集以下信息（如果用户已提供则跳过）：

1. API 地址 — JeecgBoot 后端地址，如 https://boot3.jeecg.com/jeecgboot
2. X-Access-Token — JWT 令牌，从浏览器 F12 → Network → 任意请求的 Request Headers 中复制

用户未提供时提示：

请提供 JeecgBoot 后端地址和 X-Access-Token。

Step 1: 判断操作类型

根据用户意图判断操作类型：

⚠️ 菜单挂载与角色授权为可选操作，不得默认执行：

• 用户只说"创建报表"→ 仅执行 create_report + validate_report，不挂载菜单，不授权角色
• 用户明确说"挂载到菜单"、"绑定菜单"、"授权给 xxx 角色"等关键词 → 才调用 publish_report 或 create_and_publish
• 违反此规则会导致：超出用户意图、产生不必要的菜单记录、因全量拉取权限列表而显著增加耗时

Step 2: 查询报表

API 初始化（统一入口）：所有 Python 操作前必须先调用 init_api，与 desform_utils 保持一致：

import sys
sys.path.insert(0, r'<skill目录>/scripts')
from onlreport_api import init_api
init_api('<api_base>', '<token>')

后续按需导入：list_all_reports_table, list_fields_by_code_table, list_reports, query_report, list_fields, list_params, parse_sql, create_report, edit_report, gen_id, create_menu, get_role_id_by_code, grant_menu_to_role, add_data_rule, query_data_rules

2.1 快速列表（语法糖）

首选方式，调用 list_all_reports_table() 一次返回所有报表的名称/编码/SQL 表格，自动分页遍历：

from onlreport_api import init_api, list_all_reports_table
init_api('<api_base>', '<token>')
list_all_reports_table()

返回 Markdown 表格，仅含三个字段（报表名称、报表编码、报表 SQL），方便 AI 直接使用：

| 报表名称 | 报表编码 | 报表 SQL |
|----------|----------|----------|
| 关联报表查询 | fz_sql | SELECT u.id, u.username ... |
| ... | ... | ... |

或通过 CLI：

python "<skill目录>/scripts/onlreport_api.py" \
    --api-base <URL> --token <TOKEN> -a list-table

2.2 按编码查字段（语法糖）

首选方式，调用 list_fields_by_code_table(code) 直接通过报表编码查字段：

from onlreport_api import init_api, list_fields_by_code_table
init_api('<api_base>', '<token>')
list_fields_by_code_table('fz_sql')

返回 Markdown 表格，仅含三个字段（字段编码、字段文本、字段类型），自动分页：

| 字段编码 | 字段文本(显示名) | 字段类型 |
|----------|-----------------|----------|
| id | ID | String |
| username | username | String |
| realname | realname | String |

或通过 CLI：

python "<skill目录>/scripts/onlreport_api.py" \
    --api-base <URL> --token <TOKEN> -a fields-table --code fz_sql

底层 API：GET /online/cgreport/item/listByHeadCode?headCode={code}

2.3 查询报表详情

用户指定报表 ID 或编码后，依次查询：

GET /online/cgreport/head/queryById?id={headId}        # 报表头配置
GET /online/cgreport/item/listByHeadId?headId={headId}  # 字段列表
GET /online/cgreport/param/listByHeadId?headId={headId}  # 参数列表

展示完整配置供用户参考，询问是否需要修改。

Step 3: 新增报表

3.1 收集需求

从用户描述中提取：

创建前必须校验报表编码唯一性，调用 check_code_available(code) 或直接调用接口：

GET /sys/duplicate/check?tableName=onl_cgreport_head&fieldName=code&fieldVal={code}

返回 success: true 表示编码可用，false 表示已被占用，需换一个。create_report() 内部已自动调用此校验。

SQL 有两种来源：

1. 用户直接提供 SQL → 直接使用
2. 用户描述需求 → 需要用户确认表名和字段（调用 parseSql 验证）

3.2 调用 parseSql 解析字段

必须先调用 parseSql 获取字段和参数列表：

GET /online/cgreport/head/parseSql?sql={urlEncodedSql}&dbKey={dbKey}

返回结构：字段列表 fields[] 和参数列表 params[]。

为什么必须先调用 parseSql？ 因为 SQL 中的 ${paramName} 会被解析为参数列表，字段列表是后续构造 items 配置的依据。

parseSql 失败处理

SQL 包含复杂函数（如 name like concat('%','${username}','%')）时会解析失败。解决方案：

1. 先将问题条件去掉，用简化 SQL 解析
2. 解析成功后，在 SQL 参数 tab 手工新增参数名（如 username，对应 ${username}）
3. 最终保存时 cgrSql 使用完整的原始 SQL

3.3 智能字段配置

根据字段名语义，自动推导每个字段的配置。

字段通用属性

searchMode 说明：有效值只有 single（单值查询）和 group（范围查询）两种。String 类型的 single 查询在后端会自动执行 LIKE 模糊匹配；Date/Datetime 类型用 group 实现范围选择。有字典配置时下拉选择自动生效。

parseSql 返回的 fieldType 通常是 String，AI 必须根据字段名语义修正为正确的类型（Date/Datetime/BigDecimal/Integer/Long/Image 等）。

isOrder/isSearch 为 null 表示"否"，不要用 0，否则可能影响前端展示。

字典配置 (dictCode)

普通字典（输入字典 code）：

• 常用系统字典：sex、priority、valid_status、urgent_level、yn

SQL 字典（查另一张表）：格式固定为 SELECT id 'value', name 'text' FROM table_name，字段别名必须是 value 和 text：

SELECT username AS value, realname AS text FROM sys_user

replaceVal 格式（导出时文本替换）：显示文本_数据库值 逗号分隔，例如 男_1,女_2

分组表头 (groupTitle)

同一分组的多个字段设置相同的 groupTitle，可实现多级表头：

{"fieldName": "q1_amount", "groupTitle": "第一季度"}
{"fieldName": "q1_count",  "groupTitle": "第一季度"}

字段跳转 (fieldHref)

支持以下语法：

Step 4: 编辑报表

4.1 查询现有配置

1. 用户提供报表 ID 或编码
2. 依次调用 queryById、listByHeadId（字段）、listByHeadId（参数）
3. 展示现有配置

4.2 确认修改需求

根据用户需求，确定：

• 哪些字段需要修改 isShow/isSearch/orderNum 等
• 哪些字段需要新增或删除
• SQL 是否需要调整

4.3 构造 editAll 请求

editAll 使用 PUT 方法（非 POST）。

与新增类似，但需注意：

• head.id = 现有报表 ID（必填）
• deleteItemIds = 要删除的字段 ID 逗号拼接
• deleteParamIds = 要删除的参数 ID 逗号拼接

替换参数的完整流程

编辑时若需要替换参数（如从无参改为有参，或修改参数配置），步骤：

1. 查询旧参数列表，收集所有旧参数 ID
2. 新参数对象必须包含 id（gen_id() 生成）和 headId（报表 ID）
3. 在 payload 中设置 deleteParamIds 删除旧参数，params 传入新参数

old_params = api_request(f'/online/cgreport/param/listByHeadId?headId={head_id}')['result']
delete_param_ids = ','.join(p['id'] for p in old_params) if old_params else None

new_params = [
    {"id": gen_id(), "headId": head_id, "paramName": "log_type", "paramTxt": "日志类型", "paramValue": "1", "orderNum": 1}
]

payload = {
    "head": {...},
    "items": items,
    "params": new_params,
    "deleteParamIds": delete_param_ids   # 有旧参数时必传，否则会重复
}

注意：editAll 的 params 中每条记录必须有 id 和 headId，否则保存后参数不生效。新增时（create_report）的 params 可以不带这两个字段。

Step 5: 展示摘要并确认

在执行 API 前必须展示以下摘要，等待用户确认：

## Online 报表配置摘要

- 报表编码：sales_report
- 报表名称：销售统计报表
- 数据源：默认
- 目标环境：https://boot3.jeecg.com/jeecgboot

### SQL 语句
SELECT s.id, s.name, s.amount, s.sale_date, s.status
FROM biz_sales s WHERE 1=1

### 字段配置

| 序号 | 字段名 | 显示名称 | 类型 | 显示 | 查询 | 排序 | 合计 |
|------|--------|---------|------|------|------|------|------|
| 0 | id | ID | String | 否 | 否 | 否 | - |
| 1 | name | 名称 | String | 是 | 单值 | 否 | - |
| 2 | amount | 金额 | BigDecimal | 是 | 否 | 是 | 是 |
| 3 | sale_date | 销售日期 | Date | 是 | 范围 | 是 | - |
| 4 | status | 状态 | String | 是 | 单值 | 否 | - |

### 参数
| 参数名 | 显示名称 | 默认值 |
|--------|---------|--------|
| (无) | | |

确认以上配置？(y/n)

Step 6: 调用 API

用户确认后执行。使用 Python 调用 API（Windows 环境下 curl 中文会出错）：

Windows 执行环境（强制规则，违反会让用户吐槽"执行太慢"）

现象：Windows 的 Bash tool 会把 python / python -c / skill 脚本当作长命令自动 run_in_background，tool 立即返回 background ID，真正输出要等完成通知——把毫秒级调用放大到数秒。

规则：

• Windows（platform=win32） → 用 Bash tool 调用 powershell -Command "python xxx.py"，同步返回。
• Linux / macOS → 用 Bash tool 直接调用 python xxx.py。
• 任何平台都不用 curl：跨平台不一致，Windows Bash 下同样被后台化。

脚本执行前强制检查（3 项，缺一不可）：

1. ✅ Windows 下用 powershell -Command "python xxx.py"，不是直接 python xxx.py
2. ✅ 脚本已写入 .py 文件（禁止 python -c 内联代码）
3. ✅ 脚本第一行已加编码声明：import sys; sys.stdout.reconfigure(encoding='utf-8')（防 GBK 崩溃重试）

Windows 正确示例：

Bash: powershell -Command "python <skill_base_dir>/scripts/onlreport_api.py --api-base ... --token ..."

<skill_base_dir> 是本 SKILL.md 所在目录，运行时用实际路径替换。

Windows 错误示例（会被后台化，用户立即感知到"卡"）：

Bash: python onlreport_api.py ...     ← 返回 "Command running in background with ID: xxx"
Bash: python -c "..."                  ← 同上
Bash: curl -X POST ...                 ← 同上

调用方式：import onlreport_api，调用 init_api 初始化后直接使用封装函数，无需修改脚本文件。

import sys
sys.path.insert(0, r'<skill目录>/scripts')
from onlreport_api import init_api, parse_sql, create_report, gen_id
init_api('<api_base>', '<token>')

脚本中封装了以下操作：

查询类

• list_reports() — 查询报表列表
• list_all_reports_table() — 查询所有报表（Markdown 表格，自动分页）
• list_fields_by_code_table(code) — 按编码查字段（Markdown 表格）
• query_report(head_id) — 查询报表头
• list_fields(head_id) — 查询字段列表
• list_params(head_id) — 查询参数列表
• get_report_id_by_code(code) — 按编码获取报表 ID
• parse_sql(sql, db_key) — 解析 SQL 字段

创建 / 编辑

• create_report(code, name, sql, db_source, items, params) — 创建报表，返回含 head_id 的 dict
• edit_report(...) — 编辑报表（PUT editAll）

发布流程（高级语法糖，推荐优先使用）

• validate_report(head_id) — 验证 SQL 是否可执行，返回 True/False
• publish_report(head_id, name, role_code='admin', parent_id='') — 验证 SQL + 创建菜单 + 授权角色，三步合一
• create_and_publish(code, name, sql, items, params=[], db_source='', role_code='admin', parent_id='') — 全流程一键完成：创建报表 + 验证 + 建菜单 + 授权

字段构建辅助

• build_item(field_name, field_txt, ...) — 按字段名语义自动推断类型/查询/显示，支持手动覆盖任意属性

菜单 & 权限

• create_menu(head_id, name, parent_id='') — 创建报表菜单
• get_role_id_by_code(role_code) — 按角色编码获取角色 ID
• grant_menu_to_role(role_id, menu_id) — 追加授权菜单给角色
• add_data_rule(menu_id, role_id, rule_name, rule_column, rule_conditions, rule_value) — 完整四步数据规则配置

build_item 用法示例（推荐，替代手写 dict）

from onlreport_api import init_api, build_item, create_and_publish
init_api('<api_base>', '<token>')

items = [
    build_item('id',          'ID',       order_num=0),          # 自动隐藏
    build_item('username',    '用户名',   order_num=1),          # 自动单值查询
    build_item('status',      '状态',     order_num=2),          # 自动 dictCode=valid_status
    build_item('amount',      '金额',     order_num=3),          # 自动 BigDecimal + 合计
    build_item('create_time', '创建时间', order_num=4),          # 自动 Datetime + 可排序
    # 手动覆盖
    build_item('email', '邮箱', order_num=5, field_href='mailto:${email}'),
    build_item('sex',   '性别', order_num=6, dict_code='sex'),
]

# 一键：建报表 + 验证 SQL + 建菜单 + 授权 admin
head_id = create_and_publish('my_report', '我的报表', 'SELECT ... FROM ...', items)