Skip to main content

方法规范

方法规范文档。

1. 自定义方法命名

info

命名规范:

  • 命名原则:
    • 使用驼峰命名
    • 必须包含明确含义,编码使用全英文单词,禁止使用汉语拼音及简拼。
  • 方法编码:直接按功能get、update、save、delete、select、open...开头+业务信息,无需加下划线,使用驼峰命名
  • 方法名称:功能修饰
  • 应用范围:服务端方法、客户端方法

示例:

自定义方法命名方式例子1例子2例子3
方法编码get、update、save、delete、select、open...开头+业务信息getUserInfoopenUserEditdeleteUserInfo
方法名称功能修饰获取用户信息打开用户编辑窗体删除用户信息

2. SPI/EP方法命名

命名规范:
  • 命名原则:
    • 使用驼峰命名
    • 必须包含明确含义,编码使用全英文单词,禁止使用汉语拼音及简拼。
  • 方法编码:对应前缀_功能修饰
    • SPI前缀:spi_
    • EP前缀:ep_
  • 方法名称:功能修饰

示例:

SPI/EP方法命名方式SPI例子EP例子
SPI/EP方法编码对应前缀_功能修饰spi_getDataep_getData
SPI/EP方法名称功能修饰获取数据获取数据

3. 业务动作命名

命名规范:
  • 命名原则:
    • 使用驼峰命名
    • 必须包含明确含义,编码使用全英文单词,禁止使用汉语拼音及简拼;
    • 业务动作扩展点实现命名保留默认。
  • 方法编码:action_功能修饰
  • 方法名称:功能修饰

示例:

业务动作命名方式例子1例子2例子3
业务动作方法编码action_功能修饰action_saveaction_submitaction_print
业务动作扩展点编码ep_action_功能修饰ep_action_saveep_action_submitep_action_print
方法名称功能修饰保存提交打印

4. 规则

info

规则名称必须加上必要注释或者规则说明,规则编码一般不做要求。命名要求如下:

  • 在新增规则时,规则加上 “【”+ 功能修饰+ “】 ”
  • ”执行方法“规则保留默认,无需修改。

示例:

规则命名方式例子1例子2
规则名称规则名称【功能修饰】中断规则【入参为空则中断当前】修改数据库中的记录【报销申请主表】

5. 函数粒度

info

在编写方法(函数)实现功能时遵循以下规则:

  • 尽量降低配置方法间的藕合度、以便修改和扩展。
  • 事件中调用相应的窗体、控件方法时不要在窗体、控件方法中配置相应的规则或函数,建议只调用实现相关功能的自定义方法。
  • 每个方法(函数)配置的规则不要过多(不建议超过10个)。
  • 如果实现的功能过于复杂,需要在方法配置过多规则时,把规则拆分封装到相应的方法进行调用。

6. 逻辑执行编写和嵌套层数

info

在自定义方法编写具体逻辑时应遵循以下规则:

  • 如果需要经过几层的判断(true或false),所有条件都成立或大部分条件成立时才去执行一/多个规则或方法时,应把嵌套条件封装在一个方法里并返回结果后中断规则退出。根据返回条件是非而执行相应规则或方法,不要直接在多层嵌套If…Else里去执行规则/方法。
  • 编写逻辑执行条件前,最小化找到分支之前所判断条件体的数量,将最常见的条件放在首位,如果成立则中断规则。
  • 尽量使用表达式的结果非(!),来做为If判断条件。
  • If…Else 不宜嵌套层数过多(不建议超过10层)