作者：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 valuehttps://www.cnblogs.com/javastack/archive/2021/09/29/= "";
try {
//反射獲取欄位值
value = https://www.cnblogs.com/javastack/archive/2021/09/29/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開發手冊（嵩山版）》最新發布，速速下載！
覺得不錯，別忘了隨手點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/303978.html
標籤：其他