14、SpringMVC之註解配置

来源:https://www.cnblogs.com/Javaer1995/archive/2023/11/19/17833503.html
-Advertisement-
Play Games

14.1、概述 在實際工作中，一般使用配置類和註解代替web.xml和SpringMVC配置文件的功能； 在 Servlet3.0 環境中，容器會在類路徑中查找實現了 javax.servlet.ServletContainerInitializer 介面的類， 如果找到了的話，就會用它來配置 Se ...


14.1、概述

  • 在實際工作中，一般使用配置類和註解代替web.xml和SpringMVC配置文件的功能；

  • 在 Servlet3.0 環境中，容器會在類路徑中查找實現了 javax.servlet.ServletContainerInitializer 介面的類，
    如果找到了的話，就會用它來配置 Servlet 容器；

  • Spring 提供了 ServletContainerInitializer 這個介面的實現，類名為 SpringServletContainerInitializer，
    這個類又會查找實現了 WebApplicationInitializer 介面的類，並將配置的任務交給它們來完成；

  • Spring3.2 引入了一個便利的 WebApplicationInitializer 基礎實現，類名為 AbstractAnnotationConfigDispatcherServletInitializer；

  • 當自定義的類繼承了 AbstractAnnotationConfigDispatcherServletInitializer 並將其部署到 Servlet3.0 容器的時候，
    容器會自動發現它，並用它來配置 Servlet 上下文。

14.2、環境搭建

14.2.1、在project創建新module

image

12.2.2、選擇maven

image

14.2.3、設置module名稱和路徑

image

image

14.2.4、module初始狀態

image

14.2.5、配置打包方式和引入依賴

image

註意：預設的打包方式為 jar，為了能配置web資源，需要將打包方式設置為 war

<?xml version="1.0" encoding="UTF-8"?>
<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>online.liaojy</groupId>
    <artifactId>spring_mvc_annotation</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <dependencies>
        <!-- SpringMVC (基於依賴的傳遞性，會間接引入Spring的依賴)-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.1</version>
        </dependency>
        <!-- 日誌（Thymeleaf必須要sl4j，logback則是sl4j的實現） -->
        <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>
        <!-- Spring5和Thymeleaf整合包 -->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
        <!--文件上傳-->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.3.1</version>
        </dependency>
    </dependencies>

</project>

14.2.6、配置web資源目錄

image

打開Project Structure，選擇對應的module，併為該module創建一個web.xml文件

image

註意：web.xml文件需要放到web資源路徑（工程路徑\src\main\webapp）下

image

因為使用配置類和註解來配置 Servlet 上下文，所以 web.xml 不再需要配置。

14.2.7、創建攔截器

image

package online.liaojy.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author liaojy
 * @date 2023/11/15 - 7:22
 */
public class AAAInterceptor implements HandlerInterceptor {

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }

}

14.2.8、創建模板目錄及頁面模板

image

註意：html要引入thymeleaf的約束：xmlns:th="http://www.thymeleaf.org"

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>

<h1>index.html</h1>

</body>
</html>

image

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>錯誤頁面</title>
</head>
<body>

<h1>errorPage.html</h1>

</body>
</html>

14.2.9、配置tomcat

image

image

image

14.3、web.xml的註解配置

14.3.1、創建Spring配置類

image

package online.liaojy.config;

/**
 * @author liaojy
 * @date 2023/11/16 - 23:59
 * 該類用於代替spring的配置文件
 */
public class SpringConfig {

    //ssm整合之後，spring的配置信息寫在此類中

}

14.3.2、創建SpringMVC配置類

image

package online.liaojy.config;

/**
 * @author liaojy
 * @date 2023/11/17 - 0:02
 * 該類用於代替SpringMVC的配置文件
 */
public class SpringMVCConfig {
}

14.3.3、創建代替web.xml的初始化類

image

package online.liaojy.config;

import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.filter.HiddenHttpMethodFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

import javax.servlet.Filter;

