Spring+SpringMVC+Mybatis+Maven搭建项目

Spring+SpringMVC+Mybatis+Maven搭建项目

1.前言

这篇文章一步步总结了搭建一个基于Maven的Spring+SpringMVC+Mybatis框架的完整过程，同时加入了基础工具类，包括读取配置文件，监听器和定时器等。文件可以免积分下载：http://download.csdn.net/download/jintao_ma/9661038

2.建立一个web项目

2.1 maven创建web项目

显然，由于SpringMVC的存在，表明这篇讲述的是一个Web项目，使用maven的maven-archetype-webapp这个模板，搭建一个项目，在命令行下执行：

mvn archetype:create -DgroupId=com.mycompany.app -DartifactId=myWebApp -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false

然后新建的myWebApp项目中，只有java/main目录，我们新建下面三个目录才是一个完整的maven web项目：

java/resources

test/main

test/resources

接着导入eclipse，file->import:

2.2 设置web项目的版本和jdk版本

新导入的项目的web版本默认是2.3，jdk版本是1.5；我们需要重新设置一下，设置为最新的；

修改项目目录.settings下的org.eclipse.wst.common.project.facet.core.xml，修改后如下：

<?xml version="1.0" encoding="UTF-8"?><faceted-project>  <fixed facet="wst.jsdt.web"/>  <installed facet="java" version="1.8"/>  <installed facet="jst.web" version="3.0"/>  <installed facet="wst.jsdt.web" version="1.0"/></faceted-project>

同时修改项目中的web.xml:

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" ><web-app>  <display-name>Archetype Created Web Application</display-name></web-app>

改为

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

2.3 maven设置

2.3.1 项目run as->maven clean报错：

-Dmaven.multiModuleProjectDirectory system property is not set

可以设一个环境变量M2_HOME指向你的maven安装目录M2_HOME=D:\Apps\apache-maven-3.3.1，然后在Window->Preference->Java->Installed JREs->Edit，在Default VM arguments中设置-Dmaven.multiModuleProjectDirectory=$M2_HOME

2.3.2 maven update project

经过前面的几项设置，项目的web版本已经是3.0，jdk也是1.8了，也可以进行maven clean和install；但是每次在进行maven->project时，项目还会变为 web 2.3和jdk 1.5

我们还需要在pom中增加下面的配置：

<build>    <finalName>myWebApp</finalName>     <plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.5</version><configuration><source>1.8</source><target>1.8</target></configuration></plugin></plugins>  </build>

然后就可以maven-clean，maven-install；然后maven update project；就没有任何的错误和警告了。

3.加入Spring，SpringMVC和Mybatis

3.1 spring.xml

