天天看点

工作经验-Java代码规范Java代码规范

Java代码规范

代码编码规范
  • 以阿里巴巴的开发规范文档基础。详情见阿里巴巴开发规范.java。
  • 安装规范插件

编辑器安装阿里巴巴编码规范插件,idea和 eclipse都有对应的插件。编码中代码给出提示对应的修改即可。如图

工作经验-Java代码规范Java代码规范
工作经验-Java代码规范Java代码规范
  • 安装下载地址:

Eclipse https://blog.csdn.net/qq_32448349/article/details/81744418

Idea https://blog.csdn.net/weixin_39220472/article/details/80077803

代码格式风格

eclipse 和 idea 使用统一的风格,提供统一的eclipseProfile.xml文件。

Eclipse直接在preferences->Java->Code Style->Formatter中导入xml文件。

Idea安装插件Eclipse Code Formatter插件,导入到xml文件。如图

工作经验-Java代码规范Java代码规范
工作经验-Java代码规范Java代码规范
  • 代码编写完成后对代码进行格式化, 如果代码为历史代码,格式化后变动较大,则进行局部格式化。

Eclipse 快捷键:Ctrl + Shift + F

Idea 快捷键:Ctrl + Alt + L

代码长度

代码 循环嵌套 (for ,while…)层次不超过3层,如果超过思考一下实现的方式是否有更优的方式。

代码的行长度设置为120个字符,在上一步导入即可。手动设置自行百度。

一个复杂方法不超过100行,注意统一个逻辑的代码要重构为一个方法,重构快捷键:ctrl+alt+M进行重构。

Idea支持的重构快捷键:

工作经验-Java代码规范Java代码规范
代码注释风格
  • 类注释

第一行对类的功能进行说明,最少包含字段:

@author 作者

@version 版本

@date 创建日期

工作经验-Java代码规范Java代码规范
  • 方法注释

第一行对方法的功能进行说明。

方法也需要加入author信息,当此类中的所有方法都是同一人完成可以不加,例如controller,当service有不同人写入方法时,必须填写此字段。

如果是Impl层实现类只需要在 interface层加入注释即可,不需要在实现层加入注释。

因为项目是多人合作,修改他人代码时遇到不懂的业务代码可以找到作者询问意图,如果是代码是模版生成,在修改方法时需要加入,最少包含字段:

@param 字段

@return 返回对象

@author 作者

工作经验-Java代码规范Java代码规范
  • 字段注释

不用使用 双斜杠  //注释,使用如图注释:

工作经验-Java代码规范Java代码规范
异常处理
  1. 捕捉异常的目的是为了处理它
  2. 多个异常应分别捕捉并处理,避免使用一个单一的catch来处理。
  3. 异常信息必须打印到日志中,不允许日志信息不抛出
  4. 日志记录代码: log.error("查询异常:", e); 前面的提示信息要明确,定位错误
    工作经验-Java代码规范Java代码规范
Redis缓存

Key值的定义:项目名称_模块名称_用途_使用方式,全大写,例如:

public static final String EMC_USER_SMS_PREFIX = “EMC_USER_SMS_PREFIX_”;

String key = EMC_USER_SMS_PREFIX + mobile;

Git使用
  1. 由于本机环境修改的配置不需要提交
  2. 提交前检查确认是否有不要提交的文件
  3. 提交写入注释

Continue...