架构师技能3:code review-高效代码50例

2023-03-01 15:44:58 浏览数 (1)

声明:转载和总结网上相关文章,感谢最初的原创。 这篇文章对代码对细节做code review很有帮忙,因此稍微做了修改发上来。

导读

前文 架构师技能3:如何做code review 单纯从优秀代码对特质来总结code review框架性内容。而本文转载的是从实际代码细节方面来code review。

世界上只有两种物质:高效率和低效率;世界上只有两种人:高效率的人和低效率的人。——萧伯纳

同理,世界上只有两种代码:高效代码和低效代码;世界上只有两种人:编写高效代码的人和编写低效代码的人。如何编写高效代码,是每个研发团队都面临的一个重大问题。所以,作者根据实际经验,查阅了大量资料,总结了"Java高效代码50例",让每一个Java程序员都能编写出"高效代码"。

建议:在多数情况下,比较为了所谓提升微小性能忽略代码简单清晰整洁易懂的原则也是得不偿失。

一、常量&变量


1.1.直接赋值常量值,而不是声明新对象

直接赋值常量值,只是创建了一个对象引用,而这个对象引用指向常量值。

反例:(几乎没有javaer这么声明常量)

代码语言:javascript复制
Long i = new Long(1L);
String s = new String("hello");

new String("hello")除创建字符串外,str所引用的String对象底层还包含一个char[]数组,这个char[]数组依次存放了h,e,l,l,o 

正例:

代码语言:javascript复制
Long i = 1L;
String s = "hello";

s = "hello";创建一个“hello”字符串,而且JVM的字符缓存池还会缓存这个字符串;

1.2.当成员变量值无需改变时,尽量定义为静态常量

在类的每个对象实例中,每个成员变量都有一份副本,而成员静态常量只有一份实例。

反例:

代码语言:javascript复制
public class HttpConnection {
    private final long timeout = 5L
    ...
}

正例:

代码语言:javascript复制
public class HttpConnection {
     private static final long TIMEOUT = 5L
      ...
 }

1.2.1 但也要尽量避免随意使用静态变量。

当某个对象被定义为static变量所引用,那么GC通常是不会回收这个对象所占有的内存,如

代码语言:javascript复制
public class A{
       private static B b = new B();
}

此时静态变量b的生命周期与A类同步,如果A类不会卸载,那么b对象会常驻内存,直到程序终止。

1.3.尽量使用基本数据类型,避免自动装箱和拆箱

  Java 中的基本数据类型double、float、long、int、short、char、boolean,分别对应包装类Double、Float、Long、Integer、Short、Character、Boolean。JVM支持基本类型与对应包装类的自动转换,被称为自动装箱和拆箱。

     虽然包装类型和基本类型在使用过程中是可以相互转换,但它们两者所产生的内存区域是完全不同的,基本类型数据产生和处理都在栈中处理,包装类型是对象,是在堆中产生实例。因此装箱和拆箱都是需要CPU和内存资源的。

      所以应尽量避免使用自动装箱和拆箱。在集合类对象,有对象方面需要的处理适用包装类型,其他的处理提倡使用基本类型。

反例:

代码语言:javascript复制
Integer sum = 0;
int[] values = ...;
for (int value : values) {
  sum  = value; // 相当于result = Integer.valueOf(result.intValue()   value);
}

正例:

代码语言:javascript复制
int sum = 0;
int[] values = ...;
for (int value : values) {
  sum  = value;
}

1.4.如果变量的初值会被覆盖,就没有必要给变量赋初值

反例:

代码语言:javascript复制
List<UserDO> userList = new ArrayList<>();
if (isAll) {
  userList = userDAO.queryAll();
} else {
  userList = userDAO.queryActive();
}

正例:

代码语言:javascript复制
List<UserDO> userList;
if (isAll) {
  userList = userDAO.queryAll();
} else {
  userList = userDAO.queryActive();
}

