【SpringMVC】 4.2 異常處理

二七零零發表於2021-02-21

SpringMVC

SpringMVC學習記錄

注意：以下內容是學習 北京動力節點 的SpringMVC視訊後所記錄的筆記、原始碼以及個人的理解等，記錄下來僅供學習

第4章 SpringMVC 核心技術

4.2異常處理

SpringMVC框架處理異常的常用方式：使用@ExceptionHandler註解處理異常。

異常處理步驟：

新建maven web專案
加入依賴
新建一個自定義異常類 MyUserException , 再定義它的子類NameException ,AgeException
在controller丟擲NameException , AgeException
建立一個普通類，作用全域性異常處理類
(1). 在類的上面加入@ControllerAdvice
(2). 在類中定義方法，方法的上面加入@ExceptionHandler
建立處理異常的檢視頁面
.建立springmvc的配置檔案
(1).元件掃描器，掃描@Controller註解
(2).元件掃描器，掃描@ControllerAdvice所在的包名
(3).宣告註解驅動

專案結構：

4.2.1 @ExceptionHandler 註解

使用註解@ExceptionHandler可以將一個方法指定為異常處理方法。該註解只有一個可選屬性value,為一個Class<?>陣列，用於指定該註解的方法所要處理的異常類，即所要匹配的異常。
而被註解的方法，其返回值可以是ModelAndView、String，或void，方法名隨意，方法引數可以是 Exception 及其子類物件、HttpServletRequest、HttpServletResponse 等。系統會自動為這些方法引數賦值。
對於異常處理註解的用法，也可以直接將異常處理方法註解於Controller之中。

(1) 自定義異常類

定義三個異常類：NameException、AgeException、MyUserException。其中 MyUserException 是另外兩個異常的父類。
MyUserException.java

package com.bjpowernode.exception;
public class MyUserException extends Exception {
    public MyUserException() {
        super();
    }

    public MyUserException(String message) {
        super(message);
    }
}

AgeException.java

package com.bjpowernode.exception;

//當年齡有問題時，丟擲的異常
public class AgeException extends MyUserException {
    public AgeException() {
        super();
    }

    public AgeException(String message) {
        super(message);
    }
}

NameException.java

package com.bjpowernode.exception;
//表示當使用者的姓名有異常，丟擲NameException
public class NameException extends MyUserException {
    public NameException() {
        super();
    }
    public NameException(String message) {
        super(message);
    }
}

(2) 修改 Controller 丟擲異常

MyController.java

package com.bjpowernode.controller;

import com.bjpowernode.exception.AgeException;
import com.bjpowernode.exception.MyUserException;
import com.bjpowernode.exception.NameException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.xml.ws.RequestWrapper;

/**
 * @RequestMapping:
 *    value ： 所有請求地址的公共部分，叫做模組名稱
 *    位置： 放在類的上面
 */
@Controller
public class MyController {
    @RequestMapping(value = "/some.do")
    public ModelAndView doSome(String name,Integer age) throws MyUserException {
        //處理some.do請求了。 相當於service呼叫處理完成了。
        ModelAndView mv  = new ModelAndView();

        //try {
            //根據請求引數丟擲異常
            if (!"zs".equals(name)) {
                throw new NameException("姓名不正確！！！");
            }

            if (age == null || age > 80) {
                throw new AgeException("年齡比較大！！！");
            }

        //}catch(Exception e){
        //   e.printStackTrace();
        //}
        mv.addObject("myname",name);
        mv.addObject("myage",age);
        mv.setViewName("show");
        return mv;
    }
}

(3) 定義異常請求以及響應頁面

請求頁面：
index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%
    String basePath = request.getScheme() + "://" +
            request.getServerName() + ":" + request.getServerPort() +
            request.getContextPath() + "/";
%>
<html>
<head>
    <title>Title</title>
    <base href="<%=basePath%>" />
</head>
<body>
     <p>處理異常的，全域性異常處理</p>
    <form action="some.do" method="post">
        姓名：<input type="text" name="name"> <br/>
        年齡：<input type="text" name="age"> <br/>
        <input type="submit" value="提交請求">
    </form>
</body>
</html>

響應頁面
ageError.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
   ageError.jsp <br/>
   提示資訊：${msg} <br/>
   系統異常訊息：${ex.message}

</body>
</html>

defaultError.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
   defaultError.jsp <br/>
   提示資訊：${msg} <br/>
   系統異常訊息：${ex.message}

