Spring Boot异常处理实战

Dear 丶 2021-07-24 16:29 387阅读 0赞

**一 pom**

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0  http://maven.apache.org/xsd/maven-4.0.0.xsd">
         <modelVersion>4.0.0</modelVersion>
         <groupId>org.fkit</groupId>
         <artifactId>exceptiontest</artifactId>
         <version>0.0.1-SNAPSHOT</version>
         <packaging>jar</packaging>
         <name>exceptiontest</name>
         <url>http://maven.apache.org</url>
         
         <parent>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-parent</artifactId>
               <version>2.0.0.RELEASE</version>
               <relativePath />
         </parent>
         <properties>
               <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
               <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
               <java.version>1.8</java.version>
         </properties>
         <dependencies>
               
               <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-web</artifactId>
               </dependency>
               
               <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-thymeleaf</artifactId>
               </dependency>
               <dependency>
                    <groupId>junit</groupId>
                    <artifactId>junit</artifactId>
                    <scope>test</scope>
               </dependency>
         </dependencies>
    </project>

**二 启动类**

package org.fkit.exceptiontest;
    
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    
    //@SpringBootApplication指定这是一个 spring boot的应用程序.
    @SpringBootApplication
    public class App
    {
      public static void main( String[] args )
      {
          // SpringApplication 用于从main方法启动Spring应用的类。
          SpringApplication.run(App.class, args);
      }
    }

**三 控制器**

1 BaseController

package org.fkit.exceptiontest.controller;
    
    import javax.servlet.http.HttpServletRequest;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.servlet.ModelAndView;
    
    
    public class BaseController {
    
    
        @ExceptionHandler(value = Exception.class)
        public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
            System.out.println("BaseController defaultErrorHandler()......");
            ModelAndView mav = new ModelAndView();
            mav.addObject("exception", e);
            mav.addObject("url", req.getRequestURL());
            mav.setViewName("error");
            return mav;
        }
    }

2 BookController

package org.fkit.exceptiontest.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    
    @Controller
    public class BookController extends BaseController{
        
        @RequestMapping("/find")
        public String find() throws Exception{
            System.out.println("find()......");
            int i = 5/0;
            return "success";
        }
    }

3 DeptController

package org.fkit.exceptiontest.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    
    @Controller
    public class DeptController {
    
    
        @RequestMapping("/add")
        public String add(String deptname) throws Exception{
            System.out.println("add()......");
            if(deptname == null ){
                throw new NullPointerException("部门名称不能为空!");
            }
            return "success";
        }
    }

4 TestController

package org.fkit.exceptiontest.controller;
    
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    
    @Controller
    public class TestController{
    
    
        @RequestMapping("/")
        public String index(){
            return "index";
        }
        
        @RequestMapping("/hello")
        public String hello() throws Exception{
            // 抛出异常
            throw new Exception();
        }
        
        @RequestMapping("/test")
        public String test() throws Exception{
            System.out.println("test()......");
            // 模拟异常
            int i = 5/0;
            return "success";
        }
        
        /**
         * 在异常抛出的时候，Controller会使用@ExceptionHandler注解的方法去处理异常，而不会抛出给 Servlet 容器
         * */
        @ExceptionHandler(value = Exception.class)
        public String testErrorHandler(Exception e)  {
            System.out.println("TestController testErrorHandler()......");
            return "服务器故障，请联系管理员。";
        }
        
    }

5 UserController

package org.fkit.exceptiontest.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    
    @Controller
    public class UserController extends BaseController{
        
        @RequestMapping("/login")
        public String login(String username) throws Exception{
            System.out.println("login()......");
            if(username == null ){
                throw new NullPointerException("用户名不存在!");
            }
            return "success";
        }
    }

**四 统一异常处理**

package org.fkit.exceptiontest.exception;
    
    import java.util.HashMap;
    import java.util.Map;
    
    import javax.servlet.http.HttpServletRequest;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    
    @ControllerAdvice
    public class GlobalExceptionHandler {
    
    
        @ExceptionHandler(value = Exception.class)
        @ResponseBody
        public Object globalErrorHandler(HttpServletRequest request,Exception e) throws Exception {
            System.out.println("GlobalExceptionHandler globalErrorHandler()......");
            // 创建返回对象Map并设置属性，会被@ResponseBody注解转换为JSON返回
            Map<String, Object> map = new HashMap<>();
            map.put("code", 100);
            map.put("message", e.getMessage());
            map.put("url", request.getRequestURL().toString());
            map.put("data", "请求失败");
            return map;
        }
    }

**五 视图**

1 index.html

<!DOCTYPE html>
    <html xmlns:th="http://www.thymeleaf.org">
    <head>
    <meta charset="UTF-8"></meta>
    <title>异常处理示例</title>
    <link rel="stylesheet" th:href="@{css/bootstrap.min.css}" />
    <link rel="stylesheet"  th:href="@{css/bootstrap-theme.min.css}"/>
    <script type="text/javascript"  th:src="@{js/jquery-1.11.0.min.js}"></script>
    <script type="text/javascript"  th:src="@{js/bootstrap.min.js}"></script>
    </head>
    <body>
    <div class="panel panel-primary">
         
         <div class="panel-heading">
               
               <h3 class="panel-title">异常处理示例</h3>
         </div>
    </div>
    <div class="container">
         <div class="row">
               <div class="col-md-4">
                    <a th:href="@{hello}">Spring Boot默认异常处理</a><br/><br/>
                    <a th:href="@{test}">@ExceptionHandler处理异常</a><br/><br/>
                    <hr/>
                    <a th:href="@{login}">UserController：父级Controller异常处理</a><br/><br/>
                    <a th:href="@{find}">BookController：父级Controller异常处理</a><br/><br/>
                    <hr/>
                    <a th:href="@{add}">Advice异常处理返回json</a><br/><br/>
               </div>
         </div>
    </div>
    </body>
    </html>

2 error.html

<!DOCTYPE html>
    <html xmlns:th="http://www.thymeleaf.org">
    <head>
    <meta charset="UTF-8"></meta>
    <title>异常处理示例</title>
    <link rel="stylesheet" th:href="@{css/bootstrap.min.css}" />
    <link rel="stylesheet"  th:href="@{css/bootstrap-theme.min.css}"/>
    <script type="text/javascript"  th:src="@{js/jquery-1.11.0.min.js}"></script>
    <script type="text/javascript"  th:src="@{js/bootstrap.min.js}"></script>
    </head>
    <body>
    <div class="panel panel-primary">
         
         <div class="panel-heading">
               
               <h3 class="panel-title">异常处理示例</h3>
         </div>
    </div>
    <div class="container">
         <div class="row">
               <div class="col-md-4">
                    <div th:text="统一异常处理"></div>
                    <div th:text="${url}"></div>
               <div th:text="${exception.message}"></div>
               </div>
         </div>
    </div>
    </body>
    </html>

**六 测试**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 5][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70]: /images/20210724/357546fe87db4dd496414ced17ba6243.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 1]: /images/20210724/5bf6232d0d734f94b08ca112c9777d11.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 2]: /images/20210724/18750218c58b4cae9d8abcc666861883.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 3]: /images/20210724/15e6c0b0d7c1455590c083a6af038999.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 4]: /images/20210724/5129ef03716c4eb68220539265b446d4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 5]: /images/20210724/db1e8ee7b8c34712a450e784a461bcde.png