【springMVC】SpringMVCのインターセプターと例外処理【ソースコード添付】

1.インターセプター

1. SpringMVC のインターセプター (Interceptor) は
、サーブレットのフィルター (Filter) に似ており、主にユーザーの要求 (コントローラーメソッド) をインターセプトし、対応する処理を行うために使用されます。例: 権限の検証、ユーザーがログインしているかどうかの判断など。
2. インターセプターの定義
(1) HandlerInterceptor インターフェースを実装する
(2) HandlerInterceptorAdapter クラスを継承する。
3. インターセプターの3つの抽象メソッド
(1) preHandle: コントローラーメソッドが実行される前にpreHandle()を実行し、ブール型の戻り値はインターセプトするか解放するかを示し、解放するためにtrueを返す、つまりコントローラーメソッドを呼び出す; インターセプトを示すために false を返す、つまり、コントローラーメソッドを呼び出さないことを示します
(2) postHandle: コントローラーメソッドの実行後に postHandle() を実行します
(3) afterComplation: ビューとモデルデータの処理とレンダリングの後に afterComplation() を実行しますビュー
4. インターセプターの実行順序
( 1) 単一のインターセプターの実行順序
プログラムは、最初にインターセプタークラスの preHandler() メソッドを実行し、メソッドの戻り値が true の場合、引き続き実行します。実行; ビジネスプロセッサ (Controller クラス) がリクエストを処理した後、postHandler() メソッドが実行され、DispatcherServlet を介してクライアントにレスポンスが返されます。 DispatcherServlet がリクエストを処理すると、 afterCompletion() メソッドが実行されます。
ここに画像の説明を挿入
(2) 複数のインターセプタの実行順序
①各インターセプタの preHandle() が true を返す場合
複数のインターセプターが同時に動作する場合、それらの preHandle() メソッドは構成ファイル内のインターセプターの構成順序で実行され、それらの postHandle および afterCompletion() メソッドは構成順序の逆の順序で実行されます。
②インターセプターのpreHandle()がfalseを返した場合、
preHandle()はfalseを返し、インターセプター前のpreHandle()が実行され、postHandle()は実行されず、AfterComplation()が実行される
5.カスタムインターセプター
pom .xml の依存関係

<dependencies>
    <!--SpringMVC-->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.3.1</version>
    </dependency>
    <!--日志-->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>
    <!--servletAPI-->
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>
    <!--Spring与Thymeleaf整合-->
    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring5</artifactId>
        <version>3.0.12.RELEASE</version>
    </dependency>
</dependencies>

（1）InterceptorController.java

@Controller
public class InterceptorController {
    
    
    @RequestMapping("/testInterceptor")
    public String testInterceptor(){
    
    
        return "success";
    }
}

（2）CustomerInterceptor.java

//若想配置多个拦截器，只需要复制该拦截器，改个类名就可
@Component
public class CustomerInterceptor implements HandlerInterceptor {
    
    
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    
    
        System.out.println("InterceptorTest--->preHandle");
        //return false表示不拦截
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    
    
        System.out.println("InterceptorTest--->postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    
    
        System.out.println("InterceptorTest--->afterCompletion");
    }
}

（3）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 http://www.springframework.org/schema/context/spring-context.xsd
            http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <context:component-scan base-package="com.jd.mvc"/>
    <!--配置视图解析器-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!--视图前缀-->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--视图后缀-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>
    <!--配置SpringMVC的视图控制器-->
    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <mvc:default-servlet-handler/>
    <!--开启SpringMVC的注解驱动-->
    <mvc:annotation-driven/>
    <!--配置拦截器-->
    <mvc:interceptors>
<!--        <bean class="com.jd.mvc.interceptor.CustomerInterceptor"/>-->
			<!--配置第2个拦截器-->
<!--        <bean class="com.jd.mvc.interceptor.CustomerInterceptor2"/>-->
<!--        <ref bean="firstInterceptor"/>-->
<!--        以上两种配置会对所有的请求尽心拦截-->
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/"/>
            <ref bean="customerInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
</beans>

（4）index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>首页</h1><br>
<a th:href="@{/testInterceptor}">测试Interceptor</a>
</body>
</html>

（5）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"
         metadata-complete="true">
    <!--1.配置编码过滤器，在此之前不能获取任何的请求参数，只要获取请求参数，设置编码方式就无用-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <!--设置请求的编码-->
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <!--设置响应的编码-->
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <!--表示对所有的都进行编码，过滤器的执行顺序是根据<filter-mapping>的顺序执行的-->
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!--2.配置HiddenHttpMethodFilter-->
    <filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <!--3.配置SpringMVC的前端控制器-->
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

プロジェクトを tomcat サーバーにデプロイして実行し、ハイパーリンクをクリックして
ここに画像の説明を挿入
アイデアコンソールに戻ると、2 つのインターセプターの実行順序が表示されます。

2.例外ハンドラ

SpringMVC は、コントローラーメソッドの実行中に発生する例外インターフェースを提供します。 HandlerExceptionResolver HandlerExceptionResolverインターフェース
の実装クラスは次のとおりです。 DefaultHandlerExceptionResolver および
SimpleMappingExceptionResolver

構成ベースの例外処理

(1) SpringMVCの設定ファイルに設定

<!--配置SpringMVC的异常映射-->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    <property name="exceptionMappings">
        <props>
            <!--properties的键表示处理器方法执行过程中出现的异常;
                properties的值表示若出现指定异常时，设置一个新的视图名称，跳转到指定页面-->
            <prop key="java.lang.ArithmeticException">error</prop>
        </props>
    </property>
    <!--exceptionAttribute属性设置一个属性名，将异常信息共享在请求域中-->
    <property name="exceptionAttribute" value="ex"/>
</bean>

（2）index.html

<!--设置将异常信息共享在请求域中的键-->
<a th:href="@{/testException}">测试Exception</a><br>

（3）error.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
出现了错误！！！
<!--获取异常并输出-->
<p th:text="${ex}"></p>
</body>
</html>

(4) コントローラ方式

@RequestMapping("/testException")
public String testException(){
    
    
    int i = 10/0;
    return "error";
}

ここに画像の説明を挿入

注釈ベースの例外処理

Java クラスを作成し、対応するアノテーションをマークするだけで、SpringMVC 構成ファイルの構成を保存できます。

@ControllerAdvice
public class ExceptionController {
    
    
    @ExceptionHandler(value = {
    
    ArithmeticException.class,NullPointerException.class})
    public String testException(Exception ex, Model model){
    
    
        model.addAttribute("ex",ex);
        return "error";
    }
}