【深度好文】深度分析如何获取方法参数名

Java框架

浏览数:119

2019-6-22

AD:资源代下载服务

声明:本文属原创文章,首发于公号:
程序员自学之道,转载请注明出处!

发现问题

对Java字节码有一定了解的朋友应该知道,Java 在编译的时候,默认会将方法参数名丢弃,因此我们无法在运行时获取参数名称。但是在使用 SpringMVC 的时候,我发现一个奇怪的现象,当我们需要接收请求参数的时候,相应的 Controller 方法只需要正常声明,就可以直接接收正确的参数,例如:

注:以下例子使用 maven 进行编译,且非 SpringBoot 项目,SpringBoot 已经自动解决了参数名解析的问题,后面咱们会讨论

@RestController
@RequestMapping("calculator")
public class CalculatorController {
    @GetMapping("add")
    public int add(int aNum, int bNum) {
        return aNum + bNum;
    }
}

当接收到 http://localhost:8080/calculator/add?aNum=12&bNum=3 这样的请求时,会返回 15,即aNum 和 bNum 都能被正确解析

然而,当我们使用 MyBatis 时,如果接口方法有多个参数而且我们没有打上 @Param 注解的话,执行的时候就会报错。例如,我们有如下的接口:

@Mapper
public interface AccountMapper {
    @Select("select * from `account` where `name` = #{name} and mobile_phone = #{mobilePhone}")
    Account getByNameAndMobilePhone(String name, String mobilePhone);
}

方法中包含两个参数,但是没有打上 @Param 注解,这时候如果调用这个方法,会报错:

org.apache.ibatis.binding.BindingException: Parameter 'name' not found. Available parameters are [arg1, arg0, param1, param2]

从错误信息中可以看出,是因为 MyBatis 没有正确解析方法参数名称导致异常

这就很奇怪了,为什么 Spring 可以正确解析方法参数名称,但是 MyBatis 却不行?Java编译的时候不是默认会将方法参数名丢弃吗?我只是普通编译,并没有做特殊处理,那Spring又是从哪里找到方法参数名的呢?

带着这些问题,我开始进行研究和探索。

获取参数名的几种方式

通过查阅各种资料,我知道,获取参数名称的方式主要有两种。

一、-g 参数

当我们对 Java 源码进行编译时,无论是直接使用命令行还是使用 IDE 为我们编译,实际上最终都是调用 javac 命令进行的,在编译的时候,我们如果添加上 -g 参数,即告诉编译器,我们需要调试信息,这时,生成的字节码当中就会包含局部变量表的信息(方法参数也是局部变量),于是我们就可以通过解析字节码获取参数名了

我们用最最经典的 HelloWorld 程序中的 main 方法为例,看一下编译的效果:

 public class HelloWorld{
    public static void main(String[] argsName){
        System.out.println("HelloWorld!");
    }
}

我们直接执行如下 javac 命令来编译并查看生成的字节码信息:

javac HelloWorld.java
javap -verbose HelloWorld.class


可以看到,我们的参数名 argsName 已经被抹掉了。而如果字节码中都没有我们所需要的信息,那么在运行时,反射或者是别的方法也都无能为力了,巧妇难为无米之炊呐。

接下来,我们试一下添加 -g 参数会发生什么:

javac -g HelloWorld.java
javap -verbose HelloWorld.class


可以看到,这里多了一个 LocalVariableTable,即局部变量表,其中就有我们的参数名称 argsName!

那么,我们如何在方法运行时从字节码信息中获取参数名称呢?你可以直接通过 javap 来获取字节码信息,然后自己去根据信息的格式去解析,然而这样太低效了,而且太繁琐了。

这时候如果我们请大名鼎鼎的 ASM 来当“导游”,带着我们游览字节码内部构造,实现起来就轻松多了。

