HandlerMethodReturnValueHandler:对方法返回值进行处理的策略接口
/**
* 策略模式接口:处理 Controller 方法返回值
*/
public interface HandlerMethodReturnValueHandler {
/**
* 该处理程序是否支持给定的方法返回类型(只有返回true才回去调用handleReturnValue)
*/
boolean supportsReturnType(MethodParameter returnType);
/**
* 处理给定的返回值
* 通过向 ModelAndViewContainer 添加属性和设置视图或者
* 通过调用 ModelAndViewContainer.setRequestHandled(true) 来标识响应已经被直接处理(不再调用视图解析器)
*/
void handleReturnValue(Object returnValue, MethodParameter returnType,
ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception;
}
我们也可以实现自己的HandlerMethodReturnValueHandler
:
package cn.bjut.entity;
import cn.bjut.annotation.PersonAnnotation;
import org.springframework.core.MethodParameter;
import org.springframework.util.Assert;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.method.support.ModelAndViewContainer;
import javax.servlet.http.HttpServletResponse;
public class MyHandlerMethodReturnValueHandler implements HandlerMethodReturnValueHandler {
@Override
public boolean supportsReturnType(MethodParameter returnType) {
return returnType.getParameterType() == Person.class;
}
@Override
public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
Assert.isInstanceOf(Person.class, returnValue);
//标识请求是否已经在该方法内完成处理
mavContainer.setRequestHandled(true);
// 获取方法上的注解
PersonAnnotation personAnnotation = returnType.getMethodAnnotation(PersonAnnotation.class);
HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
response.setContentType("text/plain;charset=UTF-8");
Person person = (Person) returnValue;
response.getWriter().println(personAnnotation.value() + ":" + person);
}
}
Controller
package cn.bjut.controller;
import cn.bjut.annotation.PersonAnnotation;
import cn.bjut.entity.Person;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
public class DemoController {
@PersonAnnotation("person")
@RequestMapping(value = "/demo", method = RequestMethod.GET)
public Person getPerson() {
return new Person("xiya", 25);
}
}
自定义注解:
package cn.bjut.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PersonAnnotation {
String value() default "";
}
在SpringMVC添加如下配置:
<mvc:annotation-driven>
<mvc:return-value-handlers>
<bean class="cn.bjut.entity.MyHandlerMethodReturnValueHandler"/>
</mvc:return-value-handlers>
</mvc:annotation-driven>
E:\t00ls\Merry>curl http://localhost:8080/SpringMVCDemo/demo
person:Person{name='xiya', age=25}
而对于使用了@ResponseBody
注解标识的方法的处理流程大致相同:SpringMVC调用了RequestResponseBodyMethodProcessor
,而该类本身就实现了HandlerMethodReturnValueHandler
。然后调用相应的HttpMessageConverter
来处理。
@Override
public void handleReturnValue(Object returnValue, MethodParameter returnType,
ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException {
mavContainer.setRequestHandled(true);
ServletServerHttpRequest inputMessage = createInputMessage(webRequest);
ServletServerHttpResponse outputMessage = createOutputMessage(webRequest);
// Try even with null return value. ResponseBodyAdvice could get involved.
writeWithMessageConverters(returnValue, returnType, inputMessage, outputMessage);
}