2021-02-07

jackson学习之九:springboot整合(配置文件)

欢迎访问我的GitHub

这里分类和汇总了欣宸的全部原创(含配套源码):https://github.com/zq2599/blog_demos

系列文章汇总

  • jackson学习之一:基本信息
  • jackson学习之二:jackson-core
  • jackson学习之三:常用API操作
  • jackson学习之四:WRAP_ROOT_VALUE(root对象)
  • jackson学习之五:JsonInclude注解
  • jackson学习之六:常用类注解
  • jackson学习之七:常用Field注解
  • jackson学习之八:常用方法注解
  • jackson学习之九:springboot整合(配置文件)
  • jackson学习之十(终篇):springboot整合(配置类)

关于springboot整合jackson

  • 本文是《jackson学习》系列的第九篇,学习如何在springboot项目中使用jackson,以springboot-2.3.3版本为例,jackson是springboot的默认json处理工具,如下图红框所示,jackson在maven配置中被spring-boot-starter-web间接依赖,可直接使用:

在这里插入图片描述

  • 在springboot项目中常用的配置方式有两种:
  1. 用properties或yml配置文件来配置,即本篇的内容;
  2. 用配置类来配置,这是下一篇文章的主题;

本篇概览

今天实战内容如下:

  1. 开发springboot应用,体验springboot默认支持jackson,包括jackson注解和ObjectMapper实例的注入;
  2. 在application.yml中添加jackson配置,验证是否生效;