这个 ASM 可牛了,
它不仅可以查看字节码的信息,甚至可以动态修改类的定义或者新建一个原本没有的类!在各种框架中被广泛地使用,SpringAOP中使用的 CGLib 底层就是使用 ASM 来实现的。有兴趣可以查看官网:
https://asm.ow2.io/ 之前我也写过一篇文章
《Java用ASM写一个HelloWorld程序》,有兴趣可以看一下。

言归正传,如何通过 ASM 来获取参数名称呢? 直接上代码:

首先添加依赖:

<dependency>
     <groupId>asm</groupId>
    <artifactId>asm</artifactId>
    <version>3.3.1</version>
</dependency>
/**
 * 使用字节码工具ASM来获取方法的参数名
 */
public static String[] getMethodParamNames(final Method method) throws IOException {
  final int methodParameterCount =  method.getParameterTypes().length;
  final String[] methodParametersNames = new String[methodParameterCount];
  ClassReader cr = new ClassReader(method.getDeclaringClass().getName());
  ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);
  cr.accept(new ClassAdapter(cw) {
      @Override
      public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
          MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
          final Type[] argTypes = Type.getArgumentTypes(desc);
          //参数类型不一致
          if (!method.getName().equals(name) || !matchTypes(argTypes,  method.getParameterTypes())) {
              return mv;
          }
          return new MethodAdapter(mv) {
              @Override
              public void visitLocalVariable(String name, String desc, String signature, Label start, Label end, int index) {
                  //如果是静态方法,第一个参数就是方法参数,非静态方法,则第一个参数是 this, 然后才是方法的参数
                  int methodParameterIndex = Modifier.isStatic(method.getModifiers()) ? index : index - 1;
                  if (0 <= methodParameterIndex && methodParameterIndex < methodParameterCount) {
                      methodParametersNames[methodParameterIndex] = name;
                  }
                  super.visitLocalVariable(name, desc, signature, start, end, index);
              }
          };
      }
  }, 0);
  return methodParametersNames;
}

/**
 * 比较参数是否一致
 */
private static boolean matchTypes(Type[] types, Class<?>[] parameterTypes) {
   if (types.length != parameterTypes.length) {
       return false;
   }
   for (int i = 0; i < types.length; i++) {
       if (!Type.getType(parameterTypes[i]).equals(types[i])) {
           return false;
       }
   }
   return true;
}

简而言之,ASM使用了访问者模式,它就像一个导游,带着我们去游览字节码文件中的各个“景点”。我们实现不同的 Visitor 接口就像是手上握有不同景点门票的游客,导游会带着 ClassVisitor 去总体参观类定义的景观,而类内部有方法,如果你想看一下方法内部的定义,需要”额外购票”,即需要实现 MethodVisitor 才能跟着导游去参观方法定义这个景点。而在游览各个景点的时候,我们可以只游览我们感兴趣的部分,这就可以继承适配器(ClassAdapter和MethodAdapter分别是ClassVisitor和MethodVisitor的适配器)然后只实现我们感兴趣的方法即可。

这里对于类的定义,我们只对方法感兴趣,因此只实现 visitMethod 方法;在方法中,我们只对 LocalVariableTable 有兴趣,因此只实现 visitLocalVariable 方法。这样我们得到了局部变量表,再根据一些规则就可以拿到我们的参数名称了!是不是很棒!

顺便说一下,如果你使用 maven 来管理项目的话,这个 -g 参数会在编译的时候自动加上,因此我们不需要额外添加就可以通过字节码拿到,这也就是为什么 SpringMVC 可以拿到方法参数名称的原因。

但是这种方式对于接口和抽象方法是不管用的,因为抽象方法没有方法体,也就没有局部变量,自然也就没有局部变量表了

MyBatis 是通过接口跟 SQL 语句绑定然后生成代理类来实现的,因此它无法通过解析字节码来获取方法参数名。

虽然通过字节码的方法的确可以拿到参数名,但还是不方便,而且它对接口和抽象方法的参数名也无能为力。有没有更方便更全面的方法呢?答案是:有的。

-parameters 参数

JDK8 在反射包中引入了 java.lang.reflect.Parameter 来获取参数相关的信息

