关于一些Spring MVC控制器的参数注解总结

昨天同事问我控制器参数的注解的问题，我好久没那样写过，把参数和url一起设置，不过，今天我看了一些文章，查了一些资料，我尽可能的用我自己的理解方式来解释它吧！

[email protected]绑定单个请求参数值

@RequestParam用于将请求参数区数据映射到功能处理方法的参数上。

[java] view plain copy
public String requestparam1(@RequestParam String username)

请求中包含username参数（如/requestparam1?username=zhang），则自动传入。

此处要特别注意：右击项目，选择“属性”，打开“属性对话框”，选择“Java Compiler”然后再打开的选项卡将“Add variable attributes to generated class files”取消勾选，意思是不将局部变量信息添加到类文件中，如图6-12所示：

图6-12

当你在浏览器输入URL，如“requestparam1?username=123”时会报如下错误

Name for argument type [java.lang.String] not available, and parameter name information not found in class file either，表示得不到功能处理方法的参数名，此时我们需要如下方法进行入参：

[java] view plain copy
public String requestparam2(@RequestParam("username") String username)  

即通过@RequestParam("username")明确告诉Spring Web MVC使用username进行入参。

@RequestParam注解主要有哪些参数：

value：参数名字，即入参的请求参数名字，如username表示请求的参数区中的名字为username的参数的值将传入；

required：是否必须，默认是true，表示请求中一定要有相应的参数，否则将报404错误码；

defaultValue：默认值，表示如果请求中没有同名参数时的默认值，默认值可以是SpEL表达式，如“#{systemProperties[‘java.vm.version‘]}”。

[java] view plain copy
public String requestparam4(@RequestParam(value="username",required=false) String username)

表示请求中可以没有名字为username的参数，如果没有默认为null，此处需要注意如下几点：

原子类型：必须有值，否则抛出异常，如果允许空值请使用包装类代替。

Boolean包装类型类型：默认Boolean.FALSE，其他引用类型默认为null。

[java] view plain copy
public String requestparam5(
@RequestParam(value="username", required=true, defaultValue="zhang") String username)

　　表示如果请求中没有名字为username的参数，默认值为“zhang”。

如果请求中有多个同名的应该如何接收呢？如给用户授权时，可能授予多个权限，首先看下如下代码：

[java] view plain copy
public String requestparam7(@RequestParam(value="role") String roleList)

　　如果请求参数类似于url?role=admin&rule=user，则实际roleList参数入参的数据为“admin,user”，即多个数据之间使用“，”分割；我们应该使用如下方式来接收多个请求参数：

public String requestparam7(@RequestParam(value="role") String[] roleList)

　　或

public String requestparam8(@RequestParam(value="list") List<String> list)

[email protected]绑定URI模板变量值

@PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上。

1 @RequestMapping(value="/users/{userId}/topics/{topicId}")
2 public String test(
3        @PathVariable(value="userId") int userId,
4        @PathVariable(value="topicId") int topicId) 

如请求的URL为“控制器URL/users/123/topics/456”，则自动将URL中模板变量{userId}和{topicId}绑定到通过@PathVariable注解的同名参数上，即入参后userId=123、topicId=456

所以，关于控制器参数，先介绍这么多。