4.1. 推荐编码标准

代码格式

  • 对于 Java 和 Groovey 代码,推荐按照 Java 代码规范 定义的编码标准。如果是在 IntelliJ IDEA 中编码,可以使用默认的编码格式,或者使用快捷键 Ctrl-Alt-L 进行代码格式化。

    每行最大长度是 120 个字符,缩进 4 个字符,用空格替换 tab。

  • XML 代码: 缩进 4 个字符,用空格替换 tab。

命名规范

标识符命名规则示例

Java 和 Groovy 类

界面控制器类

UpperCamelCase(首字母大写驼峰)

浏览界面控制器 − {EntityClass}Browse

编辑界面控制器 − {EntityClass}Edit.

CustomerBrowse

OrderEdit

XML 界面描述文件

组件标识符,查询语句中参数名称

lowerCamelCase(首字母小写驼峰),只包含字母和数字

attributesTable

:component$relevantTo

:ds$attributesDs

数据源标识符

lowerCamelCase(首字母小写驼峰),只包含字母和数字以 Ds 结尾。

attributesDs

SQL 脚本

保留字

lowercase(小写)

create table

表名

UPPERCASE(单词全大写下划线分隔)。名称需要以项目名称开头以区分命名空间。推荐表名使用单数形式,比如 ORDER,而不是 ORDERS

SALES_CUSTOMER

列名

UPPER_CASE(单词全大写下划线分隔)

CUSTOMER

TOTAL_AMOUNT

外键列名

UPPER_CASE(单词全大写下划线分隔),包含此列指向的表名(去掉项目前缀)加上_ID 后缀。

CUSTOMER_ID

索引名

UPPER_CASE(单词全大写下划线分隔),以 IDX开头,包含带有项目名称的表名加上作为索引字段的名称。

IDX_SALES_CUSTOMER_NAME