</body>
</html>

nameError.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
   nameError.jsp <br/>
   提示資訊：${msg} <br/>
   系統異常訊息：${ex.message}

</body>
</html>

(4) 定義全域性異常處理類

不過，一般不這樣使用。而是將異常處理方法專門定義在一個類中，作為全域性的異常處理類。需要使用註解@ControllerAdvice，字面理解就是“控制器增強”，是給控制器物件增強功能的。使用@ControllerAdvice 修飾的類中可以使用@ExceptionHandler。當使用@RequestMapping 註解修飾的方法丟擲異常時，會執行@ControllerAdvice 修飾的類中的異常處理方法。@ControllerAdvice 是使用@Component 註解修飾的，可以context:component-scan掃描到@ControllerAdvice 所在的類路徑(包名)，建立物件。

GlobalExceptionHandler.java

package com.bjpowernode.handler;

import com.bjpowernode.exception.AgeException;
import com.bjpowernode.exception.NameException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;

/**
 * @ControllerAdvice : 控制器增強（也就是說給控制器類增加功能--異常處理功能）
 *           位置：在類的上面。
 *  特點：必須讓框架知道這個註解所在的包名，需要在springmvc配置檔案宣告元件掃描器。
 *  指定@ControllerAdvice所在的包名
 */
@ControllerAdvice
public class GlobalExceptionHandler {
    //定義方法，處理髮生的異常
    /*
        處理異常的方法和控制器方法的定義一樣， 可以有多個引數，可以有ModelAndView,
        String, void,物件型別的返回值

        形參：Exception，表示Controller中丟擲的異常物件。
        通過形參可以獲取發生的異常資訊。

        @ExceptionHandler(異常的class)：表示異常的型別，當發生此型別異常時，
        由當前方法處理
     */

    @ExceptionHandler(value = NameException.class)
    public ModelAndView doNameException(Exception exception){
        //處理NameException的異常。
        /*
           異常發生處理邏輯：
           1.需要把異常記錄下來， 記錄到資料庫，日誌檔案。
             記錄日誌發生的時間，哪個方法發生的，異常錯誤內容。
           2.傳送通知，把異常的資訊通過郵件，簡訊，微信傳送給相關人員。
           3.給使用者友好的提示。
         */
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","姓名必須是zs，其它使用者不能訪問");
        mv.addObject("ex",exception);
        mv.setViewName("nameError");
        return mv;
    }


    //處理AgeException
    @ExceptionHandler(value = AgeException.class)
    public ModelAndView doAgeException(Exception exception){
        //處理AgeException的異常。
        /*
           異常發生處理邏輯：
           1.需要把異常記錄下來， 記錄到資料庫，日誌檔案。
             記錄日誌發生的時間，哪個方法發生的，異常錯誤內容。
           2.傳送通知，把異常的資訊通過郵件，簡訊，微信傳送給相關人員。
           3.給使用者友好的提示。
         */
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","你的年齡不能大於80");
        mv.addObject("ex",exception);
        mv.setViewName("ageError");
        return mv;
    }

    //處理其它異常， NameException, AgeException以外，不知型別的異常
    @ExceptionHandler
    public ModelAndView doOtherException(Exception exception){
        //處理其它異常
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","你的年齡不能大於80");
        mv.addObject("ex",exception);
        mv.setViewName("defaultError");
        return mv;
    }
}

@ControllerAdvice 是使用@Component 註解修飾的
這句話看了原始碼是這樣的，ControllerAdvice類是用@Component 註解的，
@Component 作用：把普通pojo類例項化到spring容器中，相當於配置檔案中的 <bean id="" class=""/>
@Component,@Service,@Controller,@Repository註解的類，並把這些類納入進spring容器中管理。

(5) 定義 Spring 配置檔案

springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!--宣告元件掃描器-->
    <context:component-scan base-package="com.bjpowernode.controller" />

    <!--宣告 springmvc框架中的檢視解析器， 幫助開發人員設定檢視檔案的路徑-->
    <bean  class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!--字首：檢視檔案的路徑-->
        <property name="prefix" value="/WEB-INF/view/" />
        <!--字尾：檢視檔案的副檔名-->
        <property name="suffix" value=".jsp" />
    </bean>
    
    
    <!--處理需要的兩步-->
    <context:component-scan base-package="com.bjpowernode.handler" />
    <mvc:annotation-driven />
