Java代码规范

编程规约

命名规范

  • 方法
    增加/插入——add*()
    删除——delete*()
    更改/更新——update*()
    查询/获取单个对象——find*()
    查询/获取多个对象——query*()
  • 枚举
    对于Enum类型和值名称使用 Pascal 大小写
    命名不能缩写,枚举内的内容可以缩写
    命名禁止加Enum 后缀
  • 参数
    参数名称使用Camel大小写
    参数名称可缩写
  • 属性
    以名词或形容词命名
    使用 Pascal 大小写
    禁止缩写
    javabean属性命名尽量使用常规的驼峰式命名规则
    属性名第一个单词尽量避免使用一个字母:如eBook, eMail
    boolean属性名避免使用 “is” 开头的名称,因为javabean规范的boolean取值操作是isXXX
    在类属性的名称中包含类名是多余的,如 Book.BookTitle。而是应该使用 Book.Title
  • 常量
    禁止缩写
    采用完整的英文大写单词,在词与词之间用下划线连接,如:DEFAULT_VALUE
    命名尽量简短,不要超过16个字符
    同一组的常量可以用常量类封装在一起,便于引用和维护
    代码中用到常量的,用静态常量表示
正例:
Private final static String SUCCESS=”success”;
Private final static String ERROR = “error”;
调用:类名.SUCCESS
  • 字段和变量
    private、protected 使用 Camel 大小写。
    禁止使用public。
    字段命名规范:驼峰命名 比如:studentName,studentId
    对于主键字段, id命名:如:studentId,需要加上与实体类相关的名称。
    对于时间类型的字段,采用dateTime, 格式:YYYY-MM-dd HH:mm:ss
    布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。
    DataSet类型的变量以ds开头,DataTable类型的变量以table开头
    在变量名中使用互补对,如 min/max、begin/end 和 open/close。
    即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。
    对不易清楚识别出该变量类型的变量应使用类型缩写作其前缀,如字符串使用strXXX,boolean使用isXXX,hasXXX等等。
    命名尽量简短,不要超过16个字符
  • 静态字段
    使用名词、名词短语或者名词的缩写命名静态字段。
    使用帕斯卡(Pascal)命名法,又叫大驼峰命名法,每个单词的第一个字母都大写
正例:int MyAge;
      char MyName[10];
  • 集合
    用名词加集合名称的方式来命名,第一个单词首字母小写,如
List<User> userList = new ArrayList<>();
Map<String, User> userMap = new HashMap<>();

禁止使用单个字母如l,m来命名
数组应该总是用下面的方式来命名

byte[] buffer; 而不是:byte buffer[];
  • 泛型
    以一个大写字母(建议优先使用T)表示类的类型,以一个小写字母(如:t)表示类名
  • JS代码
    Js中不要用alert用$.message.alert
    datagrid加在数据时,尽量使用js的方式加载,而不是在jsp的table中编写url等信息,这样可以使我们的datagrid加在数据是更加的灵活。
  • 分页信息获取
    分页时,pageNum或pageSize取值时,用三目运算符?:
int pageNum = Integer.parseInt(page == null ? "1" : page);
int pageSize = Integer.parseInt(rows == null ? "15" : rows);

注释规范

单行注释://……
块注释:/……/
文档注释:/**……*/

  • Javadoc注释标签语法:
    @author 对类的说明 标明开发该类模块的作者
    @version 对类的说明 标明该类模块的版本
    @see 对类、属性、方法的说明 参考转向,也就是相关主题
    @param 对方法的说明 对方法中某参数的说明
    @return 对方法的说明 对方法返回值的说明
    @exception 对方法的说明 对方法可能抛出的异常进行说明

  • 类(接口)注释

正例:
 /**
* 类的描述
* @author Administrator
* @Time 2012-11-2014:49:01
*
*/
public classTest extends Button {
  ……
}
  • 构造方法注释
正例:
public class Test extends Button {
  /**
   * 构造方法 的描述
   * @param name
   *       按钮的上显示的文字
   */
  public Test(String name){
     ……
  }
}
  • 方法注释:
    方法注释+姓名+时间+java开发版本
