Spring和mybatis的整合

一、搭建项目开发环境

1. 新建一个maven项目SpringMybatis，项目结构如下：

说明：

src/main/java 存放java代码和映射文件：

com.study.springmybatis.dao 存放mapper接口

com.study.springmybatis.mapper 存放mapper映射文件

com.study.springmybatis.model 存放pojo类

com.study.springmybatis.service 存放service接口和对应的实现类

src/test/java存放测试代码

src/main/resources 存放数据库配置文件和xml配置文件

2. 在pom.xml文件引入spring和mybatis相关的依赖，这里用的是阿里的maven远程仓库http://maven.aliyun.com/nexus/content/groups/public/

 <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.study.springmybatis</groupId>
   <artifactId>SpringMybatis</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>

   <name>SpringMybatis</name>
   <url>http://maven.apache.org</url>

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

   <dependencies>
     <!-- 添加Spring相关的依赖 begin-->
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-core</artifactId>
             <version>4.3.12.RELEASE</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context</artifactId>
             <version>4.3.12.RELEASE</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-tx</artifactId>
             <version>4.3.12.RELEASE</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-jdbc</artifactId>
             <version>4.3.12.RELEASE</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-test</artifactId>
             <version>4.3.12.RELEASE</version>
         </dependency>

         <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-aop</artifactId>
           <version>4.3.12.RELEASE</version>
         </dependency>

         <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-beans</artifactId>
           <version>4.3.12.RELEASE</version>
         </dependency>

         <dependency>
           <groupId>org.apache.geronimo.bundles</groupId>
           <artifactId>aspectjweaver</artifactId>
           <version>1.6.8_2</version>
         </dependency>
    <!-- 添加Spring相关的依赖 end-->

    <!-- 添加mybatis的核心包 begin-->
         <dependency>
             <groupId>org.mybatis</groupId>
             <artifactId>mybatis</artifactId>
             <version>3.2.8</version>
         </dependency>
    <!-- 添加mybatis的核心包 end-->

    <!-- 添加mybatis与Spring整合的核心包 begin -->
         <dependency>
             <groupId>org.mybatis</groupId>
             <artifactId>mybatis-spring</artifactId>
             <version>1.2.0</version>
         </dependency>
    <!-- 添加mybatis与Spring整合的核心包 end -->

    <!--数据库连接相关包 begin  -->
         <dependency>
           <groupId>org.wisdom-framework</groupId>
           <artifactId>mysql-connector-java</artifactId>
           <version>5.1.34_1</version>
         </dependency>

         <dependency>
           <groupId>commons-dbcp</groupId>
           <artifactId>commons-dbcp</artifactId>
           <version>1.4</version>
         </dependency>

         <dependency>
           <groupId>commons-pool</groupId>
           <artifactId>commons-pool</artifactId>
           <version>1.6</version>
         </dependency>

         <dependency>
           <groupId>c3p0</groupId>
           <artifactId>c3p0</artifactId>
           <version>0.9.1.2</version>
         </dependency>
    <!--数据库连接相关包 end  -->

    <!-- 其他附加包 begin-->
         <dependency>
           <groupId>commons-logging</groupId>
           <artifactId>commons-logging</artifactId>
           <version>1.1.3</version>
         </dependency>    

         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.12</version>
             <scope>test</scope>
         </dependency>
     <!-- 其他附加包 end-->

   </dependencies>
 </project>

二、创建表SQL和使用mybatis逆向工程生成代码

1.建表

 CREATE TABLE `t_user` (
   `id` int(11) NOT NULL AUTO_INCREMENT,
   `username` varchar(30) NOT NULL COMMENT '用户名称',
   `birthday` date DEFAULT NULL COMMENT '生日',
   `sex` char(2) DEFAULT NULL COMMENT '性别',
   `address` varchar(256) DEFAULT NULL COMMENT '地址',
   PRIMARY KEY (`id`)
 ) ENGINE=MyISAM AUTO_INCREMENT=5 DEFAULT CHARSET=utf8 COMMENT='用户信息表';

2. 使用mybatis逆向工程生成代码

mybatis逆向工程能根据数据库的表结构生成对应的mapper映射文件，接口，实体类，具体操作方法可以看我的前一篇文章：mybatis逆向工程，然后修改生成文件的名称为符合java命名规范的名称

3. 生成逆向工程后的代码目录结构如下，这里使用的是spring的注解管理bean

