如何搭建SpringMVC的最小化工程

Spring是一个轻量级的Java开源框架,它是一个Full-Stack(全栈)的分层式的Java SE/EE框架。开发者可以很方便地使用Spring的IoC(反转控制)、AOP(面向切面)和MVC(模型-视图-控制器)等功能特性。本文会在Eclipse中搭建一个最小化的SpringMVC工程,以作为后续Spring学习的入门教程。

一、环境描述

二、添加服务器

启动Eclipse,然后访问菜单Window → Preferences,然后在打开的首选项窗口中,打开Server → Runtime Environments,如下图所示:

Eclipse首选项窗口

点击上图中的Add按钮,然后在打开的新建服务器运行时环境的窗口中选择Apache → Apache Tomcat v8.0,然后点击Next按钮,如下图所示:

添加服务器运行时环境

在下一步的窗口中,填写Tomcat服务器的名称和安装目录。本文将服务器名称指定为“Apache Tomcat v8.0”,安装目录指定为“/usr/local/Tomcat”,最后点击Finish按钮,如下图所示:

指定服务器名称和安装目录

此时,会返回Eclipse的首选项窗口,点击OK按钮便能成功添加Tomcat服务器了,如下图所示:

服务器配置完成

三、新建和配置Java工程

在Eclipse中访问菜单File → New → Java Project,在新建Java工程的窗口中指定工程名为“SpringTest”,指定执行的JRE为“JavaSE-1.8”,然后点击Finish按钮,如下图所示:

新建Java工程

现在可以在Eclipse的Package Explorer视图中看到“SpringTest”工程了。在工程名上点击鼠标右键,在右键菜单中选择Properties(或者按下Alt+Enter快捷键),打开工程的属性窗口,选择该窗口中的Project Facets,如下图所示:

SpringTest工程的属性

因为默认的Java工程并没有被配置为使用Project Facets,所以此处需要点击Convert to faceted form...,添加对Project Facet的支持。然后,在Project Facet列表进行如下配置:

  • 将Java的版本指定为1.8;
  • 将Dynamic Web Module的版本指定为3.1;
  • 将JavaScript的版本指定为1.0。

Project Facet的配置如下图所示,然后点击OK按钮:

Project Facets窗口

Project Explorer视图中,右键点击工程名称,然后在右键菜单中访问Configure → Convert to Maven Project,如下图所示:

转换为Maven工程

在打开的创建POM的窗口中,工程的Maven配置如下图所示:

新建POM文件

点击上图中的Finish按钮,工程的pom文件便创建完成了。

在Eclipse中打开和编辑工程的/SpringTest/pom.xml文件,添加对spring-webmvcspring-context的依赖关系,该文件内容最终如下所示:

  1. <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">
  2. <modelVersion>4.0.0</modelVersion>
  3. <groupId>SpringTest</groupId>
  4. <artifactId>SpringTest</artifactId>
  5. <version>0.0.1-SNAPSHOT</version>
  6. <packaging>war</packaging>
  7. <dependencies>
  8. <!-- springframework begins -->
  9. <dependency>
  10. <groupId>org.springframework</groupId>
  11. <artifactId>spring-webmvc</artifactId>
  12. <version>4.2.4.RELEASE</version>
  13. </dependency>
  14. <dependency>
  15. <groupId>org.springframework</groupId>
  16. <artifactId>spring-context</artifactId>
  17. <version>4.2.4.RELEASE</version>
  18. </dependency>
  19. </dependencies>
  20. <build>
  21. <sourceDirectory>src</sourceDirectory>
  22. <plugins>
  23. <plugin>
  24. <artifactId>maven-compiler-plugin</artifactId>
  25. <version>3.5.1</version>
  26. <configuration>
  27. <source>1.8</source>
  28. <target>1.8</target>
  29. </configuration>
  30. </plugin>
  31. <plugin>
  32. <artifactId>maven-war-plugin</artifactId>
  33. <version>2.6</version>
  34. <configuration>
  35. <warSourceDirectory>WebContent</warSourceDirectory>
  36. <failOnMissingWebXml>false</failOnMissingWebXml>
  37. </configuration>
  38. </plugin>
  39. </plugins>
  40. </build>
  41. </project>

