云服务器网:购买云服务器和VPS必上的网站!

SpringBoot怎么返回Json数据格式

这篇文章主要介绍“SpringBoot怎么返回Json数据格式”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强

这篇文章主要介绍“springboot怎么返回json数据格式”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“SpringBoot怎么返回json数据格式”文章能帮助大家解决问题。

一、@RestController 注解

在 Spring Boot 中的 Controller 中使用 @RestController 注解即可返回 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 依赖:

    org.springframework.boot
    spring-boot-starter-json
    2.0.3.RELEASE
    compile

再次点进去上面提到的 spring-boot-starter-json 依赖,可以看到如下代码:

    com.fasterxml.jackson.core
    jackson-databind
    2.9.6
    compile


    com.fasterxml.jackson.datatype
    jackson-datatype-jdk8
    2.9.6
    compile


    com.fasterxml.jackson.datatype
    jackson-datatype-jsr310
    2.9.6
    compile


    com.fasterxml.jackson.module
    jackson-module-parameter-names
    2.9.6
    compile

到此为止,可以知道 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 getUserList() {
        List 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 getMap() {
        Map 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() {            @Override            public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {                jsonGenerator.writeString("");            }        });        return objectMapper;    }}// 修改一下上面返回 Map 的接口,将几个值改成 null 测试一下:@RequestMapping("/map")public Map getMap() {    Map 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 字段转成空字符串了。}三、FastjsonFastjson 是阿里巴巴开源的。Jackson 和 fastjson 有哪些区别?从扩展上来看,fastjson 没有 Jackson 灵活,从速度或者上手难度来看,fastjson 可以考虑,它也比较方便。fastjson 的依赖
    com.alibaba    fastjson    1.2.35

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;@Configurationpublic 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 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 {    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 getUser() {        User user = new User(1, "倪升武", "123456");        return new JsonResult(user);        // {"code":"0","data":{"id":1,"password":"123456","username":"倪升武"},"msg":"操作成功!"}    }    @RequestMapping("/list")    public JsonResult getUserList() {        List 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
 getMap() {        Map 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":"操作成功!"}    }}关于“SpringBoot怎么返回Json数据格式”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识,可以关注云服务器网(yuntue.com)行业资讯频道,小编每天都会为大家更新不同的知识点。

 

本文来源:https://www.yuntue.com/post/47480.html | 云服务器网,转载请注明出处!

关于作者: yuntue

云服务器(www.yuntue.com)是一家专门做阿里云服务器代金券、腾讯云服务器优惠券的网站,这里你可以找到阿里云服务器腾讯云服务器等国内主流云服务器优惠价格,以及海外云服务器、vps主机等优惠信息,我们会为你提供性价比最高的云服务器和域名、数据库、CDN、免费邮箱等企业常用互联网资源。

为您推荐

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注