Springboot使用参数解析器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;
}
  1. supportsParameter 方法

    • 该方法用于判断当前解析器是否支持给定的方法参数。
    • 如果返回 true,表示该解析器可以解析参数,否则返回 false
  2. 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接口测试

  • 16
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

山河亦问安

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值