204 lines
8.0 KiB
Python
204 lines
8.0 KiB
Python
"""完整配置构建器
|
||
|
||
一站式组合 table_config + form_config + column_config,
|
||
从简洁的字段描述生成完整的 VisualDev 创建 payload。
|
||
支持主表 + 子表(table 控件)结构。
|
||
"""
|
||
|
||
import json
|
||
import time
|
||
from typing import Any, Dict, List, Optional
|
||
|
||
from aibridge.builders.column_config import build_column_data
|
||
from aibridge.builders.form_config import build_form_data
|
||
from aibridge.builders.table_config import build_tables, build_tables_with_child
|
||
|
||
|
||
def build_full_config(
|
||
full_name: str,
|
||
en_code: str,
|
||
table_name: str,
|
||
table_label: str,
|
||
description: str,
|
||
category: str,
|
||
fields: List[Dict[str, Any]],
|
||
system_id: str = "",
|
||
db_link_id: str = None, # ★ 禁止使用 "0"(主库),必须显式传入业务库 ID
|
||
web_type: int = 2,
|
||
sort_code: int = 1000,
|
||
search_field_count: int = 3,
|
||
display_field_count: int = 3,
|
||
child_tables: Optional[List[Dict[str, Any]]] = None,
|
||
) -> Dict[str, Any]:
|
||
"""构建完整的可视化开发功能配置
|
||
|
||
Args:
|
||
full_name: 功能名称,如 "文具销售商管理"
|
||
en_code: 功能编码,如 "salesVendorManage"
|
||
table_name: 数据库表名,如 "base_sales_vendor"
|
||
table_label: 表中文名,如 "文具销售商表"
|
||
description: 功能描述
|
||
category: 分类 ID
|
||
fields: 字段定义列表,每个元素参考 FieldDef.to_dict() 格式
|
||
system_id: 系统 ID(创建 API 不接受,仅用于发布后修正)
|
||
db_link_id: ★ 必须传入业务数据库连接 ID(禁止 "0" 主库)。从 config.db_link_id 获取
|
||
web_type: 页面类型 (1=纯表单 2=表单加列表 3=表单列表工作流 4=数据视图)
|
||
sort_code: 排序码
|
||
search_field_count: 搜索条件字段数量
|
||
display_field_count: 列表显示字段数量
|
||
child_tables: 子表定义列表,每个子表包含:
|
||
- table_name: 子表数据库表名(如 "base_order_item")
|
||
- table_label: 子表中文名(如 "订单明细表")
|
||
- fields: 子表字段定义列表
|
||
- label: 表单中子表标签(如 "添加明细",默认 "添加明细")
|
||
- foreign_key_field: 外键字段名(默认 "F_ParentId")
|
||
- relation_field: 主表关联字段(默认 "F_Id")
|
||
- show_summary: 是否显示合计行(默认 0)
|
||
- summary_field: 合计字段列表(默认空)
|
||
|
||
Returns:
|
||
包含 tables/formData/columnData 和功能元数据的配置字典。
|
||
tables, formData, columnData 为 JSON 字符串(API 要求)。
|
||
"""
|
||
# ★ 强制校验:禁止 db_link_id 为 "0"(主库),业务表必须使用业务数据库
|
||
if not db_link_id or db_link_id == "0":
|
||
raise ValueError(
|
||
'db_link_id 不能为空或 "0"(主库)。'
|
||
'业务表必须创建在业务数据库中。请传入正确的 db_link_id(如 config.db_link_id)。'
|
||
)
|
||
|
||
render_key = int(time.time() * 1000)
|
||
|
||
# 补全字段默认值
|
||
for f in fields:
|
||
f.setdefault("jnpfKey", "input")
|
||
f.setdefault("required", False)
|
||
f.setdefault("dataType", "varchar")
|
||
f.setdefault("dataLength", "200")
|
||
|
||
# 补全子表字段默认值
|
||
if child_tables:
|
||
for ct in child_tables:
|
||
for cf in ct["fields"]:
|
||
cf.setdefault("jnpfKey", "input")
|
||
cf.setdefault("required", False)
|
||
cf.setdefault("dataType", "varchar")
|
||
cf.setdefault("dataLength", "200")
|
||
|
||
# 构建 tables
|
||
if child_tables:
|
||
tables = build_tables_with_child(table_name, table_label, fields, child_tables)
|
||
else:
|
||
tables = build_tables(table_name, table_label, fields)
|
||
|
||
# 构建 child_tables 参数给 form_config
|
||
form_child_tables = None
|
||
if child_tables:
|
||
form_child_tables = []
|
||
for ct in child_tables:
|
||
form_child_tables.append({
|
||
"child_table_name": ct["table_name"],
|
||
"fields": ct["fields"],
|
||
"label": ct.get("label", "添加明细"),
|
||
"show_summary": ct.get("show_summary", 0),
|
||
"summary_field": ct.get("summary_field", []),
|
||
})
|
||
|
||
form_data = build_form_data(fields, table_name, render_key, form_child_tables)
|
||
column_data = build_column_data(
|
||
fields, table_name, render_key,
|
||
search_field_count, display_field_count,
|
||
)
|
||
|
||
return {
|
||
"tables": json.dumps(tables, ensure_ascii=False),
|
||
"formData": json.dumps(form_data, ensure_ascii=False),
|
||
"columnData": json.dumps(column_data, ensure_ascii=False),
|
||
"appColumnData": json.dumps(column_data, ensure_ascii=False), # APP端列表配置,与PC端相同
|
||
"full_name": full_name,
|
||
"en_code": en_code,
|
||
"description": description,
|
||
"category": category,
|
||
"system_id": system_id,
|
||
"db_link_id": db_link_id,
|
||
"web_type": web_type,
|
||
"sort_code": sort_code,
|
||
}
|
||
|
||
|
||
def build_create_payload(config: Dict[str, Any], dynamic_table: bool = True) -> Dict[str, Any]:
|
||
"""从 build_full_config 的输出构建 API 创建 payload
|
||
|
||
JNPF create 接口要求物理表已存在(会校验主键策略),有两种策略:
|
||
|
||
**动态建表模式 (dynamic_table=True,默认)**:
|
||
create 时传空 tables,跳过物理表校验;Release 时自动建表。
|
||
适用于全新功能,表不需要预先存在。
|
||
|
||
**预建表模式 (dynamic_table=False)**:
|
||
create 时传完整 tables,要求物理表必须已存在。
|
||
适用于已有物理表的场景(如手动建表、从其他系统迁移)。
|
||
使用前先通过 `client.data_model.get_table_info(link_id, table)` 确认表存在。
|
||
|
||
Args:
|
||
config: build_full_config 返回的配置字典
|
||
dynamic_table: 是否动态建表(默认 True)
|
||
|
||
Returns:
|
||
可直接传入 VisualDevAPI.create() 的 data 字典
|
||
"""
|
||
return {
|
||
"fullName": config["full_name"],
|
||
"enCode": config["en_code"],
|
||
"type": 1,
|
||
"description": config["description"],
|
||
"webType": config["web_type"],
|
||
"state": 0,
|
||
"sortCode": config["sort_code"],
|
||
"category": config["category"],
|
||
"dbLinkId": config.get("db_link_id", "0"),
|
||
"tables": "[]" if dynamic_table else config["tables"],
|
||
"formData": config["formData"],
|
||
"columnData": config["columnData"],
|
||
"appColumnData": config.get("appColumnData", config["columnData"]), # APP端列表配置
|
||
}
|
||
|
||
|
||
def build_update_payload(config: Dict[str, Any], form_id: str) -> Dict[str, Any]:
|
||
"""从 build_full_config 的输出构建 API 更新 payload
|
||
|
||
.. warning::
|
||
update API 的后端实现 (ConcurrencyUtils.checkAutoIncrement)
|
||
通过 JDBC 查询**物理数据库表**的主键信息,而非读取 JSON 配置。
|
||
因此调用 update 时,物理表必须已存在,否则报 "表[xxx]无主键!"。
|
||
|
||
**推荐做法**:使用动态建表模式 (build_create_payload(dynamic_table=True))
|
||
直接 Create → Release,无需中间 Update 步骤。
|
||
Release 时后端会从 formData 的 tableName 字段自动创建物理表。
|
||
|
||
仅在物理表已存在时(如从其他系统迁移、手动建表)才使用本函数。
|
||
|
||
Args:
|
||
config: build_full_config 返回的配置字典
|
||
form_id: 已创建功能的 ID
|
||
|
||
Returns:
|
||
可直接传入 VisualDevAPI.update() 的 data 字典
|
||
"""
|
||
return {
|
||
"id": form_id,
|
||
"fullName": config["full_name"],
|
||
"enCode": config["en_code"],
|
||
"type": 1,
|
||
"description": config["description"],
|
||
"webType": config["web_type"],
|
||
"state": 0,
|
||
"sortCode": config["sort_code"],
|
||
"category": config["category"],
|
||
"dbLinkId": config.get("db_link_id", "0"),
|
||
"tables": config["tables"],
|
||
"formData": config["formData"],
|
||
"columnData": config["columnData"],
|
||
"appColumnData": config.get("appColumnData", config["columnData"]), # APP端列表配置
|
||
}
|