跳到主要内容

系统开发规范

一、JSON文件规范​

1. 核心字段要求​

所有JSON文件必须包含以下关键字段：

1.1 全局唯一标识符 _t​

  • 定义：表名标识符，全局唯一
  • 规则：
    • 格式：模块名_业务类型（如 mall_u 表示会员表，mall_o 表示订单表）
    • 示例： 
      "_t": "mall_u",
      "_t": "mall_o"

1.2 数据唯一ID id​

  • 定义：数据对象的全局唯一标识
  • 规则：
    • 格式：owl_ + _t值 + _ + 递增数字
    • 示例： 
      "id": "owl_mall_u_50001",
      "id": "owl_mall_o_50001"

1.3 元数据 #meta​

  • 定义：根节点下的元数据配置

  • 关键字段：

    字段名说明
    rem模块栏目名称/表名称（必填）
    projectName项目名称（必填）
    parent父级模块标识（如树形结构中的父节点）
    visitType访问类型（如公开/私有）
    pos排序权重（数值类型）
    group分组标识（如功能模块分组）

  • 示例：

    "#meta": {
      "rem": "会员信息表",
      "projectName": "电商系统",
      "parent": "user_group_001",
      "visitType": "private",
      "pos": 10,
      "group": "user_management"
    }

1.4 JSON文件的field​

JSON文件的field说明请参考《JSON文件的field字段说明》，其中包含详细参数说明。

二、通用Service规范​

2.1 Service命名规则​

每个JSON文件生成对应的Service，命名规则为：

owl_<_t值>Service
  • 示例： 
    owl_mall_uService（会员表Service）
    owl_mall_oService（订单表Service）
    owl_hello_basicService（最简单的表Service）
    owl_hello_generalService（复杂一点的表Service）

2.2 核心方法说明​

所有Service均包含以下默认方法：

2.2.1 数据操作方法​
方法名功能描述
add新增数据
update更新数据
del软删除数据
get获取单条数据
2.2.2 数据查询方法​
方法名功能描述
search复杂条件搜索
count统计符合条件的记录数
2.2.3 辅助方法​
方法名功能描述
lock/unlock分布式锁控制
index重建索引
2.2.4 完整API文档​

Service的完整API文档请参考《Service API 文档》，其中包含详细参数说明。