jimureport
积木报表 AI 生成器
不涉及「Online 报表」(cgreport)或「Online 表单」(cgform)。
一键脚本(必看,覆盖三类全场景)
写自定义 JSON / Python 之前,先看用户需求是否命中下表现成脚本,命中则直接调用,禁止重新组装 JSON 或 Python:
| 用户描述(关键词) | 直接调用 | 默认覆盖 |
|---|---|---|
| 「全图表」「所有图表」「图表大全」「测试所有数据集类型」「SQL+API+JSON」「图表展示」 | python scripts/generate_all_reports.py --base-url ... --token ... --name "..." --mysql-host ... --mysql-port ... --mysql-db ... --mysql-user ... --mysql-pwd ... |
25 个图表(SQL 12 + API 2 + JSON 4 + 不绑 7),自动建 chart_demo_all 表插数据 + 自动创建 YApi mock + 一次保存 |
| 「纵向分组」「按XX分组」「分组报表」「分组汇总」 | python scripts/create_group_report.py --base-url ... --token ... --report-name "..." --db-code ... --sql "..." --group-field 分组字段名 [--agg-fields "field:SUM,..."] [--col-titles "field:标题,..."] [--col-widths "field:宽度,..."] |
自动选含「积木」的数据源(resolve_db_source),凭证由 get_ds_connection 运行时取,不猜 MySQL 密码;布局随 parse_sql 字段动态生成 |
命中规则与禁止事项
- 关键词命中即用:用户说「生成全部图表」「全图表测试」「演示所有图表」「测试 SQL/API/JSON 三种数据集」时,第一反应就是
generate_all_reports.py,不要回头自己写 chart_entry/echarts 模板 - 3 秒能跑完:实测 ~3.1s 端到端创建。脚本启动后不要分块等待、不要发 AskUser 求确认,直接
Bash等结果 - Mock 新建必须用唯一路径:
create_mock遇到同路径会静默覆盖已有接口数据,污染他人接口。创建新接口时必须在路径末尾追加时间戳或序号(如/sales_20260427),只有用户明确说"修改/更新已有接口"时才可复用原路径 - saveDb 串行:脚本已改为串行调用
save_db,避免jimu_report_db_fieldINSERT 并发引发 MySQL deadlock - 新增图表类型时:在
CHARTS列表加一行,写一个tpl_xxx函数即可,无需重写主流程
执行流程
第零步(必须):Token 优先
用户消息里没有 X-Access-Token 时,立刻询问,拿到 token 后再读任何文件。等待回复期间不要预读文件——等待时间不计入 3 分钟,文件读取时间计入。
第一步(必须):按「执行速度规范」表选最小文件集
不要先 Glob examples/,直接查下方「执行速度规范」表,按场景只读指定文件。禁止在表外额外读文件。 场景匹配优先于文件名匹配:
multi-level-header.md主要是交叉表 groupRight/dynamic,纵向分组+静态多级表头不要读它(浪费 ~30s 读不适用示例)。
读完指定文件后直接 Write JSON 配置 → 执行 CLI 命令 → 输出预览链接。两步完成,禁止多余动作。
报表链接格式(创建成功后直接输出,禁止调接口验证是否存在):
- 设计器:
http://{host}/jmreport/index/{report_id}?token={token}&tenantId=1- 预览:
http://{host}/jmreport/view/{report_id}?token={token}&tenantId=1
报表名称规则:用户明确指定名称时直接使用;未指定时 AI 自动生成名称,生成后须调
GET /jmreport/query/report/folder?pageNo=1&pageSize=10&reportType=&name={name}&token={token}检查是否重复,有同名则追加后缀(如_2、_20260415)。
utils 子模块速查(需确认某函数签名时,Grep 对应小文件,禁止读全量 jimureport_utils.py):
| 需要确认的函数 | 读哪个文件 |
|---|---|
| Session、gen_id/code/layer、col_letter、_compute_sign | jimureport_core.py |
| parse_api、parse_sql、save_db、update_db、parse_and_save_dataset、parallel_parse/save/api | jimureport_dataset.py |
| make_designer、base_save、get_report、report_urls、print_summary | jimureport_report.py |
| make_styles | jimureport_styles.py |
| chart_entry、virtual_row、build_chart_layout、update_chart_config、parallel_fill_charts、pick_chart_axes | jimureport_chart.py |
| create_link、parallel_create_links | jimureport_link.py |
| ensure_datasource、find_datasource、get_ds_connection、query_mysql、execute_ds | jimureport_datasource.py |
| 禁止 | 替代 |
|---|---|
| 读全量 jimureport_utils.py | 按上表 Grep/Read 对应子模块(各 25-175 行) |
| 找 DB 凭证 | 用 memory 中的配置或问用户 |
| Windows 下 Bash tool 跑 python | 改用 PowerShell tool 跑 python xxx.py / python -c "...",同步返回(详见下方「Windows 执行环境」) |
| 调外部 API 验证字段 | 直接按用户提供的字段写脚本,不预调 API |
擅自调用 create_mock() |
用户已提供接口 URL 时直接 save_db(api_url=URL),禁止调用 create_mock();只有用户明确说"帮我创建 mock"或未提供 URL 时才调用,无需询问 |
sleep + cat 轮询输出 |
Bash 命令在 Windows 始终被后台化;若仍要走 Bash,必须用 TaskOutput(task_id, block=true) 等待结果,禁止用 sleep/cat 轮询 |
| 报表创建后调接口验证是否存在 | /save 返回 success:true 即成功,直接输出设计/预览链接,无需查报表列表 |
手写 border 样式({"style":1} 或任何非数组格式) |
必须用 make_styles() 获取 styles 列表,它已内置正确的 ["thin","#d8d8d8"] 数组格式;手写 border 一律禁止,会导致整表渲染空白 |
API 数据集手动传 api_convert="function(res){return res.data;}" |
save_db 已将此值设为 db_type="1" 的默认行为,无需手动传;若 API 返回裸数组则显式传 api_convert="" |
用户未指定的可选参数自行填值(如 customEditConf.eventParams、freeze、rpbar、background 等) |
只写用户明确给出的字段,其余可选参数一律省略,不得自造默认值 |
Windows 执行环境(强制规则,违反会让用户吐槽"执行太慢")
现象:Windows 的 Bash tool 会把 python / python -c / skill 脚本当作长命令自动 run_in_background,tool 立即返回 background ID,真正输出要等完成通知——把毫秒级调用放大到数秒,历史上多次让单报表从 1 分钟拖到 18 分钟。
规则:
- Windows(platform=win32) → 用 Bash tool 调用
powershell -Command "python xxx.py",同步返回。 - Linux / macOS → 用 Bash tool 直接调用
python xxx.py。 - 任何平台都不用
curl:跨平台不一致,Windows Bash 下同样被后台化。
脚本执行前强制检查(4 项,缺一不可):
- ✅ Windows 下用
powershell -Command "python xxx.py",不是直接python xxx.py - ✅ 脚本已写入
.py文件(禁止python -c内联代码) - ✅ 脚本第一行已加编码声明:
import sys; sys.stdout.reconfigure(encoding='utf-8')(防 GBK 崩溃重试) - ✅ 已读过
references/pitfalls.md(任何场景都必须,防止踩已记录的坑)
Windows 正确示例:
Bash: powershell -Command "python <skill_base_dir>/scripts/xxx.py --base-url ... --token ..."
<skill_base_dir>是本 SKILL.md 所在目录,运行时用实际路径替换,禁止写死C:/Users/...。
Windows 错误示例(会被后台化,用户立即感知到"卡"):
Bash: python generate_all_reports.py ... ← 返回 "Command running in background with ID: xxx"
Bash: python -c "..." ← 同上
Bash: curl -X POST ... ← 同上
历史教训:曾因默认走 Bash + python 被用户连续吐槽"执行太慢了 / 生成这么慢"。根因是 Bash tool 在 Windows 对 python 也会后台化,不限于 curl。另一常见重试原因:脚本缺编码声明导致
UnicodeEncodeError: 'gbk' codec,加第3项检查可消除。
前置条件
用户须提供 X-Access-Token。
SQL 数据集数据源选取(用户未指定 dbSource 时必须执行)
用户未指明数据源时,先调 GET /jmreport/initDataSource(带 token header),按以下规则处理:
| 返回结果 | 处理方式 |
|---|---|
result 为空数组 |
告知用户需要先在积木报表中新增数据源,停止创建 |
result 非空,存在 name 含"积木"的项 |
自动选该项,将其 id 作为 db_source 传入 save_db |
result 非空,无含"积木"的项 |
列出所有数据源名称,询问用户选哪个,等待回复后再继续 |
接口返回字段:每项包含 id(传给 db_source)和 name(展示给用户)。
脚本中直接调用(禁止在脚本里重新手写此逻辑):
from jimureport_utils import resolve_db_source
# 用户未指定数据源时:
db_source = resolve_db_source(session) # 自动选含「积木」的;无则抛 RuntimeError 列出清单
RuntimeError 消息已包含数据源列表,捕获后直接转告用户即可。
上下文优先:本次对话中已经通过
resolve_db_source或用户回复确定过db_source,后续同一会话的报表直接复用,不得重复调用initDataSource。
API 数据集前置询问(用户未提供 API 地址时必须先问)
用户未给出 API 地址时,必须先询问:
请问接口用哪种方式创建?
- mock 接口:通过 YApi 创建 mock 接口(参见下方「YApi Mock 数据源」章节)
- 本地代码:请提供本地 JeecgBoot 项目路径,我直接把 Controller 写入项目
收到答复后的处理规则:
| 用户选择 | 处理方式 |
|---|---|
| mock 接口 | 按「YApi Mock 数据源」章节流程,用 yapi_mock.py 创建 mock 接口,返回 mock URL 填入数据集 |
| 本地代码 | 询问项目路径(如 D:\path\to\jeecg-boot),只生成 Controller 写入项目,返回静态数据({"data": [...]}),不生成 Entity / Mapper / Service / SQL |
🚀 CLI 创建(一条命令)
python /scripts/jimureport_creator.py \
--api-base http://BASE_URL --token TOKEN --config /path/to/config.json
配置 A:SQL 普通/分组报表
{
"action": "create", "reportName": "报表名称", "theme": "blue",
"datasets": [{"dbCode":"ds1","dbChName":"数据集","dbDynSql":"SELECT col1,col2 FROM t ORDER BY col1","dbSource":"","isPage":"0"}],
"table": {"datasetCode":"ds1","title":"报表名称","columns":[
{"field":"col1","title":"列1","width":120,"group":true},
{"field":"col2","title":"列2","width":100,"funcname":"SUM"}
]}
}
columns 可选属性:
group:true(分组) /funcname:"SUM"(聚合) /subtotalText:"小计"
配置 B:SQL + 图表
{
"action":"create","reportName":"名称","layout":"chart_bottom",
"datasets":[
{"dbCode":"dt","dbChName":"表格","dbDynSql":"SELECT ...","isPage":"1"},
{"dbCode":"dc","dbChName":"图表","dbDynSql":"SELECT x AS name,y AS value,'' AS type FROM ...","isPage":"0"}
],
"table":{"datasetCode":"dt","title":"名称","columns":[...]},
"chart":{"datasetCode":"dc","chartType":"bar.simple","title":"图表","width":"650","height":"380"}
}
layout:
chart_bottom/chart_top/chart_right/chart_only
配置 C:JSON 数据集(dbCode 必须字符串!)
{
"action":"create","reportName":"名称",
"datasets":[{"dbCode":"my_data","dbChName":"数据","dbType":"3","isList":"1","isPage":"0",
"jsonData":[{"name":"张三","age":"25"}],
"fieldList":[["name","姓名"],["age","年龄"]]}],
"table":{"datasetCode":"my_data","title":"名称","columns":[
{"field":"name","title":"姓名","width":100},{"field":"age","title":"年龄","width":80}]}
}
禁止纯数字 dbCode(如 gen_code()),JSON 数据集模板引擎无法解析。
f-string 写绑定字段时必须转义花括号:
f"#{{{db_code}.{field}}}"→ 生成#{db_code.field}。若写成f"#{db_code}.{field}#"则花括号被 Python 吃掉,变成#db_code.field#(格式错误,末尾多#,数据不渲染)。
配置 D:自定义 rows(复杂多级表头)
build_table_rows 无法满足时(如四级合并表头),传 customRows + customMerges 跳过自动构建:
{
"action":"create","reportName":"名称",
"datasets":[{"dbCode":"ds1","dbType":"3","jsonData":[...],"fieldList":[...]}],
"table":{"datasetCode":"ds1","columns":[{"field":"f1","title":"F1","width":100}]},
"groupField":"ds1.group_field",
"customRows":{"1":{"cells":{"1":{"text":"标题","style":0,"merge":[0,5]}},"height":40}},
"customMerges":["B2:G2"],
"customStyles":[{"align":"center","font":{"size":16,"bold":true}},{"align":"center","font":{"bold":true,"color":"#FFF"},"bgcolor":"#4472C4"},{"align":"center","valign":"middle"}],
"customCols":{"0":{"width":27},"1":{"width":100},"len":100}
}
修改已有报表
# get_report → 改 design → base_save(**design 展开,get_report 返回的 design 是安全的)
designer, design = get_report(session, report_id)
design["rows"]["3"]["cells"]["1"]["text"] = "新值"
design["chartList"] = filled_charts # 如有图表回填,直接替换 chartList
session.request("/save", base_save(report_id, designer, **design))
# ↑ get_report 返回的 design 只含 base_save 接受的 key,**design 展开无冲突
# 注意:手动拼的 design dict 禁止 **展开,必须显式列出 rows/cols/styles/merges/chartList
⚠️ Bug 修复必须用 patch 脚本,禁止重跑创建脚本 任何情况下发现已有报表存在问题(无论是用户反馈还是 AI 自己发现),正确做法是写一个独立 patch 脚本(
get_report→ 改局部字段 →base_save回写;数据集错误用update_db),不得修改并重新执行创建脚本。重跑创建脚本会生成新 ID 的报表,原报表(含已配置的权限、分享链接、引用关系)不会被修复,且产生垃圾报表。
报表大类
积木报表分为两大类,默认为数据报表:
| 大类 | 说明 | designerObj 关键字段 |
|---|---|---|
| 数据报表(默认) | 展示型报表,从数据集查询渲染 | submitForm 不设置或为 0 |
| 填报报表 | 在报表上填写数据并提交到后端 | submitForm: 1 |
数据报表类型判断
| 用户描述 | 数据绑定 | 数据集配置 |
|---|---|---|
| 明细/列表 | #{db.field} |
isList:"1" isPage:"1" |
| 套打/单条 | ${db.field} |
isList:"0" isPage:"0" |
| 按XX分组 | #{db.group(field)} |
isPage:"0" |
| 交叉表 | #{db.groupRight(field)} + #{db.dynamic(field)} |
isPage:"0" |
单元格绑定字段名获取
写 #{dbCode.fieldName} 绑定前,不得凭 SQL 别名手写字段名。
直接用 parse_sql 返回的 fieldName(推荐,最快):
fl = parse_sql(session, sql)
fields = [f["fieldName"] for f in fl]
# MySQL 将所有别名转小写,AS totalAmount → totalamount,直接用即可
/field/tree/{reportId}是备用方案(需报表先/save存在才能调),parse_sql已返回同样的真实字段名,无需多一次调用。
性能优化(单报表推荐模板)
单报表单数据集场景,以下 3-step 流程总 HTTP ≤ 5 次(含数据源已存在的 1 次)。实测端到端 ~0.8s。
from jimureport_utils import (
Session, gen_id, make_designer, make_styles, base_save, report_urls,
ensure_datasource, parse_and_save_dataset, # ← 推荐新路径
)
session = Session(BASE_URL, TOKEN)
# ① 确保数据源存在(1-2 HTTP,已存在时只 1 次)
ds_id = ensure_datasource(
session, name="mongodb", db_type="mongodb",
db_url="<db_host>:27017/<db_name>",
db_username="qqyun", db_password="qqyun188"
)
# ② 预生成 report_id(客户端,0 HTTP)
report_id = gen_id()
# ③ parse_sql + saveDb 组合(2 HTTP,report_id 允许尚不存在)
sql = f"select * from mongo.{COLLECTION}"
field_list, db_id = parse_and_save_dataset(
session, report_id, DB_CODE, "中文名", sql,
db_source=ds_id, is_list="1", is_page="1"
)
# ④ 构建 rows/cols/styles 后,首次 /save —— 一步创建报表 + 写入布局(1 HTTP)
designer = make_designer(report_id, REPORT_NAME)
session.request("/save", base_save(report_id, designer,
rows=rows, cols=cols, styles=styles, merges=merges, chartList=[]))
| 阶段 | 原来 HTTP | 现在 HTTP | 说明 |
|---|---|---|---|
| 数据源 | 3(查+存+再查) | 1-2 | ensure_datasource 合并 |
| 首次占位 /save | 1 | 0 | parse_and_save_dataset 直接对 orphan report_id 调 saveDb |
| 解析 SQL | 1 | 1 | — |
| 保存数据集 | 1 | (合并在 ③) | — |
| 最终 /save | 1 | 1 | 首次创建 + 写入布局 |
| 合计(已存在数据源) | 7 | 4 | 省 3 次 HTTP |
关键原理:saveDb 接受尚不存在于服务端的
report_id(orphan),后续 /save 以此 id 首次创建报表时,数据集会正确绑定。实测验证通过。addDataSource返回result: true(不返回 id),新建后必须再查一次;/initDataSource无签名比/getDataSourceByPage快。
仍可用的旧路径(保留兼容)
parallel_init_and_parse 已不推荐但保留 —— 旧脚本无需修改。新脚本一律用 parse_and_save_dataset。
API 数据集快速路径(2 HTTP,实测 ~0.5s)
API 数据集无需 queryFieldBySql,字段手动定义,整个流程只需 2 次 HTTP:
from jimureport_utils import Session, gen_id, make_designer, base_save, save_db
session = Session(BASE_URL, TOKEN)
# ① 客户端生成 report_id(0 HTTP)
report_id = gen_id()
# ② saveDb:orphan report_id 合法,直接绑定(1 HTTP)
field_list = [
{"fieldName": "f1", "fieldText": "字段1", "widgetType": "String", "orderNum": 0, "tableIndex": 0, "extJson": "", "dictCode": ""},
# ... 其余字段
]
save_db(session, report_id, DB_CODE, "数据集名称",
API_URL, field_list,
db_type="1", api_url=API_URL, api_method="0",
is_list="1", is_page="0")
# ③ /save:首次创建报表 + 完整设计一步完成(1 HTTP)
designer = make_designer(report_id, REPORT_NAME)
session.request("/save", base_save(
report_id, designer,
rows=rows, cols=cols, styles=styles, merges=merges, chartList=[],
isGroup=True, groupField=f"{DB_CODE}.group_field", # 交叉/分组报表需要
))
| 旧流程(3 HTTP) | 新流程(2 HTTP) |
|---|---|
| POST /save 空报表 → 取 report_id | gen_id() 本地生成(0 HTTP) |
| POST /saveDb | POST /saveDb(同) |
| POST /save 完整设计 | POST /save 完整设计(同) |
实测:区域省份销售额交叉报表,3 步 ~3s → 2 步 ~0.5s(2026-04-22 验证)。 适用场景:所有 API 数据集报表(交叉表、分组表、明细表均可)。
MongoDB / NoSQL 数据源特别说明
testConnection仅检测 TCP 连通,不验证账号密码。它返回 success 不代表凭证正确。- 真实鉴权发生在
queryFieldBySql/ 预览时。凭证错会在这两步报Exception authenticating。 - 禁止在创建脚本里尝试多种格式(标准分离 / 连接串 / 多 authSource)的试错循环 —— 白白浪费 3-6 秒。只试用户给的一种,失败立刻报错让用户检查 MongoDB 服务端
db.getUsers()。
性能优化(多数据集 / 多报表场景)
核心原则:能并行的全部并行,消灭串行等待。
from jimureport_utils import parallel_parse_sqls, parallel_save_dbs, parallel_create_links
from concurrent.futures import ThreadPoolExecutor
# ① 并行解析所有 SQL(一轮完成)
fl_a, fl_b, fl_c = parallel_parse_sqls(session, [
{"sql": sql_a}, {"sql": sql_b}, {"sql": sql_c},
])
# ② 并行保存所有数据集(一轮完成)
db_id_a, db_id_b, db_id_c = parallel_save_dbs(session, [
{"report_id": rid, "db_code": "dsA", "sql": sql_a, "field_list": fl_a, ...},
{"report_id": rid, "db_code": "dsB", "sql": sql_b, "field_list": fl_b, ...},
{"report_id": rid, "db_code": "dsC", "sql": sql_c, "field_list": fl_c, ...},
])
# ③ 并行创建所有钻取/联动(一轮完成)
link1, link2, link3 = parallel_create_links(session, [
{"report_id": rid, "link_name": "钻取1", "link_type": "0", ...},
{"report_id": rid, "link_name": "钻取2", "link_type": "0", ...},
{"report_id": rid, "link_name": "联动1", "link_type": "2", ...},
])
# ④ 多张报表最终 /save 并行
with ThreadPoolExecutor(max_workers=2) as ex:
f1 = ex.submit(lambda: session.request("/save", base_save(rid1, d1, ...)))
f2 = ex.submit(lambda: session.request("/save", base_save(rid2, d2, ...)))
f1.result(); f2.result()
| 优化点 | 节省 |
|---|---|
parse_sql 直接取字段名,跳过 first_save + field/tree |
每张报表省 2 次请求 |
parallel_parse_sqls |
N 次串行 → 1 轮并行 |
parallel_save_dbs |
N 次串行 → 1 轮并行 |
parallel_create_links |
N 次串行 → 1 轮并行 |
多报表 /save 并行 |
M 次串行 → 1 轮并行 |
行列索引规则
- 全部 0-indexed,A列(col0)留空,数据从 col1(B列)开始
- merge:
[extraRows, extraCols],0=只占自身 - merges 用 Excel 记法:
"B2:F2"(UI行号 = code行号+1)
分组汇总
| 用户说法 | 实现 |
|---|---|
| "合计行" | 数据行下方加 =SUM(列号) |
| "分组小计" | subtotal:"groupField" + funcname:"SUM" + subtotalText:"小计" |
| 只说"分组" | 只用 group() + aggregate:"group" |
funcname 聚合函数值(⚠️ 必须严格使用以下字符串,写错则不生效)
| 用户需求 | funcname 值 |
|---|---|
| 合计 / 求和 | "SUM" |
| 平均 / 平均值 | "AVERAGE" (❌ 不是 "AVG") |
| 最大值 | "MAX" |
| 最小值 | "MIN" |
| 计数 | "COUNT" |
| 不聚合(分组列占位) | "-1" |
分组列 vs 聚合列属性对比
| 属性 | 分组列(group) | 聚合列(select) |
|---|---|---|
aggregate |
"group" |
"select" |
subtotal |
"groupField" |
"-1" |
funcname |
"-1" |
"SUM" / "AVERAGE" / "MAX" / "MIN" / "COUNT" |
subtotalText |
小计行标签文字 | 小计行标签文字 |
查询参数(paramList)
含查询控件时读 references/query-params.md § 0(含 SQL FreeMarker 条件、widgetType/searchMode 对照表、日期范围拆分规则)。
样式规范(必读约定,无需用户提醒)
- 所有表格报表必须带 border:优先用
from jimureport_utils import make_styles的 5 种预置样式(索引 0-4) - col0 始终留白 30px 不加边框:标题行从 col1 开始合并(merges 写
B1:F1不含 A 列)。make_styles()预置样式 0-4 均含边框,col0 必须单独追加无边框样式:styles = make_styles() styles.append({"align": "center"}) # index 5:col0 专用,无边框 # 所有行的 col0 统一用 style: 5 "0": {"text": "", "style": 5} - 自定义样式时
border必须嵌套(不能**展开到顶层),color(文字色)与font平级放 style 顶层 - ⚠️ 凡是自定义 styles 数组或修改单元格配置,必须先读
references/styling.md,不得凭经验猜属性层级(color在顶层而非font内是高频踩坑点,引擎静默忽略错误写法)
完整规范 + col0 留白模板代码 → references/styling.md
图表类型速查
含图表时读 references/chart-types-quickref.md(系统名称 → chartType 对照 + series 字段取值 + 地图数据语义规则)。
完整 ECharts 配置模板 → references/chart-echarts-templates.md。
执行速度规范(3分钟内完成)
文件读取按场景取最小集,只读表中指定的文件,不得额外读其他文件:
| 场景 | 读取文件(精确,不多读) |
|---|---|
| 普通表格 / JSON数据集(无分组) | 只读 references/pitfalls.md(遇到报错按症状索引跳节,用 offset 只读对应节) |
| 纵向分组(含小计/聚合) | 只读 examples/vertical-group-subtotal-example.md(含完整布局;pitfalls 已熟记无需重读) |
| 纵向分组 + 自定义排序(textOrders) | 只读 examples/vertical-group-custom-sort.md |
| customGroup(自定义横向分组,每条记录→一列) | 只读 references/horizontal-grouping.md(§5.3.2 已内嵌完整 JSON 模板 + 所有关键属性;无需再读 examples/horizontal-group.md) |
| groupRight + dynamic(交叉表,列头横向动态展开) | references/horizontal-grouping.md + examples/horizontal-group.md 示例1 |
| groupRight + dynamic + 跟随分组扩展统计行(rightFollowExten) | 只读 references/horizontal-grouping.md §「跟随分组扩展统计行」节 |
| 含条码/二维码 / 补全空白行 / 自定义编辑单元格 | 只读 references/cell-config.md |
| 含查询控件(paramList) | references/query-params.md § 0 + examples/param-query.md |
| 含图表(无联动/钻取) | references/chart-types-quickref.md(选 chartType)→ references/chart-canonical-configs.md + references/chart-echarts-templates.md;图表显示条数/排序/数据过滤需求必须先查 references/chart-echarts-props.md §9,禁止改数据集类型或切片数据 |
| 含图表联动 | 上一行 + examples/chart-linkage.md |
| 含报表钻取 | references/report-drilling.md + examples/report-drilling.md |
| 含表达式 | 只读 references/expressions.md |
| 数据填报报表 | 只读 references/fillform.md |
| 主子报表(套打式或循环块式,子表纵向展开,eri≥40) | references/mastersub-report.md + examples/master-sub-table.md |
| 分栏报表(loopTime 横向循环,eri=卡片实际行数,禁止缓冲行) | 只读 references/loopblock-grouping.md §5(offset=106) |
| 分版(并列独立展开,zonedEdition/zonedEditionList) | 只读 references/loopblock-grouping.md §5.5(offset=219,limit=60) |
| 多源报表(多个数据集来自不同表且有共同关联字段;或用户要求同一行同时绑定主子两表字段) | 只读 examples/multi-source-table.md |
| 样式细节(边框/留白/优先级) | 只读 references/styling.md |
| 自定义 styles 数组(含 color / bgcolor / font 任意属性) | 必读 references/styling.md(color 文字色必须放 style 顶层,不能放 font 内;违反则静默失效) |
| 修改已有报表单元格配置(style / merge / text / direction 等) | 必读 references/styling.md,确认属性层级后再动手 |
| 数据源管理(MongoDB/Redis/MySQL等 addDataSource) | 只读 references/dataset-advanced.md § 1 |
| 有参考报表 ID | get_report 照搬,跳过所有文件 |
| 需要示例数据/字段未确定 | 只读 references/mock-apis.md 选接口 |
pitfalls.md 读取规则:仅「普通表格/无分组」行要求全节读取;其他场景遇到运行时报错时,按 pitfalls.md 顶部症状索引找对应节,用
Read(offset=N, limit=40)只读该节(不要全读,9 个节每节约 20 行)。
API 数据集 + customGroup 快速路径(用户提供了 API URL + token 时,不超过 3 步):
- 读
references/horizontal-grouping.md§5.3.2 拿到模板- 在脚本里调
parse_api(session, api_url)获取字段名(1 次 HTTP,合并进脚本,不单独执行)- 替换模板中的字段名 → PowerShell 执行脚本
自定义图表脚本规范(含 SQL/API 数据集)
写自定义图表脚本前必须先确认以下规范,杜绝反复调试。
# ① BASE_URL 必须含 /jmreport
session = Session("http://host:port/jmreport", TOKEN)
# ② make_designer:首次 /save 时 report_id 传空字符串
designer = make_designer("", REPORT_NAME)
# !! 拿到 report_id 后,最终保存前必须重新构造 designer(带真实 id),否则单元格数据不会写入 !!
# designer = make_designer(report_id, REPORT_NAME) ← 最终保存前用这个
# ③ rows 必须带 "len" key
rows = {"len": 200, "1": {"height": 25, "cells": {}}, ...}
# ④ base_save 前两个参数是位置参数,不可用关键字
resp = session.request("/save", base_save("", designer, rows=rows, cols=cols, styles=styles, merges=[], chartList=[]))
# ⑤ 首次 /save 返回的 result 是 dict,取 id
report_id = resp["result"]["id"]
# ⑥ save_db 位置参数顺序(第4个是 db_name,不是 db_ch_name)
db_id = save_db(session, report_id, "db_code", "中文名", sql_or_empty, field_list,
db_type="1", api_url=mock_url, ...) # API 数据集
# ⚠️ JSON数据集(db_type="3")json_data 必须包裹 {"data":[...]},不能传裸数组:
# json_data=json.dumps({"data": raw_list}, ensure_ascii=False)
# ⑦ 图表回填:SQL → /qurestSql (result 是 list);API → /qurestApi (result["data"] 是 list)
# 完整代码见 references/chart-echarts-templates.md § SQL/API 图表数据回填
# ⑧ 最终保存:get_report 返回的 design 可直接 **展开
designer2, design2 = get_report(session, report_id)
design2["chartList"] = filled_charts
session.request("/save", base_save(report_id, designer2, **design2))
已知坑点(必读)
写脚本前先 Read
references/pitfalls.md,避免踩坑重试浪费时间。 写循环块报表前必须先 Readreferences/loopblock-grouping.md,里面有完整配置模板,禁止从头自己写。 ⚠️ API 数据集有paramList时,apiUrl末尾必须加?paramName=${paramName},否则联动/钻取参数传不进去。多参数用&连接。写完save_db后立即目视检查api_url字符串含占位符。 ⚠️ 交叉表(groupRight+dynamic)底部跟随分组扩展统计行:必须用独立静态行 +rightFollowExten:"follow"+ Excel公式(如=MAX(G6)),dynamic 单元格的funcname必须设为"-1",禁止设为"MAX"/"MIN"/"SUM"——那不会生成跟随横向扩展的统计行。非分组维度字段(如姓名、性别)用aggregate:"select",不用group()。详见references/horizontal-grouping.md§「跟随分组扩展统计行」。
工具脚本(按需使用)
| 操作 | 命令 |
|---|---|
| 查询报表 | python report_tools.py --base-url URL --token T list [-k 关键词] |
| 报表详情 | python report_tools.py --base-url URL --token T detail <id> |
| 删除/复制 | python report_tools.py --base-url URL --token T delete/copy <id> |
| 分享 | python report_export.py share --name 名称 |
| 导出 | python report_export.py export <id> --format pdf |
| 改图表类型 | python chart_tools.py change-type <id> bar.multi |
| 创建 YApi Mock | python yapi_mock.py list |
YApi Mock 数据源
报表需要 API 数据源时,使用内置 YApi 平台(https://api.jeecg.com)创建 mock 接口。 登录凭证处理流程:
- 先检查 memory 中是否已有 YApi 凭证记录
- 有则直接使用;没有则询问用户:
请提供 YApi 登录账号(邮箱)和密码,用于创建 mock 接口。
- 用户提供后,立即保存到 memory(reference 类型),下次直接读取,无需再问
import sys
sys.path.insert(0, '<skill目录>/scripts')
from yapi_mock import init_yapi, create_mock
init_yapi() # 自动登录
mock_url = create_mock(
path='/sales', # 路径后缀,不含 basepath(/claude)
title='销售数据',
data=[
{"month": "一月", "amount": 12000},
{"month": "二月", "amount": 15000},
]
)
# mock_url = https://api.jeecg.com/mock/57/claude/sales
固定参数:project_id=57,catid=1157,basepath=/claude
路径规则:接口路径只写后缀(如 /sales),完整 URL = https://api.jeecg.com/mock/57/claude/sales
⚠️ 新建 vs 修改(严格区分,防止污染他人数据):
| 用户意图 | 做法 |
|---|---|
| 新建接口(默认) | 路径追加时间戳或序号,如 /sales_20260427,强制创建新接口 |
| 明确说"修改/更新已有接口" | 直接用原路径调 create_mock() 或 update_mock() |
create_mock()遇到同路径会静默覆盖已有接口数据,共享项目中会破坏他人接口。默认必须用唯一路径。
分页规则:自建 mock 接口不需要分页,data 直接返回完整数组,不加 pageNo / pageSize 参数。
积木报表中使用 mock URL 作为 API 数据集时,调用 save_db(..., db_type="1", api_url=mock_url) 即可,dbCode 是自定义编码(如 sales_data),与 URL 无关。
API 数据集查询条件传参规则:见「已知坑点」章节(含代码示例)及 references/dataset-core.md § 3.2.2。
fieldList 必须带 orderNum(从 0 开始),否则数据集「排序」列为空,字段顺序不确定:
{"fieldName": "col1", "fieldText": "列1", "fieldType": "String", "orderNum": 0},
{"fieldName": "col2", "fieldText": "列2", "fieldType": "String", "orderNum": 1},
查询 AI 已创建的接口列表
init_yapi() # 先登录,自动带上 Cookie
# 列出 project_id=57 下已创建的所有接口(需登录态)
# GET https://api.jeecg.com/api/interface/list?page=1&limit=20&project_id=57
# 返回字段:_id(接口ID), path(路径), title(名称), method, up_time
# 完整 mock URL = https://api.jeecg.com/mock/57{path}
命令行等效:python yapi_mock.py list(自动登录后分页列出所有接口)
高级 Mock 脚本(按参数动态返回不同数据)
自动判断规则(AI 必须遵守):
| 场景 | 做法 |
|---|---|
报表有联动/钻取/主子表,且目标图表数据集需按参数过滤(如 ?category=手机) |
create_mock 建接口 → set_advmock 写脚本,脚本里按 params.xxx 分支返回 |
| 静态展示,不需要按参数过滤 | 只用 create_mock,不调 set_advmock |
⚠️ 正确 API 是
/api/plugin/advmock/save,禁止用/api/interface/up的isOpen/script字段——那个字段不生效。
from yapi_mock import init_yapi, set_advmock
init_yapi(email='...', password='...')
# 先用 create_mock / list_mocks 拿到接口 ID,再调:
set_advmock(
iface_id='5933', # 接口 _id(字符串)
script=r"""
if(params.leibie=='手机'){
mockJson = {"data": [{"name":"苹果手机","value":25500}]}
}else if(params.leibie=='电脑'){
mockJson = {"data": [{"name":"MacBook","value":47500}]}
}else{
mockJson = {"data": [...]} // 兜底默认值,无参数时返回
}
""",
enable=True,
)
脚本规则:
- 用
params.xxx读取 URL query 参数 - 用
mockJson = {...}赋值返回体(不是return) - 必须写兜底
else分支,确保无参数时有数据 - 字段名须与积木报表数据集的
axisX/axisY(或fieldName)完全一致
常用配置速查
冻结行列(freeze)
base_save(report_id, designer, ..., freeze="A3", freezeLineColor="red")
| freeze 值 | 效果 |
|---|---|
"A1" |
不冻结(默认) |
"A2" |
冻结第 1 行 |
"A3" |
冻结前 2 行 |
"C1" |
冻结前 2 列 |
"C3" |
同时冻结前 2 行和前 2 列 |
报表背景色(background)
# 启用背景色(在 base_save override 里传,或 patch 时改 design["background"])
base_save(report_id, designer, ..., background={"enabled": True, "color": "#e8f5e9"})
# 禁用背景色
base_save(report_id, designer, ..., background=False)
⚠️
bgColor写在make_designer(**extra)里无效;必须作为base_save的顶层 override 传递。 patch 已有报表时:design["background"] = {"enabled": True, "color": "#hex"}→base_save(id, designer, **design)
预览页工具条(rpbar)
btnList/childrenBtnList存的是「显示」的按钮编号,从列表中删除编号即可隐藏,[]= 全部隐藏。rpbar必须是 dict 对象,不能json.dumps()。
base_save(report_id, designer, ..., rpbar={
"show": True, "pageSize": "",
"btnList": [1,2,3,4,5,6,7,8,9],
"childrenBtnList": [7.1,7.2,7.3,7.4,8.1,8.2,8.3,8.4,8.5,8.6]
})
| 主按钮 | 子按钮 | ||
|---|---|---|---|
| 1 首页 | 5 下一页 | 7.1 默认打印 | 8.1 导出 Excel |
| 2 上一页 | 6 末页 | 7.2 打印当前页 | 8.2 大数据 Excel |
| 3 当前/总页数 | 7 打印 | 7.3 分页缩放打印 | 8.3 导出 PDF |
| 4 分页显示数 | 8 导出 | 7.4 整体缩放打印 | 8.4 导出 PDF 图像 |
| 9 清晰度 | 8.5 导出图像 / 8.6 导出 WORD |
图表 extData 必填字段
| 字段 | 说明 |
|---|---|
| chartId / id | = layer_id(两个都要填) |
| chartType | bar.simple / pie.normal / line.simple 等 |
| dataType | "sql" / "api" / "json" / "files" / "javabean" |
| apiStatus | "1"=动态SQL / "0"=静态JSON |
| dataId | save_db() 返回值 |
| dbCode | 数据集编码 |
| axisX / axisY | X/Y 轴字段名 |
| series | 分组字段名,单系列传 "" |
钻取/联动 linkType 对照
| linkType | 说明 | reportId | paramValue |
|---|---|---|---|
| "0" | 报表钻取 | 目标报表 ID | 字段名 |
| "1" | 网络链接 | 当前报表 ID | 字段名 |
| "2" 表格→图表 | 联动 | 当前报表 ID | 字段名 |
| "2" 图表→图表 | 联动 | 当前报表 ID | name/value/seriesName |
| "4" | 主子报表 | 当前报表 ID | — |
- 单元格触发:
cell["linkIds"] = link_id+cell["display"] = "link" - 图表触发:
extData["linkIds"] = link_id(放 extData 内部,不在顶层) - 联动必须有
linkChartId(目标图表 layer_id);目标图表 paramList 必须设 paramValue 默认值
searchMode 映射
| searchMode | 控件 |
|---|---|
| 1 | 输入框 |
| 2 | 范围查询 |
| 3 | 下拉多选 |
| 4 | 下拉单选 |
| 5 | 模糊查询 |
| 6 | 下拉树 |
| 8 | 时间控件 |