2. 程式人生 > 其它 >Spring Boot對json資料的處理以及返回資料的封裝

Spring Boot對json資料的處理以及返回資料的封裝

阿新 • • 發佈：2020-12-16

技術標籤：javaspringBootjavaspring boot

SpringBoot 對Json的配置

jackson 中對null的處理(spring boot 預設)

在實際專案中，我們難免會遇到一些 null 值出現，我們轉 json 時，是不希望有這些 null 出現的，比如
我們期望所有的 null 在轉 json 時都變成 “” 這種空字串，那怎麼做呢？在 Spring Boot 中，我們做一
下配置即可，新建一個 jackson 的配置類：

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;
 }
}

使用阿里巴巴FastJson的設定

關於 fastJson 和 jackson 的對比，網上有很多資料可以檢視，主要是根據自己實際專案情況來選擇合適
的框架。從擴充套件上來看，fastJson 沒有 jackson 靈活，從速度或者上手難度來看，fastJson 可以考慮，
我們專案中目前使用的是阿里的 fastJson，挺方便的。

fastJson依賴匯入

使用 fastJson 需要匯入依賴，本次使用 1.2.35 版本，依賴如下：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.35</version>
</dependency>

使用 fastJson 處理 nul

使用 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 {
  /**
  * 使用阿里 FastJson 作為JSON MessageConverter
  * @param converters
  */
  @Override
  public void configureMessageConverters(List<HttpMessageConverter<?>>
converters) {
    FastJsonHttpMessageConverter converter = new
FastJsonHttpMessageConverter();
    FastJsonConfig config = new FastJsonConfig();
    config.setSerializerFeatures(
        // 保留map空的欄位
        SerializerFeature.WriteMapNullValue,
        // 將String型別的null轉成""
        SerializerFeature.WriteNullStringAsEmpty,
        // 將Number型別的null轉成0
        SerializerFeature.WriteNullNumberAsZero,
        // 將List型別的null轉成[]
        SerializerFeature.WriteNullListAsEmpty,
        // 將Boolean型別的null轉成false
        SerializerFeature.WriteNullBooleanAsFalse,
        // 避免迴圈引用
        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 資料的型別不確定，所以在定義統一的 json 結構時，我們需要用到泛型。統一的 json
結構中屬性包括資料、狀態碼、提示資訊即可，構造方法可以根據實際業務需求做相應的新增即可，一
般來說，應該有預設的返回結構，也應該有使用者指定的返回結構。如下：


import cn.hutool.core.exceptions.ValidateException;
import com.common.enums.ResultCodeEnum;
import com.common.enums.ResultStatusEnum;
//這個程式碼沒有引入，可以將最後一個刪除
import com.common.exceptions.*;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;

import java.io.PrintWriter;
import java.io.Serializable;
import java.io.StringWriter;
import java.net.ConnectException;
import java.sql.SQLException;

/**
 * 統一定義ResponseBody 返回結構
 *
 */
@Data
@Slf4j
public class ResultModel implements Serializable {
    private static final long serialVersionUID = 1071681926787951549L;

    /**
     * 響應業務狀態
     */
    private Integer status;

    /**
     * 業務響應碼, 根據業務響應碼反映異常錯誤型別
     */
    private Integer code;

    /**
     * 響應訊息
     */
    private String msg;

    /**
     * 異常詳細資訊
     */
    private String detailMessage;

    /**
     * 響應中的資料
     */
    private Object data;

    /**
     * 是否請求成功
     */
    private boolean success;

    /**
     * 分頁查詢時有效
     */
    private long total;

    private String token;

    protected ResultModel(Integer status, String msg, Object data, boolean isSuccess) {
        this.status = status;
        this.msg = msg;
        this.data = data;
        this.success = isSuccess;
    }

    public static ResultModel ok() {
        return new ResultModel(ResultCodeEnum.SUCCESS, ResultStatusEnum.OK, ResultStatusEnum.OK.getMsg(), null, true);
    }

    public static ResultModel ok(Object data) {
        return new ResultModel(ResultCodeEnum.SUCCESS, ResultStatusEnum.OK, ResultStatusEnum.OK.getMsg(), data, true);
    }

    public static ResultModel ok(Object data, String msg) {
        return new ResultModel(ResultCodeEnum.SUCCESS, ResultStatusEnum.OK, msg, data, true);
    }

    public static ResultModel ok(Object data, String msg, Integer status) {
        ResultStatusEnum statusEnum = ResultStatusEnum.getByCode(status);
        return new ResultModel(ResultCodeEnum.SUCCESS, statusEnum, msg, data, true);
    }

    public static ResultModel ok(Object data, Integer status) {
        ResultStatusEnum statusEnum = ResultStatusEnum.getByCode(status);
        return new ResultModel(ResultCodeEnum.SUCCESS, statusEnum, statusEnum.getMsg(), data, true);
    }

    public static ResultModel fail() {
        return new ResultModel(ResultCodeEnum.ERROR, ResultStatusEnum.INTERNAL_SERVER_ERROR,
                ResultStatusEnum.INTERNAL_SERVER_ERROR.getMsg(), null, false);
    }

    public static ResultModel fail(String msg) {
        return fail(null, msg);
    }

    public static ResultModel fail(Throwable throwable) {
        return new ResultModel(throwable);
    }

    public static ResultModel fail(Object data, String msg) {
        return new ResultModel(ResultCodeEnum.ERROR, ResultStatusEnum.INTERNAL_SERVER_ERROR, msg, data, false);
    }

    public static ResultModel fail(Object data, String msg, Integer status) {
        ResultStatusEnum statusEnum = ResultStatusEnum.getByCode(status);
        return new ResultModel(ResultCodeEnum.ERROR, statusEnum, msg, data, false);
    }

    public static ResultModel fail(Object data, Integer status) {
        ResultStatusEnum statusEnum = ResultStatusEnum.getByCode(status);
        return new ResultModel(ResultCodeEnum.ERROR, statusEnum, statusEnum.getMsg(), data, false);
    }

    public static ResultModel pageOk(Object data, long total) {
        ResultModel model = new ResultModel(ResultCodeEnum.SUCCESS, ResultStatusEnum.OK, ResultStatusEnum.OK.getMsg(),
                data, true);
        model.setTotal(total);

        return model;
    }

    public static ResultModel format(ResultStatusEnum statusEnum) {
        boolean isSuccess = true;
        ResultCodeEnum codeEnum = ResultCodeEnum.SUCCESS;
        switch (statusEnum) {
            case INVALID_REQUEST:
            case UNAUTHORIZED:
            case FORBIDDEN:
            case NOT_FOUND:
            case INTERNAL_SERVER_ERROR:
                codeEnum = ResultCodeEnum.ERROR;
                isSuccess = false;
                break;
            default:
                break;
        }

        return new ResultModel(codeEnum, statusEnum,
                statusEnum.getMsg(), null, isSuccess);
    }

    public static ResultModel format(ResultStatusEnum statusEnum, String msg, Object data) {

        boolean isSuccess = true;
        ResultCodeEnum codeEnum = ResultCodeEnum.SUCCESS;
        switch (statusEnum) {
            case INVALID_REQUEST:
            case UNAUTHORIZED:
            case FORBIDDEN:
            case NOT_FOUND:
            case INTERNAL_SERVER_ERROR:
                codeEnum = ResultCodeEnum.ERROR;
                isSuccess = false;
                break;
            default:
                break;
        }

        return new ResultModel(codeEnum, statusEnum,
                msg, data, isSuccess);
    }

    private ResultModel(ResultCodeEnum codeEnum, ResultStatusEnum statusEnum, String msg, Object data, boolean isSuccess) {
        this.status = statusEnum.getCode();
        this.code = codeEnum.getCode();
        this.msg = msg;
        this.data = data;
        this.success = isSuccess;
        this.total = 0;
    }

    public ResultModel(Throwable throwable) {
        this.success = false;

        log.error("系統錯誤,", throwable);

        this.status = 500;

        // 獲取詳細資訊
        StringWriter stringWriter= new StringWriter();
        PrintWriter writer= new PrintWriter(stringWriter);
        throwable.printStackTrace(writer);
        StringBuffer buffer= stringWriter.getBuffer();

        this.detailMessage = buffer.toString();
        if (throwable instanceof NullPointerException) {
            this.code = 1001;
            this.msg = "空指標異常";
        } else if (throwable instanceof ClassCastException) {
            this.code = 1002;
            this.msg = "型別強制轉換異常";
        } else if (throwable instanceof ConnectException) {
            this.code = 1003;
            this.msg = "連結失敗";
        } else if (throwable instanceof IllegalArgumentException) {
            this.code = 1004;
            this.msg = "傳遞非法引數異常";
        } else if (throwable instanceof IndexOutOfBoundsException) {
            this.code = 1006;
            this.msg = "下標越界異常";
        } else if (throwable instanceof SecurityException) {
            this.code = 1007;
            this.msg = "安全異常";
        } else if (throwable instanceof SQLException) {
            this.code = 1008;
            this.msg = "資料庫錯誤";
        } else if (throwable instanceof ArithmeticException) {
            this.code = 1009;
            this.msg = "算術運算異常";
        } else if (throwable instanceof ValidationException || throwable instanceof ValidateException) {
            this.code = 1010;
            this.msg = "引數異常," + throwable.getMessage();
        } else if (throwable instanceof BusinessException) {
            this.code = 500;
            this.msg = throwable.getMessage();
        } else if (throwable instanceof UnauthorizedException) {
            this.code = 401;
            this.msg = "許可權認證異常";
        } else if (throwable instanceof ElasticException) {
            this.code = 1011;
            this.msg = "Elastic異常";
        } else if (throwable instanceof RRException) {
            this.code = 1012;
            this.msg = "業務異常";
        } else if (throwable instanceof RuntimeException) {
            this.code = 1013;
            this.msg = "執行時異常";
        } else if (throwable instanceof Exception) {
            this.code = 9999;
            this.msg = "伺服器錯誤";
        }
    }
}




/**
 * 請求資源狀態碼列舉
 *
 */

public enum ResultCodeEnum {
    /**
     * 成功 0
     */
    SUCCESS(0, "請求成功"),
    /**
     * 失敗 1
     */
    ERROR(1, "請求失敗");
    private Integer code;
    private String msg;

    ResultCodeEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}


package com.dhcc.mrp.common.enums;


/**
 * HTTP狀態碼
 *
 */
public enum ResultStatusEnum {
    /**
     * 200 請求成功
     */
    OK(200, "OK", "請求成功！"),
    /**
     * 201 建立或者修改資料成功
     */
    CREATED(201, "CREATED", "資源建立成功！"),
    /**
     * 204 刪除資料成功
     */
    NO_CONTENT(204, "NO CONTENT", "伺服器成功處理了請求，但不需要返回任何實體內容！"),
    /**
     * 400 請求有錯誤
     */
    INVALID_REQUEST(400, "INVALID REQUEST", "請求失敗,具體檢視返回業務狀態碼與對應訊息！"),
    /**
     * 401 沒有許可權
     */
    UNAUTHORIZED(401, "Unauthorized", "請求失敗,未經過身份認證！"),
    /**
     * 403 使用者訪問被禁止（已經授權）
     */
    FORBIDDEN(403, "Forbidden", "使用者訪問被禁止！"),
    /**
     * 404 請求不存在
     */
    NOT_FOUND(404, "NOT FOUND", "請求不存在！"),

    /**
     * 405 請求方法不支援
     */
    NOT_SUPPORT(405, "Not Support", "請求方法不支援！"),
    /**
     * 500 伺服器發生錯誤
     */
    INTERNAL_SERVER_ERROR(500, "INTERNAL SERVER ERROR", "伺服器遇到了一個未曾預料的狀況,導致了它無法完成對請求的處理！");

    private Integer code;
    private String name;
    private String msg;

    ResultStatusEnum(Integer code, String name, String msg) {
        this.code = code;
        this.name = name;
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

    public static ResultStatusEnum getByCode(Integer code) {
        if (code == null) {
            // 預設返回200
            return ResultStatusEnum.OK;
        }

        ResultStatusEnum[] types = ResultStatusEnum.values();
        for (ResultStatusEnum type : types) {
            if (type.code.equals(code)) {
                return type;
            }
        }

        return ResultStatusEnum.OK;
    }

}

相關推薦

Spring Boot對json資料的處理以及返回資料的封裝

技術標籤：javaspringBootjavaspring boot SpringBoot 對Json的配置 jackson 中對null的處理(spring boot 預設)

spring boot websocket 實時訊息推送和資料展示

一、實現目標 1、線上聊天，客服聊天，聊天室 2、業務資料實時展示，自動更新

Spring Boot如何通過CORS處理跨域問題

跨域的產生就是因為瀏覽器的同源策略。它是瀏覽器的核心安全功能，所謂的同源，就是指域名，協議，還有埠要相同。傳統的方案就是JSONP（前端處理方案），但是JSONP有很大的侷限性，就是隻支援GET請求，所以不能滿足我

Spring Boot 專案jar包瘦身/lib資料夾匯出(分離)

Spring Boot 專案jar包瘦身/lib資料夾匯出(分離) 因為專案依賴很少變動,而且每次傳阿里雲上,jar包大,速度慢...

vue Excel匯出功能-前端處理後臺返回資料流

產品資料大屏展示專案（下圖），因需要匯出部分客戶資訊的excel表，資料表由後臺實現，前端負責匯出，

Spring Boot中是如何處理日期時間格式的

在springboot中開發RESTful介面，經常會遇到日期時間轉換相關的問題，例如我們明明輸入看起來很正常的日期時間字串，但是系統卻報錯無法解析：

Spring MVC 上傳檔案(處理multipart型別資料)

技術標籤：springmvcjava web應用中有很多上傳檔案或者圖片的業務。那麼這種業務在Springmvc中是如何實現的呢？本篇文章就講述了在SpringMVC中如何實現檔案上傳功能。

python資料處理中Pandas資料處理及分析----超詳細

實現Pandas自行車行駛資料分析 假設現在有一組自行車行駛資料，這組資料記錄的是蒙特利爾市內7條自行車道的自行車騎行人數，下面用python中的pandas對其進行分析。原始資料找我要就行QQ 2534659467 註明來意

Spring Boot 2.x 專案中使用Redis快取封裝 （持續更新中....）

Spring Boot 2.x 專案中使用Redis快取封裝 專案中多使用Redis快取，團隊協作中Redis程式碼經常重複，並且不規範，這裡封裝RedisService用做公共服務通過繼承的方式呼叫

jmeter對JSON返回資料處理和後續呼叫

想要解決的問題： 測試時，token等前面介面返回的資料，後面的請求時需要用到，通過查詢介面，獲取response資料，作為下個請求post的引數值

spring boot 下對JSON返回值去除null和空欄位操作

在開發過程中，我們需要統一返回前端json格式的資料，但有些介面的返回值存在 null或者\"\"這種沒有意義的欄位。

Spring Boot專案維護全域性json資料程式碼例項

這篇文章主要介紹了Spring Boot專案維護全域性json資料程式碼例項,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

rabbitmq傳送訊息的兩種格式：傳送json資料和直接傳送物件以及對json與物件之間的相互轉換

前奏：json格式字串與Java物件的相互轉換方法 第一種：com.fasterxml.jackson.databind.ObjectMapper 包

Spring Boot 無侵入式 實現API介面統一JSON格式返回

無侵入式 統一返回JSON格式 其實本沒有沒打算寫這篇部落格的，但還是要寫一下寫這篇部落格的起因是因為，現在呆著的這家公司居然沒有統一的API返回格式?，詢問主管他居然告訴我用HTTP狀態碼就夠用了（fxxk），天哪HT

統一返回json資料處理

public class Result<T> { private Integer code; private String msg; private T data; public Integer getCode() {

Spring Boot 無侵入式 實現 API 介面統一 JSON 格式返回

定義返回JSON格式 後端返回給前端一般情況下使用JSON格式, 定義如下 { \"code\": 200,

spring boot cors 動態新增以及cookie 處理

spring boot 4.2 之後直接支援基於註解解決了，使用很簡單，但是需要嚴格控制跨域請求的就需要一些調整了

spring boot專案可通過Result類或者自定返回類實現controller層返回資料

一.通過Result類實現返回資料 //使用者註冊 @PostMapping(\"/registerUser\") public Result registerUser(@RequestBody User user){

測試開發進階——spring boot——MVC——thymeleaf模板——通過model.addAttribute返回資料給模板

控制器： package com.awaimai.web; import com.alibaba.fastjson.JSONObject; import org.hibernate.validator.constraints.*;

spring boot -- 控制器類中方法返回物件json序列化

前言 　　fastjson：是一個Java語言編寫的高效能功能完善的JSON庫。它採用一種“假定有序快速匹配”的演算法，把JSON Parse的效能提升到極致，是目前Java語言中最快的JSON庫。Fastjson介面簡單易用，已經被廣泛使用