1.5.尽量使用函数内基本类型的临时变量(局部变量

在函数内,基本类型的参数和临时变量都保存在栈(Stack)中,访问速度较快;其他变量,如静态变量、实例变量等,都在堆(Heap)中创建,速度较慢。对象类型的参数和临时变量的引用都保存在栈(Stack)中,内容都保存在堆(Heap)中,访问速度较慢。在类中,任何类型的成员变量都保存在堆(Heap)中,访问速度较慢。

反例:

代码语言:javascript复制
public final class Accumulator {
    private double result = 0.0D;
    public void addAll(@NonNull double[] values) {
        for(double value : values) {
            result  = value;
        }
    }
    ...
}

正例:

代码语言:javascript复制
public final class Accumulator {
    private double result = 0.0D;
    public void addAll(@NonNull double[] values) {
        double sum = 0.0D;
        for(double value : values) {
            sum  = value;
        }
        result  = sum;
    }
    ...
}

1.6.尽量不要在循环体外定义变量

在老版JDK中,建议“尽量不要在循环体内定义变量”,但是在新版的JDK中已经做了优化。通过对编译后的字节码分析,变量定义在循环体外和循环体内没有本质的区别,运行效率基本上是一样的。

反而,根据“ 局部变量作用域最小化 ”原则,变量定义在循环体内更科学更便于维护,避免了延长大对象生命周期导致延缓回收问题 。

反例:

代码语言:javascript复制
UserVO userVO;
List<UserDO> userDOList = ...;
List<UserVO> userVOList = new ArrayList<>(userDOList.size());
for (UserDO userDO : userDOList) {
    userVO = new UserVO();
    userVO.setId(userDO.getId());
    ...
    userVOList.add(userVO);
}

正例:

代码语言:javascript复制
List<UserDO> userDOList = ...;
List<UserVO> userVOList = new ArrayList<>(userDOList.size());
for (UserDO userDO : userDOList) {
    UserVO userVO = new UserVO();
    userVO.setId(userDO.getId());
    ...
    userVOList.add(userVO);
}

1.7.不可变的静态常量,尽量使用非线程安全类

不可变的静态常量,虽然需要支持多线程访问,也可以使用非线程安全类。

反例:

代码语言:javascript复制
public static final Map<String, Class> CLASS_MAP;
static {
    Map<String, Class> classMap = new ConcurrentHashMap<>(16);
    classMap.put("VARCHAR", java.lang.String.class);
    ...
    CLASS_MAP = Collections.unmodifiableMap(classMap);
}

正例:

代码语言:javascript复制
public static final Map<String, Class> CLASS_MAP;
static {
    Map<String, Class> classMap = new HashMap<>(16);
    classMap.put("VARCHAR", java.lang.String.class);
    ...
    CLASS_MAP = Collections.unmodifiableMap(classMap);
}

1.8.不可变的成员变量,尽量使用非线程安全类

不可变的成员变量,虽然需要支持多线程访问,也可以使用非线程安全类。

反例:

代码语言:javascript复制
@Service
 public class StrategyFactory implements InitializingBean {
     @Autowired
     private List<Strategy> strategyList;
     private Map<String, Strategy> strategyMap;
     @Override
     public void afterPropertiesSet() {
         if (CollectionUtils.isNotEmpty(strategyList)) {
             int size = (int) Math.ceil(strategyList.size() * 4.0 / 3);
 Map<String, Strategy> map = new ConcurrentHashMap<>(size);
             for (Strategy strategy : strategyList) {
                 map.put(strategy.getType(), strategy);
             }
  strategyMap = Collections.unmodifiableMap(map);
         }
     }
     ...
 }
 正例:
@Service
 public class StrategyFactory implements InitializingBean {
     @Autowired
     private List<Strategy> strategyList;
     private Map<String, Strategy> strategyMap;
     @Override
     public void afterPropertiesSet() {
         if (CollectionUtils.isNotEmpty(strategyList)) {
             int size = (int) Math.ceil(strategyList.size() * 4.0 / 3);
 Map<String, Strategy> map = new HashMap<>(size);
             for (Strategy strategy : strategyList) {
                 map.put(strategy.getType(), strategy);
             }
             strategyMap = Collections.unmodifiableMap(map);
         }
     }
     ...
 }

二、对象&类


2.1.禁止使用JSON转化对象

JSON提供把对象转化为JSON字符串、把JSON字符串转为对象的功能,于是被某些人用来转化对象。这种对象转化方式,虽然在功能上没有问题,但是在性能上却存在问题。

反例:

List<UserDO> userDOList = ...; List<UserVO> userVOList = JSON.parseArray(JSON.toJSONString(userDOList), UserVO.class); 正例:

代码语言:javascript复制
List<UserDO> userDOList = ...;
List<UserVO> userVOList = new ArrayList<>(userDOList.size());
for (UserDO userDO : userDOList) {
    UserVO userVO = new UserVO();
    userVO.setId(userDO.getId());
    ...
    userVOList.add(userVO);
}

特别是数据量很大的大对象,Jackjson系列化非常耗时,fastjson比较好点,具体可以看java(12)-深入分析java进程CPU飙高和长耗时

2.2.尽量不使用反射赋值对象

用反射赋值对象,主要优点是节省了代码量,主要缺点却是性能有所下降。

但是这个没有绝对之说,要看看具体使用场景。

反例:

代码语言:javascript复制
List<UserDO> userDOList = ...;
 List<UserVO> userVOList = new ArrayList<>(userDOList.size());
 for (UserDO userDO : userDOList) {
     UserVO userVO = new UserVO();
     BeanUtils.copyProperties(userDO, userVO);
     userVOList.add(userVO);
 }
 正例:
List<UserDO> userDOList = ...;
 List<UserVO> userVOList = new ArrayList<>(userDOList.size());
 for (UserDO userDO : userDOList) {
     UserVO userVO = new UserVO();
     userVO.setId(userDO.getId());
     ...
     userVOList.add(userVO);
 }

2.3.采用Lambda表达式替换内部匿名类

对于大多数刚接触JDK8的同学来说,都会认为Lambda表达式就是匿名内部类的语法糖。实际上, Lambda表达式在大多数虚拟机中采用invokeDynamic指令实现,相对于匿名内部类在效率上会更高一些。

反例:

代码语言:javascript复制
List<User> userList = ...;
Collections.sort(userList, new Comparator<User>() {
    @Override
    public int compare(User user1, User user2) {
        Long userId1 = user1.getId();
        Long userId2 = user2.getId();
        ...
        return userId1.compareTo(userId2);
    }
});

正例:

代码语言:javascript复制
List<User> userList = ...;
Collections.sort(userList, (user1, user2) -> {
    Long userId1 = user1.getId();
    Long userId2 = user2.getId();
    ...
    return userId1.compareTo(userId2);
});

2.4.尽量避免定义不必要的子类

多一个类就需要多一份类加载,所以尽量避免定义不必要的子类。

反例:

代码语言:javascript复制
public static final Map<String, Class> CLASS_MAP =
     Collections.unmodifiableMap(new HashMap<String, Class>(16) {
     private static final long serialVersionUID = 1L;
     {
         put("VARCHAR", java.lang.String.class);
     }
 });
 正例:
public static final Map<String, Class> CLASS_MAP;
 static {
     Map<String, Class> classMap = new HashMap<>(16);
     classMap.put("VARCHAR", java.lang.String.class);
     ...
     CLASS_MAP = Collections.unmodifiableMap(classMap);
 }

2.5.尽量指定类的final修饰符 为类指定final修饰符,可以让该类不可以被继承。如果指定了一个类为final,则该类所有的方法都是final的,Java编译器会寻找机会内联所有的final方法。内联对于提升Java运行效率作用重大,具体可参见Java运行期优化,能够使性能平均提高50%。

在JAVA核心API中,有许多应用final的例子,例如java、lang、String,为String类指定final防止了使用者覆盖length()方法。

反例:

代码语言:javascript复制
public class DateHelper {
     ...
 }
 正例:
public final class DateHelper {
     ...
 }
 注意:使用Spring的AOP特性时,需要对Bean进行动态代理,如果Bean类添加了final修饰,会导致异常。

三、方法


3.1.把跟类成员变量无关的方法声明成静态方法

静态方法的好处就是不用生成类的实例就可以直接调用。静态方法不再属于某个对象,而是属于它所在的类。只需要通过其类名就可以访问,不需要再消耗资源去反复创建对象。即便在类内部的私有方法,如果没有使用到类成员变量,也应该声明为静态方法。

反例:

代码语言:javascript复制
public int getMonth(Date date) {
  Calendar calendar = Calendar.getInstance();
  calendar.setTime(date);
  return calendar.get(Calendar.MONTH)   1;
}

正例:

代码语言:javascript复制
public static int getMonth(Date date) {
  Calendar calendar = Calendar.getInstance();
  calendar.setTime(date);
  return calendar.get(Calendar.MONTH)   1;
}

当然该用例是不是可以封装到工具类更好?

3.2.尽量使用基本数据类型作为方法参数类型,避免不必要的装箱、拆箱和空指针判断

反例:

代码语言:javascript复制
public static double sum(Double value1, Double value2) {
    double double1 = Objects.isNull(value1) ? 0.0D : value1;
    double double2 = Objects.isNull(value2) ? 0.0D : value2;
    return double1   double2;
}
double result = sum(1.0D, 2.0D);

正例:

代码语言:javascript复制
public static double sum(double value1, double value2) {
    return value1   value2;
}
double result = sum(1.0D, 2.0D);

3.3.尽量使用基本数据类型作为方法返回值类型,避免不必要的装箱、拆箱和空指针判断

在JDK类库的方法中,很多方法返回值都采用了基本数据类型,首先是为了避免不必要的装箱和拆箱,其次是为了避免返回值的空指针判断。比如:Collection.isEmpty()和Map.size()。

反例:

代码语言:javascript复制
public static Boolean isValid(UserDO user) {
    if (Objects.isNull(user)) {
        return false;
    }
  return Boolean.TRUE.equals(user.getIsValid());
}

// 调用代码
UserDO user = ...;
Boolean isValid = isValid(user);
if (Objects.nonNull(isValid) && isValid.booleanValue()) {
    ...
}

正例:

代码语言:javascript复制
public static boolean isValid(UserDO user) {
    if (Objects.isNull(user)) {
        return false;
    }
  return Boolean.TRUE.equals(user.getIsValid());
}
 
 
// 调用代码
UserDO user = ...;
if (isValid(user)) {
    ...
}

3.4.协议方法参数值非空,避免不必要的空指针判断

协议编程,可以@NonNull和@Nullable标注参数,是否遵循全凭调用者自觉。

反例:

代码语言:javascript复制
public static boolean isValid(UserDO user) {
     if (Objects.isNull(user)) {
         return false;
     }
   return Boolean.TRUE.equals(user.getIsValid());
 }
 正例:
public static boolean isValid(@NonNull UserDO user) {
   return Boolean.TRUE.equals(user.getIsValid());
 }

3.5.协议方法返回值非空,避免不必要的空指针判断

协议编程,可以@NonNull和@Nullable标注参数,是否遵循全凭实现者自觉。

反例:

代码语言:javascript复制
// 定义接口
 public interface OrderService {
     public List<OrderVO> queryUserOrder(Long userId);
 }
 
 
 // 调用代码
 List<OrderVO> orderList = orderService.queryUserOrder(userId);
 if (CollectionUtils.isNotEmpty(orderList)) {
     for (OrderVO order : orderList) {
         ...
     }
 }
 正例:
// 定义接口
 public interface OrderService {
     @NonNull
     public List<OrderVO> queryUserOrder(Long userId);
 }
 
 
 // 调用代码
 List<OrderVO> orderList = orderService.queryUserOrder(userId);
 for (OrderVO order : orderList) {
     ...
 }

3.6.被调用方法已支持判空处理,调用方法无需再进行判空处理

代码语言:javascript复制
反例:
UserDO user = null;
 if (StringUtils.isNotBlank(value)) {
     user = JSON.parseObject(value, UserDO.class);
 }
 正例:
UserDO user = JSON.parseObject(value, UserDO.class);

3.7.尽量避免不必要的函数封装 方法调用会引起入栈和出栈,导致消耗更多的CPU和内存,应当尽量避免不必要的函数封装。当然,为了使代码更简洁、更清晰、更易维护,增加一定的方法调用所带来的性能损耗是值得的。

代码语言:javascript复制
反例:
// 函数封装
 public static boolean isVip(Boolean isVip) {
     return Boolean.TRUE.equals(isVip);
 }
 
 // 使用代码
 boolean isVip = isVip(user.getVip());
 正例:
boolean isVip = Boolean.TRUE.equals(user.getVip());

3.8.尽量指定方法的final修饰符

方法指定final修饰符,可以让方法不可以被重写,Java编译器会寻找机会内联所有的final方法。内联对于提升Java运行效率作用重大,具体可参见Java运行期优化,能够使性能平均提高50%。

注意:所有的private方法会隐式地被指定final修饰符,所以无须再为其指定final修饰符。

代码语言:javascript复制
反例:
public class Rectangle {
     ...
     public double area() {
         ...
     }
 }
 正例:
public class Rectangle {
     ...
     public final double area() {
         ...
     }
 }
注意:使用Spring的AOP特性时,需要对Bean进行动态代理,如果方法添加了final修饰,将不会被代理。

3.9、尽量缓存经常使用的对象

尽可能将经常使用的对象进行缓存,可以使用数组,或HashMap的容器来进行缓存,但这种方式可能导致系统占用过多的缓存,性能下降,推荐可以使用一些第三方的开源工具,如EhCache,Oscache进行缓存,他们基本都实现了FIFO/FLU等缓存算法。

3.10、不要重复初始化变量

默认情况下,调用类的构造函数时,java会把变量初始化成确定的值,所有的对象被设置成null,整数变量设置成0,float和double变量设置成0.0,逻辑值设置成false。当一个类从另一个类派生时,这一点尤其应该注意,因为用new关键字创建一个对象时,构造函数链中的所有构造函数都会被自动调用。

这里有个注意,给成员变量设置初始值但需要调用其他方法的时候,最好放在一个方法。比如initXXX()中,因为直接调用某方法赋值可能会因为类尚未初始化而抛空指针异常,如:public int state = this.getState()。

4、表达式


4.1.尽量减少方法的重复调用

代码语言:javascript复制
反例:
List<UserDO> userList = ...;
 for (int i = 0; i < userList.size(); i  ) {
     ...
 }
 正例:
List<UserDO> userList = ...;
 int userLength = userList.size();
 for (int i = 0; i < userLength; i  ) {
     ...
 }

4.2.尽量避免不必要的方法调用

代码语言:javascript复制
反例:
List<UserDO> userList = userDAO.queryActive();
 if (isAll) {
     userList = userDAO.queryAll();
 }
 正例:
List<UserDO> userList;
 if (isAll) {
     userList = userDAO.queryAll();
 } else {
     userList = userDAO.queryActive();
 }

4.3.尽量使用移位来代替正整数乘除

用移位操作可以极大地提高性能。对于乘除2^n(n为正整数)的正整数计算,可以用移位操作来代替。

代码语言:javascript复制
反例:
int num1 = a * 4;
 int num2 = a / 4;
 正例:
int num1 = a << 2;
 int num2 = a >> 2;

4.4.提取公共表达式,避免重复计算

提取公共表达式,只计算一次值,然后重复利用值。

代码语言:javascript复制
反例:
double distance = Math.sqrt((x2 - x1) * (x2 - x1)   (y2 - y1) * (y2 - y1));
 正例:
double dx = x2 - x1;
 double dy = y2 - y1;
 double distance = Math.sqrt(dx * dx   dy * dy);
 或
 double distance = Math.sqrt(Math.pow(x2 - x1, 2)   Math.pow(y2 - y1, 2));

4.5.尽量不在条件表达式中用!取反 使用!取反会多一次计算,如果没有必要则优化掉。

代码语言:javascript复制
反例:
if (!(a >= 10)) {
     ... // 条件处理1
 } else {
     ... // 条件处理2
 }
 正例:
if (a < 10) {
     ... // 条件处理1
 } else {
     ... // 条件处理2
 }

4.6.对于多常量选择分支,尽量使用switch语句而不是if-else语句

if-else语句,每个if条件语句都要加装计算,直到if条件语句为true为止。switch语句进行了跳转优化,Java中采用tableswitch或lookupswitch指令实现,对于多常量选择分支处理效率更高。经过试验证明:在每个分支出现概率相同的情况下,低于5个分支时if-else语句效率更高,高于5个分支时switch语句效率更高。

代码语言:javascript复制
反例:
if (i == 1) {
     ...; // 分支1
 } else if (i == 2) {
     ...; // 分支2
 } else if (i == ...) {
     ...; // 分支n
 } else {
     ...; // 分支n 1
 }
 正例:
switch (i) {
     case 1 :
         ... // 分支1
         break;
     case 2 :
         ... // 分支2
         break;
     case ... :
         ... // 分支n
         break;
     default :
         ... // 分支n 1
         break;
 }
 备注:如果业务复杂,可以采用Map实现策略模式。

五、字符串


5.1.尽量不要使用正则表达式匹配(尽量避免split)

正则表达式匹配效率较低,尽量使用字符串匹配操作。

除非是必须的,否则应该避免使用split,split由于支持正则表达式,所以效率比较低,如果是频繁的几十,几百万的调用将会耗费大量资源,如果确实需要频繁的调用split,可以考虑使用apache的StringUtils.split(string,char),频繁split的可以缓存结果。

代码语言:javascript复制
反例:
String source = "a::1,b::2,c::3,d::4";
 String target = source.replaceAll("::", "=");
 Stringp[] targets = source.spit("::");
 正例:
String source = "a::1,b::2,c::3,d::4";
 String target = source.replace("::", "=");
 Stringp[] targets = StringUtils.split(source, "::");

5.2.尽量使用字符''替换字符串

字符串的长度不确定,而字符的长度固定为1,查找和匹配的效率自然提高了。

反例:

代码语言:javascript复制
String source = "a:1,b:2,c:3,d:4";
 int index = source.indexOf(":");
 String target = source.replace(":", "=");
 正例:
String source = "a:1,b:2,c:3,d:4";
 int index = source.indexOf(':');
 String target = source.replace(':', '=');

如果该字符串只有一个字符的话,同样在字符串相加的时候,使用 字符’ ’ 代替 字符串” “:

反例:

代码语言:javascript复制
String string = s   "d" // violation.
string = "abc"   "d" // violation.

 正例:将一个字符的字符串替换成’ ‘

代码语言:javascript复制
        String string = s   'd'
        string = "abc"   'd'

5.3.尽量使用StringBuilder进行字符串拼接

String是final类,内容不可修改,所以每次字符串拼接都会生成一个新对象。StringBuilder在初始化时申请了一块内存,以后的字符串拼接都在这块内存中执行,不会申请新内存和生成新对象。

代码语言:javascript复制
反例:
String s = "";
 for (int i = 0; i < 10; i  ) {
     if (i != 0) {
         s  = ',';
     }
     s  = i;
 }
 正例:
StringBuilder sb = new StringBuilder(128);
 for (int i = 0; i < 10; i  ) {
     if (i != 0) {
         sb.append(',');
     }
     sb.append(i);
 }

5.4.不要使用"" 转化字符串 使用"" 进行字符串转化,使用方便但是效率低,建议使用String.valueOf.

代码语言:javascript复制
反例:
int i = 12345;
 String s = ""   i;
 正例:
int i = 12345;
 String s = String.valueOf(i);

5.5、StringBuffer,StringBuilder的区别在于:

java.lang.StringBuffer 线程安全的可变字符序列。一个类似于String的字符串缓冲区,但不能修改。StringBuilder与该类相比,通常应该优先使用StringBuilder类,因为它支持所有相同的操作,但由于它不执行同步,所以速度更快。为了获得更好的性能,在构造StringBuffer或StringBuilder时应尽量指定她的容量。当然如果不超过16个字符时就不用了。 相同情况下,使用StringBuilder比使用StringBuffer仅能获得10%~15%的性能提升,但却要冒多线程不安全的风险。综合考虑还是建议使用StringBuffer。

六、数组


6.1.不要使用循环拷贝数组,尽量使用System.arraycopy拷贝数组

推荐使用System.arraycopy拷贝数组,也可以使用Arrays.copyOf拷贝数组。

代码语言:javascript复制
反例:
int[] sources = new int[] {1, 2, 3, 4, 5};
 int[] targets = new int[sources.length];
 for (int i = 0; i < targets.length; i  ) {
     targets[i] = sources[i];
 }
 正例:
int[] sources = new int[] {1, 2, 3, 4, 5};
 int[] targets = new int[sources.length];
 System.arraycopy(sources, 0, targets, 0, targets.length);

6.2.集合转化为类型T数组时,尽量传入空数组T[0]

将集合转换为数组有2种形式:toArray(new T[n])和toArray(new T[0])。在旧的Java版本中,建议使用toArray(new T[n]),因为创建数组时所需的反射调用非常慢。在OpenJDK6后,反射调用是内在的,使得性能得以提高,toArray(new T[0])比toArray(new T[n])效率更高。此外,toArray(new T[n])比toArray(new T[0])多获取一次列表大小,如果计算列表大小耗时过长,也会导致toArray(new T[n])效率降低。

代码语言:javascript复制
反例:
List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5, ...);
 Integer[] integers = integerList.toArray(new Integer[integerList.size()]);
 正例:
