springboot全局异常处理详解

时间:2022-05-31 22:05:56

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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;
  }
 
}

说明:

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

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

1、全局异常处理类

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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;
  }
}

说明:

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

2、controller

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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;
  //  }
 
}

注意:

  1. 同一个异常被局部范围异常处理器和全局范围异常处理器同时覆盖,会选择小范围的局部范围处理器
  2. 同一个异常被小范围的异常类和大范围的异常处理器同时覆盖,会选择小范围的异常处理器

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。

原文链接:http://www.cnblogs.com/java-zhao/p/5769018.html