项目开发中自己出的问题

109 阅读3分钟

1. 模块结构规范

  • 注意要点:
    • 凡是公共模块内容,只允许指定负责人(一般为该模块的开发者)处理,其他人只有使用权;
    • 处理公共模块的负责人,后续做了调优处理,必须兼容使用者现有的使用方式;特殊情况,必须将改动量降到最低,发布操作说明文档;

    不要自己私自更改别人写的公共组件!

2. 编程规约

  • 不允许使用拼音;
  • 命名意图必须明显,使用英文字母、下划线、数字随机组合;

3. 条件组合

  • 条件数量<=3:if - else if - else;
  • 条件数量>=3:推荐使用switch或数组;
  • 条件数量>5:能处理成数据库配置的,使用数据库配置;不能的继续使用switch或数组;

4. 校验规约

  • 自定义批处理校验
    • 必须明确提示 校验不通过的数据
      • 前台:非空校验、数据格式校验、其他校验;
      • 后台:重复性校验、其他校验;
    • 检测到校验不通过的,后续遍历必须终止,示例代码:

image.png

5. 注释规约

  • 自己认为重要的地方,写好注释,方便自己后续修改,方便维护人员维护;
    • 单行注释 //
    • 多行注释 /** */

6. 代码提交规范

  • 只允许提交自己负责的代码块
  • 提交时的备注,提交内容简述--提交人--提交时间;
  • 代码同步处理:每次服务器部署时,都必须将整合分支代码同步到自己的分支;

7. 代码清理规范

  • 及时清理不再使用的代码段或配置信息:
    • 对于垃圾代码或过时配置,坚决清理干净,避免程序过于臃肿,代码冗余;
    • 对于暂时注释掉,或许可能恢复使用的代码片段,在注释代码上方,统一规定使用三个斜杠(///)来说明注释掉代码的理由;

8. 表单提交、确认事件处理

  • 与后台进行数据交互的表单,必须加防止表单重复提交功能:
    • 统一规定:点一次,按钮灰化---》 等待后台响应 ---》 报错则解除灰化,表单不关闭;成功则关闭表单,作废;
    • 防止表单重复提交功能(按钮禁用)---前台不用加(后台有提示,防止表单重提);

9. 分页查询注意点

  • 非切换页码的查询触发事件-必须重置查询起始位置,从第一页开始搜索

image.png

  • 切换页码查询,使用事件页码即可:

image.png

10. 前后台数据交互,响应数据处理规约

  • 后台,统一返回
{
    data: Object, // 任意类型的业务数据
    message: "", // 提示信息
    status: 200 // 状态码200表示成功;201~299业务警告
}
  • 框架负责人统一拦截所有响应,只开放200~299状态码的响应给业务模块,其他code统一处理;
  • 前台根据状态码判断请求是否成功,
    • 若使用Message消息提示,必须提供showClose: true;的功能

11. 代码库分类

  • master --- 主分支

  • team-all --- 最全整合分支

  • 其他 --- 开发人员私有分支