java反射获取方法参数名的几种方式总结

 更新时间:2025年02月24日 10:01:17   作者:笨猪大难临头  
这篇文章主要介绍了如何通过添加编译参数或使用Spring的工具类来获取方法参数名,还总结了不同版本的JDK和Spring项目中参数名获取的优缺点,并提供了应用场景举例,需要的朋友可以参考下

1、前言

一般当我们用类似下面的反射去获取方法参数名时得到的一般是 arg0、arg1, 参数名默认会丢失, 导致无法获取到真实的方法参数名,下面介绍如何通过其他方式解决。

    class A {
        void getUser(String userName, String userId){}
    }
    
    Method method = A.class.getMethod(String.class,String.class);
    Parameter[] parameters = method.getParameters();
    for (Parameter parameter : parameters) {
        String name = parameter.getName();
        System.out.println(name); // 得到的是arg0, arg1 而非 userName、userId
    }

2、解决方式

方式2.1: 添加编译参数配置 -parameters

java默认在编译工程代码为class文件时,会将方法参数名擦除,替换成arg0、arg1之类。但是我们可以在编译时配置将参数名也一并编译进去,在maven中新增如下编译插件配置

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <!-- 配置编译时将方法参数名保留 -->
                    <compilerArgs>
                        <arg>-parameters</arg>
                    </compilerArgs>
                </configuration>
            </plugin>

对于较新的 maven 版本(>= 3.6.2), 也可以直接使用 parameters 配置项:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
        <parameters>true</parameters>
    </configuration>
</plugin>

添加-parameters的编译参数后,可以看到我们编译后的class文件是源码的参数名,而非原来的arg0、arg1。 之后我们用原生的反射Parameter.getName() 就可以获取到的方法参数的真实参数名了

注意: 该方式仅对JDK8及以上版本有效, 以前版本JDK没有提供该保留机制

方式2.2: 使用Spring的内部工具类 - ParameterNameDiscoverer

如果正好你的项目依赖了spring,则可以直接使用spring的内部工具类ParameterNameDiscoverer去获取到方法真实参数名。ParameterNameDiscoverer的实现类
主要包含 LocalVariableTableParameterNameDiscoverer、StandardReflectionParameterNameDiscoverer 。 下面介绍如何使用

1、StandardReflectionParameterNameDiscoverer的使用

该发现器需要与 方式2.1: 添加编译参数配置 -parameters 一样添加编译配置, 因为底层也是直接用反射Parameter去获取而已

  // 创建参数名发现器
  ParameterNameDiscoverer discoverer = new StandardReflectionParameterNameDiscoverer();

  Method method = A.class.getMethod(String.class,String.class);

  // 获取方法真实参数名.  userName, userId
  String[] parameterNames = discoverer.getParameterNames(method);

2、LocalVariableTableParameterNameDiscoverer的使用

  // 创建参数名发现器
  ParameterNameDiscoverer discoverer = new LocalVariableTableParameterNameDiscoverer();

  Method method = A.class.getMethod(String.class,String.class);

  // 获取方法真实参数名.  userName, userId
  String[] parameterNames = discoverer.getParameterNames(method);

该发现器底层原理是在编译类时生成一个调试信息的局部变量表LocalVariableTable,然后基于ASM字节码技术去解析LocalVariableTable得到参数名, 所以它也需要在编译时额外添加
编译配置, 请在maven中添加如下-g的编译参数配置

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <compilerArgs>
                        <!-- 生成局部变量表 -->
                        <arg>-g:vars</arg>
                    </compilerArgs>
                </configuration>
            </plugin>
        </plugins>
    </build>

该方法优点是JDK8以下版本也能使用,但是缺点是无法获取到接口的方法参数名

3、DefaultParameterNameDiscoverer的使用

  // 创建参数名发现器
  ParameterNameDiscoverer discoverer = new DefaultParameterNameDiscoverer();

  Method method = A.class.getMethod(String.class,String.class);

  // 获取方法真实参数名.  userName, userId
  String[] parameterNames = discoverer.getParameterNames(method);

这个参数名发现器是一个组合模式的发现器, 本身不去实现获取参数名的逻辑,而是组合其他参数名发现器, 然后迭代调用每个参数名发现器直到找到真实参数名。 从下面源码来看

主要内置了前面讲到的两种StandardReflectionParameterNameDiscoverer 和 LocalVariableTableParameterNameDiscoverer。 所以如果要让对应的参数名发现器生效,需要配合对应发现器的使用逻辑