在介绍配置文件之前，先在pom.xml中引入相关的jar包，下面把这篇所有需要的依赖（包括后面所用到的定时器jar包）全部贴上来，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.mycompany.app</groupId>  <artifactId>myWebApp</artifactId>  <packaging>war</packaging>  <version>1.0-SNAPSHOT</version>  <name>myWebApp</name>  <url>http://maven.apache.org</url>    <properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><spring.version>[4.3.0.RELEASE,)</spring.version>  </properties>    <dependencies>    <dependency>      <groupId>junit</groupId>      <artifactId>junit</artifactId>      <version>[4.10,)</version>      <scope>test</scope>    </dependency>    <!-- 添加数据库驱动 -->    <dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>[5.1.39,)</version></dependency><!-- 添加Mybatis --><dependency>    <groupId>org.mybatis</groupId>          <artifactId>mybatis</artifactId>          <version>[3.4.0,)</version>   </dependency> <!-- 添加mybatis-spring的依赖 --><dependency><groupId>org.mybatis</groupId>             <artifactId>mybatis-spring</artifactId>             <version>[1.3.0,)</version></dependency><!-- 添加Spring的依赖 --><dependency><groupId>org.springframework</groupId><artifactId>spring-core</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-web</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-context</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><dependency>    <groupId>org.springframework</groupId>    <artifactId>spring-aop</artifactId>    <version>${spring.version}</version></dependency><dependency>    <groupId>aopalliance</groupId>    <artifactId>aopalliance</artifactId>    <version>[1.0,)</version></dependency><dependency>    <groupId>aspectj</groupId>    <artifactId>aspectjweaver</artifactId>    <version>1.5.4</version></dependency><dependency>    <groupId>aspectj</groupId>    <artifactId>aspectjrt</artifactId>    <version>1.5.4</version></dependency><dependency>    <groupId>cglib</groupId>    <artifactId>cglib</artifactId>    <version>[3.2.4,)</version></dependency><!-- 引入jstl标签库 --><dependency>    <groupId>jstl</groupId>    <artifactId>jstl</artifactId>   <version>1.2</version>   </dependency><!-- 引入jstl标签库 -->       <dependency>    <groupId>taglibs</groupId>    <artifactId>standard</artifactId>    <version>1.1.2</version></dependency><!-- 配置log4j --><dependency>    <groupId>log4j</groupId>    <artifactId>log4j</artifactId>    <version>[1.2.17,)</version></dependency><!-- 配置slf4j --><dependency>    <groupId>org.slf4j</groupId>    <artifactId>slf4j-api</artifactId>    <version>[1.7.21,)</version></dependency><!-- 配置slf4j-log --><dependency>    <groupId>org.slf4j</groupId>    <artifactId>slf4j-log4j12</artifactId>    <version>[1.7.21,)</version></dependency><!-- 配置commons-io--><dependency>    <groupId>commons-io</groupId>    <artifactId>commons-io</artifactId>   <version>[2.5,)</version></dependency><!--配置quartz定时器 --><dependency><groupId>org.quartz-scheduler</groupId><artifactId>quartz</artifactId><version>[2.2.3,)</version></dependency><!--配置quartz所依赖的jar --><dependency><groupId>commons-collections</groupId><artifactId>commons-collections</artifactId><version>[3.2.1,)</version></dependency><!-- 配置commons-logging --><dependency><groupId>commons-logging</groupId><artifactId>commons-logging</artifactId><version>[1.2,)</version></dependency><dependency><groupId>commons-fileupload</groupId><artifactId>commons-fileupload</artifactId><version>[1.3.2,)</version></dependency>  </dependencies>    <build>    <finalName>myWebApp</finalName>       <plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.5</version><configuration><source>1.8</source><target>1.8</target></configuration></plugin></plugins>  </build>  </project>

<version>[1,1)</version>这样的写法意思是获取大于等于1.1版本的最新的jar包，这样以后就不用手动升级了，每次maven->update project就可以了。

接着在配置spring.xml之前，建议先看上一篇文章的总结：http://blog.csdn.net/Jintao_Ma/article/details/52853865，spring.xml的作用就是把spring和mybatis进行集成，这篇文章的spring配置和上一篇稍有不同，首先扫描的包发生了变化

<!-- 扫描注解,Spring的配置文件不扫描@Controller注解，因为controller层由springMvc配置文件扫描解析 --><context:component-scan base-package="com.mycompany"><context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller" /></context:component-scan>

这里面去掉了controller层的扫描，controller层由spring mvc来进行扫描；然后是aop配置中增加了“..”

<!-- 添加规则事务 --><aop:config proxy-target-class="true"><!-- 第一个*代表所有的返回值类型  --><!-- 第一个..代表中间隔着任意多个包层次 --><!-- 第二个*代表所有的类 --><!-- 第三个*代表类所有方法 最后一个..代表所有的参数。 --><aop:pointcut expression="execution(* com.mycompany..service.*.*(..))" id="txPoint"/><aop:advisor advice-ref="txAdvice" pointcut-ref="txPoint"/></aop:config>

因为service层在不同的包中，我们希望只对service进行事务，com.mycompany..service代表com.mycompany项目所有目录下的名为service文件夹

3.2 web.xml

先配置spring.xml文件的读取：

<!--contextConfigLocation在 ContextLoaderListener类中的默认值是 /WEB-INF/applicationContext.xml--><context-param><param-name>contextConfigLocation</param-name><param-value>classpath:spring.xml,classpath:springQuartz.xml</param-value></context-param>      <listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>   </listener>

配置context-param，里面读取spring.xml(先忽略springQuartz.xml，后面提到), 然后监听器listener在项目初始化的时候就能够读取spring.xml中的配置，顺便说一下不同节点在web.xml中的执行顺序，context-param -> listener -> filter ->  servlet

