2. 程式人生 > >企業實戰之spring專案《介面響應體格式統一封裝》

企業實戰之spring專案《介面響應體格式統一封裝》

阿新 • • 發佈：2019-01-22

前言

在之前的文章中我們有介紹過，如何更好、更簡單的寫好一個介面（介面返回值篇），今天的這篇文章我們主要介紹，怎麼統一處理下介面的返回格式問題。

###問題分析
我們先來分析下我們所面臨的問題在哪裡，然後接著給出解決方案。在寫一個介面時，我們通常會先統一定義一下介面的返回格式是什麼，然後在跟前端去對接，通常的返回格式大體兩種(我們以儲存使用者為例)：

1. 成功/失敗響應格式不一致（此種方式作為我們預設的介面響應方式）
  • 儲存使用者成功，響應體
{
    "id": 10000,
    "pwd": "123456",
    "nickname": "小竹馬",
    "img": "http://avatar.csdn.net/0/E/9/1_aiyaya_.jpg"
 
,
    "status": "NORMAL",
    "createTime": 1515075974540
}
  • 失敗響應體(下面的格式是spring boot預設的錯誤響應格式，只不過我們在其基礎上增加了一個code欄位用於解釋更詳細的錯誤碼)
{
    "status": 400,
    "error": "Bad Request",
    "message": "引數無效",
    "code": 10001,
    "path": "/zhuma-demo/users",
    "exception": "org.springframework.web.bind.MethodArgumentNotValidException"
 
,
    "errors": [
        {
            "fieldName": "status",
            "message": "值是無效的"
        }
    ],
    "timestamp": 1515076067369
}
2.成功/失敗響應體格式一致
  • 儲存使用者成功，響應體
{
    "code": 1,
    "msg": "成功",
    "data": {
        "id": 10000,
        "pwd": "123456",
        "nickname": "小竹馬",
        "img"
 
: "http://avatar.csdn.net/0/E/9/1_aiyaya_.jpg",
        "status": "NORMAL",
        "createTime": 1515076287882
    }
}
  • 失敗響應體
{
    "code": 10001,
    "msg": "引數無效",
    "data": [
        {
            "fieldName": "status",
            "message": "值是無效的"
        }
    ]
}

那麼如果我們想要的響應體格式是第二種，我們該如何寫我們的程式碼呢？你可能想是這樣麼？

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public PlatformResult addUser(@Validated @RequestBody User user) {
        user.setId(10000L);
        user.setCreateTime(new Date());
        return PlatformResult.success(user);
    }

}

PlatformResult.success()這段邏輯顯然很多餘，每個方法都要這樣寫一遍，所以上述方式並不是我們想要的，我們要的是

@ResponseResult(PlatformResult.class)
@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public User addUser(@Validated @RequestBody User user) {
        user.setId(10000L);
        user.setCreateTime(new Date());
        return user;
    }

}

我們加了一個自定義的註解@ResponseResult(PlatformResult.class)，引數PlatformResult.class告訴這個Controller類下的所有方法都以這個類PlatformResult的格式進行返回，這個註解可以標記在類或方法上，好了，我們的目的明朗了許多，要做的就是標記這個註解讓它實現介面返回值格式控制這個功能，下面我們給出具體的實現方式。

實現思路

首先介紹下完成我們這次主要功能的幾個類：

  1. Result 是返回格式類的父介面（所有返回格式類都需要繼承它）
  2. PlatformResult 通用返回結果格式（我們上面說的第二種返回結果）
  3. DefaultErrorResult 全域性錯誤返回結果（我們上面說的第一種錯誤時的返回結果）
  4. GlobalExceptionHandler全域性異常處理
  5. ResponseResult 註解類（用於在Controller上指定返回值格式類）
  6. ResponseResultInterceptor 攔截器（主要用於將ResponseResult註解類的標記資訊傳入ResponseResultHandler中）
  7. ResponseResultHandler 響應體格式處理器（主要轉換邏輯都在這裡）

程式碼實現

下面將有一大片程式碼襲來，要頂住！O(∩_∩)O哈哈~

1. Result 介面類
package com.zhuma.demo.comm.result;

import java.io.Serializable;

/**
 * @desc 響應格式父介面
 *
 * @author zhumaer
 * @since 4/1/2018 3:00 PM
 */
public interface Result extends Serializable {
}

說明
理論上所有的返回格式類都需要實現該接口才能被使用

