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

12.2.2、选择maven

14.2.3、设置module名称和路径

14.2.4、module初始状态

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

注意：默认的打包方式为 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资源目录

打开Project Structure，选择对应的module，并为该module创建一个web.xml文件

注意：web.xml文件需要放到web资源路径（工程路径\src\main\webapp）下

因为使用配置类和注解来配置 Servlet 上下文，所以 web.xml 不再需要配置。

14.2.7、创建拦截器

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、创建模板目录及页面模板

注意：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>



<!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

14.3、web.xml的注解配置

14.3.1、创建Spring配置类

package online.liaojy.config;

/**

 * @author liaojy

 * @date 2023/11/16 - 23:59

 * 该类用于代替spring的配置文件

 */

public class SpringConfig {

    //ssm整合之后，spring的配置信息写在此类中

}

14.3.2、创建SpringMVC配置类

package online.liaojy.config;

/**

 * @author liaojy

 * @date 2023/11/17 - 0:02

 * 该类用于代替SpringMVC的配置文件

 */

public class SpringMVCConfig {

}

14.3.3、创建代替web.xml的初始化类

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、将类标识为配置类

// @Configurable 注解：将类标识为配置类

@Configurable

14.4.2、实现 WebMvcConfigurer 接口

14.4.3、配置扫描组件

先创建一个需要扫描的包及组件

package online.liaojy.controller;

import org.springframework.stereotype.Controller;

/**

 * @author liaojy

 * @date 2023/11/19 - 16:56

 */

@Controller

public class TestController {

}



// @ComponentScan 注解：用于扫描指定包的组件

@ComponentScan("online.liaojy.controller")

14.4.4、配置默认servlet处理器

    // 配置默认servlet处理器

    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {

        configurer.enable();

    }

14.4.5、配置mvc注解驱动

// @EnableWebMvc 注解：开启mvc的注解驱动

@EnableWebMvc

14.4.6、配置视图控制器

    // 配置视图控制器

    public void addViewControllers(ViewControllerRegistry registry) {

        // addViewController 设置视图控制器要处理的请求路径，setViewName 设置匹配请求路径的逻辑视图

        registry.addViewController("/").setViewName("index");

    }

14.4.7、配置文件上传解析器

    // 配置文件上传解析器

    // @Bean 注解：用于将所标识方法的返回值作为一个 bean 来进行管理，bean的id为方法名

    @Bean

    public CommonsMultipartResolver multipartResolver(){

        return new CommonsMultipartResolver();

    }

14.4.8、配置拦截器

    // 配置拦截器

    public void addInterceptors(InterceptorRegistry registry) {

        AAAInterceptor aaaInterceptor = new AAAInterceptor();

        // addInterceptor 设置要使用的拦截器，

        // addPathPatterns 设置该拦截器要拦截的请求路径（ /** 表示所有路径），excludePathPatterns 设置要排除的拦截路径

        registry.addInterceptor(aaaInterceptor).addPathPatterns("/**").excludePathPatterns("/abc");

    }

14.4.9、配置异常解析器

    // 配置异常解析器

    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、配置视图解释器

配置视图解释器，无论是通过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、测试效果

