手把手教你去除项目中的重复代码（一）---注解+反射处理接口通用逻辑

一. 前言

  我们都知道代码的可维护性是一个项目是否成熟的重要指标，而提升可维护性的一个重要方法就是减少项目中的重复代码。如果项目中存在多处重复代码，当出现bug时，我们必须同时修改所有出现重复功能的代码，很容易遗漏，这也就是代码的“坏味道”之一“散弹式修改”。

散弹式修改（Shotgun Surgery）类似 发散式变化（Divergent Change）,但恰恰相反。如果每遇到某种变化，都必须在许多不同的类中做出许多小修改，你所面临的坏味道就是散弹式修改（Shotgun Surgery）。如果需要修改的代码散布在四处，你不但很难找到它们，也很容易忘记某个重要的修改。

  那么我们应该怎么来消除这些重复代码呢？接下来几篇文章会通过实际案例来分享下消除重复的经验。
  本篇为第一篇文章，接下来的两篇链接如下
  手把手教你去除项目中的重复代码（二）—注解+反射实现通用的日志打印功能
  手把手教你去除项目中的重复代码（三）—模板+策略模式消除 if…else 和重复代码
  

二 . 利用注解 + 反射消除重复代码

一.需求描述

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

1. 按照银行提供的 API 文档的顺序，把所有参数构成定长的数据，然后拼接在一起作为整个字符串。
2. 因为每一种参数都有固定长度，未达到长度时需要做填充处理：

   - 字符串类型的参数不满长度部分需要以下划线右填充，也就是字符串内容靠左；
   - 数字类型的参数不满长度部分以 0 左填充，也就是实际数字靠右；
   - 货币类型的表示需要把金额向下舍入 2 位到分，以分为单位，作为数字类型同样进行左填充。

3. 对所有参数做 MD5 操作作为签名（为了方便理解，Demo 中不涉及加盐处理）。

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


  代码很容易实现，直接根据接口定义实现填充操作、加签名、请求调用操作即可：

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();
        //数字靠右，多余的地方用0填充
        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();
    }
}

  可以看到，这段代码处理流程中字符串拼接、加签和发请求的逻辑，在所有方法重复；同时对每个类型的处理是硬编码，当参数成百上千个时很难修改与维护。

二.使用注解+反射进行优化

1.定义注解

  首先定义两个注解

 /**
  * 接口 API 的注解 BankAPI，包含接口 URL 地址和接口说明
  */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Inherited
public @interface BankAPI {
    String desc() default "";
    String url() default "";
}

 /**
  * 请求子段的注解，包含参数的顺序、类型和长度等元数据
  */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
@Inherited
public @interface BankAPIField {
    int order() default -1;
    int length() default -1;
    BankAPIFieldEnum type() default BankAPIFieldEnum.S;
}

  然后定义两个请求Bean,并使用上面的注解来添加对应的元数据信息，其中AbstractAPIRequest 基类用来保存请求参数中的公共部分。

@BankAPI(url = "/bank/createUser", desc = "创建用户接口")
@Data
public class CreateUserAPIRequest extends AbstractAPIRequest {
    @BankAPIField(order = 1, type = BankAPIFieldEnum.S, length = 10)
    private String name;
    @BankAPIField(order = 2, type = BankAPIFieldEnum.S, length = 18)
    private String identity;
    @BankAPIField(order = 4, type = BankAPIFieldEnum.S, length = 11) //注意这里的order需要按照API表格中的顺序
    private String mobile;
    @BankAPIField(order = 3, type = BankAPIFieldEnum.N, length = 5)
    private int age;
}


@BankAPI(url = "/bank/pay", desc = "支付接口")
@Data
public class PayAPIRequest extends AbstractAPIRequest {
    @BankAPIField(order = 1, type = BankAPIFieldEnum.N, length = 20)
    private long userId;
    @BankAPIField(order = 2, type = BankAPIFieldEnum.M, length = 10)
    private BigDecimal amount;
}

2.通过反射配合注解实现动态的接口参数组装

private static String remoteCall(AbstractAPIRequest api) throws IOException {
    //从BankAPI注解获取请求地址
    BankAPI bankAPI = api.getClass().getAnnotation(BankAPI.class);
    bankAPI.url();
    StringBuilder stringBuilder = new StringBuilder();
    Arrays.stream(api.getClass().getDeclaredFields()) //获得所有字段
            .filter(field -> field.isAnnotationPresent(BankAPIField.class)) //查找标记了注解的字段
            .sorted(Comparator.comparingInt(a -> a.getAnnotation(BankAPIField.class).order())) //根据注解中的order对字段排序
            .peek(field -> field.setAccessible(true)) //设置可以访问私有字段
            .forEach(field -> {
                //获得注解
                BankAPIField bankAPIField = field.getAnnotation(BankAPIField.class);
                Object value = "";
                try {
                    //反射获取字段值
                    value = field.get(api);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
                //根据字段类型以正确的填充方式格式化字符串
               stringBuilder.append(bankAPIField.type().format(value,bankAPIField));
            });
    //签名逻辑
    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;
}

3.使用策略枚举的方式实现实现对不同类型的参数匹配不同的处理方式。

/**
 * 基于枚举的策略模式
 */
public enum BankAPIFieldEnum {
    S {
        @Override
        public String format(Object value, BankAPIField bankAPIField) {
            return String.format("%-" + bankAPIField.length() + "s", value.toString()).replace(' ', '_');
        }
    },
    N {
        @Override
        public String format(Object value, BankAPIField bankAPIField) {
            return String.format("%" + bankAPIField.length() + "s", value.toString()).replace(' ', '0');
        }
    },
    M {
        @Override
        public String format(Object value, BankAPIField bankAPIField) {
            if (!(value instanceof BigDecimal))
                throw new RuntimeException("对应字段类型必须是BigDecimal，请检查！");
            return String.format("%0" + bankAPIField.length() + "d", ((BigDecimal) value).setScale(2, RoundingMode.DOWN).multiply(new BigDecimal("100")).longValue());
        }
    };

    public abstract String format(Object value, BankAPIField bankAPIField);
}

4.实现具体的服务调用示例。

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

//创建用户方法
public static String createUser(String name, String identity, String mobile, int age) throws IOException {
    CreateUserAPIRequest createUserAPIRequest = new CreateUserAPIRequest();
    createUserAPIRequest.setName(name);
    createUserAPIRequest.setIdentity(identity);
    createUserAPIRequest.setAge(age);
    createUserAPIRequest.setMobile(mobile);
    return remoteCall(createUserAPI);
}
//支付方法
public static String pay(long userId, BigDecimal amount) throws IOException {
    PayAPIRequest payAPI = new PayAPIRequest();
    payAPIRequest.setUserId(userId);
    payAPIRequest.setAmount(amount);
    return remoteCall(payAPIRequest);
}

三.总结

  许多涉及类结构性的通用处理，都可以按照这个模式来减少重复代码。
  反射给予了我们在不知晓类结构的时候，按照固定的逻辑处理类的成员；
  而注解给了我们为这些成员补充元数据的能力，使得我们利用反射实现通用逻辑的时候，可以从外部获得更多我们关心的数据。

 
下一篇：手把手教你去除项目中的重复代码（二）—注解+反射实现通用的日志打印功能
 
参考资料

Java业务开发常见错误100例 -朱晔
代码整洁之道