2. PlatformResult 通用返回結果
package com.zhuma.demo.comm.result;

import com.zhuma.demo.enums.ResultCode;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @desc 平臺通用返回結果
 * 
 * @author zhumaer
 * @since 10/9/2017 3:00 PM
 */
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Data
public class PlatformResult implements Result {

	private static final long serialVersionUID = 874200365941306385L;

	private Integer code;

	private String msg;

	private Object data;

	public static PlatformResult success() {
		PlatformResult result = new PlatformResult();
		result.setResultCode(ResultCode.SUCCESS);
		return result;
	}

	public static PlatformResult success(Object data) {
		PlatformResult result = new PlatformResult();
		result.setResultCode(ResultCode.SUCCESS);
		result.setData(data);
		return result;
	}

	public static PlatformResult failure(ResultCode resultCode) {
		PlatformResult result = new PlatformResult();
		result.setResultCode(resultCode);
		return result;
	}

	public static PlatformResult failure(ResultCode resultCode, Object data) {
		PlatformResult result = new PlatformResult();
		result.setResultCode(resultCode);
		result.setData(data);
		return result;
	}

	public static PlatformResult failure(String message) {
		PlatformResult result = new PlatformResult();
		result.setCode(ResultCode.PARAM_IS_INVALID.code());
		result.setMsg(message);
		return result;
	}

	private void setResultCode(ResultCode code) {
		this.code = code.code();
		this.msg = code.message();
	}

}
3. DefaultErrorResult 預設全域性錯誤返回格式
package com.zhuma.demo.comm.result;

import java.util.Date;

import com.zhuma.demo.enums.ExceptionEnum;
import com.zhuma.demo.exception.BusinessException;
import com.zhuma.demo.util.RequestContextHolderUtil;
import com.zhuma.demo.util.StringUtil;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.autoconfigure.web.DefaultErrorAttributes;

import com.zhuma.demo.enums.ResultCode;
import org.springframework.http.HttpStatus;

/**
 * @desc 預設全域性錯誤返回結果
 *       備註：該返回資訊是spring boot的預設異常時返回結果{@link DefaultErrorAttributes}，目前也是我們服務的預設的錯誤返回結果
 * 
 * @author zhumaer
 * @since 9/29/2017 3:00 PM
 */
@Builder
@AllArgsConstructor
@NoArgsConstructor
@Data
public class DefaultErrorResult implements Result {

	private static final long serialVersionUID = 1899083570489722793L;

	/**
	 * HTTP響應狀態碼 {@link org.springframework.http.HttpStatus}
	 */
	private Integer status;

	/**
	 * HTTP響應狀態碼的英文提示
	 */
	private String error;

	/**
	 * 異常堆疊的精簡資訊
	 * 
	 */
	private String message;

	/**
	 * 我們系統內部自定義的返回值編碼，{@link ResultCode} 它是對錯誤更加詳細的編碼
	 * 
	 * 備註：spring boot預設返回異常時，該欄位為null
	 */
	private Integer code;

	/**
	 * 呼叫介面路徑
	 */
	private String path;

	/**
	 * 異常的名字
	 */
	private String exception;

	/**
	 * 異常的錯誤傳遞的資料
	 */
	private Object errors;

	/**
	 * 時間戳
	 */
	private Date timestamp;

	public static DefaultErrorResult failure(ResultCode resultCode, Throwable e, HttpStatus httpStatus, Object errors) {
		DefaultErrorResult result = DefaultErrorResult.failure(resultCode, e, httpStatus);
		result.setErrors(errors);
		return result;
	}

	public static DefaultErrorResult failure(ResultCode resultCode, Throwable e, HttpStatus httpStatus) {
		DefaultErrorResult result = new DefaultErrorResult();
		result.setCode(resultCode.code());
		result.setMessage(resultCode.message());
		result.setStatus(httpStatus.value());
		result.setError(httpStatus.getReasonPhrase());
		result.setException(e.getClass().getName());
		result.setPath(RequestContextHolderUtil.getRequest().getRequestURI());
		result.setTimestamp(new Date());
		return result;
	}

