跳转到内容

低代码平台搭建规则规范

  • 降低维护和沟通成本,内部人员形成统一
  • 统一交互模式避免界面混乱
  • 解决潜在的代码问题

一.字典类型(主分类)维护规则

Section titled “一.字典类型(主分类)维护规则”

1.数据结构定义:系统所有枚举类字段统一采用数据字典类型进行配置,实现字典类型的集中维护与管理,保障字段枚举值的标准化、可扩展性与可维护性
2.类型编码命名规范:字典类型的编码需遵循大驼峰命名法,即每个单词首字母大写,其余字母小写,无下划线、无特殊字符,编码需与类型名称语义强关联,具备可读性与唯一性; 示例:ProjectMode、Type

二.字典子项(明细枚举值)维护规则

Section titled “二.字典子项(明细枚举值)维护规则”

编码命名规范

1.编码统一采用大写英文字母,禁止小写、数字、特殊字符

2.编码长度优先采用 2 位,为对应名称的拼音首字母缩写;

3.若2位编码存在重复冲突,则扩展为4 位,仍以名称拼音首字母缩写为基准,确保编码全局唯一

4.编码与子项名称一一对应,语义清晰、无歧义

示例:

投资建设TZ
施工SG
施工方式SGFS

参考:(链接https://docs.youchaoyun.cn/cn/skills/product/color_specification/)

一、数据表标识与字段标识维护规则

Section titled “一、数据表标识与字段标识维护规则”

1.命名规范:数据表标识和字段标识需遵循小驼峰命名法首单词全部小写,后续单词首字母大写,无下划线、无特殊字符、无空格

2.语义与唯一性要求:字段标识必须与字段名称语义强关联,符合业务含义,具备高可读性;同一数据表内的字段标识必须唯一,禁止重名

示例:

字典类型dictTypes
全称fullName
用户users

二、配置字段-字段类型选型规范

Section titled “二、配置字段-字段类型选型规范”

字段类型需严格匹配字段业务语义与数据存储需求,保障数据存储合规性、前端交互合理性与后续扩展性,全系统统一选型标准,避免类型混用;以下是常用的字段类型选型规则

字段类型需严格匹配字段业务语义与数据存储需求,保障数据存储合规性、前端交互合理性与后续扩展性,全系统统一选型标准,避免类型混用;以下是常用的字段类型选型规范:

字段类型分类推荐字段类型标识适用业务场景选型说明
文本类单行文本短文本、名称、编码、枚举值、标识类用于长度比较短的短文本字符
文本类多行文本原因、说明、备注、描述、大段文字输入用于需要换行、多段落的长文本场景,支持纯文本与富文本配置
日期时间类日期仅需记录年月日的业务日期用于无需时分秒的业务时间,适配工期、节点等场景
日期时间类日期时间需要完整记录年月日时分秒的时间用于系统操作时间、日志时间等需要精确到秒的场景
关联关系类一对多主表关联多个子表数据用于主表与子表一对多关联,支持子数据列表展示
关联关系类多对一从表关联单个主表数据用于从表归属单个主表的场景,为常用关联类型
关联关系类一对一两个表一一对应关联用于主表与扩展表一对一关联,适用于字段拆分、权限隔离
关联关系类多对多两个表互相多个关联用于多对多交叉关联,支持双向选择与批量关联
选择类数据字典(单选)固定枚举值单选用于固定选项单选场景,绑定数据字典维护
选择类数据字典(多选)固定枚举值多选用于需要同时选择多个选项的场景,绑定数据字典维护
文件附件类附件文件、图片、文档上传用于单文件或多文件上传,支持格式与大小校验
布尔状态类布尔值二选一状态、开关类用于是 / 否、启用 / 停用等二元状态
数值类整数数量、次数、序号用于整数型数值,支持范围校验
数值类小数金额、比例、计量值用于带小数的数值,支持精度配置

一、导航栏菜单命名与图标配置规范

Section titled “一、导航栏菜单命名与图标配置规范”

字数规范:导航栏菜单名称统一采用4个汉字的标准格式,确保导航栏视觉对齐,布局工整,提升界面一致性与没关系

语义规范:菜单名称需与对应业务模块核心功能语义强关联、高度概括,具备清晰的业务辨识度,便于用户快速理解模块定位;禁止使用生僻词、歧义表述、口语化命名

图标规范:导航栏菜单栏不配置图表

菜单栏

二、操作栏菜单命名与图标配置规范

Section titled “二、操作栏菜单命名与图标配置规范”

图标配置要求:所有一级菜单必须配置菜单栏图标,图标需与菜单业务语义强关联

命名规范:菜单名称需高度概况模块核心内容

唯一性要求:系统内菜单名称唯一,避免混淆 操作栏

位置固定操作列统一固定在表格最右侧,并设置为右固定,确保滚轮横向滚动时操作按钮始终可见,提升操作的便捷程度

顺序规则操作项按用户操作频率、业务逻辑优先级从左到右排序,核心高频操作(如查看、编辑)前置,低频操作后置,提升操作效率

展示形式操作列内的所有操作项(如查看、编辑、添加子记录等),默认以文字+图标形式展示,采用系统统一的链接样式 操作

弹窗设置

弹窗设置按照默认,打开方式”抽屉”,弹窗尺寸”中” 操作

核心配置原则

列表默认排序需严格匹配业务场景与用户使用习惯,保障数据展示的合理性与易用性,全系统统一排序规则,避免配置混乱。

排序方式要求:所有以日期、时间为核心的字段(如创建日期、合同开工时间、中标通知书时间等),默认排序方式统一设置为降序(倒序),确保最新数据优先展示,符合用户查看习惯。 示例:日期字段默认按「降序」排序,最新时间的数据展示在列表最前端

优先级规则:若列表存在多字段排序,日期 / 时间字段需优先作为第一排序项,保障核心时间维度的展示优先级。
排序

核心布局原则

表单字段统一采用水平布局、字段标题右对齐,字段标题宽度120,的标准格式,保障界面视觉对齐、布局规整,提升表单填写效率与美观度;字段需严格按照业务逻辑顺序从上到下、从左到右排列,符合用户填写习惯

布局格式要求

  • 所有表单字段默认按一行 2 个字段进行排版,左右两列对齐,避免单行列占满、多列混杂的情况

  • 仅多行文本、富文本、markdown等大输入框字段(如简介、备注),可单独占一行,适配大段内容输入场景

  • 必填项(带*标识)优先前置,核心业务字段按优先级从上到下排列,辅助字段后置

布局

页面主题编辑器选择默认,导航栏背景色选择#1677ff

主题