List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5, ...);
 Integer[] integers = integerList.toArray(new Integer[0]); // 勿用new Integer[]{}
 建议:集合应该提供一个toArray(Class<T> clazz)方法,避免无用的空数组初始化(new T[0])。

6.3.集合转化为Object数组时,尽量使用toArray()方法

转化Object数组时,没有必要使用toArray[new Object[0]],可以直接使用toArray()。避免了类型的判断,也避免了空数组的申请,所以效率会更高。

代码语言:javascript复制
反例:
List<Object> objectList = Arrays.asList(1, "2", 3, "4", 5, ...);
 Object[] objects = objectList.toArray(new Object[0]);
 正例:
List<Object> objectList = Arrays.asList(1, "2", 3, "4", 5, ...);
 Object[] objects = objectList.toArray();

6.4、尽量避免使用二维数组

二维数据占用的内存空间比一维数组多得多,大概10倍以上。

6.5、array(数组)和ArrayList的使用

array 数组效率最高,但容量固定,无法动态改变,ArrayList容量可以动态增长,但牺牲了效率。

7、集合


7.1.初始化集合时,尽量指定集合大小

Java集合初始化时都会指定一个默认大小,当默认大小不再满足数据需求时就会扩容,每次扩容的时间复杂度有可能是O(n),是一件很耗费性能的事。所以,尽量指定预知的集合大小,就能避免或减少集合的扩容次数。

