當前位置:網站首頁>利用注解+反射消除重複代碼,你學會了嗎?

利用注解+反射消除重複代碼,你學會了嗎?

2021-08-20 13:49:59 你的_班主任

等我們工作一定年限(3-5年),很多同學抱怨,業務開發沒有什麼技術含量,用不到設計模式,平時寫代碼都是CRUD,要麼就是API調用,平常最多寫一個單例模式,其他高級特性和設計模式根本沒有用武之地。

今天舉一個在工作中很常用的例子,假設銀行提供了一些 API 接口,對參數的序列化有點特殊,不使用 JSON,而是需要我們把參數依次拼在一起構成一個大字符串。

  1. 按照銀行提供的 API 文檔的順序,把所有參數構成定長的數據,然後拼接在一起作為整個字符串。
  2. 因為每一種參數都有固定長度,未達到長度時需要做填充處理:
    • 字符串類型的參數不滿長度部分需要以下劃線右填充,也就是字符串內容靠左;
    • 數字類型的參數不滿長度部分以 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();
    }
}

大部分同學可能都會這樣寫,但是如果接口幾十個,或者參數達到幾十或者上百個,出錯概率極大

那應該如何改造這段代碼呢?沒錯,就是要用注解和反射!

/**
* @author: rfs
* @create: 2021/8/20
* @description: 我們定義一個接口 API 的注解 BankAPI,包含接口 URL 地址和接口說明
**/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Inherited
public @interface BackAPI {
    String desc() default "";
    String url() default "";
}
/**
* @author: rfs
* @create: 2021/8/20
* @description: 用於描述接口的每一個字段規範,包含參數的次序、類型和長度三個屬性
**/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
@Inherited
public @interface BankAPIField {
    int order()default -1;
    int length()default -1;
    BankAPIFieldType type();
}
/**
* @author: rfs
* @create: 2021/8/20
* @description: 字段類型枚舉
**/
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);
}

 

創建一個AbstractAPI 公共抽象類是一個空實現,因為這個案例中的接口並沒有公共數據可以抽象放到基類。

public abstract class AbstractAPI {
}

接下來兩個Http接口繼承這個基類,並添加響應的注解

@Data
@BackAPI(url = "/bank/pay",desc = "支付接口")
public class PayAPI extends AbstractAPI {
    @BankAPIField(order = 1,type = BankAPIFieldType.N,length = 20)
    private long userId;
    @BankAPIField(order = 2,type = BankAPIFieldType.M,length = 10)
    private BigDecimal amount;
}
@Data
@BackAPI(url = "/bank/createUser",desc = "創建用戶接口")
public class CreateUserAPI extends AbstractAPI {
    @BankAPIField(order = 1,type = BankAPIFieldType.S,length = 10)
    private String name;
    @BankAPIField(order = 2, type =BankAPIFieldType.S, length = 18)
    private String identity;
    @BankAPIField(order = 4, type =BankAPIFieldType.S, length = 11)
    private String mobile;
    @BankAPIField(order = 3, type = BankAPIFieldType.N, length = 5)
    private int age;
}

 接下來就是利用反射配合注解獲取動態的接口參數,所有處理參數排序、填充、加簽、請求調用的核心邏輯,都匯聚在了 remoteCall 方法中

 public static String remoteCall(AbstractAPI api) {
        BackAPI backAPI = api.getClass().getAnnotation(BackAPI.class);
        StringBuilder stringBuilder = new StringBuilder();
        Arrays.stream(api.getClass().getDeclaredFields())
                .filter(field -> field.isAnnotationPresent(BankAPIField.class))
                .sorted(Comparator.comparingInt(a -> a.getAnnotation(BankAPIField.class).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 "";
    }

有了這個核心方法,BankService 中每一個接口的實現就非常簡單了,只是參數的組裝,然後調用 remoteCall 即可。

/**
     * @author: rfs
     * @create: 2021/8/20
     * @description: 創建用戶接口
     **/
    public static String createUser(String name, String identity, String mobile, int age) {
        CreateUserAPI createUserAPI = new CreateUserAPI();
        createUserAPI.setName(name);
        createUserAPI.setIdentity(identity);
        createUserAPI.setAge(age);
        createUserAPI.setMobile(mobile);
        return remoteCall(createUserAPI);
    }

    /**
     * @author: rfs
     * @create: 2021/8/20
     * @description: 支付接口
     **/
    public static String pay(long userId, BigDecimal amount) {
        PayAPI payAPI = new PayAPI();
        payAPI.setUserId(userId);
        payAPI.setAmount(amount);
        return remoteCall(payAPI);
    }

許多涉及類結構性的通用處理,都可以按照這個模式來减少重複代碼!!

版權聲明
本文為[你的_班主任]所創,轉載請帶上原文鏈接,感謝
https://cht.chowdera.com/2021/08/20210820134959360z.html

隨機推薦