SpringBoot 全局異常配置及返回自定義頁面

1. 全局異常的配置

---

1. 創建異常處理類

package com.test.spring_boot_demo.domain;

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

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class CustomExtHandler {

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

    //  捕獲全局異常，處理所有不可知的異常
    @ExceptionHandler(value = Exception.class)
    // @ResponseBody
   Object handleException(Exception e, HttpServletRequest request) {
        LOG.error("url {}, msg {}", request.getRequestURL(), e.getMessage());
        Map<String, Object> map = new HashMap<>();
        map.put("code", "100");
        map.put("msg", e.getMessage());
        map.put("url", request.getRequestURL());
        return map;
    }

}

• 使用 @RestControllerAdvice 註解，可以不需要 @ResponseBody 註解

2. 創建controller接口

@GetMapping("/test/exception")
public Object testException() {
    int n = 1/0;
    return "test exception";
}

3. 訪問測試

• 瀏覽器訪問地址

  http://localhost:8080/test/exception
  

• 返回結果

  {"msg":"/ by zero","code":"100","url":"http://localhost:8080/test/exception"}
  

2. 觸發異常返回自定義頁面

---

1. 官網介紹

• 官方地址

2. 添加模板引擎依賴

<!-- 模板引擎 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

3. 添加自定義異常類

package com.test.spring_boot_demo.domain;

public class MyException extends RuntimeException {

    private String code;
    private String msg;

    public MyException(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

4. 添加自定義異常監聽器

@ExceptionHandler(value = MyException.class)
Object handleMyException(MyException e) {
    ModelAndView modelAndView = new ModelAndView();
    modelAndView.setViewName("error.html");
    modelAndView.addObject("msg", e.getMessage());
    return modelAndView;
}

5. 添加Http請求接口

@GetMapping("/test/myexception")
public Object myexc() {
    throw new MyException("500", "my ext 異常");
}

6. 測試

• 測試：瀏覽器訪問

  http://localhost:8080/test/myexception
  

• 結果：跳轉到新的頁面

  出異常 template