在默认中initialCapacity只有16,而loadFactor是 0.75,需要多大的容量,你最好能准确的估计你所需要的最佳大小,同样的Hashtable,Vectors也是一样的道理。

反例:

代码语言:javascript复制
List<UserDO> userDOList = ...;
Set<Long> userSet = new HashSet<>();
Map<Long, UserDO> userMap = new HashMap<>();
List<UserVO> userList = new ArrayList<>();
for (UserDO userDO : userDOList) {
    userSet.add(userDO.getId());
    userMap.put(userDO.getId(), userDO);
    userList.add(transUser(userDO));
}

正例:

代码语言:javascript复制
List<UserDO> userDOList = ...;
int userSize = userDOList.size();
Set<Long> userSet = new HashSet<>(userSize);
Map<Long, UserDO> userMap = new HashMap<>((int) Math.ceil(userSize * 4.0 / 3));
List<UserVO> userList = new ArrayList<>(userSize);
for (UserDO userDO : userDOList) {
    userSet.add(userDO.getId());
    userMap.put(userDO.getId(), userDO);
    userList.add(transUser(userDO));
}

7.2.不要使用循环拷贝集合,尽量使用JDK提供的方法拷贝集合

JDK提供的方法可以一步指定集合的容量,避免多次扩容浪费时间和空间。同时,这些方法的底层也是调用System.arraycopy方法实现,进行数据的批量拷贝效率更高。