14、SpringMVC之注解配置的更多相关文章

  1. 【Spring】SpringMVC非注解配置的两种方式

    目录结构: contents structure [+] SpringMVC是什么 Spring MVC的设计原理 SpringMVC配置的第一种方式 1,复制Jar包 2,Web.xml文件 3,M ...

  2. springmvc的注解配置

    springmvc大大减少了对xml的配置,减少了配置量,以及可以在一个controller类中进行多个请求配置 一.springmvc配置 context:component-scan 开启包扫描, ...

  3. SpringMVC 非注解配置

    web.xml配置: <servlet> <servlet-name>springmvc</servlet-name> <servlet-class>o ...

  4. 关于什么是SpringMVC，和SpringMVC基于xml配置、注解配置、纯注解配置

    首先我们先要了解一下,什么是SpringMVC? SpringMVC是Spring框架内置的MVC的实现.SpringMVC就是一个Spring内置的MVC子框架,也就是说SpringMVC的相关包都 ...

  5. spring mvc 第一天【注解实现springmvc的基本配置】

    创建pojo,添加标识类的注解@Controller,亦可添加该Handler的命名空间:设置类的@RequestMapping(value="/hr") 该类中的方法(Handl ...

  6. SpringMVC基础配置(通过注解配置,非xml配置)

    SpringMVC是什么,有多火,我这里就不再啰嗦了,SpringMVC比Struts2好用太多,我在学校的时候私下里两种都接触过,对比之后果断选择了SpringMVC,后来在做Android应用开发 ...

  7. SpringMVC整合mybatis基于纯注解配置

    Mybatis整合Spring配置 第一部分:配置Spring框架 配置SpringMVC的步骤 配置流程图 导入包(哪些包,基本包5个,1日志依赖包,2webmvc支持包)SpringMVC配置 & ...

  8. 记录一下SpringMVC扫描注解包的配置

    最近做了一个小项目,使用Spring4+SpringMVC+Hibernate5 但是整合完毕了之后,在页面上请求添加记录的时候发现无法开启事务,报错的信息如下: org.springframewor ...

  9. SpringMVC的注解方式配置

    SpringMVC支持使用注解方式配置,比配置文件方式更加灵活易用,是SpringMVC使用的主流模式. 1.在配置文件中开启SpringMVC的注解 <!-- 开启包扫描 --> < ...

  10. spring-mvc注解配置小记

    Controller中注解Service时,Service的实现类需加@Service,dao的实现类需加@Repository. 另:配置文件中对应的包也需要扫描到!!! <context:a ...

随机推荐

  1. 基本定时器TIM6实现精确延时

    1.基本定时器的特点 (1).16位自动重装载累加计数器 (2).16位可编程(可实时修改)预分频器,用于对输入的时钟按系数为1-65536之间的任意数值 !!!注意基本定时器只有向上计数模式,不要被 ...

  2. python的一些常用编码技巧(持续更新)

    语法问题 我常用的库函数 1 copy库 import copy copy.deepcopy() 2.list库 from typing import List 获取迭代对象的第一个值 方法一:使用l ...

  3. vue组件间传值 父组件向子组件传值

    ² 父组件以属性的形式绑定值到子组件身上 ² 子组件通过使用属性props接收(props是单向绑定的(只读属性):当父组件的属性变化时,将传导给子组件,但是反过来不会) 第1步,父组件以动态属性的方 ...

  4. minos 2.3 中断虚拟化——GICv2 管理

    首发公号:Rand_cs 硬件肯定需要软件配合,这一节就来实战 GICv2 首先准备好 GICv2 手册:https://developer.arm.com/documentation/ihi0048 ...

  5. 短链服务接口慢优化 redis应用

    短链服务接口慢优化 redis应用 短链接服务:1.长链接 查询 短链接(长链接如果存在,直接返回短链接,如果长链接不存在,则需要生成短链接),比如:在获取短信之前,或者管理后台编辑短信内容之前,需要 ...

  6. Java邮件发送解决ssl javax.mail实现方式

    package test; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.activation.DataH ...

  7. Playbook条件语句

    目录 Playbook条件语句 1. when的基本使用 1.1 when的基本示例 1.2比较运算符 1.3 比较运算符示例 1.4 逻辑运算符 1.5 逻辑运算符示例 2. 条件判断与block ...

  8. nginx中多个server块共用upstream会相互影响吗

    背景 nginx中经常有这样的场景,多个server块共用一个域名. 如:upstream有2个以上的域名,nginx配置两个server块,共用一个upstream配置. 那么,如果其中一个域名发生 ...

  9. QT学习：07 字符编码的问题

    --- title: framework-cpp-qt-07-字符编码的问题 EntryName: framework-cpp-qt-07-char-coding date: 2020-04-13 1 ...

  10. USB 协议学习：000-有关概念

    USB 协议学习:000-有关概念 背景 USB作为一种串行接口,应用非常广泛.掌握usb也是作为嵌入式工程师的一项具体要求. 概述 USB( Universal Serial Bus, 通用串行总线 ...