后端开发规范

后端开发规范

SOA服务接口规范
1、SOA接口命名提供出去后不能变更，废弃接口使用@deprecated进行标记
2、SOA接口出入参定义为一个大对象，且出入参参数不能删除，只能增加，废弃字段使用@deprecated进行标记

一般规范

• 开发必须会使用乐观锁。乐观锁不要采用有意义的字段，考虑用version字段
• 设计表结构慎用大字段。注意控制输入不要超过字段长度，或者截段
• mysql尽量少用join查询；分库的不要用，其他情况酌情处理
• 分页页面展示不超过10。提供接口查询量大，必须分页
• 缓存。所有的读操作，必须考虑缓存。 缓存key必须是唯一的，缓存时间根据实际情况设置，key值要有业务意义；做+ 设计的时候告知需求方，我们使用缓存的影响。缓存配置要考虑默认值,如取不到数据,使用默认值。且不能影响正常业务；考虑后台能够随时清理缓存。redis manage
• 所有的定时任务考虑是否支持多进程的，是否有补跑机制. 考虑使用多频率调用的方法处理数据。避免集中式爆发；单台机器多线程加上原子控制，集群指定服务器ip跑定时任务。
• 批量操作，一定要使用分批处理。批处理中一定要考虑间隔和上限，1000条做一次
• 设计表时要加上以下字段：create_time、creator_id、creator、last_modified、modified_id、modified_by、is_deleted如是日志表考虑client_ip、server_ip
• 是否所有页面上的功能都考虑了多浏览器环境支持(必须支持火狐，chrome)
• 对数据唯一性要求很高的话，考虑唯一索引
• 接口返回尽量要保证幂等
• 页面提交按钮必须防呆。（如考虑遮罩）
• 源文件编码格式为UTF-8
• Long与Ineger大小比较，用equals方法，或者先使用longValue()或intValue()方法来得到他们的基本类型的值然后使用==比较也是可以的。

命名规范

• 使用驼峰命名法，方法名以动词开头；类命名如：HelloWorld。变量命名如：headCount。常量命名应使用CONSTANT_CASE格式（译注：所有字母大写，单词使用下划线分隔）。（final, static）
• controller层以Controller结尾，Service层以Service结尾，实现类以ServiceImpl结尾，Dao层以Dao结尾，实现类以**DaoImpl结尾
• 工具类以Utils结尾，并放到单独的包如：common,utils
• 方法命名：dao层如果是单条查询请用get开头,如：getOperatorById,查询集合通过find*list开头,findMerchantListByOperatorId；get单表单条数据；find..List单表list；query多表对象；query..List多表list ；新增用insert开头，更新用update开头，删除用delete开头，Service层方法命名根据具体业务来，见名知意，如取消订单，cancelOrder。
• 参数的命名：参数的名字必须和变量的命名规范一致。使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：
• sql文件以*_mapper.xml结尾 ，如order_mapper.xml
• jsp与html文件名全部小写,单词之间用_隔开，如：order_list.jsp
• model层：持久层对象必须和表名一致，表现层对象一律使用 vo（Value Object）结尾。用（request，response）结尾
• 关于属性的定义，数组定义为：xxxs，列表定义为xxxList

编码原则

• 所有问题要采用缩进风格编写，缩进的空格数为4个
• 不允许把多个短语句写在一行中，即一行只写一条语句
• 相对独立的程序块之间、变量说明之后必须加空行
• 必须要有注释，源程序注释量必须在30％以上，注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作 用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期。方法内的单行注释用//,其他都用/** 。。。*/
• 不允许提交编译报错和带黄色警告的代码。
• 每个类文件不能超过2000行，每个方法不能超过150行。代码宽度150列。
• If-else不应嵌套太多，不能超过三层，如果嵌套太多应该考虑调整你的逻辑了或者换种实现方式嵌套循环不能超过三层。
• 日志处理，一般的异常情况都需要增加log日志，尽量不要用“System.out.println()”
• 代码段原则上要放在大括号{}之内，如果只有一行代码也必须放在大括号之中，不允许省略，并且大括号不允许与其中的代码段在同一行。
• 不要在controller层做业务逻辑，统一在sevice层处理：controller层所做的事情是获取入参，做数据有效性校验。完+ 成后则拼装DO并传入service层做业务逻 辑处理。
• 对外接口异常统一返回异常编码和异常说明，内部正确使用异常,不要随意地就抛出一个异常，特别是Exception异常。但在try－catch时尽量捕获具体异常,最 好不要catch（Exception）这么写。
• 业务使用手动事务，后台酌情考虑。不允许有大事务。（事务的传播性考虑）aop配置事务必须指定到方法
• 外部接口调用需要记录日志，数据表记录等——提供给外部的接口
• 调用接口获得的返回值需要做对象非空、业务逻辑验证等操作；调用接口的结果对象转换成本地定义对象，避免接口修改通知不及时引起的系统异常
• 系统功能及数据有合适的权限控制（比如菜单权限，水平权限）
• 没有冗余代码(特别是一注释就注释一大片的那种)；面向接口编程
• 没有硬编码（如数据库源配置、跳转URL、魔鬼数字、通用错误码、bean初始化）
• 面向用户端的接口，必须做安全校验。
• update操作涉及多条或多表数据时，确保并发场景下无死锁问题,批量更新多表按表名排序，单表按主键排序
• 无SQL注入的漏洞（在编写mybatis的映射语句时，尽量采用“#{xxx}”这样的格式。若不得不使用“${xxx}”这样的参数，要手工地做好过滤工作，来防止sql注入 攻击）；不要用like，用SELECT * from end_user where INSTR(user_name,'jun.')
• spring.xml 配置bean一定要有id且唯一（考虑jar包冲突）
• 第三方jar 引入是否exclude了和现在有冲突的版本 spring mybatis log4j等
• pom文件，版本控制放到最上面。

接口提供：

• 接口可扩展（入参xxRequest、出参xxResponse）
• 是否需要支持可重复调用
• 是否需要提供回滚接口
• 入参强制校验
• dao层考虑水平和垂直拆分的影响（是否需要路由、聚合函数分页等如何处理）
• 重要数据操作，比如金额一定要有流水，不是简单的日志记录（log总是多多益善）
• 接口层统一返回对象，异常只能在接口内部处理，不能抛出来。返回对象包含3个基本属性。1，返回编号 2，返回数据 3，返回消息
• SoaResponse.java