代码语言:javascript复制
反例:
List<UserDO> user1List = ...;
 List<UserDO> user2List = ...;
 List<UserDO> userList = new ArrayList<>(user1List.size()   user2List.size());
 for (UserDO user1 : user1List) {
     userList.add(user1);
 }
 for (UserDO user2 : user2List) {
     userList.add(user2);
 }
 正例:
List<UserDO> user1List = ...;
 List<UserDO> user2List = ...;
 List<UserDO> userList = new ArrayList<>(user1List.size()   user2List.size());
 userList.addAll(user1List);
 userList.addAll(user2List);

7.3.尽量使用Arrays.asList转化数组为列表

原理与"不要使用循环拷贝集合,尽量使用JDK提供的方法拷贝集合"类似。

代码语言:javascript复制
反例:
List<String> typeList = new ArrayList<>(8);
 typeList.add("Short");
 typeList.add("Integer");
 typeList.add("Long");
 
 
 String[] names = ...;
 List<String> nameList = ...;
 for (String name : names) {
     nameList.add(name);
 }
 正例:
List<String> typeList = Arrays.asList("Short", "Integer", "Long");
 
 
 String[] names = ...;
 List<String> nameList = ...;
 nameList.addAll(Arrays.asList(names));

7.4.直接迭代需要使用的集合

