springboot全局异常处理详解

所属分类：软件编程 / java 阅读数： 42

收藏 0赞 0分享

一、单个controller范围的异常处理

package com.xxx.secondboot.web;

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.xxx.secondboot.exception.MyExceptionResponse;

import io.swagger.annotations.Api;

@Api("测试controllerAdvice和全局异常处理")
@RestController
@RequestMapping("/advice1")
public class AdviceController {

  @RequestMapping(value = "/test1", method = RequestMethod.GET)
  public String test1() {
    throw new RuntimeException("advice1 - exception1");
  }

  @RequestMapping(value = "/test2", method = RequestMethod.GET)
  public String test2() {
    throw new RuntimeException("advice1 - exception2");
  }

  @ExceptionHandler(RuntimeException.class)
  public MyExceptionResponse exceptionHandler() {
    MyExceptionResponse resp = new MyExceptionResponse();
    resp.setCode(300);
    resp.setMsg("exception-Handler");
    return resp;
  }

}

说明：

在controller中加入被@ExceptionHandler修饰的类即可（在该注解中指定该方法需要处理的那些异常类）
该异常处理方法只在当前的controller中起作用

二、全部controller范围内起作用的异常处理（全局异常处理）

1、全局异常处理类

package com.xxx.secondboot.web;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import com.xxx.secondboot.exception.MyExceptionResponse;
import com.xxx.secondboot.exception.MyRuntimeException;

//@ControllerAdvice(annotations=RestController.class)
//@ControllerAdvice(basePackages={"com.xxx","com.ooo"})
@ControllerAdvice
public class GlobalExceptionHandler {
  @ExceptionHandler(RuntimeException.class)
  //  @ExceptionHandler(value={RuntimeException.class,MyRuntimeException.class})
  //  @ExceptionHandler//处理所有异常
  @ResponseBody //在返回自定义相应类的情况下必须有，这是@ControllerAdvice注解的规定
  public MyExceptionResponse exceptionHandler(RuntimeException e, HttpServletResponse response) {
    MyExceptionResponse resp = new MyExceptionResponse();
    resp.setCode(300);
    resp.setMsg("exception-Handler");
    //    response.setStatus(600);
    return resp;
  }
}

说明：

@ControllerAdvice是controller的一个辅助类，最常用的就是作为全局异常处理的切面类
@ControllerAdvice可以指定扫描范围
@ControllerAdvice约定了几种可行的返回值，如果是直接返回model类的话，需要使用@ResponseBody进行json转换
1. 返回String，表示跳到某个view
2. 返回modelAndView
3. 返回model + @ResponseBody

2、controller

package com.xxx.secondboot.web;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;

@Api("测试controllerAdvice和全局异常处理")
@RestController
@RequestMapping("/advice1")
public class AdviceController {

  @RequestMapping(value = "/test1", method = RequestMethod.GET)
  public String test1() {
    throw new RuntimeException("advice1 - exception1");
  }

  @RequestMapping(value = "/test2", method = RequestMethod.GET)
  public String test2() {
    throw new RuntimeException("advice1 - exception2");
  }

  //  @ExceptionHandler(RuntimeException.class)
  //  public MyExceptionResponse exceptionHandler() {
  //    MyExceptionResponse resp = new MyExceptionResponse();
  //    resp.setCode(300);
  //    resp.setMsg("exception-Handler");
  //    return resp;
  //  }

}

注意：