Python 官方文档:入门教程 => 点击学习
目录自定义注解自定义解析器包装请求注册解析器用法总结spring mvc 的 @RequestBody 注解只能将请求体中的 JSON 数据封装成 Bean,而无法对单一字段实施管理
spring mvc 的 @RequestBody 注解只能将请求体中的 JSON 数据封装成 Bean,而无法对单一字段实施管理(例如 required、name 等属性),这篇文章记录了我的自定义注解 @jsonArg。
首先思考,我们需要这个注解做什么?
于是我们的注解类 @JsonArg 至少应该长这样:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface JsonArg {
@AliasFor("name")
String value() default "";
@AliasFor("value")
String name() default "";
boolean required() default true;
String defaultValue() default ValueConstants.DEFAULT_NONE;
}
其中:
@Retention(RetentionPolicy.RUNTIME)
声明我们需要在运行期动态地获取它地信息@Target(ElementType.PARAMETER)
声明这个注解只能作用在方法参数是的,它和 Spring MVC 自带的 @RequestParam 注解非常像,但 @RequestParam 只能作用于 query parameters 和 fORM data。
单纯的定义注解类程序是无法知道我们要它做什么的,所以我们要告诉程序在遇到这个注解时该做什么。
public class JsonArgMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
@Override
protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) {
JsonArg ann = parameter.getParameterAnnotation(JsonArg.class);
return (ann != null ? new JsonArgNamedValueInfo(ann) : new JsonArgNamedValueInfo());
}
@Override
protected Object resolveName(String name, MethodParameter parameter, NativeWEBRequest request) throws Exception {
ContentCachingRequestWrapper contentCachingRequestWrapper = request.getNativeRequest(ContentCachingRequestWrapper.class);
String body;
assert contentCachingRequestWrapper != null;
byte[] contentAsByteArray = contentCachingRequestWrapper.getContentAsByteArray();
if (contentAsByteArray.length == 0) {
try (BufferedReader reader = contentCachingRequestWrapper.getReader()) {
body = reader.lines().collect(Collectors.joining(""));
}
} else {
body = new String(contentAsByteArray);
}
return JSONObject.parseObject(body).get(name);
}
@Override
public boolean supportsParameter(MethodParameter parameter) {
return true;
}
private static class JsonArgNamedValueInfo extends NamedValueInfo {
public JsonArgNamedValueInfo() {
super("", false, ValueConstants.DEFAULT_NONE);
}
public JsonArgNamedValueInfo(JsonArg annotation) {
super(annotation.name(), annotation.required(), annotation.defaultValue());
}
}
}
注意到在 resolveName() 方法中我们获取的 request 类型是 ContentCachingRequestWrapper。
这是因为默认的 request 只能读取一次请求体,而我们的解析器在解析每个方法参数时都需要读取一次请求体。
添加过滤器将我们的请求转换为所需要的 ContentCachingRequestWrapper。
@Component
public class CachingRequestBodyFilter extends GenericFilterBean {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
if (servletRequest instanceof httpservletRequest) {
filterChain.doFilter(new ContentCachingRequestWrapper((HttpServletRequest) servletRequest), servletResponse);
} else {
filterChain.doFilter(servletRequest, servletResponse);
}
}
}
最后,将自定义的解析器注册到 Spring MVC。
@Configuration
public class springMVCConfig implements WebMvcConfigurer {
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
resolvers.add(new JsonArgMethodArgumentResolver());
}
}
和 @RequestParam 的用法相似。
public CommonResult<Object> signUp(
@JsonArg(name = "uname") String username,
@JsonArg(required = false, name = "pwd", defaultValue = "123") String passWord
) {
log.info("[Username]: {}, [Password]: {}", username, password);
return null;
}
大功告成!
以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。
--结束END--
本文标题: 自定义@RequestBody注解如何获取JSON数据
本文链接: https://www.lsjlt.com/news/208555.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
下载Word文档到电脑,方便收藏和打印~
2024-03-01
2024-03-01
2024-03-01
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
0