Springboot使用参数解析器HandlerMethodArgumentResolver,解析请求头里的数据

简介: HandlerMethodArgumentResolver 是 Spring MVC 中的一个接口,它允许你自定义方法参数的解析过程。当处理请求时,Spring MVC 需要将请求中的信息映射到控制器方法的参数上,而 HandlerMethodArgumentResolver 允许你在这个过程中进行自定义操作。

HandlerMethodArgumentResolver 是 Spring MVC 中的一个接口,它允许你自定义方法参数的解析过程。当处理请求时,Spring MVC 需要将请求中的信息映射到控制器方法的参数上,而 HandlerMethodArgumentResolver 允许你在这个过程中进行自定义操作。


以下是关于 HandlerMethodArgumentResolver 的详细介绍:


接口定义:

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter parameter);
    Object resolveArgument(MethodParameter parameter,
                           ModelAndViewContainer mavContainer,
                           NativeWebRequest webRequest,
                           WebDataBinderFactory binderFactory) throws Exception;
}


supportsParameter 方法:


该方法用于判断当前解析器是否支持给定的方法参数。

如果返回 true,表示该解析器可以解析参数,否则返回 false。

resolveArgument 方法:


当 supportsParameter 返回 true 时,该方法将被调用,用于实际解析方法参数的值。

它接收四个参数:

MethodParameter:表示要解析的方法参数。

ModelAndViewContainer:用于存储视图和模型数据的容器。

NativeWebRequest:封装了底层的 ServletRequest 和 ServletResponse。

WebDataBinderFactory:用于创建 WebDataBinder 实例的工厂。

使用场景:

自定义解析器通常用于从请求中提取数据,将其转换为控制器方法参数所需的类型。

常见的应用包括从请求头、Cookie、路径变量或请求参数中提取信息,以便在控制器方法中使用。


代码示例:


每次请求,获取请求头中的token信息,根据token自动获取用户User对象,以便在控制器方法中使用。


代码如下:


Token注解


@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Token {
    String value() default "";
}


User类


@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
@Builder
public class User {
    private Long userId;
    private String username;
    private String passworld;
    private String token;
}


TokenMethodArgumentResolver类


@Component
public class TokenMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(Token.class)?true:false;
    }
    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
       if(parameter.getParameterAnnotation(Token.class) instanceof Token){
           String token = webRequest.getHeader("token");
           //解析token,获取useId,从数据库获缓存中获取用户User对象,这里模拟,这里简单写一下
           Long userId= 1L;
           User user = User.builder()
                   .userId(userId)
                   .username("admin")
                   .passworld("123456")
                   .token(token)
                   .build();
           return user;
       }
       return null;
    }
}



TokenWebMvcConfigurer配置类


@Configuration
public class TokenWebMvcConfigurer extends WebMvcConfigurationSupport {
    @Autowired
    TokenMethodArgumentResolver tokenMethodArgumentResolver;
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(tokenMethodArgumentResolver);
    }


   //这段代码的作用是告诉 Spring MVC 如何处理以 "/swagger-ui/" 开头的请求路径,将其映射到 Swagger UI 的静态资源。这通常用于在应用中集成 Swagger,以便查看和测试 API 文档。

@Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.
                addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
                .resourceChain(false);
    }
}

 

控制层


@RestController
public class TestController {
    @GetMapping("/user/find")
    public User find(@Token User user){
        return user;
    }
}


ApiPost接口测试


相关文章
|
2天前
|
JSON Java 数据格式
Spring Boot实现各种参数校验
这些是Spring Boot中实现参数校验的一些常见方法,你可以根据项目需求选择适合的方式来进行参数校验。
10 0
|
13天前
|
Java 数据库连接 Spring
Spring Boot命令行启动添加参数
Spring Boot命令行启动添加参数
|
13天前
|
缓存 前端开发 Java
SpringBoot启动后加载初始化数据
SpringBoot启动后加载初始化数据
|
28天前
|
机器学习/深度学习 算法 编译器
【C++ 泛型编程 中级篇】深度解析C++:类型模板参数与非类型模板参数
【C++ 泛型编程 中级篇】深度解析C++:类型模板参数与非类型模板参数
47 0
|
1月前
|
XML Java 数据库连接
spring boot 参数的过滤注解与实战
在Spring Boot应用中,对于入参的过滤,通常会涉及到对Web层的数据验证和处理。Spring Boot借助Spring框架提供了强大的验证框架支持,主要基于JSR-303/JSR-380(Bean Validation API)规范,以及Spring自身的@Valid或@Validated注解来实现请求参数的验证。以下是一些常见的使用案例来展示如何对参数进行过滤和验证。
28 1
|
1月前
|
安全 JavaScript 前端开发
若依实现单点登录(解析请求链接中的参数做鉴权认证)
若依实现单点登录(解析请求链接中的参数做鉴权认证)
17 0
|
1月前
|
JSON JavaScript 前端开发
解决js中Long类型数据在请求与响应过程精度丢失问题(springboot项目中)
解决js中Long类型数据在请求与响应过程精度丢失问题(springboot项目中)
33 0
|
1月前
argparse的基本使用--参数解析
argparse的基本使用--参数解析
28 0

推荐镜像

更多