在Eclipse中打开工程的/SpringTest/WebContent/WEB-INF目录,删除该目录下的lib子目录。然后,在WEB-INF目录中新建web.xml文件,该文件的内容如下所示:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app version="3.1" xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
  5. http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd">
  6. <context-param>
  7. <param-name>contextConfigLocation</param-name>
  8. <param-value>/WEB-INF/applicationContext.xml</param-value>
  9. <!-- 默认是/WEB-INF/applicationContext.xml -->
  10. </context-param>
  11. <listener>
  12. <listener-class>
  13. org.springframework.web.context.ContextLoaderListener
  14. </listener-class>
  15. </listener>
  16. <servlet>
  17. <servlet-name>SpringMVC</servlet-name>
  18. <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  19. <init-param>
  20. <param-name>contextConfigLocation</param-name>
  21. <param-value>/WEB-INF/SpringMVC-servlet.xml</param-value>
  22. <!-- 默认是/WEB-INF/[servlet名字]-servlet.xml -->
  23. </init-param>
  24. <load-on-startup>1</load-on-startup>
  25. </servlet>
  26. <servlet-mapping>
  27. <servlet-name>SpringMVC</servlet-name>
  28. <url-pattern>/</url-pattern>
  29. </servlet-mapping>
  30. </web-app>

web.xml文件还指定了applicationContext.xml文件和SpringMVC-servlet.xml文件的路径。在WEB-INF目录中新建SpringMVC-servlet.xml文件,该文件的内容如下所示:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xmlns:mvc="http://www.springframework.org/schema/mvc"
  5. xmlns:context="http://www.springframework.org/schema/context"
  6. xmlns:aop="http://www.springframework.org/schema/aop"
  7. xmlns:tx="http://www.springframework.org/schema/tx"
  8. xsi:schemaLocation="http://www.springframework.org/schema/beans
  9. http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
  10. http://www.springframework.org/schema/mvc
  11. http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
  12. http://www.springframework.org/schema/context
  13. http://www.springframework.org/schema/context/spring-context-4.0.xsd
  14. http://www.springframework.org/schema/aop
  15. http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
  16. http://www.springframework.org/schema/tx
  17. http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">
  18. <!-- 设置使用注解的类所在的jar包 -->
  19. <context:component-scan base-package="hello" />
  20. </beans>

SpringMVC-servlet.xml文件将Spring注解组件的扫描根目录设置为hello包。在WEB-INF目录中新建applicationContext.xml文件,该文件的内容如下所示:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
  4. xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx"
  5. xsi:schemaLocation="http://www.springframework.org/schema/beans
  6. http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
  7. http://www.springframework.org/schema/tx
  8. http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
  9. http://www.springframework.org/schema/aop
  10. http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
  11. http://www.springframework.org/schema/context
  12. http://www.springframework.org/schema/context/spring-context-4.0.xsd">
  13. </beans>

因为这个最小化工程没有用到任何Bean,所以applicationContext.xml文件中的配置是空的。

若工程提示xml文件有错误,则需要在Package Explorer视图中右键点击工程名称,然后在右键菜单中访问Maven → Update Project选项,更新工程的Maven依赖关系即可,如下图所示:

更新工程的Maven依赖关系

在工程的src目录中新建一个名为“hello”的包,然后在这个包中再新建一个名为“HelloController”的类文件,该文件的内容如下所示:

  1. package hello;
  2. import org.springframework.stereotype.Controller;
  3. import org.springframework.web.bind.annotation.RequestMapping;
  4. import org.springframework.web.bind.annotation.ResponseBody;
  5. @Controller
  6. public class HelloController {
  7. private int count = 0;
  8. @RequestMapping("hello")
  9. public @ResponseBody String test() {
  10. return String.format("hello, world! This comes from spring, visited %d times!", ++count);
  11. }
  12. }

至此,SpringMVC的最小化工程已经创建和配置完毕了。

四、启动应用

在Eclipse中访问菜单Window → Show View → Servers,打开Servers视图,如下图所示:

Servers视图

点击servers视图中的No servers are available. Click this link to create a new server,为工程新建的服务器配置如下图所示:

为SpringTest工程新建服务器配置

点击Next按钮,然后将下一步窗口左侧中的“SpringTest”资源添加到窗口的右侧,如下图所示:

为服务器添加资源

此时,便能在Servers视图中看到这个工程使用的Tomcat服务器了,右键点击服务器名称,然后选择右键菜单的DebugStart命令,即可调试或运行这个最小化工程了。

打开浏览器,然后在地址栏中输入以下URL:

  1. http://localhost:8080/SpringTest/hello

打开的测试页面如下图所示:

打开SpringTest的测试页面

至此,SpringMVC的最小化工程已经运行验证完毕了!