评价代码是否优良的一个重要原则就是:易读。因为很多代码是需要多人一起维护的,即使是原作者自己维护,时隔几个月后,再来看的时候,也一定会陌生,因此,易读易懂的重要性就在于此,方便他人也方便自己。
下面列举一些代码编写时注意的要点
1、相同或相似逻辑的代码尽量不要出现多次。任意的Copy&Paste代码块,对日后的维护有很大隐患的,如果日后逻辑需要调整,那么每一处相同或相似的代码块都要修改,此时很容易遗漏。
2、对于一些基础的功能,比如字符串操作,数字操作和日期操作等,尽量使用开源工具包,比如apache的commons的 StringUtils,NumberUtils,DateUtils,ToStringBuilder 等,以及Google的Guava,这些开源工具用的人比较多,经过大家的检验,稳定性和安全性会好很多。
3、嵌套循环和嵌套IF,尽量少于3层。层数过多的话,不易阅读,排版也显得凌乱。减少嵌套的方式如下:
1)对于IF嵌套,可以考虑使用 判断相反的条件 然后return或continue。
比如,如下为多层嵌套,
if (a == true){
b = ....;
if (b == true){
c = .....;
if (c == true) {
......// do sth
}
}
}
可调整为如下,减少层次:
if (a == false){
return;
}
b = ....;
if (b == false){
return;
}
c = ....;
if (c == false){
return;
}
.....// Do sth
2)对于For嵌套,可以考虑将最底层的逻辑移到一个新方法中,尽量控制到 一段代码中 只有2层
比如,如下为3层
for ( : ){
for ( : ){
for ( : ){
....// do sth
}
}
}
可调整为如下,减少至2层
for ( : ){
for ( : ){
doSth();
}
}
method doSth(){
for ( : ){
....// Do sth
}
}
4、List的contains 方法尽量少用:
contains 的实现原理是遍历整个List,逐一用equals去比较,因此,当size小的时候(比如个位数),性能还能忍受,size大的时候,如果成千上万了,那么性能将会极差。替代方案是:把List的element放到Map的key中,使用Map.containsKey 。如果key的对象是非Java的基础类,那么记得要重载 hashcode 和 equals 方法。
5、List转Map<object, List>或者Map<object, Map>的简单写法:性能好的写法
List<String> stringList = new ArrayList<String>();
stringList.add("1");
.......
Map<String, List<String>> stringMap = new HashMap<String, List<String>>();
// 性能最好的写法,方法都是调用一次
for (String str : stringList){
List<String> valueList = stringMap.get(str);
if (valueList == null){
valueList = new ArrayList<String>();
stringMap.put(str, valueList);
}
valueList.add(str);
}
代码行数最少的写法
// 代码行数少的写法,但是map的containsKey和get方法中都会调用相同的方法,调用了2次
for (String str : stringList){
if (!stringMap.containsKey(str)){
stringMap.put(str, new ArrayList<String>());
}
stringMap.get(str).add(str);
}
也或者直接使用 Guava的Multimap 和相关实现,更简洁。
4、JSON序列化要避免滥用:
JSON是大家很常用的,对象的序列化与反序列化非常方便快速,因此,用JSON做为数据格式进行保存数据也很方便,比如保存到Redis中,代码写起来也很简单。
但是,如果JSON字符串比较大的时候,比如,几K,十几K和几十K,此时,在高并发的场景下,CPU的耗费是非常可观的,性能也不会是很美妙。而且很多服务框架也都是用JSON为序列化格式,这样一次服务端处理,就至少要2次序列化和反序列化,这就更加恶化。
服务端到接口参数和返回结果,也尽量避免过于复杂对象,越简单,性能越好。
因此,要避免滥用JSON。对于保存对象,也可以考虑Java的 ObjectInputStream和ObjectOutputStream,再配合Base64。
5、Redis的操作:可用mget/mset 替换 hmget/hmset
Redis 的hash操作可以为一个hash设置多个filed的值,这很方便用于保存一个对象,但是不操作一个对象或者多个hash,并且需要一次设置/获取多个key时,hash就做不到了,需要多次交互,因而会对系统的性能有影响,因此,可以考虑使用mget/mset做为替换方案(当一个对象的属性比较少的时候,也很方便),key值的可用前述的hash的key和filed组合,这样一次也可以操作一个对象的所有值,同时还可以同时操作多个对象的值,以此减少与Redis的交互,从而提高系统的性能。
6、Java的Integer的使用:Integer 既然是对象,那么2个Integer比较的时候就要用对象的方法 equals ,以保证正确。因为Integer在赋值的时候会有拆装箱的问题。
7、Spring中的Bean 实例默认是 单例,此时,其成员变量不要更改,避免线程问题。
8、Mysql DB更新数据的时候,where 条件尽量用主键或唯一索引,一条一条的更新,这样避免并发的时候发生间隙锁(Repeatable Read的级别下),从而产生死锁。详见Mysql文档:https://dev.mysql.com/doc/refman/5.7/en/innodb-locking.html