再配置自己的servlet：

<servlet>          <servlet-name>myWebApp</servlet-name>          <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>          <init-param>  <!--         默认加载/WEb-INF/<servletName-servlet>.xml的Spring配置文件，可以通过contextConfigLocation手动指定 -->              <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>myWebApp</servlet-name>          <url-pattern>/</url-pattern>      </servlet-mapping>

在分析之前，建议先看之前总结的另一篇文章：http://blog.csdn.net/Jintao_Ma/article/details/52141953，之后就可以明白上面的配置了。这时候可能会有一个疑问，这个tomcat自带的名为'jsp'的servlet, 与mvc中的视图解析器有什么关系吗？后面进行解释

3.3 springMvc.xml

先看一下视图解析器的配置，然后分析它与tomcat自带'jsp'关系

<!-- 配置视图解析器 -->  <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">  <property name="prefix" value="/jsp/"></property>  <property name="suffix" value=".jsp"></property>  </bean>

当我们在地址栏中输入一个地址，首先它会去找servlet，由于与‘jsp'这个servlet不匹配，所以会进入我们自己配置的默认servlet，然后进入controller层次，接着controller返回的时候，会经过试图解析器的解析，完成之后再由‘jsp’这个servlet来找到对应的jsp。 

对资源文件的处理，这篇文章用的是<default-servlet-handler/>,之后还要配置<mvc annotation-driven/>,原因看这篇文章http://www.cnblogs.com/hujingwei/p/5349983.html，配置如下：

<mvc:annotation-driven/>

<mvc:default-servlet-handler/>

同时还可以配置<mvc:view-controller>，这样url请求可以不经过controller层次，直接由试图解析器进行解析，如下：

<!-- 加载系统配置文件，然后再mvc:view-controller中的path中引入 -->  <context:property-placeholder location="classpath:system.properties"/>

<mvc:view-controller path="${adminPath}" view-name="index"/>

另外需要注意一点，我们在mvc中扫描包时候，只扫描controller层的，这和spring.xml的配置正好是互补的，(或者说不要扫描service层)。 为什么mvc不能扫描service层呢，上一篇文章http://blog.csdn.net/Jintao_Ma/article/details/52853865提到了。

在springMvc.xml中还可以加入多文件上传，这样一来，springMvc.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:mvc="http://www.springframework.org/schema/mvc"      xmlns:context="http://www.springframework.org/schema/context"      xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd          http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.2.xsd          http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd">    <!-- 加载系统配置文件，然后再mvc:view-controller中的path中引入 -->  <context:property-placeholder location="classpath:system.properties"/><!-- 配置自动扫描的包,只扫描@controller注解的包 -->  <context:component-scan base-package="com.mycompany" use-default-filters="false"><context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/></context:component-scan>          <mvc:view-controller path="${adminPath}" view-name="index"/>    <mvc:annotation-driven/>  <!-- 配置视图解析器 -->  <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">  <property name="prefix" value="/jsp/"></property>  <property name="suffix" value=".jsp"></property>  </bean>   <mvc:default-servlet-handler/><!-- 支持多文件上传 -->    <bean id="multipartResolver"            class="org.springframework.web.multipart.commons.CommonsMultipartResolver">    <!-- 默认编码 -->  <property name="defaultEncoding" value="utf-8" />    <!-- 文件大小最大值 -->  <property name="maxUploadSize" value="10485760000" />    <!-- 内存中的最大值 -->  <property name="maxInMemorySize" value="40960" />        </bean> </beans>

4.其他配置

4.1 读取配置文件

全局配置配置文件有两个，一个是jdbc.properties, 另一个是system.properties, 后者可以放入一下系统的配置信息：

adminPath=/maindelTempFile=E:/Majintao/temp

配置文件加载类，PropertiesLoader.java:

