使用 IDEA搭建一个完整可用的 SpringMVC的 Maven项目

前言

本文总结了一种创建 SpringMVC Maven项目的方式，仅供参考。当然，还有很多其他不一样的创建方式，如果有更方便的，欢迎交流 。

本文环境列表如下：

macOS 10.15.2 
IntelliJ IDEA 2019.3.2 (Ultimate Edition)
java version 1.8.0_201
Apache Maven 3.6.1

最终的项目结构如下，后面的步骤中可以参考一下：

HelloSpringMVC|-- src|-- main|-- java|-- cn.spring.controller|-- HelloController.java|-- resources|-- webapp|-- static|-- css|-- image|-- js|-- WEB-INF|-- views|-- hello.jsp|-- web.xmlindex.xml|-- test|-- java|-- resources

一、创建一个 Maven项目

1. 选择菜单 File --> New --> Project
2. 选择左边的 Maven项目，勾选右边的 Create from archetype，在下面的列表中找到 org.apache.maven.archetypes:maven-archetype-webapp（注意：是选择带 ”maven“的 webapp），然后下一步
3. 在这一步键入工程名等信息，举例如下，然后下一步

   Name       : SpringDemo
   GroupId    : cn.springmvc
   ArtifactId : helloSpringmvc
   

4. 在这一步，配置正确的 Maven安装路径、Maven配置文件路径，以及仓库地址，然后 Finish结束
   如果下载不较慢，可以添加属性 name: archetypeCatalog ,value: internal可以加快下载速度。方法：在下方的 Properties界面中，选择加号 ➕，然后添加一个 name: archetypeCatalog ,value: internal，OK即可。
5. 项目创建完成后你会看到，其中 java、resources和 test文件夹没有，所以就自己创建，右键项目，New --> Directory
6. 创建好了之后，如果文件夹是灰色的，需要选中相应的文件夹右键，选择 Mark Directory as，选择相应的颜色即可
   可能因为 IDEA版本比较新，新建文件夹的时候，很智能的帮忙都弄好了
7. 创建了 static文件夹用来存放静态资源 css、js、images（图片等），和 views文件夹用来存放映射文件（例如JSP）
   目前的项目结构如下：

   SpringDemo|-- src|-- main|-- java|-- resources|-- webapp|-- static|-- css|-- image|-- js|-- WEB-INF|-- view|-- web.xmlindex.xml|-- test|-- java|-- resources
   

二、添加 SpringMVC框架支持

1. 引入主要依赖

   <!-- junit测试 -->
   <dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.12</version>
   </dependency><!-- webmvc依赖 包括了spring基本的依赖 -->
   <dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>5.1.9.RELEASE</version>
   </dependency><!--j2ee相关包 servlet、jsp、jstl-->
   <dependency><groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId><version>3.1.0</version>
   </dependency>
   <dependency><groupId>javax.servlet.jsp</groupId><artifactId>jsp-api</artifactId><version>2.2</version>
   </dependency>
   <dependency><groupId>javax.servlet</groupId><artifactId>jstl</artifactId><version>1.2</version>
   </dependency>
   

2. 点击 File，选择 Project Structure，选择右边界面中的 Facets，如果看到右边的 Spring中，已经为该项目配置了 Spring支持了，删除它即可
3. 右击项目文件夹，选择 Add framework support
4. 出现的界面中，在左边的列表中找到并勾选 Spring MVC，然后勾选右边的 Use library
5. Spring框架添加完之后，会看到 WEB-INF目录下多了两个 xml文件
   – applicationContext.xml
   – dispatcher-servlet.xml

此步骤配置SpringMVC框架支持也可不做，但是后面生成的这两个 xml文件就得自己添加，然后在 web.xml中对应配置

三、SpringMVC配置文件

修改上面得到 SpringMVC配置文件 dispatcher-servlet.xml

注：如果没有执行上一步，添加 SpringMVC框架支持，这一步需要自行新建 SpringMVC配置文件 dispatcher-servlet.xml