	public static DefaultErrorResult failure(BusinessException e) {
		ExceptionEnum ee = ExceptionEnum.getByEClass(e.getClass());
		if (ee != null) {
			return DefaultErrorResult.failure(ee.getResultCode(), e, ee.getHttpStatus(), e.getData());
		}

		DefaultErrorResult defaultErrorResult = DefaultErrorResult.failure(e.getResultCode() == null ? ResultCode.SUCCESS : e.getResultCode(), e, HttpStatus.OK, e.getData());
		if (StringUtil.isNotEmpty(e.getMessage())) {
			defaultErrorResult.setMessage(e.getMessage());
		}
		return defaultErrorResult;
	}

}
4. GlobalExceptionHandler 全域性錯誤異常處理器
package com.zhuma.demo.handler;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;

import com.zhuma.demo.comm.handler.BaseGlobalExceptionHandler;
import com.zhuma.demo.comm.result.DefaultErrorResult;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;

import com.zhuma.demo.exception.BusinessException;

/**
 * @desc 統一異常處理器
 * 
 * @author zhumaer
 * @since 8/31/2017 3:00 PM
 */
@RestController
@ControllerAdvice
public class GlobalExceptionHandler extends BaseGlobalExceptionHandler {

	/* 處理400類異常 */
	@ResponseStatus(HttpStatus.BAD_REQUEST)
	@ExceptionHandler(ConstraintViolationException.class)
	public DefaultErrorResult handleConstraintViolationException(ConstraintViolationException e, HttpServletRequest request) {
		return super.handleConstraintViolationException(e, request);
	}

	@ResponseStatus(HttpStatus.BAD_REQUEST)
	@ExceptionHandler(HttpMessageNotReadableException.class)
	public DefaultErrorResult handleConstraintViolationException(HttpMessageNotReadableException e, HttpServletRequest request) {
		return super.handleConstraintViolationException(e, request);
	}

	@ResponseStatus(HttpStatus.BAD_REQUEST)
	@ExceptionHandler(BindException.class)
	public DefaultErrorResult handleBindException(BindException e, HttpServletRequest request) {
		return super.handleBindException(e, request);
	}

	@ResponseStatus(HttpStatus.BAD_REQUEST)
	@ExceptionHandler(MethodArgumentNotValidException.class)
	public DefaultErrorResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) {
		return super.handleMethodArgumentNotValidException(e, request);
	}

	/* 處理自定義異常 */
	@ExceptionHandler(BusinessException.class)
	public ResponseEntity<DefaultErrorResult> handleBusinessException(BusinessException e, HttpServletRequest request) {
		return super.handleBusinessException(e, request);
	}

	/* 處理執行時異常 */
	@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
	@ExceptionHandler(RuntimeException.class)
	public DefaultErrorResult handleRuntimeException(RuntimeException e, HttpServletRequest request) {
		//TODO 可通過郵件、微信公眾號等方式傳送資訊至開發人員、記錄存檔等操作（這個後面我們文章我們單獨說明該怎麼處理）
		return super.handleRuntimeException(e, request);
	}

}

BaseGlobalExceptionHandler 全域性異常處理基礎類

package com.zhuma.demo.comm.handler;

import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;

import com.zhuma.demo.comm.result.DefaultErrorResult;
import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;

import com.zhuma.demo.comm.result.ParameterInvalidItem;
import com.zhuma.demo.enums.ResultCode;
import com.zhuma.demo.exception.BusinessException;
import com.zhuma.demo.util.ConvertUtil;

/**
 * @desc 全域性異常處理基礎類
 * 
 * @author zhumaer
 * @since 10/10/2017 9:54 AM
 */
@Slf4j
public class BaseGlobalExceptionHandler {

