背景
在web程序中,一个HTTP请求进来时,会被容器处理进而转换成一个servlet请求。http请求所携带的数据,虽然是格式化的但是无类型;而java作为强类型语言,同时为了健壮性考虑,必然要有完善的类型约束。那么,将数据从servlet请求中转换到java中,一个很原始的方式是手动处理。幸好,Spring MVC通过以注解往函数添加额外信息的方式,使得上述的数据转换过程能够交由框架自动处理。从一个角度去看,Controller中的函数声明及注解定义了此HTTP请求的数据格式和类型,也即规定了对外部暴露的以http协议展现的接口。不过,有些时候内置注解无法满足需求的情况。这个时候,就需要自定义自己的注解以声明参数的格式。
一、自定义注解
现在假设我们需要自定义一种数据,叫做userId。当一个http请求进入时,我们期望的效果是框架从session取数据,并且放入到controller对应的参数中。现在,定义了一个叫做UserId的注解:
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface UserId {
boolean required() default true;
}
ElementType.PARAMETER
可以看出,这个注解是用于修饰参数的。二、参数解析器
首先看位于HandlerMethodArgumentResolver.java
的这个接口。通过实现这个接口的类,就是解析器。按照我们的期望,它中间的函数应该能得到必要信息,从而按照自定义逻辑计算并返回一个值。
public interface HandlerMethodArgumentResolver {
boolean supportsParameter(MethodParameter parameter);
Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception;
}
MethodParameter
是spring对被注解修饰过参数的包装,从其中能拿到参数的反射相关信息。supportsParameter
传入一个参数,用以判断此参数是否能够使用该解析器。resolveArgument
就是之前讨论的解析函数,传入必要信息,计算并返回一个值。MethodParameter
传入supportsParameter
测试是否能够被处理,如果能够,就使用resolveArgument
处理。public class UserIdArgumentResolver implements HandlerMethodArgumentResolver {
public static final String SESSION_USER_CLIENT_ID = "_session_user_clientId";
@Getter
@Setter
private String noLoginMessage = "未登录!";
@Override
public boolean supportsParameter(MethodParameter parameter) {
return parameter.hasParameterAnnotation(UserId.class);
}
@Override
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) throws Exception {
Annotation[] annotations = parameter.getParameterAnnotations();
// 逐一处理
for (Annotation annotation : annotations) {
// userId
if (annotation instanceof UserId) {
return resolveUserId((UserId) annotation, parameter, mavContainer, webRequest, binderFactory);
}
}
return null;
}
private Object resolveUserId(ClientId annotation, MethodParameter parameter, ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) {
Object attribute = webRequest.getAttribute(SESSION_USER_CLIENT_ID, RequestAttributes.SCOPE_SESSION);
if (attribute == null && annotation.required()) {
throw new NoLoginException(noLoginMessage);
}
return attribute;
}
}
supportsParameter
的实现可以看出,只有被@UserId
注解修饰的参数才能被此解析器处理。@UserId
修饰,就会由resolveArgument
计算出参数的值。从resolveArgument
的实现看出,它从session
中取数据作为参数的值。这个NativeWebRequest
是一个关键点,看名字像是能拿到http请求的数据,粗略查询资料可知道,可从中拿到HttpServletRequest
:
HttpServletRequest request = nativeWebRequest.getNativeRequest(HttpServletRequest.class);
三、注册解析器
最后,该把我们的解析器设置到spring MVC中去了:
@Configuration
public class WebConfig {
@Bean
public WebMvcConfigurer webMvcConfigurer() {
return new WebMvcConfigurerAdapter() {
@Override
public void addArgumentResolvers(List argumentResolvers) {
argumentResolvers.add(new UserIdArgumentResolver());
}
};
}
}
通过定义WebMvcConfigurer
这个Bean能够自定义配置。看起来像是会把默认配置覆盖似的,不过实际上只是会和默认配置合并,大胆使用。最后,我们就能使用@UserId了
:
@RequestMapping(value = "/api/user", method = RequestMethod.POST)
@ResponseBody
public ResponseDTO user(@UserId String userId) {
return new ResponseDTO(new User());
}