java 反射借助 asm 獲取參數名稱最優雅簡單的方式

背景說明

最近寫反射相關的代碼，想獲取對應的參數名稱，卻發現沒有特別好的方式。

jdk7 及其以前，是無法通過反射獲取參數名稱的。

jdk8 可以獲取，但是要求指定 -parameter 啟動參數，限制較多。

期間嘗試過類似于 Mybatis 使用 @Param 的方式，但是感覺不夠優雅，后來發現了下面的這個工具。

asm-tool 是基于 asm 構建的常見工具類。

下面簡單介紹下使用方式。

快速開始

準備

jdk 1.7+

maven 3.x+

maven 引入

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>asm-tool</artifactId>
    <version>0.0.2</version>
</dependency>

獲取方法參數名稱

測試方法

AsmMethodsTest 類下定義一個帶有參數的方法

public String common(String name) {
    return name;
}

獲取參數名稱

通過 AsmMethods.getParamNamesByAsm(Method) 獲取參數名稱。

Method method = ClassUtil.getMethod(AsmMethodsTest.class,
        "common", String.class);
List<String> param =  AsmMethods.getParamNamesByAsm(method);
Assert.assertEquals("[name]", param.toString());

第一行獲取我們定義的方法對應的 Method 信息;

第一行直接調用獲取結果;

第三行進行斷言驗證。

基于參數注解

參數注解

使用過 mybatis 的開發對于 @Param 注解應該并不陌生。

其實這也是一種解決獲取方法名稱的方式，那就是基于 @Param 注解。

@Param 注解

這個注解非常簡單，直接可以定義在參數列表上，用于顯示指定該字段的名稱。

public String forParam(@Param("name") String name) {
    return name;
}

獲取方式

通過 AsmMethods.getParamNamesByAnnotation(Method) 即可獲取。

Method method = ClassUtil.getMethod(AsmMethodsTest.class,
        "forParam", String.class);
List<String> param =  AsmMethods.getParamNamesByAnnotation(method);
Assert.assertEquals("[name]", param.toString());

未指定注解的場景

如果你沒有指定注解，則會返回 arg0/arg1/... 這樣的結果。

Method method = ClassUtil.getMethod(AsmMethodsTest.class,
        "common", String.class);
List<String> param =  AsmMethods.getParamNamesByAnnotation(method);
Assert.assertEquals("[arg0]", param.toString());

獲取構造器參數名稱

簡介

和獲取方法非常類似。

也有基于注解和基于 asm 兩種方式。

基于注解

• 構造器定義

public ConstructorService(@Param("age") Integer age) {
}

• 獲取參數名稱

Constructor constructor = ClassUtil.getConstructor(ConstructorService.class, Integer.class);
List<String> param =  AsmMethods.getParamNamesByAnnotation(constructor);
Assert.assertEquals("[age]", param.toString());

基于 asm

• 構造器定義

public ConstructorService(String name) {
}

• 獲取參數名稱

Constructor constructor = ClassUtil.getConstructor(ConstructorService.class, String.class);
List<String> param =  AsmMethods.getParamNamesByAsm(constructor);
Assert.assertEquals("[name]", param.toString());