spring mvc中的@PathVariable动态参数详解

目录

• spring mvc @PathVariable动态参数
• spring mvc是如何做到根据参数名动态绑定参数的？
• 反射获取参数名
• -parameters参数
• -g参数
• ASM
• SpringMVC的处理方式
• 总结

spring mvc @PathVariable动态参数

spring mvc中的@PathVariable是用来获得请求url中的动态参数的，十分方便

@Controller  
public class TestController {  
     @RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)  
     public String getLogin(@PathVariable("userId") String userId,  
         @PathVariable("roleId") String roleId){  
         System.out.println("User Id : " + userId);  
         System.out.println("Role Id : " + roleId);  
         return "hello";  
     }  
     @RequestMapping(value="/product/{productId}",method = RequestMethod.GET)  
     public String getProduct(@PathVariable("productId") String productId){  
           System.out.println("Product Id : " + productId);  
           return "hello";  
     }  
     @RequestMapping(value="/javabeat/{regexp1:[a-z-]+}",  
           method = RequestMethod.GET)  
     public String getRegExp(@PathVariable("regexp1") String regexp1){  
           System.out.println("URI Part 1 : " + regexp1);  
           return "hello";  
     }  
}  

spring mvc是如何做到根据参数名动态绑定参数的？

使用过SpringMVC的同学都知道，当我们需要在Controller层接收客户端的请求参数时，只需要在形参上加@RequestParam注解，SpringMVC就会自动帮我们做参数绑定，如下示例：

@GetMapping("test1")
public void test1(@RequestParam("name") String name, @RequestParam("age") Integer age) {
}

客户端请求示例：

curl http://127.0.0.1:8080/test1?name=root&age=18

每个参数都加注解写起来非常的麻烦，因此SpringMVC还可以根据参数名自动匹配，只要方法的参数名和客户端请求的参数名相同即可绑定，代码可以简化为：

@GetMapping("test2")
public void test2(String name, Integer age) throws Exception {
 
}

SpringMVC是如何做到的呢？？？

反射获取参数名

熟悉SpringMVC的同学都知道，SpringMVC通过一个DispatcherServlet来分发客户端的请求，根据请求的URI映射对应的处理器Handler，将请求交给对应的Handler处理，说白了就是通过反射的方式调用Controller的方法，然后将请求的参数解析，并和方法的形参做匹配并传递过去。

要想绑定参数，首先要做的就是知晓Controller的方法需要的参数名是什么？？？

对于第一种写法，很好理解，方法想要的参数名就是@RequestParam注解的值，只需要通过反射来获取即可，如下代码：

public static void main(String[] args) throws Exception {
	Method test1 = UserController.class.getMethod("test1", String.class, Integer.class);
	for (Parameter parameter : test1.getParameters()) {
		RequestParam requestParam = parameter.getAnnotation(RequestParam.class);
		System.err.println("test1-参数名:" + requestParam.value());
	}
}
控制台输出:
test1-参数名:name
test1-参数名:age

但是对于第二种简化的写法，是无法通过反射来获取参数名称的，如下：

public static void main(String[] args) throws Exception {
	Method test2 = UserController.class.getMethod("test2", String.class, Integer.class);
	for (Parameter parameter : test2.getParameters()) {
		System.err.println("test2-参数名:"+parameter.getName());
	}
}

你们猜猜拿到的参数名是什么？？？

竟然是没有任何意义的arg0、arg1！！！

这是为什么呢？？？

熟悉JVM的同学都知道，Java代码要想在JVM里执行，首先需要通过javac命令编译成字节码Class文件，而这个编译的过程会直接将方法的参数名称丢弃，变成无意义的arg0、arg1…，因此通过反射是无法获取参数名称的。

-parameters参数

既然反射获取不到参数名是因为编译时丢弃了，那么有没有办法让javac编译时将参数名保留下来呢？？？答案是有的，那就是-parameters参数。

JDK8加入了一个新功能，编译时加上-parameters参数，即可保留参数名，通过parameter.getName()就可以获取到正常的参数名了。

示例

有如下测试类：

public class Demo {
 public void test(String name, Integer age) {
 }
}

javac Demo.java #默认的编译方式
javap -verbose Demo

javac -parameters Demo.java #加-parameters参数编译
javap -verbose Demo

可以看到，加了-parameters参数后，字节码文件会使用额外的MethodParameters区域来保存方法的参数名称。这样反射的时候通过parameter.getName()就可以获取到参数名了。

注意：只支持JDK8及以上版本！！！

-g参数

由于-parameters要求JDK至少是8版本，而SpringMVC肯定是要支持低版本JDK的，那么还有没有其他方法可以保留参数名呢？？？

答案依然是有的，那就是-g参数。

编译时，加上-g参数就是告诉编译器，我们需要调试类的信息，这时编译器在编译时，就会保留局部变量表的信息，参数也是局部变量表的一部分。

可以看到，加上-g后就可以从局部变量表中获取参数的名称了。