<?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"><!--启用spring的一些annotation --><context:annotation-config /><!-- 自动扫描该包，使 SpringMVC认为包下用了 @controller注解的类是控制器 --><context:component-scan base-package="cn.spring.*"><context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/></context:component-scan><!-- 配置注解驱动 可以将request参数与绑定到controller参数上 --><mvc:annotation-driven /><!-- 对模型视图名称的解析，即在模型视图名称添加前后缀(如果最后一个还是表示文件夹,则最后的斜杠不要漏了) 使用JSP--><!-- 默认的视图解析器 在上边的解析错误时使用 (默认使用html)- --><bean id="defaultViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"><property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/><property name="prefix" value="/WEB-INF/views/"/><!--设置JSP文件的目录位置--><property name="suffix" value=".jsp"/><property name="exposeContextBeansAsAttributes" value="true"/></bean><!--静态资源映射--><!--本项目把静态资源放在了webapp的statics目录下，资源映射如下--><mvc:resources mapping="/css/**" location="/static/css/"/><mvc:resources mapping="/js/**" location="/static/js/"/><mvc:resources mapping="/image/**" location="/static/images/"/><mvc:default-servlet-handler />  <!--这句要加上，要不然可能会访问不到静态资源，具体作用自行百度-->
</beans>

四、Spring配置文件

Spring配置文件 applicationContext.xml，负责一些非 MVC组件的配置，暂时没有所以是空的

注：如果没有执行上一步，添加 SpringMVC框架支持，这一步需要自行新建 Spring配置文件 applicationContext.xml

五、配置 web.xml

更改web.xml配置文件，其中元素的值改为 / ，表示要拦截所有的请求，并交由Spring MVC的后台控制器来处理

<?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_3_1.xsd"version="3.1"><display-name>Archetype Created Web Application</display-name><!--Welcome pages--><welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list><!--配置springMVC DispatcherServlet--><servlet><servlet-name>springMVC</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><init-param><!-- 指定 SpringMVC的配置文件路径 --><param-name>contextConfigLocation</param-name><param-value>/WEB-INF/dispatcher-servlet.xml</param-value></init-param><load-on-startup>1</load-on-startup><async-supported>true</async-supported></servlet><servlet-mapping><servlet-name>springMVC</servlet-name><url-pattern>/</url-pattern></servlet-mapping><!-- 把 applicationContext.xml加入到配置文件中 --><context-param><param-name>contextConfigLocation</param-name><param-value>/WEB-INF/applicationContext.xml</param-value></context-param><listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class></listener>
</web-app>

六、测试

1. HelloController

在包 cn.spring.controller下，新建 HelloController

@Controller
public class HelloController {@RequestMapping("sayHello")public String sayHello() {System.out.print("访问index后台。。。");return "hello";}
}

这将访问到 /WEB-INF/views/ + hello + .jsp

2. hello.jsp

在目录 /WEB-INF/views/ 底下，新建 hello.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head><title>Hello</title>
</head>
<body>
<h1>Hello SpringMVC</h1>
</body>
</html>

七、配置 Tomcat启动服务

1. 在右上角，找到一个锤子图案，点击 Add Configuration...
2. 在左上角，点击 ➕，在列表中找到并选择 Tomcat Server --> Local
3. 在 Name处为该 Tomcat服务命名或选择默认，在 Application server配置本地安装的 Tomcat
4. 选择 Deployment标签页，点击该页的 ➕，选择 Artifact...
5. 选择刚刚的项目 HelloSpringMVC:war，并OK
6. 改一下该页的 Application Context为 helloSpring，这是待会要访问的后缀，点击 OK
7. 启动刚刚新建的 Tomcat服务，在浏览器访问 http://localhost:8080/helloSpring/sayHello

总结

只要通过以上几个步骤，就可以在 IDEA上完成 SpringMVC的搭建。