正例:
/**
*添加组织结构
*@param institution
*@return 添加成功返回true
*/
  • Jsp注释:
<!--  -->
  • 全局变量注释:
正例:
public final class String
   implements Java.io.Serializable, Comparable<String>,CharSequence
{
   /** xxxxxxxxxxxxxx*/
   private final char value[];
   /** xxxxxxxxxxxxx */
   private final int offset;
   /** xxxxxxxxxxxxx */
   private final int count;
   /** xxxxxxxxxxxxx */
private int hash; // xxxxx
……
}
  • 字段/属性注释
正例:
public class EmailBody implements Serializable{
   private String id;
   private String senderName;//发送人姓名
   private String title;//不能超过120个中文字符
   private String content;//邮件正文
   private String attach;//附件,如果有的话
   private String totalCount;//总发送人数
   private String successCount;//成功发送的人数
   private Integer isDelete;//0不删除 1删除
   private Date createTime;//目前不支持定时 所以创建后即刻发送
   privateSet<EmailList> EmailList;
……
}

修改代码注释:
页面注释:
在div、部分视图等内容前添加注释,保证代码的可读性:
如:显式注释:在html中存在注释:

<!--显示信息区域-->

隐式注释:可以使用java中的“//”、“/…./”,以及JSP中自己的注释:“<%-- 注释内容 --%>”

数据库规约

命名规范

  • 只允许使用内网域名,而不是ip连接数据库
  • 线上环境、开发环境、测试环境数据库内网域名遵循命名规范
    业务名称:xxx
    线上环境:dj.xxx.db
    开发环境:dj.xxx.rdb
    测试环境:dj.xxx.tdb
    从库在名称后加-s标识,备库在名称后加-ss标识
    线上从库:dj.xxx-s.db
    线上备库:dj.xxx-sss.db
  • 库名、表名、字段名:小写,下划线风格,不超过32个字符,必须见名知意,禁止拼音英文混用
  • 表名t_xxx,非唯一索引名idx_xxx,唯一索引名uniq_xxx

表设计规范

  • 单实例表数目必须小于500
  • 单表列数目必须小于30
  • 表必须有主键,例如自增主键
    说明:
    a)主键递增,数据行写入可以提高插入性能,可以避免page分裂,减少表碎片提升空间和内存的使用
    b)主键要选择较短的数据类型, Innodb引擎普通索引都会保存主键的值,较短的数据类型可以有效的减少索引的磁盘空间,提高索引的缓存效率
    c) 无主键的表删除,在row模式的主从架构,会导致备库夯
  • 禁止使用外键,如果有外键完整性约束,需要应用程序控制
    说明:外键会导致表与表之间耦合,update与delete操作都会涉及相关联的表,十分影响sql 的性能,甚至会造成死锁。高并发情况下容易造成数据库性能,大数据高并发业务场景数据库使用以性能优先

字段设计规范

  • 必须把字段定义为NOT NULL并且提供默认值
    说明:
    a)null的列使索引/索引统计/值比较都更加复杂,对MySQL来说更难优化
    b)null 这种类型MySQL内部需要进行特殊处理,增加数据库处理记录的复杂性;同等条件下,表中有较多空字段的时候,数据库的处理性能会降低很多
    c)null值需要更多的存储空,无论是表还是索引中每行中的null的列都需要额外的空间来标识
    d)对null 的处理时候,只能采用is null或is not null,而不能采用=、in、<、<>、!=、not in这些操作符号。如:where name!=’shenjian’,如果存在name为null值的记录,查询结果就不会包含name为null值的记录
  • 禁止使用TEXT、BLOB类型
    说明:会浪费更多的磁盘和内存空间,非必要的大量的大字段查询会淘汰掉热数据,导致内存命中率急剧降低,影响数据库性能
  • 禁止使用小数存储货币
    说明:使用整数吧,小数容易导致钱对不上
  • 必须使用varchar(20)存储手机号
    说明:
    a)涉及到区号或者国家代号,可能出现±()
    b)手机号会去做数学运算么?
    c)varchar可以支持模糊查询,例如:like“138%”
  • 禁止使用ENUM,可使用TINYINT代替
    说明:
    a)增加新的ENUM值要做DDL操作
    b)ENUM的内部实际存储就是整数,你以为自己定义的是字符串?

