14、SpringMVC之注解配置

去皮卡多  金牌会员 | 2023-12-31 20:56:06 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 934|帖子 934|积分 2802

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
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>online.liaojy</groupId>
  8.     <artifactId>spring_mvc_annotation</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.     <packaging>war</packaging>
  12.     <dependencies>
  13.         
  14.         <dependency>
  15.             <groupId>org.springframework</groupId>
  16.             <artifactId>spring-webmvc</artifactId>
  17.             <version>5.3.1</version>
  18.         </dependency>
  19.         
  20.         <dependency>
  21.             <groupId>ch.qos.logback</groupId>
  22.             <artifactId>logback-classic</artifactId>
  23.             <version>1.2.3</version>
  24.         </dependency>
  25.         
  26.         <dependency>
  27.             <groupId>javax.servlet</groupId>
  28.             <artifactId>javax.servlet-api</artifactId>
  29.             <version>3.1.0</version>
  30.             <scope>provided</scope>
  31.         </dependency>
  32.         
  33.         <dependency>
  34.             <groupId>org.thymeleaf</groupId>
  35.             <artifactId>thymeleaf-spring5</artifactId>
  36.             <version>3.0.12.RELEASE</version>
  37.         </dependency>
  38.         
  39.         <dependency>
  40.             <groupId>commons-fileupload</groupId>
  41.             <artifactId>commons-fileupload</artifactId>
  42.             <version>1.3.1</version>
  43.         </dependency>
  44.     </dependencies>
  46. </project>
复制代码
14.2.6、配置web资源目录


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

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

因为使用配置类和注解来配置 Servlet 上下文，所以 web.xml 不再需要配置。
14.2.7、创建拦截器

  1. package online.liaojy.interceptor;
  3. import org.springframework.web.servlet.HandlerInterceptor;
  4. import org.springframework.web.servlet.ModelAndView;
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  9. /**
  10. * @author liaojy
  11. * @date 2023/11/15 - 7:22
  12. */
  13. public class AAAInterceptor implements HandlerInterceptor {
  15.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  16.         return true;
  17.     }
  19.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  21.     }
  23.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  25.     }
  27. }
复制代码
14.2.8、创建模板目录及页面模板


注意：html要引入thymeleaf的约束：xmlns:th="http://www.thymeleaf.org"
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6. </head>
  7. <body>
  9. <h1>index.html</h1>
  11. </body>
  12. </html>
复制代码
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>错误页面</title>
  6. </head>
  7. <body>
  9. <h1>errorPage.html</h1>
  11. </body>
  12. </html>
复制代码
14.2.9、配置tomcat




14.3、web.xml的注解配置

14.3.1、创建Spring配置类

  1. package online.liaojy.config;
  3. /**
  4. * @author liaojy
  5. * @date 2023/11/16 - 23:59
  6. * 该类用于代替spring的配置文件
  7. */
  8. public class SpringConfig {
  10.     //ssm整合之后，spring的配置信息写在此类中
  12. }
复制代码
14.3.2、创建SpringMVC配置类

  1. package online.liaojy.config;
  3. /**
  4. * @author liaojy
  5. * @date 2023/11/17 - 0:02
  6. * 该类用于代替SpringMVC的配置文件
  7. */
  8. public class SpringMVCConfig {
  9. }
复制代码
14.3.3、创建代替web.xml的初始化类

  1. package online.liaojy.config;
  3. import org.springframework.web.filter.CharacterEncodingFilter;
  4. import org.springframework.web.filter.HiddenHttpMethodFilter;
  5. import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
  7. import javax.servlet.Filter;
  9. /**
  10. * @author liaojy
  11. * @date 2023/11/17 - 0:04
  12. */
  13. public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {
  15.     // 指定代替 Spring 配置文件的配置类（可以按功能或需要来划分多个）
  16.     protected Class<?>[] getRootConfigClasses() {
  17.         return new Class[]{SpringConfig.class};
  18.     }
  20.     // 指定代替 SpringMVC 配置文件的配置类（可以按功能或需要来划分多个）
  21.     protected Class<?>[] getServletConfigClasses() {
  22.         return new Class[]{SpringMVCConfig.class};
  23.     }
  25.     // 设置 SpringMVC 的前端控制器 DispatcherServlet 需要处理的请求路径（即 url-pattern ）
  26.     protected String[] getServletMappings() {
  27.         return new String[]{"/"};
  28.     }
  30.     // 设置过滤器
  31.     @Override
  32.     protected Filter[] getServletFilters() {
  34.         // 配置编码过滤器
  35.         CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
  36.         characterEncodingFilter.setEncoding("UTF-8");
  37.         characterEncodingFilter.setForceEncoding(true);
  39.         // 配置处理请求方式的过滤器
  40.         // 注意该过滤器所在的包路径为 org.springframework.web.filter.HiddenHttpMethodFilter
  41.         HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
  43.         // 配置要使用的过滤器
  44.         return new Filter[]{characterEncodingFilter,hiddenHttpMethodFilter};
  46.     }
  47. }