生成的mapper接口UserDao.java代码

 package com.study.springmybatis.dao;

 import org.springframework.stereotype.Repository;

 import com.study.springmybatis.model.UserModel;

 /**
  * 用户接口
  *
  * @author lgs
  *
  */
 @Repository("userDao")
 public interface UserDao {
     int deleteByPrimaryKey(Integer id);

     int insert(UserModel record);

     int insertSelective(UserModel record);

     UserModel selectByPrimaryKey(Integer id);

     int updateByPrimaryKeySelective(UserModel record);

     int updateByPrimaryKey(UserModel record);
 }

生成的mapper映射文件mapper-user.xml，因为之前对生成的实体和接口做了名称修改，所以这里也要对mapper-user.xml里面的内容做对应的修改，修改后的内容如下

 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
 <mapper namespace="com.study.springmybatis.dao.UserDao" >

     <resultMap id="BaseResultMap" type="com.study.springmybatis.model.UserModel" >
         <id column="id" property="id" jdbcType="INTEGER" />
         <result column="username" property="username" jdbcType="VARCHAR" />
         <result column="birthday" property="birthday" jdbcType="DATE" />
         <result column="sex" property="sex" jdbcType="CHAR" />
         <result column="address" property="address" jdbcType="VARCHAR" />
     </resultMap>

     <sql id="Base_Column_List" >
         id, username, birthday, sex, address
     </sql>

     <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer" >
         select
         <include refid="Base_Column_List" />
         from t_user
         where id = #{id,jdbcType=INTEGER}
     </select>

     <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" >
         delete from t_user
         where id = #{id,jdbcType=INTEGER}
     </delete>

     <insert id="insert" parameterType="com.study.springmybatis.model.UserModel" >
         insert into t_user (id, username, birthday,
             sex, address)
         values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{birthday,jdbcType=DATE},
             #{sex,jdbcType=CHAR}, #{address,jdbcType=VARCHAR})
     </insert>

     <insert id="insertSelective" parameterType="com.study.springmybatis.model.UserModel" >
         insert into t_user
         <trim prefix="(" suffix=")" suffixOverrides="," >
             <if test="id != null" >
                 id,
             </if>
             <if test="username != null" >
                 username,
             </if>
             <if test="birthday != null" >
                 birthday,
             </if>
             <if test="sex != null" >
                 sex,
             </if>
             <if test="address != null" >
                 address,
             </if>
         </trim>
         <trim prefix="values (" suffix=")" suffixOverrides="," >
             <if test="id != null" >
                 #{id,jdbcType=INTEGER},
             </if>
             <if test="username != null" >
                 #{username,jdbcType=VARCHAR},
             </if>
             <if test="birthday != null" >
                 #{birthday,jdbcType=DATE},
             </if>
             <if test="sex != null" >
                 #{sex,jdbcType=CHAR},
             </if>
             <if test="address != null" >
                 #{address,jdbcType=VARCHAR},
             </if>
         </trim>
     </insert>

     <update id="updateByPrimaryKeySelective" parameterType="com.study.springmybatis.model.UserModel" >
         update t_user
         <set >
             <if test="username != null" >
                 username = #{username,jdbcType=VARCHAR},
             </if>
             <if test="birthday != null" >
                 birthday = #{birthday,jdbcType=DATE},
             </if>
             <if test="sex != null" >
                 sex = #{sex,jdbcType=CHAR},
             </if>
             <if test="address != null" >
                 address = #{address,jdbcType=VARCHAR},
             </if>
         </set>
         where id = #{id,jdbcType=INTEGER}
     </update>

     <update id="updateByPrimaryKey" parameterType="com.study.springmybatis.model.UserModel" >
         update t_user
         set username = #{username,jdbcType=VARCHAR},
             birthday = #{birthday,jdbcType=DATE},
             sex = #{sex,jdbcType=CHAR},
             address = #{address,jdbcType=VARCHAR}
         where id = #{id,jdbcType=INTEGER}
     </update>
 </mapper>

生成的pojo即实体类UserModel.java

 package com.study.springmybatis.model;

 import java.util.Date;

 /**
  * 用户信息表
  *
  * @author lgs
  *
  * @date 2017-10-21
  */
 public class UserModel {
     private Integer id;

     /**
      * 用户名称
      */
     private String username;

     /**
      * 生日
      */
     private Date birthday;

     /**
      * 性别
      */
     private String sex;

     /**
      * 地址
      */
     private String address;

     public Integer getId() {
         return id;
     }

     public void setId(Integer id) {
         this.id = id;
     }

     public String getUsername() {
         return username;
     }

     public void setUsername(String username) {
         this.username = username == null ? null : username.trim();
     }

     public Date getBirthday() {
         return birthday;
     }

     public void setBirthday(Date birthday) {
         this.birthday = birthday;
     }

     public String getSex() {
         return sex;
     }

     public void setSex(String sex) {
         this.sex = sex == null ? null : sex.trim();
     }

     public String getAddress() {
         return address;
     }

     public void setAddress(String address) {
         this.address = address == null ? null : address.trim();
     }
 }