/**
 * @author liaojy
 * @date 2023/11/17 - 0:04
 */
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {

    // 指定代替 Spring 配置文件的配置類（可以按功能或需要來劃分多個）
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }

    // 指定代替 SpringMVC 配置文件的配置類（可以按功能或需要來劃分多個）
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMVCConfig.class};
    }

    // 設置 SpringMVC 的前端控制器 DispatcherServlet 需要處理的請求路徑（即 url-pattern ）
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    // 設置過濾器
    @Override
    protected Filter[] getServletFilters() {

        // 配置編碼過濾器
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("UTF-8");
        characterEncodingFilter.setForceEncoding(true);

        // 配置處理請求方式的過濾器
        // 註意該過濾器所在的包路徑為 org.springframework.web.filter.HiddenHttpMethodFilter
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();

        // 配置要使用的過濾器
        return new Filter[]{characterEncodingFilter,hiddenHttpMethodFilter};

    }
}

14.4、SpringMVC配置類的詳細配置

14.4.1、將類標識為配置類

image

// @Configurable 註解：將類標識為配置類
@Configurable

14.4.2、實現 WebMvcConfigurer 介面

image

14.4.3、配置掃描組件

image

先創建一個需要掃描的包及組件

package online.liaojy.controller;

import org.springframework.stereotype.Controller;

/**
 * @author liaojy
 * @date 2023/11/19 - 16:56
 */
@Controller
public class TestController {
}

image

// @ComponentScan 註解：用於掃描指定包的組件
@ComponentScan("online.liaojy.controller")

14.4.4、配置預設servlet處理器

image

    // 配置預設servlet處理器
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

14.4.5、配置mvc註解驅動

image

// @EnableWebMvc 註解：開啟mvc的註解驅動
@EnableWebMvc

14.4.6、配置視圖控制器

image

    // 配置視圖控制器
    public void addViewControllers(ViewControllerRegistry registry) {
        // addViewController 設置視圖控制器要處理的請求路徑，setViewName 設置匹配請求路徑的邏輯視圖
        registry.addViewController("/").setViewName("index");
    }

14.4.7、配置文件上傳解析器

image

    // 配置文件上傳解析器
    // @Bean 註解：用於將所標識方法的返回值作為一個 bean 來進行管理，bean的id為方法名
    @Bean
    public CommonsMultipartResolver multipartResolver(){
        return new CommonsMultipartResolver();
    }

14.4.8、配置攔截器

image

    // 配置攔截器
    public void addInterceptors(InterceptorRegistry registry) {
        AAAInterceptor aaaInterceptor = new AAAInterceptor();
        // addInterceptor 設置要使用的攔截器，
        // addPathPatterns 設置該攔截器要攔截的請求路徑（ /** 表示所有路徑），excludePathPatterns 設置要排除的攔截路徑
        registry.addInterceptor(aaaInterceptor).addPathPatterns("/**").excludePathPatterns("/abc");
    }

14.4.9、配置異常解析器

image

    // 配置異常解析器
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {

        // 創建 SimpleMappingExceptionResolver 異常解析器，來對控制器方法出現的異常進行自定義異常處理
        SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();

        // 設置異常和錯誤提示頁面的映射關係
        Properties properties = new Properties();
        properties.setProperty("java.lang.ArithmeticException", "errorPage");
        simpleMappingExceptionResolver.setExceptionMappings(properties);

        // 設置共用到域對象中的異常信息的屬性名
        simpleMappingExceptionResolver.setExceptionAttribute("exceptionMessage");

        // 添加要使用的異常解析器器
        resolvers.add(simpleMappingExceptionResolver);
    }

14.4.10、配置視圖解釋器

image

配置視圖解釋器，無論是通過xml還是配置類都比較複雜；一般直接都是複製配置模板，然後根據實際修改視圖首碼及尾碼即可

    //配置生成模板解析器
    @Bean
    public ITemplateResolver templateResolver() {

        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        // ServletContextTemplateResolver 需要一個 ServletContext 作為構造參數，可通過 WebApplicationContext 的方法獲得
        ServletContextTemplateResolver templateResolver =
                new ServletContextTemplateResolver(webApplicationContext.getServletContext());

        templateResolver.setPrefix("/WEB-INF/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setCharacterEncoding("UTF-8");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        return templateResolver;

    }

    //生成模板引擎併為模板引擎註入模板解析器
    @Bean
    public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    //生成視圖解析器併為解析器註入模板引擎
    @Bean
    public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }

14.4.11、全配置彙總

package online.liaojy.config;

import online.liaojy.interceptor.AAAInterceptor;
import org.springframework.beans.factory.annotation.Configurable;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.context.ContextLoader;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.multipart.commons.CommonsMultipartResolver;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ViewResolver;
import org.springframework.web.servlet.config.annotation.*;
import org.springframework.web.servlet.handler.SimpleMappingExceptionResolver;
import org.thymeleaf.spring5.SpringTemplateEngine;
import org.thymeleaf.spring5.view.ThymeleafViewResolver;
import org.thymeleaf.templatemode.TemplateMode;
import org.thymeleaf.templateresolver.ITemplateResolver;
import org.thymeleaf.templateresolver.ServletContextTemplateResolver;

import java.util.List;
import java.util.Properties;

/**
 * @author liaojy
 * @date 2023/11/17 - 0:02
 * 該類用於代替SpringMVC的配置文件
 */

// @Configurable 註解：將類標識為配置類
@Configurable
// @ComponentScan 註解：用於掃描指定包的組件
@ComponentScan("online.liaojy.controller")
// @EnableWebMvc 註解：開啟mvc的註解驅動
@EnableWebMvc
public class SpringMVCConfig implements WebMvcConfigurer {

    // 配置預設servlet處理器
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    // 配置視圖控制器
    public void addViewControllers(ViewControllerRegistry registry) {
        // addViewController 設置視圖控制器要處理的請求路徑，setViewName 設置匹配請求路徑的邏輯視圖
        registry.addViewController("/").setViewName("index");
    }

    // 配置文件上傳解析器
    // @Bean 註解：用於將所標識方法的返回值作為一個 bean 來進行管理，bean的id為方法名
    @Bean
    public CommonsMultipartResolver multipartResolver(){
        return new CommonsMultipartResolver();
    }

    // 配置攔截器
    public void addInterceptors(InterceptorRegistry registry) {
        AAAInterceptor aaaInterceptor = new AAAInterceptor();
        // addInterceptor 設置要使用的攔截器，
        // addPathPatterns 設置該攔截器要攔截的請求路徑（ /** 表示所有路徑），excludePathPatterns 設置要排除的攔截路徑
        registry.addInterceptor(aaaInterceptor).addPathPatterns("/**").excludePathPatterns("/abc");
    }

    // 配置異常解析器
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {

        // 創建 SimpleMappingExceptionResolver 異常解析器，來對控制器方法出現的異常進行自定義異常處理
        SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();

        // 設置異常和錯誤提示頁面的映射關係
        Properties properties = new Properties();
        properties.setProperty("java.lang.ArithmeticException", "errorPage");
        simpleMappingExceptionResolver.setExceptionMappings(properties);

        // 設置共用到域對象中的異常信息的屬性名
        simpleMappingExceptionResolver.setExceptionAttribute("exceptionMessage");

        // 添加要使用的異常解析器器
        resolvers.add(simpleMappingExceptionResolver);
    }

    //配置生成模板解析器
    @Bean
    public ITemplateResolver templateResolver() {

        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        // ServletContextTemplateResolver 需要一個 ServletContext 作為構造參數，可通過 WebApplicationContext 的方法獲得
        ServletContextTemplateResolver templateResolver =
                new ServletContextTemplateResolver(webApplicationContext.getServletContext());

        templateResolver.setPrefix("/WEB-INF/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setCharacterEncoding("UTF-8");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        return templateResolver;

    }

    //生成模板引擎併為模板引擎註入模板解析器
    @Bean
    public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    //生成視圖解析器併為解析器註入模板引擎
    @Bean
    public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }

}

14.5、測試效果

image

