1. Spring 5 MVC 的 HelloWorld

Spring 5 最近也出来了，目前版本号是 5.0.0.M1。这个专栏用于记录我学习 Spring MVC 的过程。

---

下面构建一个基于 Spring 5 的 Spring MVC 应用。
文件组织图以下：

使用工具：Spring Tool Suite 3.8（装有 Spring 插件的 Eclipse 也能够，建议最新版）；Tomcat 8；JDK 8； Maven 3

1）. 建立一个 Maven Web 项目，项目摘要以下：

2）. 编写 pom.xml 文件：

<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/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>
    <groupId>com.techmap</groupId>
    <artifactId>spring5mvc</artifactId>
    <packaging>war</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring5mvc Maven Webapp</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

        <!-- 解决控制台输出 UTF-8 中文文本时乱码的问题 -->
        <argLine>-Dfile.encoding=UTF-8</argLine>

        <!-- 自定义参数 -->
        <spring.version>5.0.0.M1</spring.version>

    </properties>

    <dependencies>
        <!-- Jstl 支持 -->
        <dependency>
            <groupId>javax.servlet.jsp.jstl</groupId>
            <artifactId>javax.servlet.jsp.jstl-api</artifactId>
            <version>1.2.1</version>
        </dependency>

        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
        </dependency>

        <!-- log4j 支持 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    
        <!-- JSR 330 注解支持 -->
        <dependency>
            <groupId>javax.inject</groupId>
            <artifactId>javax.inject</artifactId>
            <version>1</version>
        </dependency>

        <!-- AspectJ 支持 -->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.9</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>1.8.9</version>
        </dependency>

        <!-- Spring 支持 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- Spring 框架支持 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>

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

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- JUnit 支持 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>

    </dependencies>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/libs-milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

    <build>
        <finalName>spring5mvc</finalName>
    </build>

</project>

3）. 编写 web.xml 文件

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
    id="WebApp_ID" version="3.0">

    <display-name>spring5mvc</display-name>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>

    <context-param>
        <description>Spring MVC 上下文配置文件路径</description>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:root-context.xml</param-value>
    </context-param>

    <servlet>
        <description>Spring MVC 核心 Servlet</description>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value></param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

</web-app>

这里配置了 Spring MVC 的核心 Servlet：DispatcherServlet。还指定了上下文配置文件的名称与路径：classpath:root-context.xml。若是不指定这个配置文件的名称与路径，默认的是 WEB-INF 目录下的一个叫作 [servlet-name]-servlet.xml 的 Spring 配置文件。

4）. 进行 Spring MVC 上下文配置

web.xml 文件中指定了 Spring MVC 上下文配置文件为 root-context.xml，这个文件放在 src/main/resources 下。下面是这个文件的内容：

<?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 http://www.springframework.org/schema/context/spring-context-4.3.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd">

    <context:component-scan base-package="com.techmap.examples.controllers" />
    
    <!-- 
        SpringMVC：启用 Spring MVC 注解驱动
         -->
    <mvc:annotation-driven />

</beans>

这个上下文配置文件目前只识别包 com.techmap.examples.controllers 下的控制器，即带有注解 @Controller 的。注意 <mvc:annotation-driven />，这表示启动 Spring MVC 的注解驱动。我测试了一下，不添加是不行的。

5）. 编写控制器

root-context.xml 文件中指定了控制器所在的包路径。下面在这个包路径下写一个控制器 HelloWorldController：

package com.techmap.examples.controllers;

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

@Controller
public class HelloWorldController
{
    
    @RequestMapping("/helloWorld")
    public String helloWorld(Model model)
    {
        System.out.println("-> Hello World!");
        
        model.addAttribute("message", "Hello World!");
        return "helloWorld";
    }
}

6）. Web 主页

在 webapp 目录下添加一个简单的 index.jsp 文件：

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%>
<%
    String basepath = request.getScheme() + "://" + request.getServerName() + ":" 
            + request.getServerPort() + request.getContextPath() + "/";
%>
<!DOCTYPE html>
<html>
<body>
<h2>首页</h2>
</body>
</html>

7）. 部署、运行与说明

至此，应用建立完成。把应用部署到 tomcat 中。在浏览器中输入

http://localhost:8080/spring5mvc

浏览器中应该会显示 index.jsp 页面。在浏览器中输入

http://localhost:8080/spring5mvc/helloWorld

应该会报错，报错信息应该是 HTTP Status 500，会像下面那样：

HTTP Status 500 - Circular view path [helloWorld]: would dispatch back to the current handler URL [/spring5mvc/helloWorld] again. Check your ViewResolver setup! (Hint: This may be the result of an unspecified view, due to default view name generation.)

缘由是，虽然找到了这个路径，可是没有对应的视图能够显示。在控制台中，应该能够找到相似下面的输出：

...
DEBUG 2016-09-01 09:09:39,157 Last-Modified value for [/spring5mvc/helloWorld] is: -1  (DispatcherServlet.java:951) 
-> Hello World!
DEBUG 2016-09-01 09:09:39,201 Invoking afterPropertiesSet() on bean with name 'helloWorld'  (AbstractAutowireCapableBeanFactory.java:1620) 
...

这说明确实执行了控制器。关于视图，会在第二篇中给出一个简单的例子。

**）这里附上我使用的 log4j.properties 内容：

# Set root logger level to WARN and append to stdout
log4j.rootLogger=DEBUG, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
#log4j.appender.stdout.layout.ConversionPattern=%d %5p (%c:%L) - %m%n
log4j.appender.stdout.layout.ConversionPattern=%-5p %d{yyyy-MM-dd HH:mm:ss,SSS} %m  (%F:%L) \n

# Print only messages of level ERROR or above in the package noModule.
log4j.logger.noModule=DEBUG

# Spring Stuff
log4j.logger.org.springframework.web.servlet.DispatcherServlet=DEBUG

其余

其实像上面那样一路走来，实在是很麻烦。更加省事的方法（实际上隐藏了更多细节）是使用 Spring Boot。官网上有快速让本身的 Controller 跑起来的教程