索引设计规范

  • 单表索引建议控制在5个以内
  • 单索引字段数不允许超过5个
    说明:字段超过5个时,实际已经起不到有效过滤数据的作用了
  • 禁止在更新十分频繁、区分度不高的属性上建立索引
    说明:
    a)更新会变更B+树,更新频繁的字段建立索引会大大降低数据库性能
    b)“性别”这种区分度不大的属性,建立索引是没有什么意义的,不能有效过滤数据,性能与全表扫描类似
  • 建立组合索引,必须把区分度高的字段放在前面
    说明:能够更加有效的过滤数据

SQL使用规范

  • 禁止使用SELECT *,只获取必要的字段,需要显示说明列属性
    说明:
    a)读取不需要的列会增加CPU、IO、NET消耗
    b)不能有效的利用覆盖索引
    c)使用SELECT *容易在增加或者删除字段后出现程序BUG
  • 禁止使用INSERT INTO t_xxx VALUES(xxx),必须显示指定插入的列属性
    说明:容易在增加或者删除字段后出现程序BUG
  • 禁止使用属性隐式转换
    说明:SELECT uid FROM t_user WHERE phone=13812345678 会导致全表扫描,而不能命中phone索引。
  • 禁止在WHERE条件的属性上使用函数或者表达式
    说明:SELECT uid FROM t_user WHERE from_unixtime(day)>=‘2017-02-15’ 会导致全表扫描
    正确的写法是:SELECT uid FROM t_user WHERE day>= unix_timestamp(‘2017-02-15 00:00:00’)
  • 禁止负向查询,以及%开头的模糊查询
    说明:
    a)负向查询条件:NOT、!=、<>、!<、!>、NOT IN、NOT LIKE等,会导致全表扫描
    b)%开头的模糊查询,会导致全表扫描
  • 禁止大表使用JOIN查询,禁止大表使用子查询
    说明:会产生临时表,消耗较多内存与CPU,极大影响数据库性能
  • 禁止使用OR条件,必须改为IN查询
    说明:旧版本Mysql的OR查询是不能命中索引的,即使能命中索引,为何要让数据库耗费更多的CPU帮助实施查询优化呢?
  • 应用程序必须捕获SQL异常,并有相应处理
  • sql语句不能放在service层,要放在eao层中,不能把eao层架空
  • sql语句查询时必须包含“isDelete ==0”这个条件
    在这里插入图片描述
  • 多用append,可以显示出sql语句结构层次。
    在这里插入图片描述
  • 如果后台的代码直接返回一个方法的调用结果,那么直接用下面的方式写
    Return institutionEao.queryByCode(code, dataBaseName, nodlevel);
    而不是
    List list = institutionEao.queryByCode(code, dataBaseName, nodlevel);
    Return list
    异常日志规约
  • 异常处理
  1. Java类库中定义的一类RuntimeException可以通过预先检查进行规避,而不应该通过catch来处理,比如:IndexOutOfBoundsException /,NullPointerException等等。
    说明:无法通过预检查的异常除外,如在解析一个外部传来的字符串形式数字时,通过catchnumberFormatException来实现。
    正例:if (obj != null) {…}
    反例:try { obj.method() } catch(NullPointerException e){…}
  2. 异常不要用来做流程控制,条件控制,因为异常的处理效率比条件分支低。
  3. 对大段代码进行try-catch,这是不负责任的表现。catch时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型,再做对应的异常处理。
  4. 捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。
  5. 有try块放到了事务代码中,catch异常后,如果需要回滚事务,一定要注意手动回滚事务。
  6. finally块必须对资源对象、流对象进行关闭,有异常也要做try-catch。
    说明:如果JDK7,可以使用try-with-resources方法。
  7. 不能在finally块中使用return,finally块中的return返回后方法结束执行,不
    会再执行try块中的return语句。
  8. 捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。
    说明:如果预期抛的是绣球,实际接到的是铅球,就会产生意外情况。
  9. 方法的返回值可以为null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE(Null Pointer Exception,空指针异常)问题。
    说明:本规约明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象,对调用者来说,也并非高枕无忧,必须考虑到远程调用失败,运行时异常等场景返回null的情况。
  10. 防止NPE,是程序员的基本修养,注意NPE产生的场景:
    1) 返回类型为包装数据类型,有可能是null,返回int值时注意判空。
    反例:public int f(){ return Integer对象},如果为null,自动解箱抛NPE。
    2) 数据库的查询结果可能为null。
    3) 集合里的元素即使isNotEmpty,取出的数据元素也可能为null。
    4) 远程调用返回对象,一律要求进行NPE判断。
    5) 对于Session中获取的数据,建议NPE检查,避免空指针。
    6) 级联调用obj.getA().getB().getC();一连串调用,易产生NPE。
    正例:可以使用JDK8的Optional类来防止NPE问题。
  11. 在代码中使用“抛异常”还是“返回错误码”,对于公司外的http/api开放接口必须使用“错误码”;而应用内部推荐异常抛出;跨应用间RPC调用优先考虑使用Result方式,封装isSuccess、“错误码”、“错误简短信息”。
    说明:关于RPC方法返回方式使用Result方式的理由:
    1)使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误。
    2)如果不加栈信息,只是new自定义异常,加入自己的理解的error message,对于调用
    端解决问题的帮助不会太多。如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。
  12. 定义时区分unchecked / checked 异常,避免直接使用RuntimeException抛出,更不允许抛出Exception或者Throwable,应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常,如:DaoException / ServiceException等。
  13. 避免出现重复的代码(Don’t Repeat Yourself),即DRY原则。
    说明:随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是共用模块。
    正例:一个类中有多个public方法,都需要进行数行相同的参数校验操作,这个时候请抽取:
    private boolean checkParam(DTO dto){…}
  • 公共模块调用异常处理
    例如:类A调用类B(公共类)中的方法
    1、对于公共类B:
    类的公共方法中先要对传入参数的类型进行验证 , 类型不对则抛出异常 。
    2、对于调用公共类的类A:
    所有的函数在接收参数时都应该检查传进来的参数类型,参数的范围。如果参数不符合要求,可以直接就返回错误。
  • 合理布局函数返回值,保证函数返回值一致
    之前写我们函数,返回值类型可以是Bool型,也可能Str或者Int等类型。函数调用后处理时,处理不当就会出现类似Bool和Int类型比较的问题,出现typeError,所以在函数编写前,要思考后本函数的作用,同时确定返回值类型,在函数的所有涉及到返回结果时,给予一致类型的返回值,方便外部调用。
  • 清理代码,去掉冗余代码
    很多时候,我们的代码都是迭代开发的。往往会罗列一些无用的函数,引入一些无用的类库。这些内容貌似无意义,但却是代码中的隐患。可能在后续的类库更新或者函数变更中爆炸。所以,代码要保持清理,对于无用的引用和定义,要加以清除。
  • 异常日志
    缺少异常处理的代码会为程序埋下巨大的隐患。严谨的代码能够很大程度上提高代码的健壮性。请在编码时一定要注意,减少隐含bug,提高产品质量。
    基本原则:上层应用中所有的异常均需要捕获并处理,防止程序异常退出。
    统一将错误抛出到页面,生产环境统一抛出错误页,需要在controller的异常的错误日志之后将异常抛出,例:
    首先需要更新一下itoo-easyui的war包依赖
发布了214 篇原创文章 · 获赞 36 · 访问量 7万+
展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 技术工厂 设计师: CSDN官方博客

分享到微信朋友圈

×

扫一扫,手机浏览