【Spring MVC】使用 Java 类配置 Spring MVC

在 Spring MVC 中，使用 Java Config（类配置） 来替代传统的 XML 配置是一种现代且常见的配置方式。通过这种方式，我们可以使用 Java 类和注解来配置 Spring MVC 的各个组件，如 DispatcherServlet、ViewResolver、Controller 等。这种方式使得代码更加简洁和类型安全。

下面是一个使用类配置 Spring MVC 的完整示例：

示例项目结构

SpringMvcJavaConfigExample/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com.example.controller/
│   │   │   │   └── HelloController.java
│   │   │   ├── com.example.config/
│   │   │   │   ├── WebConfig.java
│   │   │   │   └── AppInitializer.java
│   │   ├── webapp/
│   │   │   ├── WEB-INF/
│   │   │   │   └── views/
│   │   │   │       └── hello.jsp
├── pom.xml

1. 配置 pom.xml

在 pom.xml 中添加必要的依赖项以支持 Spring MVC 和 Servlet API。

<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>SpringMvcJavaConfigExample</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <properties>
        <java.version>1.8</java.version>
        <maven.compiler.source>${java.version}</maven.compiler.source>
        <maven.compiler.target>${java.version}</maven.compiler.target>
        <spring.version>5.3.30</spring.version>
        <jstl.version>1.2</jstl.version>
        <servlet-api.version>4.0.1</servlet-api.version>
    </properties>

    <dependencies>
        <!-- Spring MVC -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- JSTL for JSP support -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>${jstl.version}</version>
        </dependency>

        <!-- Servlet API -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>${servlet-api.version}</version>
            <scope>provided</scope>
        </dependency>

        <!-- Test dependencies -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>SpringMvcJavaConfigExample</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2. 配置 WebConfig.java

WebConfig 类是 Spring MVC 配置类，它取代了传统的 web.xml 文件。我们在此类中启用组件扫描、配置视图解析器等。

package com.example.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.ViewResolver;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = "com.example.controller")
public class WebConfig implements WebMvcConfigurer {

    // 配置视图解析器
    @Bean
    public ViewResolver viewResolver() {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/WEB-INF/views/");
        resolver.setSuffix(".jsp");
        return resolver;
    }

    // 配置静态资源处理
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/resources/**").addResourceLocations("/resources/");
    }
}

• @EnableWebMvc: 启用 Spring MVC 特性。
• @ComponentScan: 指定扫描的包，用于自动发现和注册 Controller。
• InternalResourceViewResolver: 配置视图解析器来解析 JSP 文件。

3. 配置 AppInitializer.java

AppInitializer 类用来替代传统的 web.xml 文件，用于初始化 Spring 应用程序上下文和注册 DispatcherServlet。

package com.example.config;

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

public class AppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

    @Override
    protected Class<?>[] getRootConfigClasses() {
        return null; // 无需根配置类
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[] { WebConfig.class }; // Spring MVC 配置类
    }

    @Override
    protected String[] getServletMappings() {
        return new String[] { "/" }; // 将 DispatcherServlet 映射到 "/"
    }
}

• getRootConfigClasses(): 返回应用程序的根配置类，用于定义应用范围的 bean。通常用在大型应用程序中。
• getServletConfigClasses(): 返回 Spring MVC 配置类。
• getServletMappings(): 指定 DispatcherServlet 的映射路径。

4. 创建控制器 HelloController.java

接下来，我们创建一个简单的控制器来处理请求并返回视图。

package com.example.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HelloController {

    @GetMapping("/hello")
    public String sayHello(Model model) {
        model.addAttribute("message", "Hello, Spring MVC with Java Config!");
        return "hello"; // 返回视图名称
    }
}

• @Controller: 指示该类是一个控制器。
• @GetMapping("/hello"): 处理 HTTP GET 请求，并映射到 /hello URL。
• Model: 用于将数据添加到模型，以便在视图中展示。

5. 创建视图 hello.jsp

在 WEB-INF/views/ 目录下创建一个 JSP 文件 hello.jsp。

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!DOCTYPE html>
<html>
<head>
    <title>Hello Spring MVC</title>
</head>
<body>
    <h1>${message}</h1>
</body>
</html>

6. 配置静态资源（可选）

如果你有 CSS、JavaScript、图像等静态资源，可以在 WebConfig 中配置静态资源处理器。

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/resources/**").addResourceLocations("/resources/");
}

7. 部署和运行

• 确保你的应用服务器（如 Apache Tomcat）已经启动。
• 将项目打包为 WAR 文件并部署到服务器中。
• 访问 http://localhost:8080/SpringMvcJavaConfigExample/hello，你应该会看到页面上显示的消息。

额外补充

1. 使用 DispatcherServlet 初始化参数: 如果你有额外的初始化参数可以通过 DispatcherServletInitializer 来进行配置。

@Override
protected void customizeRegistration(ServletRegistration.Dynamic registration) {
    registration.setInitParameter("throwExceptionIfNoHandlerFound", "true");
}

2. 使用其他视图解析器: 如果你想使用其他视图解析器，如 Thymeleaf、Freemarker 等，可以在 WebConfig 中配置相应的 ViewResolver。

3. 集成其他模块: 随着项目的扩展，你可能需要集成 Spring Security、Spring Data 等模块。