利用注解 + 反射消除重复代码（Java项目）

阶段汇总汇合：一年内容，200期Java口试题阶段汇总

1. 案例阐发1.1 案例场景

假定银止供给了一些 API 接心，对参数的序量��有面特别，没有利用 JSON，而是需求我们把参数顺次拼正在一同组成一个年夜字符串

根据银止供给的API文档挨次，将一切的参数组成定少的数据，而且拼接正在一同做为一全部字符串

由于每种参数皆庸奶定少度，已到达少度需求停止添补处置

• 字符串范例参数没有谦少度部门要以下划线左添补，即字符串内容靠左
• 数字范例的参数没有谦少度部门以0左添补，即实践数字靠左
• 货泉范例的暗示需求把金额背下舍进2位到分，以分为单元，做为数字范例一样停止左添补
• 参数做MD5 操纵做为署名
• 
  

1.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();
        //数字靠左，过剩的处所用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();
    }
}

如许做可以根本满意需供，可是存正在一些成绩：

• 处置逻辑相互之间有反复，纱啃失慎便会呈现Bug
• 处置流程中字符串拼接、减签战收恳求的逻辑，正在一切办法反复
• 实践办法的进参的参数范例温顺序，纷歧定战接心请求分歧，简单堕落
• 代码层里参数硬编码，没法明晰停止查对
  

1.3 利用接心战反射劣化代码1.3.1 完成界说了一切接心参数的POJO类@Data
public class CreateUserAPI {
    private String name;
    private String identity;
    private String mobile;
    private int age;
}
1.3.2 界说注解自己
@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
    String type() default "";
}
1.3.3 反射共同注解完成静态的接心参数组拆private static String remoteCall(AbstractAPI 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();
                }
                //按照字段范例以准确的添补方法格局化字符串
                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;
}

经由过程反射去静态得到class的疑息，并正在runtime的时分完成组拆历程。如许做的益处是开辟的时分会便利曲不雅许多，然后将逻辑取细节躲藏起去，而且集合放到了一个办法傍边，削减了反复，和保护傍边bug的呈现。

1.3.4 正在代码中的使用@BankAPI(url = "/bank/createUser", desc = "创立映雩接心")
@Data
public class CreateUserAPI extends AbstractAPI {
    @BankAPIField(order = 1, type = "S", length = 10)
    private String name;
    @BankAPIField(order = 2, type = "S", length = 18)
    private String identity;
    @BankAPIField(order = 4, type = "S", length = 11) //留意那里的order需求根据API表格中的挨次
    private String mobile;
    @BankAPIField(order = 3, type = "N", length = 5)
    private int age;
}



@BankAPI(url = "/bank/pay", desc = "付出接心")
@Data
public class PayAPI extends AbstractAPI {
    @BankAPIField(order = 1, type = "N", length = 20)
    private long userId;
    @BankAPIField(order = 2, type = "M", length = 10)
    private BigDecimal amount;
}