复制代码
14.4、SpringMVC配置类的详细配置

14.4.1、将类标识为配置类

  1. // @Configurable 注解：将类标识为配置类
  2. @Configurable
复制代码
14.4.2、实现 WebMvcConfigurer 接口


14.4.3、配置扫描组件


先创建一个需要扫描的包及组件
  1. package online.liaojy.controller;
  3. import org.springframework.stereotype.Controller;
  5. /**
  6. * @author liaojy
  7. * @date 2023/11/19 - 16:56
  8. */
  9. @Controller
  10. public class TestController {
  11. }
复制代码
  1. // @ComponentScan 注解：用于扫描指定包的组件
  2. @ComponentScan("online.liaojy.controller")
复制代码
14.4.4、配置默认servlet处理器

  1.     // 配置默认servlet处理器
  2.     public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
  3.         configurer.enable();
  4.     }
复制代码
14.4.5、配置mvc注解驱动

  1. // @EnableWebMvc 注解：开启mvc的注解驱动
  2. @EnableWebMvc
复制代码
14.4.6、配置视图控制器

  1.     // 配置视图控制器
  2.     public void addViewControllers(ViewControllerRegistry registry) {
  3.         // addViewController 设置视图控制器要处理的请求路径，setViewName 设置匹配请求路径的逻辑视图
  4.         registry.addViewController("/").setViewName("index");
  5.     }
复制代码
14.4.7、配置文件上传解析器

  1.     // 配置文件上传解析器
  2.     // @Bean 注解：用于将所标识方法的返回值作为一个 bean 来进行管理，bean的id为方法名
  3.     @Bean
  4.     public CommonsMultipartResolver multipartResolver(){
  5.         return new CommonsMultipartResolver();
  6.     }
复制代码
14.4.8、配置拦截器

  1.     // 配置拦截器
  2.     public void addInterceptors(InterceptorRegistry registry) {
  3.         AAAInterceptor aaaInterceptor = new AAAInterceptor();
  4.         // addInterceptor 设置要使用的拦截器，
  5.         // addPathPatterns 设置该拦截器要拦截的请求路径（ /** 表示所有路径），excludePathPatterns 设置要排除的拦截路径
  6.         registry.addInterceptor(aaaInterceptor).addPathPatterns("/**").excludePathPatterns("/abc");
  7.     }
复制代码
14.4.9、配置异常解析器

  1.     // 配置异常解析器
  2.     public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
  4.         // 创建 SimpleMappingExceptionResolver 异常解析器，来对控制器方法出现的异常进行自定义异常处理
  5.         SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();
  7.         // 设置异常和错误提示页面的映射关系
  8.         Properties properties = new Properties();
  9.         properties.setProperty("java.lang.ArithmeticException", "errorPage");
  10.         simpleMappingExceptionResolver.setExceptionMappings(properties);
  12.         // 设置共享到域对象中的异常信息的属性名
  13.         simpleMappingExceptionResolver.setExceptionAttribute("exceptionMessage");
  15.         // 添加要使用的异常解析器器
  16.         resolvers.add(simpleMappingExceptionResolver);
  17.     }
复制代码
14.4.10、配置视图解释器