直接迭代需要使用的集合,无需通过其它操作获取数据。

代码语言:javascript复制
反例:
Map<Long, UserDO> userMap = ...;
 for (Long userId : userMap.keySet()) {
     UserDO user = userMap.get(userId);
     ...
 }
 正例:
Map<Long, UserDO> userMap = ...;
 for (Map.Entry<Long, UserDO> userEntry : userMap.entrySet()) {
     Long userId = userEntry.getKey();
     UserDO user = userEntry.getValue();
     ...
 }

7.5.不要使用size方法检测空,必须使用isEmpty方法检测空

使用size方法来检测空逻辑上没有问题,但使用isEmpty方法使得代码更易读,并且可以获得更好的性能。任何isEmpty方法实现的时间复杂度都是O(1),但是某些size方法实现的时间复杂度有可能是O(n)。

代码语言:javascript复制
反例:
List<UserDO> userList = ...;
 if (userList.size() == 0) {
     ...
 }
 Map<Long, UserDO> userMap = ...;
 if (userMap.size() == 0) {
     ...
 }
 正例:
List<UserDO> userList = ...;
 if (userList.isEmpty()) {
     ...
 }
 Map<Long, UserDO> userMap = ...;
 if (userMap.isEmpty()) {
     ...
 }

7.6.非随机访问的List,尽量使用迭代代替随机访问

对于列表,可分为随机访问和非随机访问两类,可以用是否实现RandomAccess接口判断。随机访问列表,直接通过get获取数据不影响效率。而非随机访问列表,通过get获取数据效率极低。

代码语言:javascript复制
反例:
LinkedList<UserDO> userDOList = ...;
 int size = userDOList.size();
 for (int i = 0; i < size; i  ) {
     UserDO userDO = userDOList.get(i);
     ...
 }
 正例:
LinkedList<UserDO> userDOList = ...;
 for (UserDO userDO : userDOList) {
     ...
 }
 其实,不管列表支不支持随机访问,都应该使用迭代进行遍历。

7.7.尽量使用HashSet判断值存在

在Java集合类库中,List的contains方法普遍时间复杂度是O(n),而HashSet的时间复杂度为O(1)。如果需要频繁调用contains方法查找数据,可以先将List转换成HashSet。

代码语言:javascript复制
反例:
List<Long> adminIdList = ...;
 List<UserDO> userDOList = ...;
 List<UserVO> userVOList = new ArrayList<>(userDOList.size());
 for (UserDO userDO : userDOList) {
     if (adminIdList.contains(userDO.getId())) {
         userVOList.add(transUser(userDO));
     }
 }
 正例:
Set<Long> adminIdSet = ...;
 List<UserDO> userDOList = ...;
 List<UserVO> userVOList = new ArrayList<>(userDOList.size());
 for (UserDO userDO : userDOList) {
     if (adminIdSet.contains(userDO.getId())) {
         userVOList.add(transUser(userDO));
     }
 }

7.8.避免先判断存在再进行获取

如果需要先判断存在再进行获取,可以直接获取并判断空,从而避免了二次查找操作。

代码语言:javascript复制
反例:
public static UserVO transUser(UserDO user, Map<Long, RoleDO> roleMap) {
     UserVO userVO = new UserVO();
     userVO.setId(user.getId());
     ...
     if (roleMap.contains(user.getRoleId())) {
         RoleDO role = roleMap.get(user.getRoleId());
         userVO.setRole(transRole(role));
     }
 }
 正例:
public static UserVO transUser(UserDO user, Map<Long, RoleDO> roleMap) {
     UserVO userVO = new UserVO();
     userVO.setId(user.getId());
     ...
     RoleDO role = roleMap.get(user.getRoleId());
     if (Objects.nonNull(role)) {
         userVO.setRole(transRole(role));
     }
 }

7.10、ArrayList & LinkedList

一个是线性表,一个是链表,一句话,随机查询尽量使用ArrayList,ArrayList优于LinkedList,LinkedList还要移动指针,添加删除的操作LinkedList优于ArrayList,ArrayList还要移动数据,不过这是理论性分析,事实未必如此,重要的是理解好2者得数据结构,对症下药。

7.11、Collections.emptyList方法的使用