package com.mycompany.mvc.utils;import java.io.IOException;import java.io.InputStream;import java.util.NoSuchElementException;import java.util.Properties;import org.apache.commons.io.IOUtils;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.core.io.DefaultResourceLoader;import org.springframework.core.io.Resource;import org.springframework.core.io.ResourceLoader;/**  * @author Jintao_Ma  * @time 2016年7月21日23:19:39  * @description: * Properties文件载入工具类. 可载入多个properties文件, 相同的属性在最后载入的文件中的值将会 * 覆盖之前的值，但以System的Property优先.项目的基础工具类，可被上层使用 */  public class PropertiesLoader {        private static Logger logger = LoggerFactory.getLogger(PropertiesLoader.class);        private static ResourceLoader resourceLoader = new DefaultResourceLoader();        private final Properties properties;        public PropertiesLoader(String[] resourcesPaths) {          properties = loadProperties(resourcesPaths);      }        public Properties getProperties() {          return properties;      }        /**      * 取出Property，但以System的Property优先.      */      private String getValue(String key) {          String systemProperty = System.getProperty(key);          if (systemProperty != null) {              return systemProperty;          }          return properties.getProperty(key);      }        /**      * 取出String类型的Property，但以System的Property优先,如果都為Null则抛出异常.      */      public String getProperty(String key) {          String value = getValue(key);          if (value == null) {              throw new NoSuchElementException();          }          return value;      }        /**      * 取出String类型的Property，但以System的Property优先.如果都為Null則返回Default值.      */      public String getProperty(String key, String defaultValue) {          String value = getValue(key);          return value != null ? value : defaultValue;      }        /**      * 取出Integer类型的Property，但以System的Property优先.如果都為Null或内容错误则抛出异常.      */      public Integer getInteger(String key) {          String value = getValue(key);          if (value == null) {              throw new NoSuchElementException();          }          return Integer.valueOf(value);      }        /**      * 取出Integer类型的Property，但以System的Property优先.如果都為Null則返回Default值，如果内容错误则抛出异常      */      public Integer getInteger(String key, Integer defaultValue) {          String value = getValue(key);          return value != null ? Integer.valueOf(value) : defaultValue;      }        /**      * 取出Double类型的Property，但以System的Property优先.如果都為Null或内容错误则抛出异常.      */      public Double getDouble(String key) {          String value = getValue(key);          if (value == null) {              throw new NoSuchElementException();          }          return Double.valueOf(value);      }        /**      * 取出Double类型的Property，但以System的Property优先.如果都為Null則返回Default值，如果内容错误则抛出异常      */      public Double getDouble(String key, Integer defaultValue) {          String value = getValue(key);          return value != null ? Double.valueOf(value) : defaultValue;      }        /**      * 取出Boolean类型的Property，但以System的Property优先.如果都為Null抛出异常,如果内容不是true/false则返回false.      */      public Boolean getBoolean(String key) {          String value = getValue(key);          if (value == null) {              throw new NoSuchElementException();          }          return Boolean.valueOf(value);      }        /**      * 取出Boolean类型的Property，但以System的Property优先.如果都為Null則返回Default值,如果内容不为true/false则返回false.      */      public Boolean getBoolean(String key, boolean defaultValue) {          String value = getValue(key);          return value != null ? Boolean.valueOf(value) : defaultValue;      }        /**      * 载入多个文件, 文件路径使用Spring Resource格式.      */      private Properties loadProperties(String[] resourcesPaths) {          Properties props = new Properties();            for (String location : resourcesPaths) {              InputStream is = null;              try {                  Resource resource = resourceLoader.getResource(location);                  is = resource.getInputStream();                  props.load(is);              } catch (IOException ex) {                  logger.info("Could not load properties from path:" + location + ", " + ex.getMessage());              } finally {                  IOUtils.closeQuietly(is);              }          }          return props;      }  } 

配置文件工具类SystemConfig.java：

package com.mycompany.mvc.config;import java.util.Properties;import com.mycompany.mvc.utils.PropertiesLoader;/** *@author Jintao_Ma *@time 2016年7月23日14:26:12 *@description: *获取配置文件信息 */public class SystemConfig {private static Properties properties;private static String[] resourcesPaths = {"classpath:system.properties"};static{properties = new PropertiesLoader(resourcesPaths).getProperties();}public static String getProperty(String key){String systemProperty = System.getProperty(key);          if (systemProperty != null) {              return systemProperty;          }          return properties.getProperty(key);}}

然后就可以像SystemConfig.getProperty()的形式使用配置文件中的属性了。

4.2 设置监听器

监听器可以做很多事情，比如我们可以在系统加载的时候获取系统的绝对路径，然后放入System中，SystemListener.java:

package com.mycompany.mvc.listener;import javax.servlet.ServletContextEvent;import javax.servlet.ServletContextListener;import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class SystemListener implements ServletContextListener{private Logger logger = LoggerFactory.getLogger(SystemListener.class);/** * 获取系统绝对路径 */@Overridepublic void contextInitialized(ServletContextEvent servletContext) {logger.debug("servletContext init start...");System.setProperty("realPath", servletContext.getServletContext().getRealPath("/"));logger.debug("servletContext init end...");}@Overridepublic void contextDestroyed(ServletContextEvent arg0) {}}

4.3 设置定时器

新建springQuartz.xml,在其中指定扫描的包，以及执行的方法和时间等 ：

<?xml version="1.0" encoding="UTF-8"?> <beansxmlns = "http://www.springframework.org/schema/beans"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xmlns:p="http://www.springframework.org/schema/p"    xmlns:context="http://www.springframework.org/schema/context"    xmlns:aop="http://www.springframework.org/schema/aop"    xsi:schemaLocation="http://www.springframework.org/schema/beans        http://www.springframework.org/schema/beans/spring-beans-4.3.xsd        http://www.springframework.org/schema/context        http://www.springframework.org/schema/context/spring-context-4.3.xsd    http://www.springframework.org/schema/aop  http://www.springframework.org/schema/aop/spring-aop-4.3.xsd"> <context:component-scan base-package="com.mycompany.mvc.quartz"></context:component-scan><!-- 任务生成器，指定其对应的对象和其中的方法 --><bean id="fileDeleteDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"><property name="targetObject" ref="fileDelete" /><property name="targetMethod" value="fileDelete_delFile" /></bean><!-- 触发器生成器，指定任务和执行的时间 --><bean id="fileDeleteTrigger"  class="org.springframework.scheduling.quartz.CronTriggerFactoryBean"><property name="jobDetail" ref="fileDeleteDetail" /><property name="cronExpression"><value>0 0/5* * * ?</value><!-- 每隔五分钟跑一次，删除指定目录下的文件 --></property></bean><bean id="schedulerFactoryBean"  class="org.springframework.scheduling.quartz.SchedulerFactoryBean"><property name="triggers"><list><ref bean="fileDeleteTrigger" /></list></property></bean>    </beans>

接着再web.xml中读取，这就是前面提到的：

<context-param><param-name>contextConfigLocation</param-name><param-value>classpath:spring.xml,classpath:springQuartz.xml</param-value></context-param>

然后定时器就设置好了，它所指定的类，和要执行的方法是下面这个，FileDelete.java:

package com.mycompany.mvc.quartz;import java.io.File;import org.springframework.stereotype.Component;import com.mycompany.mvc.config.SystemConfig;/** * @author Jintao_Ma * @time 2016年7月25日21:45:35 * @description： * 文件删除类，可删除多个文件夹下的文件 */@Component("fileDelete")public class FileDelete {private String folder = SystemConfig.getProperty("delTempFile");private String[] folders={folder};    private static void delFiles(String[] folders) {        for (int i = 0; i < folders.length; i++) {            File f = new File(folders[i]);            File[] files = null;            if (f.exists()) {                files = f.listFiles();                for (int j = 0; j < files.length; j++) {                    files[j].delete();                }            }        }    }public void fileDelete_delFile(){delFiles(folders);}}

就是删除E:/Majintao/temp下面所有的文件夹，每5分钟查询一次。 （这个temp是我的临时文件夹 ^_^）

5.总结

一个基本的基于maven的spring+mvc+mybatis框架就搭建好了，需要增加的东西还有很多，后面可以根据需要慢慢的往其中增加其他的一些东西，以后会继续总结~  下面是本篇讲述项目的的基本结构：

PS：上一篇文章提到了事务的配置应该在service层，而且应抛出异常让controller层try...catch处理。还应该注意一点是，由于controller层没有事务，所以一个方法里应该只有一个service层的方法，也就是说一个service层的方法，应该完成一个完整的业务。