源码下载

  1. 如果您不想编码,可以在GitHub下载所有源码,地址和链接信息如下表所示(https://github.com/zq2599/blog_demos):
名称链接备注
项目主页https://github.com/zq2599/blog_demos该项目在GitHub上的主页
git仓库地址(https)https://github.com/zq2599/blog_demos.git该项目源码的仓库地址,https协议
git仓库地址(ssh)git@github.com:zq2599/blog_demos.git该项目源码的仓库地址,ssh协议
  1. 这个git项目中有多个文件夹,本章的应用在jacksondemo文件夹下,如下图红框所示:

在这里插入图片描述

  1. jacksondemo是父子结构的工程,本篇的代码在springbootproperties子工程中,如下图:

在这里插入图片描述

开始实战

  1. 由于同属于《jackson学习》系列文章,因此本篇的springboot工程作为jacksondemo的子工程存在,pom.
<?
  1. 启动类很平常:
package com.bolingcavalry.springbootproperties;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic class SpringbootpropertiesApplication { public static void main(String[] args) {  SpringApplication.run(SpringbootpropertiesApplication.class, args); }}
  1. 由于用到了swagger,因此要添加swagger配置:
package com.bolingcavalry.springbootproperties;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Contact;import springfox.documentation.service.Tag;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig { @Bean public Docket createRestApi() {  return new Docket(DocumentationType.SWAGGER_2)    .apiInfo(apiInfo())    .tags(new Tag("JsonPropertySerializationController", "JsonProperty相关测试"))    .select()    // 当前包路径    .apis(RequestHandlerSelectors.basePackage("com.bolingcavalry.springbootproperties.controller"))    .paths(PathSelectors.any())    .build(); } //构建 api文档的详细信息函数,注意这里的注解引用的是哪个 private ApiInfo apiInfo() {  return new ApiInfoBuilder()    //页面标题    .title("SpringBoot整合Jackson(基于配置文件)")    //创建人    .contact(new Contact("程序员欣宸", "https://github.com/zq2599/blog_demos", "zq2599@gmail.com"))    //版本号    .version("1.0")    //描述    .description("API 描述")    .build(); }}
  1. 序列化和反序列化用到的Bean类,可见使用了JsonProperty属性来设置序列化和反序列化时的json属性名,field0字段刻意没有get方法,是为了验证JsonProperty的序列化能力:
package com.bolingcavalry.springbootproperties.bean;import com.faster
  1. 测试用的Controller代码如下,很简单只有两个接口,serialization返回序列化结果,deserialization接受客户端请求参数,反序列化成实例,通过toString()来检查反序列化的结果,另外,还通过Autowired注解从spring容器中将ObjectMapper实例直接拿来用:
package com.bolingcavalry.springbootproperties.controller;import com.bolingcavalry.springbootproperties.bean.Test;import com.faster

验证(不用配置文件)

  1. 先来看看没有配置文件时,默认的jackson配置的表现,直接在IDEA上运行SpringbootpropertiesApplication;
  2. 浏览器访 ,如下图红框1,json_field0和json_field1都是JsonProperty注释,出现在了swagger的model中,这证明jackson注解已经生效:

在这里插入图片描述

  1. 点击上图的红框2,看看springboot引用返回的序列化结果,如下图:

在这里插入图片描述

  1. 另外,上述红框中的json格式,每个属性单独一行,像是做了格式化调整的,这是springboot做的?还是swagger展示的时候做的?用浏览器访 ,结果如下,可见springboot返回的是未经过格式化的json:

在这里插入图片描述

  • 接下来咱们添加jackson相关的配置信息并验证是否生效;

添加配置文件并验证

  1. 在resources目录新增application.yml文件,内容如下:
spring: jackson: # 日期格式化 date-format: yyyy-MM-dd HH:mm:ss # 序列化相关 serialization:  # 格式化输出  indent_output: true  # 忽略无法转换的对象  fail_on_empty_beans: true # 反序列化相关 deserialization:  # 解析json时,遇到不存在的属性就忽略  fail_on_unknown_properties: false # 设置空如何序列化 defaultPropertyInclusion: NON_EMPTY parser:  # 允许特殊和转义符  allow_unquoted_control_chars: true  # 允许单引号  allow_single_quotes: true
  1. 将鼠标放置下图红框位置,再按住Ctlr键,IDEA会弹出一个浮层,提示该配置对应的jackson代码,如下图:

在这里插入图片描述

  1. 在上图中,按住Ctlr键,用鼠标点击红框位置即可打开此配置对应的jackson源码,如下图:

在这里插入图片描述
4. 重新运行springboot应用,用浏览器访问 ,结果如下图,可见json_field0的格式变成了yyyy-MM-dd HH:mm:ss,而且json输出也做了格式化,证明application.yml中的配置已经生效:

在这里插入图片描述
5. 再来试试反序列化,打开swagger页面,操作和响应如下图所示,注意红框1里面请求参数的格式:

在这里插入图片描述

  • 至此,在springboot中通过yml配置jackson的操作实战就完成了,接下来的章节,咱们在配置类中用代码来完成yml的配置;

你不孤单,欣宸原创一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 数据库+中间件系列
  6. DevOps系列

欢迎关注公众号:程序员欣宸

微信搜索「程序员欣宸」,我是欣宸,期待与您一同畅游Java世界...
https://github.com/zq2599/blog_demos









原文转载:http://www.shaoqun.com/a/534564.html

跨境电商:https://www.ikjzd.com/

easel:https://www.ikjzd.com/w/1721

mail.ru:https://www.ikjzd.com/w/2232


欢迎访问我的GitHub这里分类和汇总了欣宸的全部原创(含配套源码):https://github.com/zq2599/blog_demos系列文章汇总jackson学习之一:基本信息jackson学习之二:jackson-corejackson学习之三:常用API操作jackson学习之四:WRAP_ROOT_VALUE(root对象)jackson学习之五:JsonInclude注解jack
002315焦点科技:002315焦点科技
skyee:skyee
收藏 | 如何利用售后卡一周增评上千条?:收藏 | 如何利用售后卡一周增评上千条?
为什么我们要开通Shopee海外仓服务?:为什么我们要开通Shopee海外仓服务?
运营干货 | 制作设计亚马逊A+页面详细步骤:运营干货 | 制作设计亚马逊A+页面详细步骤

No comments:

Post a Comment