rest-spring-boot-starter

基于spring boot，統一業務異常處理，統一返回格式包裝

依賴

<dependency>
    <groupId>tk.fishfish</groupId>
    <artifactId>rest-spring-boot-starter</artifactId>
    <version>1.0.0.RELEASE</version>
</dependency>

統一業務異常處理

@RestController
public class DemoController {

    @GetMapping("/list")
    public List<String> list() {
        throw new BizException(10001, "xxx錯誤");
    }

}

業務異常統一處理：

{
    "code": 10001,
    "msg": "xxx錯誤",
    "data": null
}

統一返回格式包裝

@RestController
public class DemoController {

    @GetMapping("/list")
    public List<String> list() {
        return Arrays.asList("1", "2");
    }

}

返回值進行包裝，忽略org.springframework.http.ResponseEntity值類型。

{
    "code": 0,
    "msg": null,
    "data": [
        "1",
        "2"
    ]
}

原理

定義統一格式：

{
    "code": 返回碼,
    "msg": 描述,
    "data": 數據
}

約定：

• code：-1，代表全局異常處理的錯誤；0，成功；正數，業務錯誤碼
• msg：一段描述
• data：真正的數據

異常處理

使用org.springframework.web.bind.annotation.RestControllerAdvice，全局捕獲異常。

package tk.fishfish.rest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 * 全局異常處理，優先級為100
 *
 * @author 奔波兒灞
 * @since 1.0
 */
@Order(100)
@RestControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger LOG = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ExceptionHandler(BizException.class)
    public ApiResult<Void> handleBizException(BizException e) {
        LOG.warn("handle bizException", e);
        Integer code = e.getCode();
        String msg = e.getMessage();
        return ApiResult.fail(code, msg);
    }

    @ExceptionHandler(Exception.class)
    public ApiResult<Void> handleException(Exception e) {
        LOG.warn("handle exception", e);
        String msg = e.getMessage();
        return ApiResult.fail(-1, msg);
    }

}

統一返回

通過實現org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice，在寫入響應前統一包裝返回內容。

package tk.fishfish.rest;

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

/**
 * 返回body處理，包裝成ApiResult。如果是ResponseEntity，則不包裝
 *
 * @author 奔波兒灞
 * @see tk.fishfish.rest.ApiResult
 * @since 1.0
 */
@RestControllerAdvice(annotations = RestController.class)
public class ApiResultResponseBodyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter methodParameter,
                                  MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass,
                                  ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // ResponseEntity，則不包裝
        if (body instanceof ResponseEntity) {
            return body;
        }
        // ApiResult，也不包裝
        if (body instanceof ApiResult) {
            return body;
        }
        // todo 基本數據類型是否特殊處理
        // 其余統一包裝成ApiResult
        return ApiResult.ok(body);
    }

}

項目地址

• Github