配置视图解释器，无论是通过xml还是配置类都比较复杂；一般直接都是复制配置模板，然后根据实际修改视图前缀及后缀即可
  1.     //配置生成模板解析器
  2.     @Bean
  3.     public ITemplateResolver templateResolver() {
  5.         WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
  6.         // ServletContextTemplateResolver 需要一个 ServletContext 作为构造参数，可通过 WebApplicationContext 的方法获得
  7.         ServletContextTemplateResolver templateResolver =
  8.                 new ServletContextTemplateResolver(webApplicationContext.getServletContext());
  10.         templateResolver.setPrefix("/WEB-INF/templates/");
  11.         templateResolver.setSuffix(".html");
  12.         templateResolver.setCharacterEncoding("UTF-8");
  13.         templateResolver.setTemplateMode(TemplateMode.HTML);
  14.         return templateResolver;
  16.     }
  18.     //生成模板引擎并为模板引擎注入模板解析器
  19.     @Bean
  20.     public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
  21.         SpringTemplateEngine templateEngine = new SpringTemplateEngine();
  22.         templateEngine.setTemplateResolver(templateResolver);
  23.         return templateEngine;
  24.     }
  26.     //生成视图解析器并为解析器注入模板引擎
  27.     @Bean
  28.     public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
  29.         ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
  30.         viewResolver.setCharacterEncoding("UTF-8");
  31.         viewResolver.setTemplateEngine(templateEngine);
  32.         return viewResolver;
  33.     }
复制代码
14.4.11、全配置汇总
  1. 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 注解：将类标识为配置类
  2. @Configurable// @ComponentScan 注解：用于扫描指定包的组件
  3. @ComponentScan("online.liaojy.controller")// @EnableWebMvc 注解：开启mvc的注解驱动
  4. @EnableWebMvcpublic class SpringMVCConfig implements WebMvcConfigurer {    // 配置默认servlet处理器
  5.     public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
  6.         configurer.enable();
  7.     }    // 配置视图控制器
  8.     public void addViewControllers(ViewControllerRegistry registry) {
  9.         // addViewController 设置视图控制器要处理的请求路径，setViewName 设置匹配请求路径的逻辑视图
  10.         registry.addViewController("/").setViewName("index");
  11.     }    // 配置文件上传解析器
  12.     // @Bean 注解：用于将所标识方法的返回值作为一个 bean 来进行管理，bean的id为方法名
  13.     @Bean
  14.     public CommonsMultipartResolver multipartResolver(){
  15.         return new CommonsMultipartResolver();
  16.     }    // 配置拦截器
  17.     public void addInterceptors(InterceptorRegistry registry) {
  18.         AAAInterceptor aaaInterceptor = new AAAInterceptor();
  19.         // addInterceptor 设置要使用的拦截器，
  20.         // addPathPatterns 设置该拦截器要拦截的请求路径（ /** 表示所有路径），excludePathPatterns 设置要排除的拦截路径
  21.         registry.addInterceptor(aaaInterceptor).addPathPatterns("/**").excludePathPatterns("/abc");
  22.     }    // 配置异常解析器
  23.     public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
  25.         // 创建 SimpleMappingExceptionResolver 异常解析器，来对控制器方法出现的异常进行自定义异常处理
  26.         SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();
  28.         // 设置异常和错误提示页面的映射关系
  29.         Properties properties = new Properties();
  30.         properties.setProperty("java.lang.ArithmeticException", "errorPage");
  31.         simpleMappingExceptionResolver.setExceptionMappings(properties);
  33.         // 设置共享到域对象中的异常信息的属性名
  34.         simpleMappingExceptionResolver.setExceptionAttribute("exceptionMessage");
  36.         // 添加要使用的异常解析器器
  37.         resolvers.add(simpleMappingExceptionResolver);
  38.     }    //配置生成模板解析器
  39.     @Bean
  40.     public ITemplateResolver templateResolver() {
  42.         WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
  43.         // ServletContextTemplateResolver 需要一个 ServletContext 作为构造参数，可通过 WebApplicationContext 的方法获得
  44.         ServletContextTemplateResolver templateResolver =
  45.                 new ServletContextTemplateResolver(webApplicationContext.getServletContext());
  47.         templateResolver.setPrefix("/WEB-INF/templates/");
  48.         templateResolver.setSuffix(".html");
  49.         templateResolver.setCharacterEncoding("UTF-8");
  50.         templateResolver.setTemplateMode(TemplateMode.HTML);
  51.         return templateResolver;
  53.     }
  55.     //生成模板引擎并为模板引擎注入模板解析器
  56.     @Bean
  57.     public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
  58.         SpringTemplateEngine templateEngine = new SpringTemplateEngine();
  59.         templateEngine.setTemplateResolver(templateResolver);
  60.         return templateEngine;
  61.     }
  63.     //生成视图解析器并为解析器注入模板引擎
  64.     @Bean
  65.     public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
  66.         ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
  67.         viewResolver.setCharacterEncoding("UTF-8");
  68.         viewResolver.setTemplateEngine(templateEngine);
  69.         return viewResolver;
  70.     }}
复制代码
14.5、测试效果




免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

去皮卡多

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表