	/**
	 * 違反約束異常
	 */
	protected DefaultErrorResult handleConstraintViolationException(ConstraintViolationException e, HttpServletRequest request) {
		log.info("handleConstraintViolationException start, uri:{}, caused by: ", request.getRequestURI(), e);
		List<ParameterInvalidItem> parameterInvalidItemList = ConvertUtil.convertCVSetToParameterInvalidItemList(e.getConstraintViolations());
		return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST, parameterInvalidItemList);
	}

	/**
	 * 處理驗證引數封裝錯誤時異常
	 */
	protected DefaultErrorResult handleConstraintViolationException(HttpMessageNotReadableException e, HttpServletRequest request) {
		log.info("handleConstraintViolationException start, uri:{}, caused by: ", request.getRequestURI(), e);
		return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST);
	}

	/**
	 * 處理引數繫結時異常（反400錯誤碼）
	 */
	protected DefaultErrorResult handleBindException(BindException e, HttpServletRequest request) {
		log.info("handleBindException start, uri:{}, caused by: ", request.getRequestURI(), e);
		List<ParameterInvalidItem> parameterInvalidItemList = ConvertUtil.convertBindingResultToMapParameterInvalidItemList(e.getBindingResult());
		return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST, parameterInvalidItemList);
	}

	/**
	 * 處理使用@Validated註解時，引數驗證錯誤異常（反400錯誤碼）
	 */
	protected DefaultErrorResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) {
		log.info("handleMethodArgumentNotValidException start, uri:{}, caused by: ", request.getRequestURI(), e);
		List<ParameterInvalidItem> parameterInvalidItemList = ConvertUtil.convertBindingResultToMapParameterInvalidItemList(e.getBindingResult());
		return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST, parameterInvalidItemList);
	}

	/**
	 * 處理通用自定義業務異常
	 */
	protected ResponseEntity<DefaultErrorResult> handleBusinessException(BusinessException e, HttpServletRequest request) {
		log.info("handleBusinessException start, uri:{}, exception:{}, caused by: {}", request.getRequestURI(), e.getClass(), e.getMessage());

		DefaultErrorResult defaultErrorResult = DefaultErrorResult

相關推薦

企業實戰之spring專案《介面響應體格式統一封裝》

前言 在之前的文章中我們有介紹過，如何更好、更簡單的寫好一個介面（介面返回值篇），今天的這篇文章我們主要介紹，怎麼統一處理下介面的返回格式問題。 ###問題分析 我們先來分析下我們所面臨的問題在哪裡，然後接著給出解決方案。在寫一個介面時，我們通常會先統一定義一下

企業實戰之Spring攔截器《統一引數校驗》

在前面的一些文章中我們有講到，通過攔截器我們可以做很多的事情，包括介面統一的 引數校驗、 登入校驗、許可權校驗等，也可以做一些HTTP響應體寫入邏輯，比如我們另一篇文章所說的《解決跨域問題》，本篇我們也就是講解下，使用攔截器對開放的介面做公共引數校驗功能實現。

Openswan企業實戰之ipsec vpn加速ERP系統

openswan ipsec vpn 公司ERP系統是放在IDC機房，租用的別人的雲服務器，因雲服務器供應商的限制，不能直接拉電路專線，又因服務器數量不夠，remoteapp方案也放棄了，只能通過軟件VPN方案來解決問題，之前搭建了一個openvpn，使用route模式，但是用戶反饋使用效果並不理

AWS企業實戰之CloudFront的配置

aws cloudfront cdn akamai對於本文，開始並不打算寫出來，因為aws有非常詳細的官方文檔，但是對於我本人在使用過程中的體會來說，官網文檔並不好理解和閱讀，英文難啃，而中文翻譯往往又不是完全正確，往往給學習帶來誤解，有甄別能力的童鞋或許會提個case或者電話咨詢一下aws的工程師，而大部分

jQuery ajax預處理 和後置處理；專案中ajax自動設定 token 請求頭, 介面響應code的統一處理

專案中經常會遇到需要統一設定 ajax請求的預處理 和 需要統一處理ajax返回的需求 比如登入時需要 在頭部新增token（X-Auth-Token） 請求完需要判斷code為已退出token失效（3001）和許可權不足（3002）的情況 開始使

深入理解Spring 之 Spring 進階開發必知必會 之 Spring 擴充套件介面

# 前言 我們在前幾篇文章中已經深入瞭解了 Spring 的 IOC 機制和 AOP 機制，在閱讀原始碼的同時，樓主對 Spring 中設計模式的運用可以說五體投地，還有我們還知道更重要的一點就是：Spring 留給了我們大量的擴充套件介面供開發者去自定義自己的

Javaweb 實戰之Spring

Java web 實戰之Spring（一）    開始接觸Java web主要是因為在做移動端開發的時候需要客戶端和伺服器的資料互動，而學習它一方面是因為好奇，另一方面也是為了更好的對接客戶端和伺服器

Java反射、泛型和註解實戰之Spring核心注入IOC的實現

一.前言 通過前兩篇文章的學習，我們已經對Java中這三個模組的知識有了初步的瞭解。為了將鞏固之前的知識，今天我們將綜合運用這三個模組的知識，來實現一個類似Spring中注入的案例。 二.專案結構 簡單的描繪了一下專案流程圖，

企業實戰之切面程式設計《統一列印日誌》

前言 面向切面程式設計是spring裡一種很不錯的程式設計思想，簡單來講就是可以將一段功能程式碼在程式執行時，動態地將該段程式碼切入到目標方法前或後插入去執行，這種方式可以實現程式碼的可插拔性，之前我們在攔截器實戰篇中說過的攔截器其實就是切面程式設計的一種實現

【asp.net core 系列】6 實戰之 一個專案的完整結構

# 0. 前言 在《asp.net core 系列》之前的幾篇文章中，我們簡單瞭解了路由、控制器以及檢視的關係以及靜態資源的引入，讓我們對於asp.net core mvc專案有了基本的認識。不過，這些並不是 asp.net core mvc專案的全部內容，剩下的內容我將結合實戰專案為大家講解其中的知識。現

Material Design 實戰 之 第六彈 —— 可摺疊式標題欄(CollapsingToolbarLayout) & 系統差異型的功能實現（充分利用系統狀態列空間）...

本模組共有六篇文章，參考郭神的《第一行程式碼》，對Material Design的學習做一個詳細的筆記，大家可以一起交流一下： Material Design 實戰 之第一彈——Toolbar（即本文） Material Design 實戰 之第二彈——滑動選

spring4.1.8擴充套件實戰之四：感知spring容器變化(SmartLifecycle介面)

本章由以下幾部分組成： SmartLifecycle介面概覽； spring容器啟動與SmartLifecycle的關係； spring容器關閉與SmartLifecycle的關係； 關於Lifecycle和SmartLifecycle； 實戰SmartLi

【實戰】Spring+Spring MVC+Mybatis實戰專案之雲筆記專案

            【實戰】Spring+Spring MVC+Mybatis實戰專案之雲筆記專案一、專案簡介         1、專案概述雲筆記，是tmocc上的一個子專案，用於客戶進行線上學習記錄，分享，收藏筆記，以及參與社群活動。2.模組劃分 使用者模組：登入、註冊

spring boot專案實戰之工具篇（ognl）

當解析複雜的json結構時，ognl是一個很方便的工具，實現基於圖對屬性的訪問，類似於以(user.name | user.depart[0])的方式獲取json內的巢狀物件欄位值。 請看以下示例，你將對ognl的作用有一個更清晰的理解： String js

Spring Boot實戰之Filter實現使用JWT進行介面認證 jwt(json web token) 使用者傳送按照約定，向服務端傳送 Header、Payload 和 Signature，

Spring Boot實戰之Filter實現使用JWT進行介面認證 jwt(json web token) 使用者傳送按照約定，向服務端傳送 Header、Payload 和 Signature，幷包含認證資訊（密碼），驗證通過後服務端返回一個token,之後使用者使用該

Spring Boot實戰之Filter實現使用JWT進行介面認證

jwt(json web token) 使用者傳送按照約定，向服務端傳送 Header、Payload 和 Signature，幷包含認證資訊（密碼），驗證通過後服務端返回一個token,之後使用者使用該token作為登入憑證，適合於移動端和api j

學習《spring 3.x企業應用開發實戰》之Spring的事務管理

1、資料庫事務基礎知識 1.1、資料庫事務的概念 （1）資料庫事物的4個特性（ACID）： 原子性（Atomic）：表示組成一個事務的多個數據庫操作是一個不可分割的原子單元，所有的操作要麼全部成功，要麼全部失敗。一致性（Consistency）：事務操作成功之後，資料庫所

spring進階 第一節 : spring boot 系列之ssm專案實戰

spring進階 第一節 : spring boot 系列之ssm專案實戰 1.spring boot 介紹 特點 - 建立獨立的spring容器應用程式 - 內嵌容器(tomcat，jetty，undertow)無需w

Spring Boot實戰之逐行釋義HelloWorld

runtime ica can pri source 訪問 exclude 這樣的 gradle 一、前言 　　 研究Spring boot也有一小段時間了，最近會將研究東西整理一下給大家分享，大概會有10~20篇左右的博客，整個系列會以一個簡單的博客系統作為基礎，因為光

Spring Boot實戰之數據庫操作

應該 element face 插入 sele run 方式 不同 pan 　　上篇文章中已經通過一個簡單的HelloWorld程序講解了Spring boot的基本原理和使用。本文主要講解如何通過spring boot來訪問數據庫，本文會演示三種方式來訪問數據庫，第一種是