快捷導(dǎo)航

springboot統(tǒng)一異常處理(返回json)并格式化異常

更新時(shí)間：2023年07月10日 10:59:42 作者：卑微小鐘

這篇文章主要介紹了springboot統(tǒng)一異常處理(返回json)并格式化異常,對spring boot的默認(rèn)異常處理方式進(jìn)行修改，要統(tǒng)一返回?cái)?shù)據(jù)格式，優(yōu)雅的數(shù)據(jù)交互，優(yōu)雅的開發(fā)應(yīng)用,需要的朋友可以參考下

統(tǒng)一異常處理

當(dāng)用spring boot開發(fā)后端時(shí)，我們常采用前后端分離的開發(fā)策略，這時(shí)候要求前端與后端需要進(jìn)行數(shù)據(jù)交互，傳統(tǒng)的一般采用json數(shù)據(jù)交互。

這時(shí)候我們要對spring boot的默認(rèn)異常處理方式進(jìn)行修改了，要統(tǒng)一返回?cái)?shù)據(jù)格式，優(yōu)雅的數(shù)據(jù)交互，優(yōu)雅的開發(fā)應(yīng)用。

首先我們要了解一般springboot的錯誤發(fā)生在什么地方。

一般發(fā)生在controller、業(yè)務(wù)層、filter中（如spring security）、攔截器中、還有就是未知錯誤了。

下面我分享一下我的處理方式: @RestControllerAdvice+filter+重寫B(tài)asicErrorController的處理方式。

@RestControllerAdvice

@RestControllerAdvice+@ExceptionHandler(Exception.class)可以處理經(jīng)過controller的異常錯誤

@RestControllerAdvice
public class BaseExceptionHandler {
    private static final Logger logger = LoggerFactory.getLogger(BaseExceptionHandler.class);
    /**
     * 未知異常
     * @param e 異常
     * @return 統(tǒng)一結(jié)果返回
     */
    @ExceptionHandler(Exception.class)
    public R exception(Exception e) {
        logger.error(e.getMessage(), e);
        return R.error().message(e.getMessage());
    }
    @ExceptionHandler(NoHandlerFoundException.class)
    public R noHandlerFoundException(){
        return R.error().message("當(dāng)前頁面不存在");
    }
}

filter捕獲所有異常

當(dāng)錯誤沒有經(jīng)過controller時(shí)，@RestControllerAdvice是不能捕獲的，這時(shí)候就需要在filter進(jìn)行處理。

public class ExceptionHandlerFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain){
        try {
            filterChain.doFilter(servletRequest, servletResponse);
        } catch (Exception e) {
            ResponseUtils.out((HttpServletResponse) servletResponse, R.error().message(e.getMessage()));
        }
    }
}

記得filter一定要注冊到springboot才有作用，下面是我喜歡的一種方式

@Bean
FilterRegistrationBean<ExceptionHandlerFilter> exceptionFilterRegistrationBean() {
    FilterRegistrationBean<ExceptionHandlerFilter> bean = new FilterRegistrationBean<>();
    bean.setFilter(new ExceptionHandlerFilter());
    bean.setOrder(Ordered.HIGHEST_PRECEDENCE);//放在最前面
    return bean;
}

未知異常處理

當(dāng)發(fā)生的異常不知道在哪時(shí)，springboot會進(jìn)行默認(rèn)異常處理，跳轉(zhuǎn)到 /error

這時(shí)我們要統(tǒng)一數(shù)據(jù)返回就必須要從這下手了，創(chuàng)建一個新的Controller處理/error，繼承BasicErrorController，并覆蓋其中的方法

@RestController
public class MyErrorController extends BasicErrorController {
    @Autowired
    public MyErrorController(ErrorAttributes errorAttributes,
                             ServerProperties serverProperties,
                             List<ErrorViewResolver> errorViewResolvers) {
        super(errorAttributes, serverProperties.getError(), errorViewResolvers);
    }
    @Override
    public ModelAndView errorHtml(HttpServletRequest request,
                                  HttpServletResponse response) {
        HttpStatus status = getStatus(request);
        Map<String, Object> model = Collections
                .unmodifiableMap(getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.TEXT_HTML)));
//        return new ModelAndView("error", model, status);
        ResponseUtils.out(response, R.error().code(status.value()).message((String) model.get("error")));
        return null;
    }
    @Override
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        Map<String, Object> body = getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.ALL));
        //可以換成項(xiàng)目中自定義的通信json
        Map<String, Object> resultBody = new HashMap<>(16);
        resultBody.put("success", false);
        resultBody.put("code", body.get("status"));
        resultBody.put("message", body.get("error"));
        Map<String, Object> data = new HashMap<>();
        data.put("timestamp", body.get("timestamp"));
        data.put("path", body.get("path"));
        resultBody.put("data", data);
        return new ResponseEntity<>(resultBody, HttpStatus.OK);
    }
}

配置文件

spring:
  mvc:
    throw-exception-if-no-handler-found: true
  web:
    resources:
      add-mappings: false
server:
  error:
    include-exception: true
  servlet:
    encoding:
      charset: utf-8

統(tǒng)一結(jié)果返回的工具類

ResponseUtils

public class ResponseUtils {
    public static void out(HttpServletResponse response, R r) {
        ObjectMapper mapper = new ObjectMapper();
        response.setStatus(HttpStatus.OK.value());
        response.setContentType("application/json;charset=UTF-8");
        try {
            mapper.writeValue(response.getWriter(), r);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

R

@Data
public class R implements Serializable {
    private boolean success;
    private Integer code;
    private String message;
    private Map<String,Object> data;
    private R(){}
    public static R ok(){
        R r = new R();
        r.setSuccess(true);
        r.setCode(200);
        r.setMessage("成功");
        r.setData(new HashMap<>());
        return r;
    }
    public static R error() {
        R r = new R();
        r.setSuccess(false);
        r.setCode(500);
        r.setMessage("失敗");
        r.setData(new HashMap<>());
        return r;
    }
    public R success(Boolean success){
        this.success = success;
        return this;
    }
    public R code(Integer code){
        this.code = code;
        return this;
    }
    public R message(String message){
        this.message = message;
        return this;
    }
    public R data(String key, Object value){
        this.data.put(key,value);
        return this;
    }
    public R data(Map<String,Object> map){
        this.setData(map);
        return this;
    }
}

到此這篇關(guān)于springboot統(tǒng)一異常處理(返回json)并格式化異常的文章就介紹到這了,更多相關(guān)springboot統(tǒng)一異常處理內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: