基于注解实现SpringMVC的配置文件

1. 注解配置SpringMVC文件

使用配置类和注解代替web.xml和SpringMVC配置文件的功能

使用注解配置MVC文件时，程序中出现的各个注解

• @Configuration：将当前类标识为配置类

• @ComponentScan（）：配置扫描组件

• @EnableWebMvc：开启mvc注解驱动

• @Eean：可以将标识的方法的返回值作为bean进行管理，bean的id为方法名

1.1 创建初始化类，代替web.xml

Spring3.2引入了一个便利的WebApplicationInitializer基础实现，名为 AbstractAnnotationConfigDispatcherServletInitializer当我们的类扩展了 AbstractAnnotationConfigDispatcherServletInitializer并将其部署到Servlet3.0容器的时候，容器会自 动发现它，并用它来配置Servlet上下文。

我们需要初始化类继承AbstractAnnotationConfigDispatcherServletInitializer类

package com.springmvc.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 wangjinyu
 * @create 2022-11-17 19:53
 * @version: 1.0
 */
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    //设置一个配置类代替Spring的配置文件
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }
​
    @Override
    //设置一个配置类代替SpringMVC的配置文件
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }
​
    @Override
    //指定DispatcherServlet映射规则，即url—pattern
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
​
    @Override
    //配置过滤器
    protected Filter[] getServletFilters() {
        // 设置编码Filter过滤器
        CharacterEncodingFilter encodingFilter = new CharacterEncodingFilter();
        encodingFilter.setEncoding("UTF-8");
        encodingFilter.setForceEncoding(true);
        // 设置HiddenHttpMethodFilter过滤器，转换put和delete请求
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{encodingFilter,hiddenHttpMethodFilter};
    }
}
​

1.2 创建SpringConfig配置类，代替spring配置文件

@Configuration
public class SpringConfig {
//ssm整合之后，spring的配置信息写在此类中
}

13.3 创建SpringMVCConfig配置类，代替SpringMVC配置文件

package com.springmvc.config;
​
import com.springmvc.Interceptors.FileInterceptors;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
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 wangjinyu
 * @create 2022-11-17 20:00
 * @version: 1.0
 * 代替SpringMVC的配置类
 * 在配置文件中可以做的事情，配置类中也可以做
 * 扫描组件，视图解析器，默认的Servlet处理静态资源，mvc注解驱动，视图控制器
 * 文件上传解析器，拦截器，异常处理解析器
 */
//将当前类的标识为配置类
@Configuration
//配置扫描组件
@ComponentScan("com.springmvc")
//开启mvc注解驱动
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {
​
    @Override
    //配置默认的Servlet处理静态资源
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        //表示当前配置可用，默认的Servlet处理
        configurer.enable();
    }
​
    @Override
    //配置视图控制器
    public void addViewControllers(ViewControllerRegistry registry) {
        // addViewController；添加路径，setViewName设置视图名称
        registry.addViewController("/").setViewName("index");
    }
​
    //@Bean注解可以将标识的方法的返回值作为bean进行管理，bean的id为方法名
    @Bean
    //配置文件上传解析器
    public CommonsMultipartResolver multipartResolver() {
        return new CommonsMultipartResolver();
    }
​
    @Override
    //配置拦截器
    public void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器方法
        FileInterceptors fileInterceptors = new FileInterceptors();
        registry.addInterceptor(fileInterceptors).addPathPatterns("/**");
    }
​
    @Override
    //配置异常处理解析器
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        //创建自定义异常处理类
        SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();
        Properties properties = new Properties();
        // key设置要处理的异常，value设置出现该异常时要跳转的页面所对应的逻辑视图
        properties.setProperty("java.lang.ArithmeticException", "error");
        //设置异常映射
        simpleMappingExceptionResolver.setExceptionMappings(properties);
        //设置共享异常信息
        simpleMappingExceptionResolver.setExceptionAttribute("ex");
        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;
    }
​
}
​