SpringBoot如何返回Json数据格式
作者：程序员史迪仔 发布时间：2023-01-12 16:28:51
标签：SpringBoot,返回,Json
一、@RestController 注解
在 Spring Boot 中的 Controller 中使用 @RestController 注解即可返回 JSON 格式的数据。
@RestController注解包含了 @Controller 和 @ResponseBody 注解。@ResponseBody注解是将返回的数据结构转换为 JSON 格式。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
String value() default "";
}
二、Jackson
在 Spring Boot 中默认使用的 JSON 解析技术框架是 Jackson。
点开 pom.xml 中的 spring-boot-starter-web 依赖，可以看到 spring-boot-starter-json 依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-json</artifactId>
<version>2.0.3.RELEASE</version>
<scope>compile</scope>
</dependency>
再次点进去上面提到的 spring-boot-starter-json 依赖，可以看到如下代码：
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jdk8</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-parameter-names</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
到此为止，可以知道 Spring Boot 中默认使用的 JSON 解析框架是 Jackson。
1、对象、List、Map 转换为Json格式
创建实体类：
public class User {
private Long id;
private String username;
private String password;
/* 省略get、set和带参构造方法 */
}
Controller 层
import com.itcodai.course02.entity.User;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@RestController
@RequestMapping("/json")
public class JsonController {
@RequestMapping("/user")
public User getUser() {
return new User(1, "倪升武", "123456");
//返回 {"id":1,"username":"倪升武","password":"123456"}
}
@RequestMapping("/list")
public List<User> getUserList() {
List<User> userList = new ArrayList<>();
User user1 = new User(1, "倪升武", "123456");
User user2 = new User(2, "达人课", "123456");
userList.add(user1);
userList.add(user2);
return userList;
//返回 [{"id":1,"username":"倪升武","password":"123456"},{"id":2,"username":"达人课","password":"123456"}]
}
@RequestMapping("/map")
public Map<String, Object> getMap() {
Map<String, Object> map = new HashMap<>(3);
User user = new User(1, "倪升武", "123456");
map.put("作者信息", user);
map.put("博客地址", "http://blog.itcodai.com");
map.put("CSDN地址", "http://blog.csdn.net/eson_15");
map.put("粉丝数量", 4153);
return map;
//返回 {"作者信息":{"id":1,"username":"倪升武","password":"123456"},"CSDN地址":"http://blog.csdn.net/eson_15","粉丝数量":4153,"博客地址":"http://blog.itcodai.com"}
}
}
2、Jackson 的配置类
在转 JSON 格式的时候将所有的 null 转换为 “” 的配置
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
import java.io.IOException;
@Configuration
public class JacksonConfig {
@Bean
@Primary
@ConditionalOnMissingBean(ObjectMapper.class)
public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
ObjectMapper objectMapper = builder.createXmlMapper(false).build();
objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
@Override
public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeString("");
}
});
return objectMapper;
}
}
// 修改一下上面返回 Map 的接口，将几个值改成 null 测试一下：
@RequestMapping("/map")
public Map<String, Object> getMap() {
Map<String, Object> map = new HashMap<>(3);
User user = new User(1, "倪升武", null);
map.put("作者信息", user);
map.put("博客地址", "http://blog.itcodai.com");
map.put("CSDN地址", null);
map.put("粉丝数量", 4153);
return map;
// 返回 {"作者信息":{"id":1,"username":"倪升武","password":""},"CSDN地址":"","粉丝数量":4153,"博客地址":"http://blog.itcodai.com"}
// 可以看到 Jackson 已经将所有 null 字段转成空字符串了。
}
三、Fastjson
Fastjson 是阿里巴巴开源的。
Jackson 和 fastjson 有哪些区别？
从扩展上来看，fastjson 没有 Jackson 灵活，从速度或者上手难度来看，fastjson 可以考虑，它也比较方便。
fastjson 的依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.35</version>
</dependency>
Fastjson 配置类
使用 fastjson 时，对 null 的处理和 Jackson 有些不同，需要继承 WebMvcConfigurationSupport 类，然后覆盖 configureMessageConverters 方法。
在方法中，我们可以选择要实现 null 转换的场景，代码如下：
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
@Configuration
public class fastJsonConfig extends WebMvcConfigurationSupport {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
FastJsonConfig config = new FastJsonConfig();
config.setDateFormat("yyyy-MM-dd");
config.setSerializerFeatures(
// 保留 Map 空的字段
SerializerFeature.WriteMapNullValue,
// 将 String 类型的 null 转成""
SerializerFeature.WriteNullStringAsEmpty,
// 将 Number 类型的 null 转成 0
SerializerFeature.WriteNullNumberAsZero,
// 将 List 类型的 null 转成 []
SerializerFeature.WriteNullListAsEmpty,
// 将 Boolean 类型的 null 转成 false
SerializerFeature.WriteNullBooleanAsFalse,
// 生成的JSON格式化
SerializerFeature.PrettyFormat,
// 避免循环引用
SerializerFeature.DisableCircularReferenceDetect);
converter.setFastJsonConfig(config);
converter.setDefaultCharset(Charset.forName("UTF-8"));
List<MediaType> mediaTypeList = new ArrayList<>();
// 解决中文乱码问题，相当于在 Controller 上的 @RequestMapping 中加了个属性 produces = "application/json"
mediaTypeList.add(MediaType.APPLICATION_JSON);
converter.setSupportedMediaTypes(mediaTypeList);
converters.add(converter);
}
}
四、封装返回的数据格式
除了要封装数据之外，我们往往需要在返回的 JSON 中添加一些其他信息，比如返回状态码 Code，返回 Msg 给调用者，调用者可以根据 Code 或者 Msg 进行一些逻辑判断。
统一的 JSON 结构中属性包括数据、状态码、提示信息即可。
public class JsonResult<T> {
private T data;
private String code;
private String msg;
/**
* 若没有数据返回，默认状态码为 0，提示信息为“操作成功！”
*/
public JsonResult() {
this.code = "0";
this.msg = "操作成功！";
}
/**
* 若没有数据返回，可以人为指定状态码和提示信息
* @param code
* @param msg
*/
public JsonResult(String code, String msg) {
this.code = code;
this.msg = msg;
}
/**
* 有数据返回时，状态码为 0，默认提示信息为“操作成功！”
* @param data
*/
public JsonResult(T data) {
this.data = data;
this.code = "0";
this.msg = "操作成功！";
}
/**
* 有数据返回，状态码为 0，人为指定提示信息
* @param data
* @param msg
*/
public JsonResult(T data, String msg) {
this.data = data;
this.code = "0";
this.msg = msg;
}
// 省略 get 和 set 方法
}
修改 Controller 中的返回值类型，测试
@RestController
@RequestMapping("/jsonresult")
public class JsonResultController {
@RequestMapping("/user")
public JsonResult<User> getUser() {
User user = new User(1, "倪升武", "123456");
return new JsonResult<>(user);
// {"code":"0","data":{"id":1,"password":"123456","username":"倪升武"},"msg":"操作成功！"}
}
@RequestMapping("/list")
public JsonResult<List> getUserList() {
List<User> userList = new ArrayList<>();
User user1 = new User(1, "倪升武", "123456");
User user2 = new User(2, "达人课", "123456");
userList.add(user1);
userList.add(user2);
return new JsonResult<>(userList, "获取用户列表成功");
// {"code":"0","data":[{"id":1,"password":"123456","username":"倪升武"},{"id":2,"password":"123456","username":"达人课"}],"msg":"获取用户列表成功"}
}
@RequestMapping("/map")
public JsonResult<Map> getMap() {
Map<String, Object> map = new HashMap<>(3);
User user = new User(1, "倪升武", null);
map.put("作者信息", user);
map.put("博客地址", "http://blog.itcodai.com");
map.put("CSDN地址", null);
map.put("粉丝数量", 4153);
return new JsonResult<>(map);
// {"code":"0","data":{"作者信息":{"id":1,"password":"","username":"倪升武"},"CSDN地址":null,"粉丝数量":4153,"博客地址":"http://blog.itcodai.com"},"msg":"操作成功！"}
}
}
来源：https://blog.csdn.net/weixin_44668898/article/details/121809240
0
投稿猜你喜欢
- 在日常开发过程中，偶尔会出现一些极端问题。比如 网络重复请求，很难过滤 请求的问题。下面一段代码，可以解决这个重复请求的问题。下面上一段代码
- 本文实例讲述了C#获取机器码的方法。分享给大家供大家参考，具体如下：using System.Runtime.InteropServices
- Kotlin使用SQLite首先确定我们的目标，SQLite只是一种工具，我们需要掌握就是增删改查就可以，我们真正需要动脑的还是项目中的业务
在学习SpringBoot的过程中遇到一个问题，因为SpringBoot是集成了tomcat的，所以项目是打成jar包，通过SpringMV- HttpServletResponse接口的sendRedirect()方法可用于将响应重定向到另一个资源，它可以是Servlet，Jsp或
- 本文实例为大家分享了Android自定义ViewGroup多行多列的具体代码，供大家参考，具体内容如下先看下效果图每行两个子孩子每行一个子孩
- 最近正在学习c#，对其中的方法重写和隐藏的概念很是模糊，现在将其归纳如下：1：方法重写：就是在基类中的方法用virtual关键字来标识，然后
- 如果要监听电池的状态改变，需要动态注册：android.intent.action.BATTERY_CHANGED，收到Action后可以根
- 静态成员变量与非静态成员变量的区别以下面的例子为例说明package cn.galc.test;public class Cat {/**
- 本文实例为大家分享了Android studio实现PopupWindow弹出框的具体代码，供大家参考，具体内容如下实现步骤：第一步：自定义
- C#是一门面向对象的语言，具有面向对象的基本特征，抽象、封装、继承、多态等性质。学习C#除了一些基本的语法，还得学习一些新的特性，比如说：泛
- 1.根据入参带分页参数进行sql查询分页 Criteria criteria = n
- 1.刷新maven项目2.清理idea缓存3.maven clean install4.重新bulid5.如果使用了lombok插件开启之后
- Common.cs: using System; using System.Collections.Generic; using Syste
- Android虚拟键盘的弹起会遮挡住部分ui，虽然通过在清单文件中设置，可以随着虚拟键盘的弹出，布局往上推，但是面对登陆界面时，并没有太大的
- 文件存储文件存储方式不受类型限制,可以将一些数据直接以文件的形式保存在设备中,例如文本文件、PDF ,音频,图片等。存储类型复杂的数据时,通
- #region 提示信息#endregion作用：折叠并隐藏代码 ，别且折叠以后能够显示白字“提示信息”如下图就是使用了#region和#e
- 重载1.构造器的重载因为构造器的名字必须与类名相同，所以同一个类的所有构造器名肯定相同，构成重载；为了让系统能区分不同的构造器，多个构造器的
- arthas能够更改日志的级别，下面是logger的用法查看logger信息，更新logger level查看所有logger信息logge
- 做侧滑删除网上有很多方案，比如重写Listview实现滑动的监听，今天说下一个SwipeListView，这个是之前一个朋友在网上开源的一个
