❤️SpringMVC成神之路之二十七、RequestAttribute详解
本文将介绍SpringMVC中的@RequestAttribute注解。
1、预备知识
2、@RequestAttribute注解
2.1、作用
用来标注在接口的参数上，参数的值来源于request作用域。
2.2、用法
如下代码，site参数上使用了@RequestAttribute("site")注解，site参数的值等于request.getAttribute("site")
@ResponseBody
public String test2(@RequestAttribute("site") String site) {
return site;
}
这个注解的源码如下
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestAttribute {
/**
* 指定request作用域中属性的名称
*/
@AliasFor("name")
String value() default "";
/**
* 同value属性
*/
@AliasFor("value")
String name() default "";
/**
* 属性是不是必须的，如果是true，request中没有取到时，则会抛出异常
* 此时可以将required设置为false，或者使用java8中的Option类型来修饰参数解决
*/
boolean required() default true;
}
3、案例
下面代码中有2个接口方法
- 第一个方法test1中向request域中丢了一个site属性，然后进行了跳转，跳转到第二个方法，最后将site作为响应体输出
- 第二个方的site参数上标注了
@RequestAttribute("site")，所以会拿到request中site的值，然后输出
package com.javacode2018.springmvc.chat18.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
@Controller
public class RequestAttributeController {
@RequestMapping("/requestattribute/test1")
public String test1(HttpServletRequest request) {
request.setAttribute("site",
"<a href='http://www.itsoku.com'>路人博客，包含了所有系列文章，阅读更方便</a>");
return "forward:/requestattribute/test2";
}
@RequestMapping(value = "/requestattribute/test2", produces = "text/html;charset=UTF-8")
@ResponseBody
public String test2(@RequestAttribute("site") String site) {
return site;
}
}
浏览器中访问第一个接口/requestattribute/test1，输出如下
若我们调整一下接口1中代码，将site的值置为空
request.setAttribute("site", null);
此时再次访问接口会报400错误，原因：request域中没有找到site这个属性对应的值，即request.getAttribute(“site”)为null
2种解决方案
- 方案1：将@RequestAttribute的required属性设置为false，常用这种方式
- 方案2：将@RequestAttribute标注的参数类型调整为java8中的java.util.Optional类型，上面的接口2的site参数类型可以调整为
Optional类型，即可解决问题
4、@RequestAttribute注解原理
@RequestAttribute注解标注的参数的值来源于org.springframework.web.servlet.mvc.method.annotation.RequestAttributeMethodArgumentResolver解析器，源码
public class RequestAttributeMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
@Override
public boolean supportsParameter(MethodParameter parameter) {
return parameter.hasParameterAnnotation(RequestAttribute.class);
}
@Override
protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) {
RequestAttribute ann = parameter.getParameterAnnotation(RequestAttribute.class);
Assert.state(ann != null, "No RequestAttribute annotation");
return new NamedValueInfo(ann.name(), ann.required(), ValueConstants.DEFAULT_NONE);
}
@Override
@Nullable
protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest request){
return request.getAttribute(name, RequestAttributes.SCOPE_REQUEST);
}
@Override
protected void handleMissingValue(String name, MethodParameter parameter) throws ServletException {
throw new ServletRequestBindingException("Missing request attribute '" + name +
"' of type " + parameter.getNestedParameterType().getSimpleName());
}
}
5、案例代码git地址
https://gitee.com/javacode2018/springmvc-series
所有系列文章的均在此仓库中。
来源：http://www.itsoku.com/course/6/238