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

2021-02-23 14:41:49 浏览数 (1)

本文就教你如何优雅消除重复代码并改变你对业务代码没技术含量的观念。

1 crud 工程师之“痛”

很多 crud 工程师抱怨业务开发没有技术含量，什么设计模式、高并发都用不到，就是堆CRUD。每次面试被问到“讲讲常用设计模式？”，都只能把单例讲到精通，其他设计模式即使听过也只会简单说说，因为根本没实际用过。 对于反射、注解，也只是知道在框架中用的很多，但自己又不写框架，更不知道该如何使用。

  • 设计模式是世界级软件大师在大型项目的经验所得，是被证实利于维护大型项目的。
  • 反射、注解、泛型等高级特性在框架被大量使用，是因为框架往往需要以同一套算法应对不同数据结构，而这些特性可以帮助减少重复代码，也是利于维护。

提升项目的可维护性是每个 coder 必须注意的，非常重要的一个手段就是减少代码重复，因为重复过多会导致：

  • 容易修改一处忘记修改另一处，造成Bug
  • 有一些代码并非完全重复，而是相似度高，修改这些类似的代码容易改（cv）错，把原本有区别的地方改成一样

2 工厂 模板方法模式，消除多if和重复代码

2.1 需求

开发购物车下单，对不同用户不同处理：

  • 普通用户需要收取运费，运费是商品价格的10%，无商品折扣
  • VIP用户同样需要收取商品价格10%的快递费，但购买两件以上相同商品时，第三件开始享受一定折扣
  • 内部用户可以免运费，无商品折扣

实现三种类型的购物车业务逻辑，把入参Map对象（K：商品ID，V：商品数量），转换为出参购物车类型Cart。

2.2 菜鸟实现

  • 购物车
  • 购物车中的商品

2.2.1 普通用户

2.2.2 VIP用户

VIP用户能享受同类商品多买的折扣。只需额外处理多买折扣部分。

2.2.3 内部用户

免运费、无折扣，只处理商品折扣和运费时的逻辑差异。

三种购物车超过一半代码重复。 虽然不同类型用户计算运费和优惠的方式不同，但整个购物车的初始化、统计总价、总运费、总优惠和支付价格逻辑都一样。

代码重复本身不可怕，可怕的是漏改或改错。 比如，写VIP用户购物车的同学发现商品总价计算有Bug，不应该是把所有Item的price加在一起，而是应该把所有Item的price*quantity相加。 他可能只修VIP用户购物车的代码，漏了普通用户、内部用户的购物车中重复逻辑实现的相同Bug。

有三个购物车，就需根据不同用户类型使用不同购物车。

  • 使用多if实现不同类型用户调用不同购物车process

就只能不断增加更多的购物车类，写重复的购物车逻辑、写更多if逻辑吗？ 当然不是，相同的代码应该只在一处出现！

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

可以把重复逻辑定义在抽象类，三个购物车只要分别实现不同部分的逻辑。 这其实就是模板方法模式。 在父类中实现购物车处理的流程模板，然后把需要特殊处理的留抽象方法定义，让子类去实现。由于父类逻辑无法单独工作，因此需要定义为抽象类。

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

有抽象类，三个子类的实现就简单了。

  • 普通用户的购物车NormalUserCart，实现0优惠和10%运费
  • VIP用户的购物车VipUserCart，直接继承NormalUserCart，只需修改多买优惠策略
  • 内部用户购物车InternalUserCart最简单，直接设置0运费、0折扣

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

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

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

这就是工厂模式，借助Spring容器实现：

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

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

3 注解 反射消除重复代码

3.1 需求

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

  • 按照银行提供的API文档的顺序，把所有参数构成定长的数据，然后拼接在一起作为整个字符串
  • 因为每种参数都有固定长度，未达到长度时需填充：
    • 字符串类型的参数不满长度部分需要以下划线右填充，也就是字符串内容靠左
    • 数字类型的参数不满长度部分以0左填充，也就是实际数字靠右
    • 货币类型的表示需要把金额向下舍入2位到分，以分为单位，作为数字类型同样进行左填充。 对所有参数做MD5操作作为签名（为了方便理解，Demo中不涉及加盐处理）。

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

3.2 菜鸟实现

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

