前言

最近看了《重构-改善既有代码的设计》这本书,总结了优化代码的几个小技巧,给大家分享一下。

提炼函数(适当抽取小函数)

定义

提炼函数就是将一段代码放进一个独立函数中,并让函数名称解释该函数用途。

一个过于冗长的函数或者一段需要注释才能让人理解用途的代码,可以考虑把它切分成一个功能明确的函数单元,并定义清晰简短的函数名,这样会让代码变得更加优雅。

优化例子

提炼函数之前:

  1. private String name;
  2. private Vector<Order> orders = new Vector<Order>();

  3. public void printOwing() {
  4. //print banner
  5. System.out.println("****************");
  6. System.out.println("*****customer Owes *****");
  7. System.out.println("****************");

  8. //calculate totalAmount
  9. Enumeration env = orders.elements();
  10. double totalAmount = 0.0;
  11. while (env.hasMoreElements()) {
  12. Order order = (Order) env.nextElement();
  13. totalAmount += order.getAmout();
  14. }

  15. //print details
  16. System.out.println("name:" + name);
  17. System.out.println("amount:" + totalAmount);
  18. }

提炼函数之后:

以上那段代码,可以抽成print banner,calculate totalAmount,print details三个功能的单一函数,如下:

  1. private String name;
  2. private Vector<Order> orders = new Vector<Order>();

  3. public void printOwing() {

  4. //print banner
  5. printBanner();
  6. //calculate totalAmount
  7. double totalAmount = getTotalAmount();
  8. //print details
  9. printDetail(totalAmount);
  10. }

  11. void printBanner(){
  12. System.out.println("****************");
  13. System.out.println("*****customer Owes *****");
  14. System.out.println("****************");
  15. }

  16. double getTotalAmount(){
  17. Enumeration env = orders.elements();
  18. double totalAmount = 0.0;
  19. while (env.hasMoreElements()) {
  20. Order order = (Order) env.nextElement();
  21. totalAmount += order.getAmout();
  22. }
  23. return totalAmount;
  24. }

  25. void printDetail(double totalAmount){
  26. System.out.println("name:" + name);
  27. System.out.println("amount:" + totalAmount);
  28. }

内联函数(适当去除多余函数)

定义

内联函数就是在函数调用点插入函数本体,然后移除该函数。

上一小节介绍了提炼函数代码优化方式,以简短清晰的小函数为荣。但是呢,小函数是不是越多越好呢?肯定不是啦,有时候你会遇到某些函数,其内部代码和函数名称同样清晰,这时候呢你可以考虑内联函数优化一下了。

优化例子

内联函数之前

  1. int getRating(){
  2. return moreThanFiveDeliveries() ? 2 : 1;
  3. }
  4. boolean moreThanFiveDeliveries(){
  5. return numberOfLateDeliveries >5;
  6. }

内联函数之后

  1. int getRating(){
  2. return numberOfLateDeliveries >5 ? 2 : 1;
  3. }

内联临时变量(去除多余临时变量)

定义

内联临时变量将所有对该变量的引用动作,替换为对它赋值的那个表达式自身。

优化例子

内联临时变量之前

  1. double basePice = anOrder.basePrice();
  2. return basePice >888;

内联临时变量之后

  1. return anOrder.basePrice() >888;

引入解释性变量

定义

引入解释性变量 就是将该复杂表达式(或其中一部分)的结果放进一个临时变量,以此变量名称来解释表达式用途。

有些表达式可能非常复杂难于阅读,在这种情况下,临时变量可以帮助你将表达式分解为可读的形式。

在比较复杂的条件逻辑中,你可以用引入解释性变量将每个条件子句提炼出来,以一个良好命名的临时变量来解释对应条件子句的意义。

优化例子

引入解释性变量之前

  1. if ((platform.toUpperCase().indexOf("mac") > -1) &&
  2. (brower.toUpperCase().indexOf("ie") > -1) &&
  3. wasInitializes() && resize > 0) {
  4. ......
  5. }

引入解释性变量之后

  1. final boolean isMacOS = platform.toUpperCase().indexOf("mac") > -1;
  2. final boolean isIEBrowser = brower.toUpperCase().indexOf("ie") > -1;
  3. final boolean wasResized = resize > 0;

  4. if (isMacOS && isIEBrowser && wasInitializes() && wasResized) {
  5. ......
  6. }

以字面常量取代魔法数

定义

创造一个常量,根据其意义为它命名,并将上述的字面数值替换为这个常量。

所谓魔法数是指拥有特殊意义,却又不能明确表现出这种意义的数字。如果你需要在不同的地点引用同一个逻辑数,每当该数字要修改时,会特别头疼,因为很可能会改漏。而字面常量取代魔法数可以解决这个头疼问题。

优化例子

以字面常量取代魔法数之前

  1. double getDiscountPrice(double price){
  2. return price * 0.88;
  3. }

以字面常量取代魔法数之后

  1. static final double DISCOUNT_CONSTANT=0.88;

  2. double getDiscountPrice(double price){
  3. return price * DISCOUNT_CONSTANT;
  4. }

用多态替代switch语句

定义

用多态替换switch语句 就是利用Java面向对象的多态特点,使用state模式来替换switch语句。

优化例子

用多态替换switch语句之前

  1. int getArea() {
  2. switch (shape){
  3. case SHAPE.CIRCLE:
  4. return 3.14 * _r * _r; break;
  5. case SHAPE.RECTANGEL;
  6. return width *,heigth;
  7. }
  8. }

用多态替换switch语句之后

  1. class Shape {
  2. int getArea(){};
  3. }

  4. class Circle extends Shape {
  5. int getArea() {
  6. return 3.14 * r * r;
  7. }
  8. }

  9. class Rectangel extends Shape {
  10. int getArea() {
  11. return width * heigth;
  12. }
  13. }

将过多的参数对象化

定义

将过多的参数对象化就是把涉及过多参数封装成一个对象传参。

一个方法有太多传参时,即难以阅读又难于维护。尤其针对dubbo远程调用这些方法,如果有过多参数,增加或者减少一个参数,都要修改接口,真的坑。如果把这些参数封装成一个对象,就很好维护了,不用修改接口。

优化例子

将过多的参数对象化之前:

  1. public int register(String username,String password,Integer age,String phone);

将过多的参数对象化之后:

  1. public int register(RegisterForm from );

  2. class RegisterForm{
  3. private String username
  4. private String password
  5. private Integer age
  6. private String phone
  7. }

参考与感谢

  • 《重构-改善既有代码的设计》

个人公众号

优化代码的几个小技巧_内联函数