广告
返回顶部
首页 > 资讯 > 后端开发 > Python >自定义@RequestBody注解如何获取JSON数据
  • 282
分享到

自定义@RequestBody注解如何获取JSON数据

Python 官方文档:入门教程 => 点击学习

摘要

目录自定义注解自定义解析器包装请求注册解析器用法总结spring mvc 的 @RequestBody 注解只能将请求体中的 JSON 数据封装成 Bean,而无法对单一字段实施管理

spring mvc 的 @RequestBody 注解只能将请求体中的 JSON 数据封装成 Bean,而无法对单一字段实施管理(例如 required、name 等属性),这篇文章记录了我的自定义注解 @jsonArg。

自定义注解

首先思考,我们需要这个注解做什么?

  • 设置该字段的必选性(required)
  • 设置该字段在请求体 JSON 中的 key 值(name、value)
  • 设置该字段的默认值(defaultValue)

于是我们的注解类 @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文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • 自定义@RequestBody注解如何获取JSON数据
    目录自定义注解自定义解析器包装请求注册解析器用法总结Spring MVC 的 @RequestBody 注解只能将请求体中的 JSON 数据封装成 Bean,而无法对单一字段实施管理...
    99+
    2023-05-15
    自定义@RequestBody注解 @RequestBody注解 @RequestBody注解获取JSON数据
  • 怎么自定义@RequestBody注解获取JSON数据
    这篇文章主要介绍“怎么自定义@RequestBody注解获取JSON数据”,在日常操作中,相信很多人在怎么自定义@RequestBody注解获取JSON数据问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”怎么自...
    99+
    2023-07-06
  • Spring spel获取自定义注解参数值方式
    目录spel获取自定义注解参数值1.注解类2.注解使用3.aop中处理 spel在注解中的使用1 语法说明2. 基本用法4 #{…}和${…}s...
    99+
    2022-11-13
  • 怎么用Spring的spel获取自定义注解参数值
    这篇文章主要介绍了怎么用Spring的spel获取自定义注解参数值的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇怎么用Spring的spel获取自定义注解参数值文章都会有所收获,下面我们一起来看看吧。spel获...
    99+
    2023-06-29
  • vue如何获取自定义属性
    在vue中获取自定义属性的方法:1.新建vue.js项目;2.自定义button标签;3.执行代码获取标签属性;具体步骤如下:首先,在vue-cli中创建一个vue.js项目;vue create project-namevue.js项目创...
    99+
    2022-10-05
  • springboot如何获取yml文件的自定义参数
    目录如何获取yml的自定义参数需求实现方式自定义yml文件,获取配置参数操作yml文件依赖mqtt链接参数,及读取yml文件工具MqttParams.yml 文件位置 如何...
    99+
    2022-11-13
  • Spring如何自定义注解
    这篇文章将为大家详细讲解有关Spring如何自定义注解,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。字段注解字段注解一般是用于校验字段是否满足要求,hibernate-validate依赖就提供了很多校验...
    99+
    2023-06-15
  • request如何获取body的json数据
    在request中可以获取到来自Http请求的body数据 比如获取json格式数据 代码: import com.alibaba.dubbo.common.utils.IOU...
    99+
    2022-11-12
  • 如何获取json数组里的数据
    要获取JSON数组中的数据,可以使用不同的方法,具体取决于您使用的编程语言和框架。以下是使用一些常见编程语言和框架的示例:在Java...
    99+
    2023-08-15
    json
  • Nginx如何获取自定义请求header头和URL参数详解
    目录一、获取 header 请求头二、获取url参数总结一、获取 header 请求头 在 ngx_lua 中访问 Nginx 内置变量 ngx.var.http_HEADER 即可...
    99+
    2022-11-13
  • 如何获取div的自定义属性值
    小编给大家分享一下如何获取div的自定义属性值,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!举例:<div goods-h...
    99+
    2022-10-19
  • SpringBoot如何获取application.properties中自定义的值
    目录结构: pom文件: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="htt...
    99+
    2022-11-12
  • Android应用中如何解析获取的json数据
    这篇文章将为大家详细讲解有关Android应用中如何解析获取的json数据,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。根据指定的URL从google 服务器上获得包含地址的json格式的数...
    99+
    2023-05-31
    android roi json
  • php如何获取数据转json数据格式
    小编给大家分享一下php如何获取数据转json数据格式,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!php获取数据转json数据格式的方法:首先连接数据库;然后执行“mysql_query($sql);”;最后通过“jso...
    99+
    2023-06-20
  • ajax如何获取json数据并显示
    使用Ajax可以通过发送HTTP请求获取JSON数据,然后将数据显示在网页上。以下是一个使用Ajax获取JSON数据并显示的示例:`...
    99+
    2023-09-13
    ajax json
  • 小程序如何获取第三方平台自定义的数据字段
    本文将为大家详细介绍“小程序如何获取第三方平台自定义的数据字段”,内容步骤清晰详细,细节处理妥当,而小编每天都会更新不同的知识点,希望这篇“小程序如何获取第三方平台自定义的数据字段”能够给你意想不到的收获,请大家跟着小编的思路慢慢深入,具体...
    99+
    2023-06-26
  • 如何在Java中自定义注解
    这篇文章给大家介绍如何在Java中自定义注解,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。一、自定义注解格式分析 Java 中自带的 @Override 注解 , 源码如下 :@Target(ElementType.M...
    99+
    2023-06-15
  • ajax跨域如何获取网站json数据
    这篇文章主要介绍了ajax跨域如何获取网站json数据,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。由于自己的公司的项目需要调用视频地址当为链接时:直接在播放器用数据库查找的...
    99+
    2023-06-08
  • 如何使用Java获取Json中的数据
    这篇文章主要介绍“如何使用Java获取Json中的数据”,在日常操作中,相信很多人在如何使用Java获取Json中的数据问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”如何使用Java获取Json中的数据”的疑...
    99+
    2023-07-06
  • Springboot如何通过自定义工具类获取bean
    目录Springboot 自定义工具类获取bean在工具类注入bean的三种方式1. 需求/目的2.使用环境3.方法一:获取ApplicationContext上下文4.方法二:将工...
    99+
    2022-11-12
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作