【程式碼優雅】使用OOP消除重複程式碼
阿新 • • 發佈：2022-12-07
使用OOP消除重複程式碼
假設銀行提供了一些API介面，對引數的序列化有點特殊，不使用JSON，而是需要我們把引數依次拼在一起構成一個大字串。
- 按照銀行提供的API文件的順序，把所有引數構成定長的資料，然後拼接在一起作為整個字串。
- 因為每一種引數都有固定長度，未達到長度時需要做填充處理：
- 字串型別的引數不滿長度部分需要以下劃線右填充，也就是字串內容靠左；
- 數字型別的引數不滿長度部分以0左填充，也就是實際數字靠右；
- 貨幣型別的表示需要把金額向下舍入2位到分，以分為單位，作為數字型別同樣進行左填充。
- 對所有引數做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(); } }
這樣做能夠基本滿足需求，但是存在一些問題：
- 處理邏輯互相之間有重複，稍有不慎就會出現Bug
- 處理流程中字串拼接、加簽和發請求的邏輯，在所有方法重複
- 實際方法的入參的引數型別和順序，不一定和介面要求一致，容易出錯
- 程式碼層面引數硬編碼，無法清晰進行核對
使用介面和反射優化程式碼
實現定義了所有介面引數的POJO類
@Data
public class CreateUserAPI {
private String name;
private String identity;
private String mobile;
private int age;
}
定義註解本身
// 我們定義一個介面 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;
String type() default "";
}
編寫一個欄位型別列舉
public enum BankAPIFieldType {
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(String.format("{} 的 {} 必須是BigDecimal"));
}
return String.format(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);
}
接下來兩個Http介面繼承這個基類，並新增響應的註解
@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;
}
反射配合註解實現動態的介面引數組裝
接下來就是利用反射配合註解獲取動態的介面引數，所有處理引數排序、填充、加簽、請求呼叫的核心邏輯，都匯聚在了 remoteCall 方法中
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();
}
//根據欄位型別以正確的填充方式格式化字串
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;
}
通過反射來動態獲得class的資訊，並在runtime的時候完成組裝過程。這樣做的好處是開發的時候會方便直觀很多，然後將邏輯與細節隱藏起來，並且集中放到了一個方法當中，減少了重複，以及維護當中bug的出現。
在程式碼中的應用
//建立使用者方法
public static String createUser(String name, String identity, String mobile, int age) throws IOException {
CreateUserAPI createUserAPI = new CreateUserAPI();
createUserAPI.setName(name);
createUserAPI.setIdentity(identity);
createUserAPI.setAge(age);
createUserAPI.setMobile(mobile);
return remoteCall(createUserAPI);
}
//支付方法
public static String pay(long userId, BigDecimal amount) throws IOException {
PayAPI payAPI = new PayAPI();
payAPI.setUserId(userId);
payAPI.setAmount(amount);
return remoteCall(payAPI);
}
其實，許多涉及類結構性的通用處理，都可以按照這個模式來減少重複程式碼。反射給予了我們在不知曉類結構的時候，按照固定的邏輯處理類的成員；而註解給了我們為這些成員補充元資料的能力，使得我們利用反射實現通用邏輯的時候，可以從外部獲得更多我們關心的資料。
ps:總結於朱曄老師課程