代码语言：javascript复制
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("d", 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("0d", userId));
        // 金额向下舍入2位到分，以分为单位，作为数字靠右，多余的地方用0填充
        stringBuilder.append(String.format("0d", 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的参数
代码语言：javascript复制
@Data
public class CreateUserAPI {
    private String name;
    private String identity;
    private String mobile;
    private int age;
}

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

  • 如下定义一个接口API的注解BankAPI，包含接口URL地址和接口说明

再定义一个自定义注解@BankAPIField，描述接口的每一个字段规范，包含参数的次序、类型和长度三个属性：

  • 定义CreateUserAPI类描述创建用户接口的信息，通过为接口增加@BankAPI注解，来补充接口的URL和描述等元数据；通过为每一个字段增加@BankAPIField注解，来补充参数的顺序、类型和长度等元数据：
  • 类似的还有PayAPI类

这2个类继承的AbstractAPI类是一个空实现，因为该案例中的接口无公共数据。

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

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

代码语言：javascript复制
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。

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

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

4 属性拷贝

对于三层架构系统，层间解耦及每层对数据的不同需求，每层都会有自己的POJO实体。 手动写这些实体之间的赋值代码，容易出错。对于复杂业务系统，实体有几十甚至几百个属性也很正常。比如ComplicatedOrderDTO，描述一个订单中几十个属性。如果转换为一个类似的DO，复制其中大部分的字段，然后把数据入库，势必需要进行很多属性映射赋值操作。就像这样，密密麻麻的代码是不是已经让你头晕了？

代码语言：javascript复制
ComplicatedOrderDTO orderDTO = new ComplicatedOrderDTO();
ComplicatedOrderDO orderDO = new ComplicatedOrderDO();
orderDO.setAcceptDate(orderDTO.getAcceptDate());
orderDO.setAddress(orderDTO.getAddress());
orderDO.setAddressId(orderDTO.getAddressId());
orderDO.setCancelable(orderDTO.isCancelable());
orderDO.setCommentable(orderDTO.isComplainable()); //属性错误
orderDO.setComplainable(orderDTO.isCommentable()); //属性错误
orderDO.setCancelable(orderDTO.isCancelable());
orderDO.setCouponAmount(orderDTO.getCouponAmount());
orderDO.setCouponId(orderDTO.getCouponId());
orderDO.setCreateDate(orderDTO.getCreateDate());
orderDO.setDirectCancelable(orderDTO.isDirectCancelable());
orderDO.setDeliverDate(orderDTO.getDeliverDate());
orderDO.setDeliverGroup(orderDTO.getDeliverGroup());
orderDO.setDeliverGroupOrderStatus(orderDTO.getDeliverGroupOrderStatus());
orderDO.setDeliverMethod(orderDTO.getDeliverMethod());
orderDO.setDeliverPrice(orderDTO.getDeliverPrice());
orderDO.setDeliveryManId(orderDTO.getDeliveryManId());
orderDO.setDeliveryManMobile(orderDO.getDeliveryManMobile()); //对象错误
orderDO.setDeliveryManName(orderDTO.getDeliveryManName());
orderDO.setDistance(orderDTO.getDistance());
orderDO.setExpectDate(orderDTO.getExpectDate());
orderDO.setFirstDeal(orderDTO.isFirstDeal());
orderDO.setHasPaid(orderDTO.isHasPaid());
orderDO.setHeadPic(orderDTO.getHeadPic());
orderDO.setLongitude(orderDTO.getLongitude());
orderDO.setLatitude(orderDTO.getLongitude()); //属性赋值错误
orderDO.setMerchantAddress(orderDTO.getMerchantAddress());
orderDO.setMerchantHeadPic(orderDTO.getMerchantHeadPic());
orderDO.setMerchantId(orderDTO.getMerchantId());
orderDO.setMerchantAddress(orderDTO.getMerchantAddress());
orderDO.setMerchantName(orderDTO.getMerchantName());
orderDO.setMerchantPhone(orderDTO.getMerchantPhone());
orderDO.setOrderNo(orderDTO.getOrderNo());
orderDO.setOutDate(orderDTO.getOutDate());
orderDO.setPayable(orderDTO.isPayable());
orderDO.setPaymentAmount(orderDTO.getPaymentAmount());
orderDO.setPaymentDate(orderDTO.getPaymentDate());
orderDO.setPaymentMethod(orderDTO.getPaymentMethod());
orderDO.setPaymentTimeLimit(orderDTO.getPaymentTimeLimit());
orderDO.setPhone(orderDTO.getPhone());
orderDO.setRefundable(orderDTO.isRefundable());
orderDO.setRemark(orderDTO.getRemark());
orderDO.setStatus(orderDTO.getStatus());
orderDO.setTotalQuantity(orderDTO.getTotalQuantity());
orderDO.setUpdateTime(orderDTO.getUpdateTime());
orderDO.setName(orderDTO.getName());
orderDO.setUid(orderDTO.getUid());

如果原始的DTO有100个字段，我们需要复制90个字段到DO中，保留10个不赋值，最后应该如何校验正确性呢？

  • 数数吗？即使数出有90行代码，也不一定正确，因为属性可能重复赋值
  • 有时字段名相近，比如complainable和commentable，容易搞反
  • 对两个目标字段重复赋值相同的来源字段
  • 明明要把DTO的值赋值到DO中，却在set的时候从DO自己取值，导致赋值无效

使用类似BeanUtils这种Mapping工具来做Bean的转换，copyProperties方法还允许我们提供需要忽略的属性：

5 总结

重复代码多了总有一天会出错。

  • 有多个并行的类实现相似的代码逻辑 考虑提取相同逻辑在父类中实现，差异逻辑通过抽象方法留给子类实现。使用类似的模板方法把相同的流程和逻辑固定成模板，保留差异的同时尽可能避免代码重复。同时，可以使用Spring的IoC特性注入相应的子类，来避免实例化子类时的大量if…else代码。
  • 使用硬编码的方式重复实现相同的数据处理算法 考虑把规则转换为自定义注解，作为元数据对类或对字段、方法进行描述，然后通过反射动态读取这些元数据、字段或调用方法，实现规则参数和规则定义的分离。也就是说，把变化的部分也就是规则的参数放入注解，规则的定义统一处理。
  • 业务代码中常见的DO、DTO、VO转换时大量字段的手动赋值，遇到有上百个属性的复杂类型，非常非常容易出错 不要手动进行赋值，考虑使用Bean映射工具进行。此外，还可以考虑采用单元测试对所有字段进行赋值正确性校验。

代码重复度是评估一个项目质量的重要指标，如果一个项目几乎没有任何重复代码，那么它内部抽象一定非常好。重构时，首要任务是消除重复。

参考

  • 《重构》
  • 搞定代码重复的三个绝招
  • https://blog.csdn.net/qq_32447301/article/details/107774036
api 费用中心 tcp/ip 编程算法

0 人点赞