java.util.Collections.emptyList()方法返回了一个空的List,但是这个List和我们平时常用的那个List是不一样的。这个方法返回的List是Collections类的一个静态内部类,它继承AbstractList后并没有实现add()、remove()等方法,因此这个返回值List并不能增加删除元素。 该方法主要目的就是返回一个不可变的列表,使用这个方法作为返回值就不需要再通过new ArrayList()创建时有初始大小,占用内存创建一个新对象,可以减少内存开销。并且返回一个size为0的List,调用者不需要校验返回值是否为null,所以建议使用这个方法返回可能为空的List。 emptySet()、emptyMap()方法同理。

八、异常


当创建一个异常时,需要收集一个栈跟踪(stack track),这个栈跟踪用于描述异常是在何处创建的。构建这些栈跟踪时需要为运行时栈做一份快照,正是这一部分开销很大。当需要创建一个 Exception 时,JVM 不得不说:先别动,我想就您现在的样子存一份快照,所以暂时停止入栈和出栈操作。栈跟踪不只包含运行时栈中的一两个元素,而是包含这个栈中的每一个元素。

如果您创建一个 Exception ,就得付出代价,好在捕获异常开销不大,因此可以使用 try-catch 将核心内容包起来。从技术上讲,你甚至可以随意地抛出异常,而不用花费很大的代价。招致性能损失的并不是 throw 操作——尽管在没有预先创建异常的情况下就抛出异常是有点不寻常。真正要花代价的是创建异常,幸运的是,好的编程习惯已教会我们,不应该不管三七二十一就抛出异常。异常是为异常的情况而设计的,使用时也应该牢记这一原则。

8.1.直接捕获对应的异常

直接捕获对应的异常,避免用instanceof判断,效率更高代码更简洁。

代码语言:javascript复制
反例:
try {
     saveData();
 } catch (Exception e) {
     if (e instanceof IOException) {
         log.error("保存数据IO异常", e);
     } else {
         log.error("保存数据其它异常", e);
     }
 }
 正例:
try {
     saveData();
 } catch (IOException e) {
     log.error("保存数据IO异常", e);
 } catch (Exception e) {
     log.error("保存数据其它异常", e);
 }

8.2.尽量避免在循环中捕获异常

当循环体抛出异常后,无需循环继续执行时,没有必要在循环体中捕获异常。因为,过多的捕获异常会降低程序执行效率。

代码语言:javascript复制
反例:
public Double sum(List<String> valueList) {
     double sum = 0.0D;
     for (String value : valueList) {
         try {
             sum  = Double.parseDouble(value);
         } catch (NumberFormatException e) {
             return null;
         }
     }
     return sum;
 }
 正例:
public Double sum(List<String> valueList) {
     double sum = 0.0D;
     try {
         for (String value : valueList) {
             sum  = Double.parseDouble(value);
         }
     } catch (NumberFormatException e) {
         return null;
     }
     return sum;
 }

8.3.禁止使用异常控制业务流程

相对于条件表达式,异常的处理效率更低。

代码语言:javascript复制
反例:
public static boolean isValid(UserDO user) {
     try {
         return Boolean.TRUE.equals(user.getIsValid());
     } catch(NullPointerException e) {
         return false;
     }
 }
 正例:
public static boolean isValid(UserDO user) {
     if (Objects.isNull(user)) {
         return false;
     }
   return Boolean.TRUE.equals(user.getIsValid());
 }

九、缓冲区


9.1.初始化时尽量指定缓冲区(如StringBuffer)大小

初始化时,指定缓冲区的预期容量大小,避免多次扩容浪费时间和空间。

StringBuffer 的构造器会创建一个默认大小(通常是16)的字符数组。在使用中,如果超出这个大小,就会重新分配内存,创建一个更大的数组,它会将自身容量增加到当前的2倍 2,也就是2*n 2,并将原先的数组复制过来,再丢弃旧的数组。在大多数情况下,你可以在创建 StringBuffer的时候指定大小,这样就避免了在容量不够的时候自动增长,以提高性能。

代码语言:javascript复制
反例:
StringBuffer buffer = new StringBuffer();
 StringBuilder builder = new StringBuilder();
 正例:
StringBuffer buffer = new StringBuffer(1024);
 StringBuilder builder = new StringBuilder(1024);

9.2.尽量重复使用同一缓冲区

针对缓冲区,Java虚拟机需要花时间生成对象,还要花时间进行垃圾回收处理。所以,尽量重复利用缓冲区。

代码语言:javascript复制
反例:
StringBuilder builder1 = new StringBuilder(128);
 builder1.append("update t_user set name = '").append(userName).append("' where id = ").append(userId);
 statement.executeUpdate(builder1.toString());
 StringBuilder builder2 = new StringBuilder(128);
 builder2.append("select id, name from t_user where id = ").append(userId);
 ResultSet resultSet = statement.executeQuery(builder2.toString());
 ...
 正例:
StringBuilder builder = new StringBuilder(128);
 builder.append("update t_user set name = '").append(userName).append("' where id = ").append(userId);
 statement.executeUpdate(builder.toString());
 builder.setLength(0);
 builder.append("select id, name from t_user where id = ").append(userId);
 ResultSet resultSet = statement.executeQuery(builder.toString());
 ...
 其中,使用setLength方法让缓冲区重新从0开始。

9.3.尽量设计使用同一缓冲区

为了提高程序运行效率,在设计上尽量使用同一缓冲区。

代码语言:javascript复制
反例:
// 转化XML(UserDO)
 public static String toXml(UserDO user) {
     StringBuilder builder = new StringBuilder(128);
     builder.append("<UserDO>");
     builder.append(toXml(user.getId()));
     builder.append(toXml(user.getName()));
     builder.append(toXml(user.getRole()));
     builder.append("</UserDO>");
     return builder.toString();
 }
 // 转化XML(Long)
 public static String toXml(Long value) {
     StringBuilder builder = new StringBuilder(128);
     builder.append("<Long>");
     builder.append(value);
     builder.append("</Long>");
     return builder.toString();
 }
 ...
 
 
 // 使用代码
 UserDO user = ...;
 String xml = toXml(user);
 正例:
