欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot 統(tǒng)一請求返回的實現

 更新時間:2020年07月15日 09:17:05   作者:阿亮叨逼叨  
這篇文章主要介紹了SpringBoot 統(tǒng)一請求返回的實現,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

目前我們的返回是直接把實體類扔給請求方,這樣很不友好,一方面沒有統(tǒng)一的格式,二來請求方不知道請求成功與否,沒有一個可以判斷的東西,也沒有說明性的返回。

本篇就來為所有接口提供一個統(tǒng)一的友好返回。

確定返回結構

首先,我們先確定好我們接口返回的格式是什么樣的,然后再一步一步實現下面的。

{
 "code": 200,
  "msg": "ok",
  "data": ""
}
  • code 字段表示狀態(tài)碼,調用方根據該碼來作為后續(xù)邏輯的依據,比如 code 值為 200 表示操作成功,沒有邏輯錯誤,此時可以提示用戶操作成功等;code 值不為 200 表示操作失敗,比如為 1001 ,表示用戶名已存在,此時前端做一些相應操作。
  • msg 字段用來充當額外說明,比如上面說的狀態(tài)為 1001,這里的 msg 就可以是 username exists 這樣的說明性文字,幫助調用方更好的理解。
  • data 字段一般是在 code 值為 200 的時候,返回具體的業(yè)務數據,可以是數組,也可以是對象。

創(chuàng)建返回碼

根據上面定的返回結構,我們可以把 code 和 msg 字段用枚舉類型整合,在項目中創(chuàng)建 common 目錄,新建 ApiCode.java 如下代碼所示:

package com.foxescap.wxbox.common;

/**
 * 全局接口狀態(tài)碼
 * @author xfly
 */
public enum ApiCode {
  /**
   * 通用成功
   */
  API_OK(200, "ok"),
  /**
   * 用戶名已存在
   */
  API_USERNAME_EXIST(1001, "username exists");

  private final int code;

  private final String msg;

  ApiCode(int code, String msg) {
    this.code = code;
    this.msg = msg;
  }

  public int code() {
    return this.code;
  }

  public String getMsg() {
    return this.msg;
  }
}

之后每有一個不同的錯誤代碼都需要在這里加上,然后調用這里的枚舉變量??赡軙悬c繁瑣,但當項目逐漸大起來以后,這樣做就能很好的管理狀態(tài)碼。

創(chuàng)建返回類

在項目中創(chuàng)建 common 目錄,新建 HttpResponse.java 文件:

package com.foxescap.wxbox.common;

import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import lombok.AllArgsConstructor;
import lombok.Data;

import java.io.Serializable;

/**
 * @author xfly
 * @param <T>
 */
@Data
@AllArgsConstructor
@JsonPropertyOrder({"code", "msg", "data"})
public class ApiResponse<T> implements Serializable {
  private static final long serialVersionUID = 1L;

  /**
   * 自定義返回碼
   */
  private int code;

  /**
   * 自定義返回說明
   */
  private String msg;

  /**
   * 返回數據
   */
  private T data;

  /**
   * 成功返回,無數據
   *
   * @return 自定義的 ApiResponse 對象
   */
  public static ApiResponse<Object> success() {
    return new ApiResponse<>(ApiCode.API_OK.code(), ApiCode.API_OK.getMsg(), "");
  }

  /**
   * 成功返回,有數據
   *
   * @param object 返回數據
   * @param <T>  返回數據類型
   * @return 自定義的 ApiResponse 對象
   */
  public static <T> ApiResponse<T> success(T object) {
    return new ApiResponse<>(ApiCode.API_OK.code(), ApiCode.API_OK.getMsg(), object);
  }

  /**
   * 失敗返回
   *
   * @param apiCode 錯誤碼
   * @return 自定義的 ApiResponse 對象
   */
  public static ApiResponse<Object> fail(ApiCode apiCode) {
    return new ApiResponse<>(apiCode.code(), apiCode.getMsg(), "");
  }
}

使用返回類

我們修改一下 Controller 里面的接口返回,現在不是直接返回實體類了,而是封裝成我們的返回類,再返回給調用方:

@GetMapping("/user/{username}")
public ApiResponse<User> findUserByUsername(@PathVariable(name = "username") String username) {
  return ApiResponse.success(userService.findByUsername(username));
}

到此這篇關于SpringBoot 統(tǒng)一請求返回的實現的文章就介紹到這了,更多相關SpringBoot 統(tǒng)一請求返回內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!

相關文章

  • Java算法練習題,每天進步一點點(1)

    Java算法練習題,每天進步一點點(1)

    方法下面小編就為大家?guī)硪黄狫ava算法的一道練習題(分享)。小編覺得挺不錯的,現在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧,希望可以幫到你
    2021-07-07
  • SpringBoot如何統(tǒng)一JSON信息返回

    SpringBoot如何統(tǒng)一JSON信息返回

    這篇文章主要介紹了SpringBoot如何統(tǒng)一JSON信息返回問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教
    2024-08-08
  • Java中生成微信小程序太陽碼的實現方案

    Java中生成微信小程序太陽碼的實現方案

    這篇文章主要介紹了Java中生成微信小程序太陽碼的實現方案,本文講解了如何生成微信小程序太陽碼,通過微信提供的兩種方案都可以實現,在實際的項目中建議采用第二種方案,需要的朋友可以參考下
    2022-05-05
  • 聊聊maven的pom.xml中的exclusions標簽的作用

    聊聊maven的pom.xml中的exclusions標簽的作用

    這篇文章主要介紹了maven的pom.xml中的exclusions標簽的作用,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2021-12-12
  • Java ShardingJDBC實戰(zhàn)演練

    Java ShardingJDBC實戰(zhàn)演練

    Sharding-JDBC 采用在 JDBC 協(xié)議層擴展分庫分表,是一個以 jar 形式提供服務的輕量級組件,其核心思路是小而美地完成最核心的事情
    2021-11-11
  • SpringBoot整合JWT的入門指南

    SpringBoot整合JWT的入門指南

    JWT全稱是json web token,它將用戶信息加密到 token 里,服務器不保存任何用戶信息,服務器通過使用保存的密鑰驗證 token 的正確性,只要正確即通過驗證,這篇文章主要給大家介紹了關于SpringBoot整合JWT的相關資料,需要的朋友可以參考下
    2021-06-06
  • java通過jni調用opencv處理圖像的方法

    java通過jni調用opencv處理圖像的方法

    今天小編就為大家分享一篇java通過jni調用opencv處理圖像的方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2018-08-08
  • SpringBoot使用@Async注解可能會遇到的8大坑點匯總

    SpringBoot使用@Async注解可能會遇到的8大坑點匯總

    SpringBoot中,@Async注解可以實現異步線程調用,用法簡單,體驗舒適,但是你一定碰到過異步調用不生效的情況,今天,我就列出90%的人都可能會遇到的8大坑點,需要的朋友可以參考下
    2023-09-09
  • SpringBoot實現類似鉤子函數的方法

    SpringBoot實現類似鉤子函數的方法

    這篇文章主要給大家介紹了關于SpringBoot實現類似鉤子函數的方法,文中通過代碼示例介紹的非常詳細,對大家的學習或者工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2024-04-04
  • 一文帶你學習Java中的線程

    一文帶你學習Java中的線程

    線程是系統(tǒng)調度的最小單元,一個進程可以包含多個線程,線程是負責執(zhí)行二進制指令的。本文將詳細給大家介紹一下Java中的線程,,需要的朋友可以參考下
    2023-05-05

最新評論