java 反射借助 asm 獲取參數(shù)名稱最優(yōu)雅簡(jiǎn)單的方式

背景說明

最近寫反射相關(guān)的代碼，想獲取對(duì)應(yīng)的參數(shù)名稱，卻發(fā)現(xiàn)沒有特別好的方式。

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

jdk8 可以獲取，但是要求指定 -parameter 啟動(dòng)參數(shù)，限制較多。

期間嘗試過類似于 Mybatis 使用 @Param 的方式，但是感覺不夠優(yōu)雅，后來發(fā)現(xiàn)了下面的這個(gè)工具。

asm-tool 是基于 asm 構(gòu)建的常見工具類。

下面簡(jiǎn)單介紹下使用方式。

快速開始

準(zhǔn)備

jdk 1.7+

maven 3.x+

maven 引入

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

獲取方法參數(shù)名稱

測(cè)試方法

AsmMethodsTest 類下定義一個(gè)帶有參數(shù)的方法

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

獲取參數(shù)名稱

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

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

第一行獲取我們定義的方法對(duì)應(yīng)的 Method 信息;

第一行直接調(diào)用獲取結(jié)果;

第三行進(jìn)行斷言驗(yàn)證。

基于參數(shù)注解

參數(shù)注解

使用過 mybatis 的開發(fā)對(duì)于 @Param 注解應(yīng)該并不陌生。

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

@Param 注解

這個(gè)注解非常簡(jiǎn)單，直接可以定義在參數(shù)列表上，用于顯示指定該字段的名稱。

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());

未指定注解的場(chǎng)景

如果你沒有指定注解，則會(huì)返回 arg0/arg1/... 這樣的結(jié)果。

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

獲取構(gòu)造器參數(shù)名稱

簡(jiǎn)介

和獲取方法非常類似。

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

基于注解

• 構(gòu)造器定義

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

• 獲取參數(shù)名稱

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

基于 asm

• 構(gòu)造器定義

public ConstructorService(String name) {
}

• 獲取參數(shù)名稱

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