使用Maven来管理项目的话，编译会默认加-g参数，不需要开发者介入。

注意：虽然-g会将局部变量表的信息保存下来，但是依然无法通过反射parameter.getName()的方式来获取参数名，需要开发者去解析Class字节码文件来获取，这是和-parameters的一个重大区别！！！

ASM

ASM是一个通用的Java字节码操作和分析框架。 它可以用于修改现有类或直接以二进制形式动态生成类。 ASM提供了一些常见的字节码转换和分析算法，可以从中构建自定义复杂转换和代码分析工具。 ASM提供与其他Java字节码框架类似的功能，但专注于性能。 因为它的设计和实现尽可能小而且快，所以它非常适合在动态系统中使用（但当然也可以以静态方式使用，例如在编译器中）。

编译时加上-g参数可以将参数名保留下来，但是依然无法通过反射来获取，需要解析字节码文件自己获取。

有没有好用的工具包来帮我们解析字节码文件呢？？？

答案依然是：有的。

Java通过ASM就可以很方便的操作字节码文件，很多开源框架都用到了ASM，例如CGLIB。

下面写一个例子，通过ASM来获取方法的参数名。

1、引入依赖

<dependency>
    <groupId>asm</groupId>
    <artifactId>asm-util</artifactId>
    <version>3.3.1</version>
</dependency>

2、代码示例

public class Demo {
	public void test(String name, Integer age) {
	}
	/**
	 * 通过ASM来访问参数名
	 * @param args
	 * @throws Exception
	 */
	public static void main(String[] args) throws Exception {
		Class<Demo> clazz = Demo.class;
		Method method = clazz.getMethod("test", String.class, Integer.class);
		InputStream in = clazz.getResourceAsStream("/" + clazz.getName().replace('.', '/') + ".class");
		ClassReader cr = new ClassReader(in);
		ClassNode cn = new ClassNode();
		cr.accept(cn, ClassReader.EXPAND_FRAMES);
		List<MethodNode> methodNodes = cn.methods;
		for (MethodNode methodNode : methodNodes) {
			if (method.getName().equals(methodNode.name)) {
				System.err.println("test方法参数:");
				List<LocalVariableNode> localVariables = methodNode.localVariables;
				for (LocalVariableNode localVariable : localVariables) {
					System.err.println(localVariable.name);
				}
			}
		}
	}
}

控制台输出：

test方法参数:

this

name

age

注意：这种方式对接口和抽象方法没有用，因为抽象方法没有方法体，也就没有局部变量表。这也就是为什么MyBatis在xml中无法根据接口方法的参数名去绑定参数的原因！！！

至此，我们已经知道，Java获取方法的参数名有两种方式，分别是加-parameters参数反射获取、-g参数通过ASM解析字节码文件获取。

那SpringMVC用的是哪种呢？？？

SpringMVC的处理方式

SpringMVC是如何解决参数名称的问题的呢？是通过-parameters参数吗？？？

当然不是，首先-parameters参数是JDK8才提供的，老版本的JDK根本没这个功能，SpringMVC是要支持JDK8之前的版本的，而且这种解决方案强制要求开发者编译时手动加参数，也很不友好。

要想知道SpringMVC的解决方案，必须看源码！！！

Debug跟踪源码的过程笔者就不详叙了，感兴趣的同学可以自己去跟踪一下。

SpringMVC将一个方法处理器封装为一个HandlerMethod类，方法的参数则用MethodParameter表示：

MethodParameter有一个获取参数名的方法getParameterName()：

获取参数名的的任务其实是交给ParameterNameDiscoverer去完成了，这是一个接口，主要的作用就是解析方法的参数名称。

MethodParameter的ParameterNameDiscoverer实现类是PrioritizedParameterNameDiscoverer。

距离真相只剩一步之遥了，去看看LocalVariableTableParameterNameDiscoverer实现吧。

只要看inspectClass()方法就知道真相了。

可以看到，LocalVariableTableParameterNameDiscoverer底层就是用的ASM的技术来获取方法的参数名的。只是Spring并没有直接依赖ASM，而是将他们封装到了自己的org.springframework.asm包下。

总结

SpringMVC获取Controller方法的参数名有三种方式，如下：

方案 限制 优缺点 参数加注解 不受限 编写麻烦 -parameters JDK8及以上才支持 直接通过parameter.getName()获取，方便 -g 不受限，编译加-g参数即可 解析比较麻烦，依赖于ASM

• 如果加了@RequestParam则优先使用注解解析。
• 如果没有注解，则采用StandardReflectionParameterNameDiscoverer解析，通过Parameter.getName()反射获取，前提是JDK版本为8以上，且开启了-parameters编译参数。
• 如果前面2种都无法获取，则采用LocalVariableTableParameterNameDiscoverer通过ASM技术来解析。

注意：如果编译不加-g参数，即使是用ASM也无法解析，巧妇难为无米之炊！！！

以上为个人经验，希望能给大家一个参考，也希望大家多多支持自由互联。