在企业开发中，代码规范是非常重要的，博主在日常开发中，以阿里规范设计了一套基础的开发规范。本文将详细介绍。
1.idea设置注释与格式规范
1.安装插件
- 安装idea插件–eclipse code formatter
- 按住ctrl + alt + S 然后点击 plugins —marketplace —installed— ok
2添加配置文件
下载好eclipse格式化文件 按住ctrl + alt + S，重启后会发现出现eclipse code formatter 选项，点击进入 按照图片进行配置，路径选择文件夹内eclipse-codestyle文件。
注意：每次保存需要 ctrl+alt +l。
2.注释规范
ctrl + alt + S — file and code templates – includes —file header，然后填写下面代码。
/** * 应用模块名称: * 代码描述: * Copyright: Copyright (C) ${YEAR}, Inc. All rights reserved. * Company: * @author * @since ${DATE} ${TIME} */
2.代码书写规范
- 入参必须使用对象或者List,非特殊情况下不允许使用jsonobject。
- service与dao层也尽量使用对象封装，减少参数罗列。
- 参数传递非必要情况不要使用map传递。
- 出参使用封装好的Result对象。
- 接口文档书写需要详细 。
- 在使用系统统一异常处理时 不需要使用try catch。
- 在特别需要时 需要向统一异常处理方法维护异常类别。
- 需要加入类注释与方法注释 详细请参考新人项目搭建文档。
- 非特殊情况方式不允许使用@requstmapping。
- 实体类需要继承 BaseEntity。
- 尽量将同一业务的接口写到一个类中，通用方法抽取出来，并提交给组长，维护到文档中。
- 服务间调用请参考ribbon与feign。
- 使用格式化文档对代码格式化。
- 类上与接口路径都需要书写，且不要省略“/”。
- 类命名规范 分别为xxController，xxService，xxServiceImpl,xxDao,xxMapper。
- 方法命名规范：
- 事务书写方式。
- 失效代码尽量删除掉，而不是注释。
- 是否等可复用魔法值需要放入枚举类中 不要在代码中写死。
- 实体类需要写明各字段注释，可使用代码生成器生成 。
- 实体中除了设计到计算字段，其他一律使用封装类类型。
- 接口类型不需要public等关键字。
- mapper中需要写全jdbcType，可以使用代码生成器生成。
其他详细可以参考 阿里巴巴Java开发手册（华山版）.pdf。