否则一样无法获取到方法参数名。

// 源码
public class DefaultParameterNameDiscoverer extends PrioritizedParameterNameDiscoverer {

	public DefaultParameterNameDiscoverer() {
		if (!GraalDetector.inImageCode()) {
			if (KotlinDetector.isKotlinReflectPresent()) {
				addDiscoverer(new KotlinReflectionParameterNameDiscoverer());
			}
			addDiscoverer(new StandardReflectionParameterNameDiscoverer()); // 依赖编译参数 -parameters
			addDiscoverer(new LocalVariableTableParameterNameDiscoverer()); //  // 依赖编译参数 -g
		}
	}

}

使用总结

1、参数名获取的本质

  • 所有方案都依赖编译时保留参数名信息(通过-parameters或-g参数), 所以编译的时候有就是有,没有就是没有,尤其是一些第三方依赖的类
  • 如果是第三方依赖的类若未携带调试信息(如未使用上述编译参数进行编译),则无论如何也是无法获取真实参数名, 除非第三方库已使用-parameters编译,仍可通过反射获取(但实际场景较少见)

2、版本适配建议

  • JDK8+项目:
    优先使用-parameters编译参数(性能最佳), 配合StandardReflectionParameterNameDiscoverer
  • JDK7及以下: 使用-g编译参数, 配合LocalVariableTableParameterNameDiscoverer
  • Spring项目: 推荐使用DefaultParameterNameDiscoverer(自动适配最优策略), 可同时配置两种编译参数提升兼容性:

3、在一些springBoot 2.0以后版本中spring-boot-starter-parent会内置了编译参数配置,所以不用配也可以直接使用ParameterNameDiscoverer, 当然需要确保项目是否覆盖了默认配置导致失效,需要重新配

知名应用场景举例

  • spring-mvc 的 @RequestParam 参数名的可省略配置
  • mybatis 的 @Param 也可以不用配置

总结 

到此这篇关于java反射获取方法参数名的几种方式总结的文章就介绍到这了,更多相关java反射获取方法参数名内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • OpenFeign如何解决Get请求自动转化成POST的问题

    OpenFeign如何解决Get请求自动转化成POST的问题

    这篇文章主要介绍了OpenFeign如何解决Get请求自动转化成POST的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • springboot 整合 freemarker代码实例

    springboot 整合 freemarker代码实例

    这篇文章主要介绍了springboot 整合 freemarker代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • 本地安装Nacos的踩坑过程及解决

    本地安装Nacos的踩坑过程及解决

    这篇文章主要介绍了本地安装Nacos的踩坑过程及解决,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06
  • SpringBoot之bootstrap和application的区别解读

    SpringBoot之bootstrap和application的区别解读

    这篇文章主要介绍了SpringBoot之bootstrap和application的区别及说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 将内容写到txt文档里面并读取及删除的方法

    将内容写到txt文档里面并读取及删除的方法

    本文有个不错的示例,主要讲解如何将内容写到txt文档里面、读取文件里面的内容以及清除txt文件里面的内容
    2014-01-01
  • Java用局域网实现聊天室功能

    Java用局域网实现聊天室功能

    这篇文章主要为大家详细介绍了Java用局域网实现聊天室功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • 使用Spring-Retry解决Spring Boot应用程序中的重试问题

    使用Spring-Retry解决Spring Boot应用程序中的重试问题

    重试的使用场景比较多,比如调用远程服务时,由于网络或者服务端响应慢导致调用超时,此时可以多重试几次。用定时任务也可以实现重试的效果,但比较麻烦,用Spring Retry的话一个注解搞定所有,感兴趣的可以了解一下
    2023-04-04
  • Java实现创建运行时类的对象操作示例

    Java实现创建运行时类的对象操作示例

    这篇文章主要介绍了Java实现创建运行时类的对象操作,结合实例形式分析了Java动态创建对象的原理与相关实现技巧,需要的朋友可以参考下
    2018-08-08
  • Redis打开rdb文件常用方法详解

    Redis打开rdb文件常用方法详解

    这篇文章主要介绍了Redis打开rdb文件常用方法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • Java current并发包超详细分析

    Java current并发包超详细分析

    current并发包、在JDK1.5之前Java并没有提供线程安全的一些工具类去操作多线程,需要开发人员自行编写实现线程安全,但仍然无法完全避免低性能、死锁、资源管理等问题。在JDK1.5时新增了java.util.current并发包,其中提供了许多供我们使用的并发编程工具类
    2023-02-02

最新评论