refactoring--除去代码异味(bad smell)(2)

来源：互联网发布：醍醐灌顶的一句话知乎编辑：程序博客网时间：2024/04/25 01:42

     让我们来看一下另外一个例子，在当前的系统中，有三种用户：常规用户，管理员和游客。
    常规用户必须每隔90 天修改一次密码（更频繁也行），管理员必须每30 天修改一次密码，游客就不需要修改了，常规用户跟管理员可以打印报表。
    先看一下当前的代码：

class UserAccount {
    final static int USERTYPE_NORMAL = 0;
    final static int USERTYPE_ADMIN = 1;
    final static int USERTYPE_GUEST = 2;
    int userType;
    String id;
    String name;
    String password;
    Date dateOfLastPasswdChange;
    public boolean checkPassword(String password) {
        ...
    }
}

class InventoryApp {
    void login(UserAccount userLoggingIn, String password) {
        if (userLoggingIn.checkPassword(password)) {
            GregorianCalendar today = new GregorianCalendar();
            GregorianCalendar expiryDate = getAccountExpiryDate(userLoggingIn);
            if (today.after(expiryDate)) {
//提示用户修改密码
                ...
            }
        }
    }

    GregorianCalendar getAccountExpiryDate(UserAccount account) {
        int passwordMaxAgeInDays = getPasswordMaxAgeInDays(account);
        GregorianCalendar expiryDate = new GregorianCalendar();
        expiryDate.setTime(account.dateOfLastPasswdChange);
        expiryDate.add(Calendar.DAY_OF_MONTH, passwordMaxAgeInDays);
        return expiryDate;

}

    int getPasswordMaxAgeInDays(UserAccount account) {
        switch (account.getType()) {
        case UserAccount.USERTYPE_NORMAL:
            return 90;
        case UserAccount.USERTYPE_ADMIN:
            return 30;
        case UserAccount.USERTYPE_GUEST:
            return Integer.MAX_VALUE;
        }
    }

    void printReport(UserAccount currentUser) {
        boolean canPrint;
        switch (currentUser.getType()) {
        case UserAccount.USERTYPE_NORMAL:
            canPrint = true;
            break;
        case UserAccount.USERTYPE_ADMIN:
            canPrint = true;
            break;
        case UserAccount.USERTYPE_GUEST:
            canPrint = false;
        }
        if (!canPrint) {
            throw new SecurityException("You have no right");
        }
//打印报表
    }
}

    用一个对象代替一种类别（注意，之前是一个类代替一种类别）
    根据之前讲的解决方法，要去掉类别代码，我们只需要为每种类别创建一个子类，比如：
   abstract class UserAccount {
    String id;
    String name;
    String password;
    Date dateOfLastPasswdChange;
    abstract int getPasswordMaxAgeInDays();

abstract boolean canPrintReport();
}

class NormalUserAccount extends UserAccount {
    int getPasswordMaxAgeInDays() {
        return 90;
    }

boolean canPrintReport() {
return true;
}
}

class AdminUserAccount extends UserAccount {
    int getPasswordMaxAgeInDays() {
        return 30;
    }

    boolean canPrintReport() {
        return true;
    }
}

class GuestUserAccount extends UserAccount {
    int getPasswordMaxAgeInDays() {
        return Integer.MAX_VALUE;
    }

boolean canPrintReport() {
return false;
}
}

但问题是，三种子类的行为（里面的代码）都差不多一样，getPasswordMaxAgeInDays 这个方法就一个数值不同（30,90或者Integer.MAX_VALUE)。canPrintReport 这个方法也不同在一个数值（true 或false ）。这三种用户类型只需要用三个对象代替就行了，无须特地新建三个子类了：
class UserAccount {
    UserType userType;
    String id;
    String name;
    String password;
    Date dateOfLastPasswdChange;
    UserType getType() {
        return userType;
    }
}

class UserType {
    int passwordMaxAgeInDays;
    boolean allowedToPrintReport;
    UserType(int passwordMaxAgeInDays, boolean allowedToPrintReport) {
        this.passwordMaxAgeInDays = passwordMaxAgeInDays;
        this.allowedToPrintReport = allowedToPrintReport;
    }

    int getPasswordMaxAgeInDays() {
        return passwordMaxAgeInDays;
    }

    boolean canPrintReport() {
        return allowedToPrintReport;
    }

    static UserType normalUserType = new UserType(90, true);
    static UserType adminUserType = new UserType(30, true);
    static UserType guestUserType = new UserType(Integer.MAX_VALUE, false);
}

    int getPasswordMaxAgeInDays(UserAccount account) {
        return account.getType().getPasswordMaxAgeInDays();
    }

    void printReport(UserAccount currentUser) {
        boolean canPrint;
        canPrint = currentUser.getType().canPrintReport();
        if (!canPrint) {
            throw new SecurityException("You have no right");
        }
//打印报表.
    }
}

注意到了吧，用一个对象代替类别，同样可以移除switch或者if-then-else-if。

总结一下类别代码的移除

    要移动一些类别代码和switch表达式，有两种方法：
    1.用基于同一父类的不同子类来代替不同的类别。
    2.用一个类的不同对象来代替不同的类别。
    当不同的类别具有比较多不同的行为时，用第一种方法。当这些类别的行为非常相似，或者只是差别在一些值上面的时候，用第二个方法。

     普遍的代码异味
    类别代码和switch表达式是比较普遍的代码异味。此外，还有其他的代码异味也很普遍。
    下面是大概的异味列表：
    代码重复
    太多的注释
    类别代码（type code）

   switch或者一大串if-then-else-if
    想给一个变量，方法或者类名取个好名字时，也怎么也取不好
    用类似XXXUtil, XXXManager, XXXController 和其他的一些命名
    在变量，方法或类名中使用这些单词“And”，“Or”等等
    一些实例中的变量有时有用，有时没用
    一个方法的代码太多，或者说方法太长
    一个类的代码太多，或者说类太长
    一个方法有太多参数
    两个类都引用了彼此（依赖于彼此）