利用註解+反射消除重複程式碼，你學會了嗎？

你的_班主任發表於2021-08-20
反射
等我們工作一定年限（3-5年），很多同學抱怨，業務開發沒有什麼技術含量，用不到設計模式，平時寫程式碼都是CRUD，要麼就是API呼叫，平常最多寫一個單例模式，其他高階特性和設計模式根本沒有用武之地
今天舉一個在工作中很常用的例子，假設銀行提供了一些 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();
    }
}

/**
* @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 公共抽象類是一個空實現，因為這個案例中的介面並沒有公共資料可以抽象放到基類。
接下來兩個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);
    }

許多涉及類結構性的通用處理，都可以按照這個模式來減少重複程式碼！！

github:https://github.com/renfushuai/javastudy/tree/master/src/main/java/com/rfs/javastudy/redundantcode/reflection

歡迎star

來自極客時間《Java業務開發常見錯誤100例》https://time.geekbang.org/column/intro/294

相關文章