背景說明
最近寫反射相關的代碼,想獲取對應的參數名稱,卻發現沒有特別好的方式。
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());