// 转化XML(UserDO)
 public static void toXml(StringBuilder builder, UserDO user) {
     builder.append("<UserDO>");
     toXml(builder, user.getId());
     toXml(builder, user.getName());
     toXml(builder, user.getRole());
     builder.append("</UserDO>");
 }
 // 转化XML(Long)
 public static void toXml(StringBuilder builder, Long value) {
     builder.append("<Long>");
     builder.append(value);
     builder.append("</Long>");
 }
 ...
 
 
 // 使用代码
 UserDO user = ...;
 StringBuilder builder = new StringBuilder(1024);
 toXml(builder, user);
 String xml = builder.toString();
 去掉每个转化方法中的缓冲区申请,申请一个缓冲区给每个转化方法使用。从时间上来说,节约了大量缓冲区的申请释放时间;从空间上来说,节约了大量缓冲区的临时存储空间。

9.4.尽量使用缓冲流减少IO操作

使用缓冲流BufferedReader、BufferedWriter、BufferedInputStream、BufferedOutputStream等,可以大幅较少IO次数并提升IO速度。

代码语言:javascript复制
反例:
try (FileInputStream input = new FileInputStream("a");
     FileOutputStream output = new FileOutputStream("b")) {
     int size = 0;
     byte[] temp = new byte[1024];
     while ((size = input.read(temp)) != -1) {
         output.write(temp, 0, size);
     }
 } catch (IOException e) {
     log.error("复制文件异常", e);
 }
 正例:
try (BufferedInputStream input = new BufferedInputStream(new FileInputStream("a"));
     BufferedOutputStream output = new BufferedOutputStream(new FileOutputStream("b"))) {
     int size = 0;
     byte[] temp = new byte[1024];
     while ((size = input.read(temp)) != -1) {
         output.write(temp, 0, size);
     }
 } catch (IOException e) {
     log.error("复制文件异常", e);
 }
 其中,可以根据实际情况手动指定缓冲流的大小,把缓冲流的缓冲作用发挥到最大。

9.5、记住在finally块中关闭Stream

程序中使用到的资源应当被释放,以避免资源泄漏。这最好在finally块中去做。不管程序执行的结果如何,finally块总是会执行的,以确保资源的正确关闭。

十、线程


10.1.在单线程中,尽量使用非线程安全类

使用非线程安全类,避免了不必要的同步开销。

代码语言:javascript复制
反例:
StringBuffer buffer = new StringBuffer(128);
 buffer.append("select * from ").append(T_USER).append(" where id = ?");
 正例:
StringBuilder buffer = new StringBuilder(128);
 buffer.append("select * from ").append(T_USER).append(" where id = ?");

10.2.在多线程中,尽量使用线程安全类

使用线程安全类,比自己实现的同步代码更简洁更高效。

代码语言:javascript复制
反例:
private volatile int counter = 0;
 public void access(Long userId) {
     synchronized (this) {
         counter  ;
     }
     ...
 }
 正例:
private final AtomicInteger counter = new AtomicInteger(0);
 public void access(Long userId) {
     counter.incrementAndGet();
     ...
 }

10.3.慎用synchronized,尽量减少同步代码块范围

      实现同步是要很大的系统开销作为代价的,甚至可能造成死锁,所以尽量避免无谓的同步控制。synchronize方法被调用时,直接会把当前对象锁了,在方法执行完之前其他线程无法调用当前对象的其他方法。       如果在一个方法中,可能只有一小部分的逻辑是需要同步控制的,如果同步控制了整个方法会影响执行效率。所以,尽量减少同步代码块的范围,只对需要进行同步的代码进行同步。

代码语言:javascript复制
反例:
private volatile int counter = 0;
 public synchronized void access(Long userId) {
   counter  ;
     ... // 非同步操作
 }
 正例:
private volatile int counter = 0;
 public void access(Long userId) {
     synchronized (this) {
         counter  ;
     }
     ... // 非同步操作
 }

10.4.尽量合并为同一同步代码块

同步代码块是有性能开销的,如果确定可以合并为同一同步代码块,就应该尽量合并为同一同步代码块。

代码语言:javascript复制
反例:
// 处理单一订单
 public synchronized handleOrder(OrderDO order) {
     ...
 }
 
 
 // 处理所有订单
 public void handleOrder(List<OrderDO> orderList) {
     for (OrderDO order : orderList) {
         handleOrder(order);
     }
 }
 正例:
// 处理单一订单
 public handleOrder(OrderDO order) {
     ...
 }
 
 
 // 处理所有订单
 public synchronized void handleOrder(List<OrderDO> orderList) {
     for (OrderDO order : orderList) {
         handleOrder(order);
     }
 }

10.5.尽量使用线程池减少线程开销

多线程中两个必要的开销:线程的创建和上下文切换。采用线程池,可以尽量地避免这些开销。

代码语言:javascript复制
反例:
public void executeTask(Runnable runnable) {
     new Thread(runnable).start();
 }
 正例:
private static final ExecutorService EXECUTOR_SERVICE = Executors.newFixedThreadPool(10);
 public void executeTask(Runnable runnable) {
     executorService.execute(runnable);
 }

十一、正则


1、正则Pattern表达式建议定义为static final静态常量,以避免执行多次预编译

后记


作为一名长期奋战在业务一线的"IT民工",没有机会去研究什么高深莫测的"理论",只能专注于眼前看得见摸得着的"技术",致力于做到"干一行、爱一行、专一行、精一行"。

0 人点赞