百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

SpringBoot + Jackson 实现自动化配置

lipiwang 2024-11-17 13:27 35 浏览 0 评论

SpringBoot 是一个用于简化 Spring 应用开发的框架,它提供了许多开箱即用的功能,使开发者可以快速构建和部署应用。Jackson 是一个流行的 Java 序列化/反序列化库,广泛用于将 Java 对象转换为 JSON 格式,反之亦然。在 SpringBoot 中,Jackson 的配置和使用非常简单,因为 SpringBoot 提供了许多自动化配置的支持。

本文将详细介绍如何在 SpringBoot 中使用 Jackson 进行自动化配置,并通过示例代码展示如何实现。

SpringBoot 和 Jackson 自动化配置的原理

SpringBoot提供了一种自动配置机制,可以自动检测类路径下的库,并基于这些库的存在来进行相应的配置。当 SpringBoot 检测到 Jackson 库在类路径下时,它会自动配置 Jackson 的相关 beans,使其能够与 Spring MVC 集成。

以下是 SpringBoot 自动配置 Jackson 的几个关键点:

  • ObjectMapper:这是 Jackson 中的核心类,用于执行序列化和反序列化操作。SpringBoot 会自动配置一个默认的 ObjectMapper 实例。
  • MessageConverters:Spring MVC 使用消息转换器将 HTTP 请求和响应转换为对象。SpringBoot会自动注册Jackson的消息转换器 MappingJackson2HttpMessageConverter。
  • 全局配置:可以通过配置文件(如application.properties或application.yml)来定制 Jackson 的行为。

项目依赖

首先,我们需要在pom.xml文件中添加必要的依赖。SpringBoot和Jackson 的依赖可以通过以下方式添加:

<dependencies>
    <!-- Spring Boot Starter Web 包含了 Spring MVC 和 Jackson 的依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- 其他必要的依赖 -->
</dependencies>

自动配置示例

我们将通过一个简单的示例来展示如何使用 Jackson 和 SpringBoot 进行自动化配置。假设我们有一个简单的 RESTful 服务,它返回一个 User 对象的 JSON 表示。

创建 User 类

package com.example.demo;
public class User {
    private String name;
    private int age;
    public User() {}
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
    // Getters and Setters
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

创建 UserController 类

package com.example.demo;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
    @GetMapping("/user")
    public User getUser() {
        return new User("John Doe", 30);
    }
}

启动应用

package com.example.demo;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication
public class DemoApplication {


    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

以上代码展示了一个基本的SpringBoot应用,它包含一个RESTful接口/user,返回一个User对象的JSON表示。

Jackson 配置定制

在默认配置的基础上,我们可以通过以下几种方式来自定义 Jackson 的行为。

在配置文件中配置

我们可以在 application.properties 或 application.yml 文件中添加 Jackson 的配置。例如,设置序列化时忽略空属性:

spring.jackson.default-property-inclusion=non_null

自定义 ObjectMapper

有时候,我们需要对 ObjectMapper 进行更细粒度的配置。可以通过以下方式在 Spring 配置中自定义 ObjectMapper:

package com.example.demo;


import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Configuration
public class JacksonConfig {


    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.enable(SerializationFeature.INDENT_OUTPUT); // 美化输出
        return objectMapper;
    }
}

自定义 MessageConverters

如果需要完全控制消息转换器,可以通过配置自定义 HttpMessageConverters:

package com.example.demo;


import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;


import java.util.List;


@Configuration
public class WebConfig implements WebMvcConfigurer {


    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new MappingJackson2HttpMessageConverter());
    }
}

使用 Jackson 注解

Jackson 提供了丰富的注解来控制序列化和反序列化的行为。以下是一些常用的注解示例:

  • @JsonIgnore:忽略某个字段。
package com.example.demo;


import com.fasterxml.jackson.annotation.JsonIgnore;


public class User {
    private String name;
    private int age;


    @JsonIgnore
    private String password;


    // Constructors, Getters, and Setters
}
  • @JsonProperty:重命名字段。
package com.example.demo;


import com.fasterxml.jackson.annotation.JsonProperty;


public class User {
    @JsonProperty("full_name")
    private String name;
    private int age;


    // Constructors, Getters, and Setters
}
  • @JsonInclude:根据条件包含字段。
package com.example.demo;


import com.fasterxml.jackson.annotation.JsonInclude;


@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
    private String name;
    private Integer age;


    // Constructors, Getters, and Setters
}

结论

在SpringBoot中使用Jackson进行自动化配置非常简单且灵活。通过 SpringBoot提供的自动配置机制,开发者可以快速集成Jackson并进行自定义配置。通过示例代码,我们展示了如何在SpringBoot应用中配置和使用 Jackson,以及如何通过注解来控制 JSON 序列化和反序列化的行为。

