作者：Leilei Chen
起源：https://llchen60.com/
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;
}近期热文举荐：
1.1,000+ 道 Java面试题及答案整顿(2021最新版)
2.别在再满屏的 if/ else 了，试试策略模式，真香！！
3.卧槽！Java 中的 xx ≠ null 是什么新语法？
4.Spring Boot 2.5 重磅公布，光明模式太炸了！
5.《Java开发手册（嵩山版）》最新公布，速速下载！
感觉不错，别忘了顺手点赞+转发哦！
发表回复