利用注解 + 反射消除重复代码，妙！

1.1 案例场景

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

1）按照银行提供的API文档顺序，将所有的参数构成定长的数据，并且拼接在一起作为一整个字符串

2）因为每一种参数都有固定长度，未达到长度需要进行填充处理

字符串类型参数不满长度部分要以下划线右填充，即字符串内容靠左
数字类型的参数不满长度部分以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;
}

利用注解 + 反射消除重复代码，妙！相关推荐

利用注解 + 反射消除重复代码（Java项目）
作者 | Leilei Chen 来源 | https://llchen60.com/ 1. 案例场景假设银行提供了一些 API 接口,对参数的序列化有点特殊,不使用 JSON,而是需要我们把参数依 ...
java 重复代码优化_利用注解 + 反射消除重复代码（Java项目）
1. 案例分析 1.1 案例场景假设银行提供了一些 API 接口,对参数的序列化有点特殊,不使用 JSON,而是需要我们把参数依次拼在一起构成一个大字符串按照银行提供的API文档顺序,将所有的参数 ...
利用Java反射机制降低代码圈复杂度
利用Java反射机制降低代码圈复杂度在实际的工作中,我遇到了项目里老代码存在圈复杂度过高的问题,在提交代码的时候通不过CI(代码检查)的Lizard复杂度检查,所以迫切需要解决这个问题,运用Java ...
无码系列5.1 代码重构消除重复代码
1 前言本文可以视为对ThoughtWorks高级顾问yuanyingjie关于"正交四原则"策略"消除重复"的"个人解读". 如有谬误, ...
【译】利用Lombok消除重复代码
当你在写Getter和Setter时,一定无数次的想过,为什么会有POJO这么烂的东西.你不是一个人!(不是骂人-)无数的开发人员花费了大量的时间来写这种样板代码,而他们本来可以利用这些时间做出更有价 ...
重构 - 提炼函数，消除重复代码
一.参考资料二.重构步骤 - 以提炼重复计算函数为例子演示代码具体步骤 1.提取重复new创建 2.提取会变化的信息 3.使用抽取的共有信息,并删除原有信息 4.提取计算函数 5.使用卫语句,简 ...
java开发之消除冗余代码的3种方法
一.利用工厂模式+模板方法模式我们以做蛋糕为例来演示如何消除重复代码. 假设我们要做3种不同口味的蛋糕,分别是抹茶,可可和草莓蛋糕,实际上3种蛋糕的制作方法是极其相似的,只有添加的粉剂不同,如果用 ...
从阿里跳槽来的工程师，分享了三套干掉 “重复代码”方式，真的太绝了！
附:糖豆广场舞永久会员TV版软件工程师和码农最大的区别就是平时写代码时习惯问题,码农很喜欢写重复代码而软件工程师会利用各种技巧去干掉重复的冗余代码. 业务同学抱怨业务开发没有技术含量,用不到设计模 ...
简化开发｜Lombok神器带你消除冗余代码
前言 Lombok是一款Java开发插件,使得Java开发者可以通过其定义的一些注解来消除业务过程中冗余的代码,尤其是简单的Java模型对象(POJO).而当我们如果在开发环境中使用Lombok开发插 ...

利用注解 + 反射消除重复代码，妙！

1.1 案例场景

1.2 初步代码实现

1.3 使用接口和反射优化代码

利用注解 + 反射消除重复代码，妙！相关推荐

最新文章

热门文章