image

本文來自博客園，作者：Javaer1995，轉載請註明原文鏈接：https://www.cnblogs.com/Javaer1995/p/17833503.html


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 在Vue3中使用Element-Plus分頁（Pagination ）組件
    在Vue3中使用Element-Plus分頁（Pagination ）組件 開發過程中數據展示會經常使用到，同時分頁功能也會添加到頁面中。 記：在Vue3中使用Element-Plus分頁組件與表格數據實現分頁交互。 開始實現 引入表格和分頁組件的H5標簽。 <strong>Element-Plus ...
  • Webpack.devServer 配置項如何使用？附devServer完整示例
    前言: 我們在平常本地開發時，可能經常需要與後端進行聯調，或者調用一些api，但是由於瀏覽器跨域的限制、開發與生產環境的差異、http與https等問題經常讓聯調的過程不夠順暢。所以本文介紹一下webpack的devServer中的proxy配置項。接下來讓我們先看一下這個配置項的基本使用： 基本使 ...
  • 系統設計(架構師)指南A：PlatformIO雲IDE實例
    前言 這是第二次博客作業，總結了近三次PTA大作業的完成情況，這三次的大作業難度逐漸增大，完全理不清邏輯，真的越想越混亂，代碼寫的也是很亂，沒有一個整體的框架結構，讀起來很困難，沒有學到java程式編寫的真諦，總之對於我，一個邏輯很差很差的人來說，越來越複雜的題目，寫起來真的痛苦，到後面的題目，基本 ...
  • Python 按規則解析並替換字元串中的變數及函數
    按規則解析並替換字元串中的變數及函數 需求 1、按照一定規則解析字元串中的函數、變數表達式，並替換這些表達式。這些函數表達式可能包含其它函數表達式，即支持函數嵌套 2、函數表達式格式：${ __函數名稱() }、${__函數名稱( 函數參數 )} 3、變數表達式格式：${ varName } 註意： ...
  • pymssql 報20002錯誤解決辦法：DB-Lib error message 20002, severity 9
    python 版本：3.6 win32 版本（因為一些特殊原因必須使用3.6） pymssql 版本：2.2.0 連接資料庫： import pymssql** def InitMssql(self): try: host = self.IniConfig.get('default','dbhost ...
  • 【Python】【OpenCV】【NumPy】圖像和原始位元組的轉換
    學習完基礎的圖像演算法，開始接觸OpenCV學習： 灰度圖中，一個像素點上的灰度級需要一個位元組（byte，2^8，8 bit）進行存儲，此時的灰度圖是二維的。而當我們需要轉換為彩色圖時，即三維，便會產生顏色通道（Channel），這個時候，一個像素點上的灰度級便會需要三個位元組來進行存儲。 可以藉助笛卡 ...
  • C語言【數組】
    本文只發佈於利用OpenCV實現尺度不變性與角度不變性的特征找圖演算法和知乎 一般來說，利用OpenCV實現找圖功能，用的比較多的是模板匹配（matchTemplate）。筆者比較喜歡裡面的NCC演算法。但是模板有個很明顯的短板，面對尺度改變，角度改變的目標就無能為力了。因此本文旨在做到模板匹配做不到的 ...
  • 三天吃透Redis面試八股文
    目錄： Redis是什麼？ Redis優缺點？ Redis為什麼這麼快？ 講講Redis的線程模型？ Redis應用場景有哪些？ Memcached和Redis的區別？ 為什麼要用 Redis 而不用 map/guava 做緩存? Redis 數據類型有哪些？ SortedSet和List異同點？ ...
一周排行
    -Advertisement-
    Play Games
  • 實用接地氣的 .NET 微服務框架
    前言 微服務架構已經成為搭建高效、可擴展系統的關鍵技術之一，然而，現有許多微服務框架往往過於複雜，使得我們普通開發者難以快速上手並體驗到微服務帶了的便利。為瞭解決這一問題，於是作者精心打造了一款最接地氣的 .NET 微服務框架，幫助我們輕鬆構建和管理微服務應用。 本框架不僅支持 Consul 服務註 ...
  • 基於surging的木舟IOT平臺如何添加網路組件
    先看一下效果吧: 如果不會寫動畫或者懶得寫動畫，就直接交給Blend來做吧; 其實Blend操作起來很簡單，有點類似於在操作PS，我們只需要設置關鍵幀，滑鼠點來點去就可以了，Blend會自動幫我們生成我們想要的動畫效果. 第一步：要創建一個空的WPF項目 第二步：右鍵我們的項目，在最下方有一個，在B ...
  • Prism:框架介紹與安裝
    Prism:框架介紹與安裝 什麼是Prism? Prism是一個用於在 WPF、Xamarin Form、Uno 平臺和 WinUI 中構建鬆散耦合、可維護和可測試的 XAML 應用程式框架 Github https://github.com/PrismLibrary/Prism NuGet htt ...
  • 不可不知的WPF畫筆（Brush）
    在WPF中，屏幕上的所有內容，都是通過畫筆（Brush）畫上去的。如按鈕的背景色，邊框，文本框的前景和形狀填充。藉助畫筆，可以繪製頁面上的所有UI對象。不同畫筆具有不同類型的輸出（ 如：某些畫筆使用純色繪製區域，其他畫筆使用漸變、圖案、圖像或繪圖）。 ...
  • .NET 8 高併發微服務電商系統實戰
    前言 嗨，大家好！推薦一個基於 .NET 8 的高併發微服務電商系統，涵蓋了商品、訂單、會員、服務、財務等50多種實用功能。 項目不僅使用了 .NET 8 的最新特性，還集成了AutoFac、DotLiquid、HangFire、Nlog、Jwt、LayUIAdmin、SqlSugar、MySQL、 ...
  • 基於surging 如何利用peerjs進行語音視頻通話
    本文主要介紹攝像頭（相機）如何採集數據，用於類似攝像頭本地顯示軟體，以及流媒體數據傳輸場景如傳屏、視訊會議等。 攝像頭採集有多種方案，如AForge.NET、WPFMediaKit、OpenCvSharp、EmguCv、DirectShow.NET、MediaCaptre（UWP），網上一些文章以及 ...
  • [WPF]數據綁定時為何會出現StringFormat失效
    前言 Seal-Report 是一款.NET 開源報表工具，擁有 1.4K Star。它提供了一個完整的框架，使用 C# 編寫，最新的版本採用的是 .NET 8.0 。 它能夠高效地從各種資料庫或 NoSQL 數據源生成日常報表，並支持執行複雜的報表任務。 其簡單易用的安裝過程和直觀的設計界面，我們 ...
  • NET Core 多身份校驗與策略模式
    背景需求： 系統需要對接到XXX官方的API，但因此官方對接以及管理都十分嚴格。而本人部門的系統中包含諸多子系統，系統間為了穩定，程式間多數固定Token+特殊驗證進行調用，且後期還要提供給其他兄弟部門系統共同調用。 原則上：每套系統都必須單獨接入到官方，但官方的接入複雜，還要官方指定機構認證的證書 ...
  • C#自定義控制項—轉換開關
    本文介紹下電腦設備關機的情況下如何通過網路喚醒設備，之前電源S狀態 電腦Power電源狀態- 唐宋元明清2188 - 博客園 (cnblogs.com) 有介紹過遠程喚醒設備，後面這倆天瞭解多了點所以單獨加個隨筆 設備關機的情況下，使用網路喚醒的前提條件： 1. 被喚醒設備需要支持這WakeOnL ...
  • .NET 8.0 前後分離快速開發框架
    前言 大家好，推薦一個.NET 8.0 為核心，結合前端 Vue 框架，實現了前後端完全分離的設計理念。它不僅提供了強大的基礎功能支持，如許可權管理、代碼生成器等，還通過採用主流技術和最佳實踐，顯著降低了開發難度，加快了項目交付速度。 如果你需要一個高效的開發解決方案，本框架能幫助大家輕鬆應對挑戰，實 ...
所有分類