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分頁組件與表格數據實現分頁交互。 開始實現 引入表格和分頁組件的H5標簽。 <strong>Element-Plus ...
  • 前言: 我們在平常本地開發時,可能經常需要與後端進行聯調,或者調用一些api,但是由於瀏覽器跨域的限制、開發與生產環境的差異、http與https等問題經常讓聯調的過程不夠順暢。所以本文介紹一下webpack的devServer中的proxy配置項。接下來讓我們先看一下這個配置項的基本使用: 基本使 ...
  • 前言 這是第二次博客作業,總結了近三次PTA大作業的完成情況,這三次的大作業難度逐漸增大,完全理不清邏輯,真的越想越混亂,代碼寫的也是很亂,沒有一個整體的框架結構,讀起來很困難,沒有學到java程式編寫的真諦,總之對於我,一個邏輯很差很差的人來說,越來越複雜的題目,寫起來真的痛苦,到後面的題目,基本 ...
  • 按規則解析並替換字元串中的變數及函數 需求 1、按照一定規則解析字元串中的函數、變數表達式,並替換這些表達式。這些函數表達式可能包含其它函數表達式,即支持函數嵌套 2、函數表達式格式:${ __函數名稱() }、${__函數名稱( 函數參數 )} 3、變數表達式格式:${ varName } 註意: ...
  • python 版本:3.6 win32 版本(因為一些特殊原因必須使用3.6) pymssql 版本:2.2.0 連接資料庫: import pymssql** def InitMssql(self): try: host = self.IniConfig.get('default','dbhost ...
  • 學習完基礎的圖像演算法,開始接觸OpenCV學習: 灰度圖中,一個像素點上的灰度級需要一個位元組(byte,2^8,8 bit)進行存儲,此時的灰度圖是二維的。而當我們需要轉換為彩色圖時,即三維,便會產生顏色通道(Channel),這個時候,一個像素點上的灰度級便會需要三個位元組來進行存儲。 可以藉助笛卡 ...
  • 本文只發佈於利用OpenCV實現尺度不變性與角度不變性的特征找圖演算法和知乎 一般來說,利用OpenCV實現找圖功能,用的比較多的是模板匹配(matchTemplate)。筆者比較喜歡裡面的NCC演算法。但是模板有個很明顯的短板,面對尺度改變,角度改變的目標就無能為力了。因此本文旨在做到模板匹配做不到的 ...
  • 目錄: Redis是什麼? Redis優缺點? Redis為什麼這麼快? 講講Redis的線程模型? Redis應用場景有哪些? Memcached和Redis的區別? 為什麼要用 Redis 而不用 map/guava 做緩存? Redis 數據類型有哪些? SortedSet和List異同點? ...
一周排行
    -Advertisement-
    Play Games
  • 前言 插件化的需求主要源於對軟體架構靈活性的追求,特別是在開發大型、複雜或需要不斷更新的軟體系統時,插件化可以提高軟體系統的可擴展性、可定製性、隔離性、安全性、可維護性、模塊化、易於升級和更新以及支持第三方開發等方面的能力,從而滿足不斷變化的業務需求和技術挑戰。 一、插件化探索 在WPF中我們想要開 ...
  • 歡迎ReaLTaiizor是一個用戶友好的、以設計為中心的.NET WinForms項目控制項庫,包含廣泛的組件。您可以使用不同的主題選項對項目進行個性化設置,並自定義用戶控制項,以使您的應用程式更加專業。 項目地址:https://github.com/Taiizor/ReaLTaiizor 步驟1: ...
  • EDP是一套集組織架構,許可權框架【功能許可權,操作許可權,數據訪問許可權,WebApi許可權】,自動化日誌,動態Interface,WebApi管理等基礎功能於一體的,基於.net的企業應用開發框架。通過友好的編碼方式實現數據行、列許可權的管控。 ...
  • Channel 是乾什麼的 The System.Threading.Channels namespace provides a set of synchronization data structures for passing data between producers and consume ...
  • efcore如何優雅的實現按年分庫按月分表 介紹 本文ShardinfCore版本 本期主角: ShardingCore 一款ef-core下高性能、輕量級針對分表分庫讀寫分離的解決方案,具有零依賴、零學習成本、零業務代碼入侵適配 距離上次發文.net相關的已經有很久了,期間一直在從事java相關的 ...
  • 前言 Spacesniffer 是一個免費的文件掃描工具,通過使用樹狀圖可視化佈局,可以立即瞭解大文件夾的位置,幫助用戶處理找到這些文件夾 當前系統C盤空間 清理後系統C盤空間 下載 Spacesniffer 下載地址:https://spacesniffer.en.softonic.com/dow ...
  • EDP是一套集組織架構,許可權框架【功能許可權,操作許可權,數據訪問許可權,WebApi許可權】,自動化日誌,動態Interface,WebApi管理等基礎功能於一體的,基於.net的企業應用開發框架。通過友好的編碼方式實現數據行、列許可權的管控。 ...
  • 一、ReZero簡介 ReZero是一款.NET中間件 : 全網唯一開源界面操作就能生成API , 可以集成到任何.NET6+ API項目,無破壞性,也可讓非.NET用戶使用exe文件 免費開源:MIT最寬鬆協議 , 一直從事開源事業十年,一直堅持開源 1.1 純ReZero開發 適合.Net Co ...
  • 一:背景 1. 講故事 停了一個月沒有更新文章了,主要是忙於寫 C#內功修煉系列的PPT,現在基本上接近尾聲,可以回頭繼續更新這段時間分析dump的一些事故報告,有朋友微信上找到我,說他們的系統出現了大量的http超時,程式不響應處理了,讓我幫忙看下怎麼回事,dump也抓到了。 二:WinDbg分析 ...
  • 開始做項目管理了(本人3年java,來到這邊之後真沒想到...),天天開會溝通整理需求,他們講話的時候忙裡偷閑整理一下常用的方法,其實語言還是有共通性的,基本上看到方法名就大概能猜出來用法。出去打水的時候看到外面太陽好好,真想在外面坐著曬太陽,回來的時候好兄弟三年前送給我的鍵盤D鍵不靈了,在打"等待 ...