架构师教你kill祖传石山代码重复/大量ifelse(中)

2.3 重构秘技 - 模板方法模式

可以把重复逻辑定义在抽象类,三个购物车只要分别实现不同部分的逻辑。

这其实就是模板方法模式

在父类中实现购物车处理的流程模板,然后把需要特殊处理的留抽象方法定义,让子类去实现。由于父类逻辑无法单独工作,因此需要定义为抽象类。


如下代码所示,AbstractCart抽象类实现了购物车通用的逻辑,额外定义了两个抽象方法让子类去实现。其中,processCouponPrice方法用于计算商品折扣,processDeliveryPrice方法用于计算运费。

架构师教你kill祖传石山代码重复/大量ifelse(中)有抽象类,三个子类的实现就简单了。

  • 普通用户的购物车NormalUserCart,实现0优惠和10%运费
  • 架构师教你kill祖传石山代码重复/大量ifelse(中)
  • VIP用户的购物车VipUserCart,直接继承NormalUserCart,只需修改多买优惠策略
  • 架构师教你kill祖传石山代码重复/大量ifelse(中)
  • 内部用户购物车InternalUserCart最简单,直接设置0运费、0折扣
  • 架构师教你kill祖传石山代码重复/大量ifelse(中)

抽象类和三个子类的实现关系图

架构师教你kill祖传石山代码重复/大量ifelse(中)

2.4 重构秘技之工厂模式 - 消除多if

既然三个购物车都叫XXXUserCart,可将用户类型字符串拼接UserCart构成购物车Bean的名称,然后利用IoC容器,通过Bean的名称直接获取到AbstractCart,调用其process方法即可实现通用。


这就是工厂模式,借助Spring容器实现:

架构师教你kill祖传石山代码重复/大量ifelse(中)

若有新用户类型、用户逻辑,只要新增一个XXXUserCart类继承AbstractCart,实现特殊的优惠和运费处理逻辑即可。

工厂+模板方法模式,消除了重复代码,还避免修改既有代码。这就是设计模式中的开闭原则:对修改关闭,对扩展开放。

3 注解+反射消除重复代码

3.1 需求

银行提供了一些API接口,对参数的序列化不使用JSON,而需要我们把参数依次拼在一起构成一个大字符串。

  • 按照银行提供的API文档的顺序,把所有参数构成定长的数据,然后拼接在一起作为整个字符串

因为每种参数都有固定长度,未达到长度时需填充:

字符串类型的参数不满长度部分需要以下划线右填充,也就是字符串内容靠左

数字类型的参数不满长度部分以0左填充,也就是实际数字靠右

货币类型的表示需要把金额向下舍入2位到分,以分为单位,作为数字类型同样进行左填充。

对所有参数做MD5操作作为签名(为了方便理解,Demo中不涉及加盐处理)。

比如,创建用户方法和支付方法的定义是这样的:

架构师教你kill祖传石山代码重复/大量ifelse(中)

架构师教你kill祖传石山代码重复/大量ifelse(中)

3.2 菜鸟实现

直接根据接口定义实现填充、加签名、请求调用:

public class BankService {

    // 创建用户
    public static String createUser(String name, String identity, String mobile, int age) throws IOException {
        StringBuilder stringBuilder = new StringBuilder();
        // 字符串靠左,多余的地方填充_
        stringBuilder.append(String.format("%-10s", name).replace(' ', '_'));
        stringBuilder.append(String.format("%-18s", identity).replace(' ', '_'));
        // 数字靠右,多余的地方用0填充
        stringBuilder.append(String.format("%05d", age));
        // 字符串靠左
        stringBuilder.append(String.format("%-11s", mobile).replace(' ', '_'));
        // MD5签名
        stringBuilder.append(DigestUtils.md2Hex(stringBuilder.toString()));
        return Request.Post("http://localhost:45678/reflection/bank/createUser")
                .bodyString(stringBuilder.toString(), ContentType.APPLICATION_JSON)
                .execute().returnContent().asString();
    }
    
    // 支付
    public static String pay(long userId, BigDecimal amount) throws IOException {
        StringBuilder stringBuilder = new StringBuilder();
        // 数字靠右
        stringBuilder.append(String.format("%020d", userId));
        // 金额向下舍入2位到分,以分为单位,作为数字靠右,多余的地方用0填充
        stringBuilder.append(String.format("%010d", amount.setScale(2, RoundingMode.DOWN).multiply(new BigDecimal("100")).longValue()));
        // MD5签名
        stringBuilder.append(DigestUtils.md2Hex(stringBuilder.toString()));
        return Request.Post("http://localhost:45678/reflection/bank/pay")
                .bodyString(stringBuilder.toString(), ContentType.APPLICATION_JSON)
                .execute().returnContent().asString();
    }
}

这段代码的重复粒度更细:

  • 三种标准数据类型的处理逻辑有重复
  • 处理流程中字符串拼接、加签和发请求的逻辑,在所有方法重复
  • 实际方法的入参的参数类型和顺序,不一定和接口要求一致,容易出错
  • 代码层面针对每一个参数硬编码,无法清晰地进行核对,如果参数达到几十个、上百个,出错的概率极大。

