基于SpringMVC的web工程的配置实现

基于SpringMVC的web工程的配置实现，有两种方式，分别是

• 第一种配置方式是，使用.xml配置文件，也就是web.xml和SpringMVC配置文件（也就是之前经常使用的springMVC.xml，当然这个文件名任意自取）
• 第二种配置方式是，使用配置类和注解。

使用web.xml和SprignMVC配置文件

1、新建maven工程：demo100

2、修改pom.xml

主要两点。
第一点，默认打包方式是jar，将打包方式修改为war。
第二点，添加依赖。

pom.xml的内容如下，

<?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>com.example</groupId>
    <artifactId>demo200</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.12</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.3.0-alpha10</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.22</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.3.1</version>
        </dependency>
    </dependencies>
</project>

3、添加web模块

main目录下新增子目录webapp。
进入Project Structure面板，指定web.xml路径和web资源目录，如下图所示，

4、修改web.xml，添加SpringMVC配置文件：springMVC.xml

web.xml主要有两点。
第一点，配置过滤器CharacterEncodingFilter。
第二点，配置前端控制器DispatcherServlet。
修改后的web.xml内容如下，

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

在resources目录下新建springMVC.xml，内容如下，它主要做了这么几件事情：

1. 配置组件扫描
2. 配置视图解析器
3. 配置视图控制器view-controller
4. 配置注解驱动annotation-driven
5. 配置default-servlet-handler
6. 配置拦截器
7. 配置文件上传解析器
8. 配置异常处理器

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!--扫描组件-->
    <context:component-scan base-package="com.example.mvc"></context:component-scan>

    <!-- 视图解析器 -->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1" />
        <property name="characterEncoding" value="UTF-8" />
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!-- 视图前缀 -->
                        <property name="prefix" value="/WEB-INF/templates/" />
                        <!-- 视图后缀 -->
                        <property name="suffix" value=".html" />
                        <property name="templateMode" value="HTML5" />
                        <property name="characterEncoding" value="UTF-8" />
                    </bean>
                </property>
            </bean>
        </property>
    </bean>

    <!-- 视图控制器 -->
    <mvc:view-controller path="/" view-name="index" />

    <!-- 启动注解驱动 -->
    <mvc:annotation-driven/>

    <!--使用默认servlet，用于访问静态资源 -->
    <mvc:default-servlet-handler/>

    <!--拦截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/"/>
            <bean class="com.example.mvc.interceptors.TestInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

    <!--文件上传解析器 -->
    <bean class="org.springframework.web.multipart.commons.CommonsMultipartResolver" id="multipartResolver"/>

    <!-- 异常处理器-->
    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <property name="exceptionMappings">
            <props>
                <prop key="java.lang.ArithmeticException">error</prop>
            </props>
        </property>
        <property name="exceptionAttribute" value="ex"></property>
    </bean>

</beans>

5、定义控制器和拦截器

在java目录下新增com.example.mvc.controller.TestController，内容如下，

package com.example.mvc.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {
    @RequestMapping("/testInterceptor")
    public String testInterceptor(){
        return "success";
    }

    @RequestMapping("/testExceptionHandler")
    public String testExceptionHandler(){
        System.out.println(1/0);
        return "success";
    }
}

在java目录下新增com.example.mvc.interceptors.TestInterceptor，内容如下，

package com.example.mvc.interceptors;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class TestInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("TestInterceptor-->preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("TestInterceptor-->postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("TestInterceptor-->afterCompletion");
    }
}

6、添加静态资源

在webapp目录下创建子目录static，在static下创建子目录css，在css下新建index.css，文件内容如下，

body{
    color: deepskyblue;
}

7、添加视图文件

在WEB-INF下新建子目录templates，在templates下新建视图文件index.html、success.html和error.html，内容分别如下，

<!-- index.html -->
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
    <link rel="stylesheet" th:href="@{/static/css/index.css}" type="text/css"/>
</head>
<body>
<a th:href="@{/testInterceptor}">测试拦截器</a><br/>
<a th:href="@{/testExceptionHandler}">测试异常处理器</a>
</body>
</html>

<!-- success.html -->
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>成功</title>
</head>
<body>
success
</body>
</html>

<!-- error.html -->
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>错误</title>
</head>
<body>
error
<p th:text="${ex}"></p>
</body>
</html>

8、启动应用

使用配置类和注解

1、新建maven工程：demo200

2、修改pom.xml

同上。

3、添加web模块

main目录下添加子目录webapp，webapp下添加子目录WEB-INF。

4、使用类和注解进行配置

1）添加配置类WebInit，替代web.xml

当类扩展了AbstractAnnotationConfigDispatcherServletInitializer，并将其部署至servlet3.0（及以上）容器时，容器会自动发现它，并用它来配置上下文。
在java目录下新建配置类com.example.mvc.config.WebInit，WebInit继承了AbstractAnnotationConfigDispatcherServletInitializer，如下，

package com.example.mvc.config;

import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

import javax.servlet.Filter;

/**
 * WebInit，替代web.xml
 */
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {
    //用于配置Spring
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }
    //用于配置SpringMVC，替代springMVC.xml
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }
    //用于配置DispatcherServlet的url-pattern
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //配置过滤器
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("UTF-8");
        return new Filter[]{characterEncodingFilter};
    }
}

getRootConfigClasses方法用来配置Spring。
getServletConfigClasses方法用来配置SpringMVC，用来替代springMVC.xml。
getServletMappings方法用来配置DispatcherServlet的url-pattern。
getServletFilters方法用来配置过滤器。

【知识点】数组的静态初始化

//初始化数组时为数组的每个元素赋值，由系统决定数组的长度。
int[] arr = new int[]{1,2,3};
int[] arr2 = {1,2,3,4,5};
System.out.println(Arrays.toString(arr));
System.out.println(Arrays.toString(arr2));

2）添加配置类SpringConfig，用于配置Spring。

在com.example.mvc.config包下新建类SpringConfig，内容如下，

package com.example.mvc.config;

public class SpringConfig {
}

3）添加配置类WebConfig，替代SpringMVC配置文件

在com.example.mvc.config包下新建WebConfig，内容如下，

package com.example.mvc.config;

import com.example.mvc.interceptors.TestInterceptor;
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.MultipartResolver;
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;

/**
 * 扫描组件
 */
@ComponentScan("com.example.mvc")

/**
 * 启动注解驱动
 */
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    /**
     * 配置视图控制器
     * @param registry
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }

    /**
     * 实现default-servlet-handler,以访问静态资源
     * @param configurer
     */
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    /**
     * 配置拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        TestInterceptor testInterceptor = new TestInterceptor();
        registry.addInterceptor(testInterceptor).addPathPatterns("/**").excludePathPatterns("/");
    }

    /**
     * 配置异常处理器
     * @param resolvers
     */
    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver resolver = new SimpleMappingExceptionResolver();
        Properties prop = new Properties();
        prop.setProperty("java.lang.ArithmeticException","error");
        resolver.setExceptionMappings(prop);
        resolver.setExceptionAttribute("ex");
        resolvers.add(resolver);
    }

    /**
     * 配置文件上传解析器
     */
    @Bean
    public MultipartResolver multipartResolver(){
        CommonsMultipartResolver commonsMultipartResolver = new CommonsMultipartResolver();
        return commonsMultipartResolver;
    }

    /**
     * 配置视图解析器
     * @return
     */
    //第一步：配置模板解析器
    @Bean
    public ITemplateResolver templateResolver(){
        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        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;
    }
}

其中，

• 扫描组件：@ComponentScan("com.example.mvc")。
• 配置视图解析器。

    @Bean
    public ITemplateResolver templateResolver(){
        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        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;
    }

• 启动注解驱动：@EnableWebMvc。
• 配置文件上传解析：返回一个CommonsMultipartResColver类型的对象即可。

@Bean
public MultipartResolver multipartResolver(){
    CommonsMultipartResColver commonsMultipartResolver = new CommonsMultipartResolver();
    return commonsMultipartResolver;
}

• 配置视图控制器：实现接口WebMvcConfigurer的addViewControllers方法。

public void addViewControllers(ViewControllerRegistry registry) {
    registry.addViewController("/").setViewName("index");
}

• 配置default-servlet-handler，以访问静态资源：实现接口WebMvcConfigurer的configureDefaultServletHandling方法。

public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
    configurer.enable();
}

• 配置拦截器：实现接口WebMvcConfigurer的addInterceptors方法。

public void addInterceptors(InterceptorRegistry registry) {
    TestInterceptor testInterceptor = new TestInterceptor();
    registry.addInterceptor(testInterceptor).addPathPatterns("/**").excludePathPatterns("/");
}

• 配置异常处理器：实现接口WebMvcConfigurer的extendHandlerExceptionResolvers方法。

public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    SimpleMappingExceptionResolver resolver = new SimpleMappingExceptionResolver();
    Properties prop = new Properties();
    prop.setProperty("java.lang.ArithmeticException","error");
    resolver.setExceptionMappings(prop);
    resolver.setExceptionAttribute("ex");
    resolvers.add(resolver);
}

5、定义控制器和拦截器

同上。

6、添加静态资源

同上。

7、添加视图文件

同上。

8、启动应用

同上。