业务的接口UserServiceI.java和实现类UserService.java

 package com.study.springmybatis.service;

 import com.study.springmybatis.model.UserModel;

 /**
  * 业务接口
  * @author lgs
  *
  */
 public interface UserServiceI {

     /**
      * 根据用户id获取用户
      * @param userId
      * @return
      */
     UserModel getUserById(Integer userId);
 }

 package com.study.springmybatis.service;

 import javax.annotation.Resource;

 import org.springframework.stereotype.Service;

 import com.study.springmybatis.dao.UserDao;
 import com.study.springmybatis.model.UserModel;

 /**
  * 业务实现类
  * @author lgs
  *
  */
 @Service("userService")
 public class UserService implements UserServiceI {

     /**
      * 使用Resource注解注入userDao实例，
      * 当需要使用userDao时，Spring就会自动注入UserDao
      */
     @Resource
     private UserDao userDao;

     public UserModel getUserById(Integer userId) {
         return userDao.selectByPrimaryKey(userId);
     }
 }

三、在src/main/resources目录下编写配置文件

1. 数据库配置dbconfig.properties

 driver=com.mysql.jdbc.Driver
 jdbc_url=jdbc:mysql://192.168.152.1:3306/study?characterEncoding=utf-8
 jdbc_username=root
 jdbc_password=123456
 validationQuery=SELECT 1

2. Spring框架的核心配置文件spring.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:p="http://www.springframework.org/schema/p"
      xmlns:context="http://www.springframework.org/schema/context"
      xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
      http://www.springframework.org/schema/context
      http://www.springframework.org/schema/context/spring-context-3.0.xsd
      ">
     <!--spring框架的配置文件  -->

     <!-- 引入dbconfig.properties属性文件 -->
     <context:property-placeholder location="classpath:dbconfig.properties" />
     <!-- 自动扫描(自动注入)，扫描com.study.springmybatis这个包以及它的子包的所有使用spring注解标注的类 -->
     <context:component-scan base-package="com.study" />
 </beans>

3. Spring框架与Mybatis框架整合的配置文件

 <?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:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="
 http://www.springframework.org/schema/beans
 http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
 http://www.springframework.org/schema/tx
 http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
 http://www.springframework.org/schema/aop
 http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
 ">
    <!--spring与mybatis整合的配置文件  -->

      <!--配置数据源 -->
     <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
         destroy-method="close">
         <property name="driverClassName">
            <value>${driver}</value>
         </property>
         <property name="url">
             <value>${jdbc_url}</value>
         </property>
         <property name="username">
             <value>${jdbc_username}</value>
         </property>
         <property name="password">
             <value>${jdbc_password}</value>
         </property>
         <property name="maxActive" value="100"></property>
         <property name="maxIdle" value="30"></property>
         <property name="maxWait" value="500"></property>
         <property name="defaultAutoCommit" value="true"></property>
     </bean>

     <!-- ========================================分隔线========================================= -->

     <!-- ========================================针对myBatis的配置项============================== -->
     <!-- 配置sqlSessionFactory -->
     <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
         <!-- 实例化sqlSessionFactory时需要使用上述配置好的数据源以及SQL映射文件 -->
         <property name="dataSource" ref="dataSource" />
         <!-- 自动扫描com/study/springmybatis/mapper/目录下的所有SQL映射的xml文件, 省掉SqlMapConfig.xml里的手工配置
         value="com/study/springmybatis/mapper/*.xml"指的是classpath(类路径)下com.study.springmybatis.mapper包中的所有xml文件
         SQL映射的xml文件位于com.study.springmybatis.mapper包下，这样就可以被自动扫描
          -->
         <property name="mapperLocations" value="classpath:com/study/springmybatis/mapper/*.xml" />
     </bean>
     <!-- 配置扫描器 -->
     <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
         <!-- 扫描com.study.springmybatis.dao这个包以及它的子包下的所有映射接口类 -->
         <property name="basePackage" value="com.study.springmybatis.dao" />
         <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
     </bean>

     <!-- ========================================分隔线========================================= -->
     <!-- 配置Spring的事务管理器 -->
     <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
         <property name="dataSource" ref="dataSource" />
     </bean>

     <!-- 注解方式配置事物 -->
     <!-- <tx:annotation-driven transaction-manager="transactionManager" /> -->

     <!-- 拦截器方式配置事物 -->
     <tx:advice id="transactionAdvice" transaction-manager="transactionManager">
         <tx:attributes>
             <tx:method name="add*" propagation="REQUIRED" />
             <tx:method name="append*" propagation="REQUIRED" />
             <tx:method name="insert*" propagation="REQUIRED" />
             <tx:method name="save*" propagation="REQUIRED" />
             <tx:method name="update*" propagation="REQUIRED" />
             <tx:method name="modify*" propagation="REQUIRED" />
             <tx:method name="edit*" propagation="REQUIRED" />
             <tx:method name="delete*" propagation="REQUIRED" />
             <tx:method name="remove*" propagation="REQUIRED" />
             <tx:method name="repair" propagation="REQUIRED" />
             <tx:method name="delAndRepair" propagation="REQUIRED" />

             <tx:method name="get*" propagation="SUPPORTS" />
             <tx:method name="find*" propagation="SUPPORTS" />
             <tx:method name="load*" propagation="SUPPORTS" />
             <tx:method name="search*" propagation="SUPPORTS" />
             <tx:method name="datagrid*" propagation="SUPPORTS" />

             <tx:method name="*" propagation="SUPPORTS" />
         </tx:attributes>
     </tx:advice>
     <!--Spring事物切面配置  -->
     <aop:config>
         <aop:pointcut id="transactionPointcut" expression="execution(* com.study.springmybatis.service.*.*(..))" />
         <aop:advisor pointcut-ref="transactionPointcut" advice-ref="transactionAdvice" />
     </aop:config>

 </beans>