3.3 重构秘技之注解&反射

针对银行请求的所有逻辑均使用一套代码实现,不会出现任何重复。

要实现接口逻辑和逻辑实现的剥离,首先要以POJO类定义所有的接口参数。

  • 创建用户API的参数
@Data
public class CreateUserAPI {
    private String name;
    private String identity;
    private String mobile;
    private int age;
}

有了接口参数定义,就能通过自定义注解为接口和所有参数增加一些元数据。

  • 如下定义一个接口API的注解BankAPI,包含接口URL地址和接口说明
  • 架构师教你kill祖传石山代码重复/大量ifelse(中)
  • 再定义一个自定义注解@BankAPIField,描述接口的每一个字段规范,包含参数的次序、类型和长度三个属性:
  • 架构师教你kill祖传石山代码重复/大量ifelse(中)
  • 定义CreateUserAPI类描述创建用户接口的信息,通过为接口增加@BankAPI注解,来补充接口的URL和描述等元数据;通过为每一个字段增加@BankAPIField注解,来补充参数的顺序、类型和长度等元数据:
  • 架构师教你kill祖传石山代码重复/大量ifelse(中)
  • 类似的还有PayAPI类
  • 架构师教你kill祖传石山代码重复/大量ifelse(中)
  • 这2个类继承的AbstractAPI类是一个空实现,因为该案例中的接口无公共数据。


通过这俩类,即可在几秒钟内完成和API清单表格的核对。若我们的核心翻译过程(即把注解和接口API序列化为请求需要的字符串的过程)没问题,只要注解和表格一致,API请求翻译就不会有问题。


通过注解实现了对API参数的描述。看反射如何配合注解实现动态的接口参数组装:

private static String remoteCall(AbstractAPI api) throws IOException {
    // 从类上获得BankAPI注解,然后拿到其URL属性,后续进行远程调用
    BankAPI bankAPI = api.getClass().getAnnotation(BankAPI.class);
    bankAPI.url();
    StringBuilder stringBuilder = new StringBuilder();
    // 使用stream快速实现获取类中所有带BankAPIField注解的字段,并把字段按order属性排序,然后设置私有字段反射可访问。
    Arrays.stream(api.getClass().getDeclaredFields()) //获得所有字段
            //查找标记了注解的字段
            .filter(field -> field.isAnnotationPresent(BankAPIField.class))
            // 根据注解中的order对字段排序
            .sorted(Comparator.comparingInt(a -> a.getAnnotation(BankAPIField.class).order()))
            .peek(field -> field.setAccessible(true)) //设置可以访问私有字段
            .forEach(field -> {
                // 实现了反射获取注解的值,然后根据BankAPIField拿到的参数类型,按照三种标准进行格式化,将所有参数的格式化逻辑集中在了这一处
                // 获得注解
                BankAPIField bankAPIField = field.getAnnotation(BankAPIField.class);
                Object value = "";
                try {
                    // 反射获取字段值
                    value = field.get(api);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
                // 根据字段类型以正确的填充方式格式化字符串
                switch (bankAPIField.type()) {
                    case "S": {
                        stringBuilder.append(String.format("%-" + bankAPIField.length() + "s", value.toString()).replace(' ', '_'));
                        break;
                    }
                    case "N": {
                        stringBuilder.append(String.format("%" + bankAPIField.length() + "s", value.toString()).replace(' ', '0'));
                        break;
                    }
                    case "M": {
                        if (!(value instanceof BigDecimal))
                            throw new RuntimeException(String.format("{} 的 {} 必须是BigDecimal", api, field));
                        stringBuilder.append(String.format("%0" + bankAPIField.length() + "d", ((BigDecimal) value).setScale(2, RoundingMode.DOWN).multiply(new BigDecimal("100")).longValue()));
                        break;
                    }
                    default:
                        break;
                }
            });
    // 实现参数加签和请求调用
    // 签名逻辑stringBuilder.append(DigestUtils.md2Hex(stringBuilder.toString()));
    String param = stringBuilder.toString();
    long begin = System.currentTimeMillis();
    //发请求
    String result = Request.Post("http://localhost:45678/reflection" + bankAPI.url())
            .bodyString(param, ContentType.APPLICATION_JSON)
            .execute().returnContent().asString();
    log.info("调用银行API {} url:{} 参数:{} 耗时:{}ms", bankAPI.desc(), bankAPI.url(), param, System.currentTimeMillis() - begin);
    return result;
}

所有处理参数排序、填充、加签、请求调用的核心逻辑,都汇聚在remoteCall。有这方法,BankService中每一个接口的实现就非常简单了,只是参数的组装,然后调用remoteCall。

架构师教你kill祖传石山代码重复/大量ifelse(中)

涉及类结构性的通用处理,都可按照该模式减少重复代码。

  • 反射使得我们在不知类结构时,按固定逻辑处理类成员
  • 注解给我们为这些成员补充元数据的能力,使得我们利用反射实现通用逻辑的时候,可以从外部获得更多我们关心的数据
上一篇:Python解析JSON详解


下一篇:Python爬虫入门教程 47-100 mitmproxy安装与安卓模拟器的配合使用-手机APP爬虫部分