A small but useful example is support for method parameter names at run time: storing such names in the class file structure goes hand in hand with offering a standard API to retrieve them (java.lang.reflect.Parameter) – 《The Java Virtual Machine Specification》

但是它依赖于编译时添加 -parameters 参数,也就是说,只有在编译的时候添加了这个参数才能在运行时通过反射获取参数信息。还是用我们的 HelloWorld 程序,我们来试一下添加 -parameters 参数:

javac -parameters HelloWorld.java
javap -verbose HelloWorld.class


可以看到,字节码文件中多了 MethodParameters 部分,里面存放的就直接是我们所需要在的参数名!我们可以直接通过反射获取:

HelloWorld.class.getMethod("main",String[].class).getParameters()[0].getName()

问题来了,我们如何在编译的时候自动加上 -parameters 这个参数呢?毕竟我们不可能只在自己的 IDE 上做设置,也不可能自己写脚本来编译。

如果你使用 maven 来管理项目的话,可以直接通过插件来完成:

<build>
  <plugins>
      <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
          <configuration>
              <source>${java.version}</source>
              <target>${java.version}</target>
              <parameters>true</parameters>
          </configuration>
      </plugin>
  </plugins>
</build>

这样这个 -parameters 参数就会在编译的时候自动加上了

关于 SpringBoot

文章开头曾提到,SpringBoot 已经自动解决了参数名解析的问题,它其实就是通过 -parameters 参数来实现的。在 spring-boot-starter-parent.pom 文件中它为我们添加了上面提到的插件及参数:

有了这个参数而且是在 JDK8+ 中运行的话无论是 SpringMVC 还是 MyBatis 都可以获取到正确的方法参数名了!

总结

获取参数名称的方式主要有两种:

  1. 编译时添加 -g 参数,然后通过解析字节码读取局部变量表获取

    maven在编译时会自动添加这个参数,但是用的时候需要解析字节码,而且对于接口和抽象方法无能为力,因为接口和抽象方法没有方法体,也就没有局部变量,因此也就没有局部变量表,所以无法通过局部变量表来获取参数名称。

  2. JDK8+ 编译时添加 -parameters 参数,然后通过反射获取

    可以通过配置插件自动添加,使用非常方便,直接通过反射即可拿到参数信息。但是需要 JDK8 及以上才能使用。

SpringMVC 和 MyBatis :

  • 有 -parameters 参数的场景,两个框架都可以正确解析参数名。
  • 只有 -g 参数时

    • SpringMVC 通过解析字节码获取 Controller 的方法参数以绑定请求参数
    • MyBatis 需要与接口绑定,而 -g 参数对接口和抽象类无效,因此不能正确解析参数名
  • -g 和 -parameters 都没有时,两者都无法正确解析参数名

后记

不知不觉写了这么多,现在也快凌晨两点了。

对于获取方法参数名这个问题的探究最早其实是来源于我在写 http-api-invoker (github 地址:https://github.com/dadiyang/h… 这个框架的时候意识到的。这个框架跟MyBatis类似,它将接口与 url 进行绑定然后生成代理类来发送 http 请求,我们无需关注参数拼接和序列化、请求发送和返回值处理的过程,只需要定义好我们的接口并打上注解即可。

在不断优化和使用的过程中我发现,每个接口方法都需要打 @Param 注解太麻烦,而 MyBatis 也同样有这个问题,然而 SpringMVC 却可以解决。因此为了更加完善这个框架,我开始一探究竟。做了很多的功课,把整个来龙去脉都了解清楚了,但是一直没有时间整理。

现在终于忙里偷闲趁着周末把这篇文章写出来了,可惜由于最近我让 http-api-invoker 框架兼容到 JDK6,还没有想好怎样让它在支持 JDK6 的前提下更好地利用 JDK8+ 的 -parameters 特性。这个留到以后再做进一步的探索吧。

更多原创好文,请关注程序员自学之道

参考文献:

作者:dadiyang