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 MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類