</beans>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--宣告，註冊springmvc的核心物件DispatcherServlet
        需要在tomcat伺服器啟動後，建立DispatcherServlet物件的例項。
        為什麼要建立DispatcherServlet物件的例項呢？
        因為DispatcherServlet在他的建立過程中， 會同時建立springmvc容器物件，
        讀取springmvc的配置檔案，把這個配置檔案中的物件都建立好， 當使用者發起
        請求時就可以直接使用物件了。

        servlet的初始化會執行init（）方法。 DispatcherServlet在init（）中{
           //建立容器，讀取配置檔案
           WebApplicationContext ctx = new ClassPathXmlApplicationContext("springmvc.xml");
           //把容器物件放入到ServletContext中
           getServletContext().setAttribute(key, ctx);
        }

        啟動tomcat報錯，讀取這個檔案 /WEB-INF/springmvc-servlet.xml（/WEB-INF/myweb-servlet.xml）
        springmvc建立容器物件時，讀取的配置檔案預設是/WEB-INF/<servlet-name>-servlet.xml .
    -->
    <servlet>
        <servlet-name>myweb</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

        <!--自定義springmvc讀取的配置檔案的位置-->
        <init-param>
            <!--springmvc的配置檔案的位置的屬性-->
            <param-name>contextConfigLocation</param-name>
            <!--指定自定義檔案的位置-->
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>

        <!--在tomcat啟動後，建立Servlet物件
            load-on-startup:表示tomcat啟動後建立物件的順序。它的值是整數，數值越小，
                            tomcat建立物件的時間越早。 大於等於0的整數。
        -->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>myweb</servlet-name>
        <!--
            使用框架的時候， url-pattern可以使用兩種值
            1. 使用副檔名方式， 語法 *.xxxx , xxxx是自定義的副檔名。 常用的方式 *.do, *.action, *.mvc等等
               不能使用 *.jsp
               http://localhost:8080/myweb/some.do
               http://localhost:8080/myweb/other.do

            2.使用斜槓 "/"
        -->
        <url-pattern>*.do</url-pattern>
    </servlet-mapping>
</web-app>

SpringMVC異常處理
2020-11-26
SpringMVC
SpringMVC 統一異常處理
2018-04-02
SpringMVC
如何使用SpringMvc處理Rest異常
2018-09-28
SpringMVCREST
SpringMVC異常的處理機制
2020-10-22
SpringMVC
Day133.異常處理 -SpringMVC
2020-12-15
SpringMVC
SpringMVC學習系列（10）之異常處理
2020-11-27
SpringMVC
SpringMVC學習筆記10-異常處理
2020-12-16
SpringMVC筆記
SpringMvc-10.14上傳、攔截器、異常處理
2020-10-14
SpringMVC
異常篇——異常處理
2022-02-27
異常處理
2024-10-18
JSP 異常處理如何處理？
2021-09-01
JS
SpringMVC【校驗器、統一處理異常、RESTful、攔截器】
2018-03-17
SpringMVCREST
異常-throws的方式處理異常
2018-09-02
React 異常處理
2019-03-01
React
JS異常處理
2018-05-08
JS
oracle異常處理
2023-05-09
Oracle
Python——異常處理
2019-08-04
Python
Python異常處理
2020-06-24
Python
ThinkPHP 異常處理
2019-12-18
PHP
JavaScript 異常處理
2020-08-13
JavaScript
JAVA 異常處理
2020-10-31
Java
異常的處理
2024-08-05
golang - 異常處理
2024-07-02
Golang
異常處理2
2024-07-02
異常處理1
2024-07-03
Java 異常處理
2024-05-30
Java
Abp 異常處理
2022-02-27
JAVA異常處理
2022-02-24
Java
08、異常處理
2021-02-20
異常處理機制(二)之異常處理與捕獲
2023-11-14
Java 異常表與異常處理原理
2019-01-27
Java
restframework 異常處理及自定義異常
2018-07-09
RESTFramework
springboot下新增全域性異常處理和自定義異常處理
2023-12-11
Spring Boot
NodeJS之異常處理
2019-03-25
NodeJS
JAVA_異常處理
2018-11-21
Java
React Native 異常處理
2018-09-15
React Native
Spring Boot 異常處理
2024-03-27
Spring Boot
PHP 核心 - 異常處理
2019-11-22
PHP