四、在src/test/java编写测试类SpringMyBatisTest，本来测试类是放在src/test/java目录下面的。但是不知道为啥找不到junit的注解@Test，这里就偷了一下懒移到src/main/java目录的com.study.springmybatis.test包下面了

 package com.study.springmybatis.test;

 import javax.annotation.Resource;

 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

 import com.study.springmybatis.model.UserModel;
 import com.study.springmybatis.service.UserServiceI;

 @RunWith(SpringJUnit4ClassRunner.class)
 //配置了@ContextConfiguration注解并使用该注解的locations属性指明spring和配置文件之后，
 @ContextConfiguration(locations = {"classpath:spring.xml", "classpath:spring-mybatis.xml" })
 public class SpringMyBatisTest {

     //注入userService
     @Resource
     private UserServiceI userService;

     @Test
     public void testGetUserById(){
         int userId = 1;
         UserModel user = userService.getUserById(userId);
         System.out.println("查询到的用户名为："+user.getUsername());
     }
 }

运行测试类的结果为：

 十月 22, 2017 3:08:00 下午 org.springframework.test.context.support.DefaultTestContextBootstrapper getDefaultTestExecutionListenerClassNames
 信息: Loaded default TestExecutionListener class names from location [META-INF/spring.factories]: [org.springframework.test.context.web.ServletTestExecutionListener, org.springframework.test.context.support.DirtiesContextBeforeModesTestExecutionListener, org.springframework.test.context.support.DependencyInjectionTestExecutionListener, org.springframework.test.context.support.DirtiesContextTestExecutionListener, org.springframework.test.context.transaction.TransactionalTestExecutionListener, org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener]
 十月 22, 2017 3:08:00 下午 org.springframework.test.context.support.DefaultTestContextBootstrapper instantiateListeners
 信息: Could not instantiate TestExecutionListener [org.springframework.test.context.web.ServletTestExecutionListener]. Specify custom listener classes or make the default listener classes (and their required dependencies) available. Offending class: [javax/servlet/ServletContext]
 十月 22, 2017 3:08:00 下午 org.springframework.test.context.support.DefaultTestContextBootstrapper getTestExecutionListeners
 信息: Using TestExecutionListeners: [org.springframework.test.context.support.DirtiesContextBeforeModesTestExecutionListener@3b6eb2ec, org.springframework.test.context.support.DependencyInjectionTestExecutionListener@1e643faf, org.springframework.test.context.support.DirtiesContextTestExecutionListener@6e8dacdf, org.springframework.test.context.transaction.TransactionalTestExecutionListener@7a79be86, org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener@34ce8af7]
 十月 22, 2017 3:08:00 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
 信息: Loading XML bean definitions from class path resource [spring.xml]
 十月 22, 2017 3:08:00 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
 信息: Loading XML bean definitions from class path resource [spring-mybatis.xml]
 十月 22, 2017 3:08:00 下午 org.springframework.context.support.GenericApplicationContext prepareRefresh
 信息: Refreshing org.springframework.context.support.GenericApplicationContext@5a61f5df: startup date [Sun Oct 22 15:08:00 CST 2017]; root of context hierarchy
 查询到的用户名为：lgs

五、需要完整工程代码的同学去我的githup上下载https://github.com/leeSmall/SpringMybatis