相关推荐

一个简单便捷搭建个人知识库的开源项目(MDwiki)

这里我通过自动翻译软件,搬运总结MDwiki官网的部署和使用方法。第一步:下载编译好的后MDwiki文件,只有一个HTML文件“mdwiki.html”。第二步:在mdwiki.html同级目录创建“...

强大、简洁、快速、持续更新 PandaWiki新一代 AI 驱动的开源知识库

PandaWiki是什么PandaWiki是一款AI大模型驱动的开源知识库搭建系统,帮助你快速构建智能化的产品文档、技术文档、FAQ、博客系统,借助大模型的力量为你提供AI创作、AI问答...

DeepWiki-Open: 开源版Deepwiki,可自己构建github文档库

Deepwiki是Devin团队开发的github文档库,用户能免费使用,但代码不是开源,而DeepWiki-Open侧是开源版本的实现。DeepWiki-Open旨在为GitHub和GitLa...

最近爆火的wiki知识管理开源项目PandaWiki

项目介绍PandaWiki是一款AI大模型驱动的开源知识库搭建系统,帮助你快速构建智能化的产品文档、技术文档、FAQ、博客系统,借助大模型的力量为你提供AI创作、AI问答、AI搜索等...

轻量级开源wiki系统介绍(轻量开源论坛系统)

wiki系统有很多DokuWiki、MediaWiki、MinDoc等等都是开源的wiki系统。商业版的wiki,像很多企业在用的confluence等。今天我们讲的是一款轻量级且开源的文档管理系统:...

DNS解析错误要怎么处理(dns解析状态异常怎么办)

在互联网时代,网络已经成为人们生活和工作中不可或缺的一部分。然而,当遇到DNS解析错误时,原本畅通无阻的网络访问会突然陷入困境,让人感到十分困扰。DNS,即域名系统,它如同互联网的电话簿,将人们易于...

网页加载慢?这些方法让你秒开网页!

打开浏览器,信心满满地准备查资料、看视频或者追剧,却发现网页怎么都打不开!是不是瞬间感觉手足无措?别慌,这个问题其实挺常见,而且解决起来并没有你想象的那么复杂。今天就来聊聊网页打不开究竟是怎么回事,以...

windows11 常用CMD命令大全(windows11msdn)

Windows11中的命令提示符(CMD)是一个强大的工具,可以通过命令行执行各种系统操作和管理任务。以下是一些常用的CMD命令,按功能分类整理,供你参考:一、系统信息与状态systeminfo显...

电脑提示DNS服务器未响应怎么解决?

我们在使用电脑的时候经常会遇到各种各样的网络问题,例如最近就有Win11电脑用户在使用的时候遇到了DNS未响应的问题,遇到这种情况我们应该怎么解决呢?  方法一:刷新DNS缓存  1、打开运行(W...

宽带拨号错误 651 全解析:故障定位与修复方案

在使用PPPoE拨号连接互联网时,错误651提示「调制解调器或其他连接设备报告错误」,通常表明从用户终端到运营商机房的链路中存在异常。以下从硬件、系统、网络三层维度展开排查:一、故障成因分类图...

如何正确清除 DNS 缓存吗?(解决你访问延时 )

DNS缓存是一个临时数据库,用于存储有关以前的DNS查找的信息。换句话说,每当你访问网站时,你的操作系统和网络浏览器都会保留该域和相应IP地址的记录。这消除了对远程DNS服务器重复查询的...

网络配置命令:ipconfig和ifconfig,两者有啥区别?

在计算机网络的世界里,网络接口就像是连接你电脑和外部网络的桥梁,而网络配置则是确保这座桥梁稳固、通信顺畅的关键。提到网络配置工具,ipconfig和ifconfig绝对是两个绕不开的名字。它们一...

救急的命令 你会几个?(救急一下)

很多人都说小编是注册表狂魔,其实不完全是,小编常用的命令行才是重点。其实所谓的命令行都是当初DOS时代的标准操作方式,随着Windows不断演化,DOS的命令早已成为Windows的一部分了——开始菜...

电脑有网却访问不了GitHub原来是这样

当满心欢喜打开电脑,准备在GitHub这个“开源宝藏库”里挖掘点超酷的项目,却遭遇了网页无法访问的尴尬。看着屏幕上那令人无奈的提示,原本高涨的热情瞬间被泼了一盆冷水,是不是感觉世界都不美好了...

rockstargames更新慢| r星更新速度 怎么办 解决办法

rockstargames更新慢|r星更新速度怎么办解决办法说到RockstarGames,那可是游戏界的大佬,作品个顶个的经典。但话说回来,每当新内容更新时,那蜗牛般的下载速度,真是让人急得...

取消回复欢迎 发表评论: