MyBatis-Spring(五)--MapperScannerConfigurer实现增删改查

上一篇文章中已经介绍，MapperScannerConfigurer可以通过扫描的方式获取我们需要的mapper，而不需要我们自己去配置，它的基本配置如下：

 <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
         <!-- 配置要扫描的包路径，这样就会扫描该包及其子包 -->
         <property name="basePackage" value="com.hyc.dao" />
         <!-- 指定SqlSessionFactory的bean名称 -->
         <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
         <!-- 指定SqlSessionTemplate的bean名称，优先级高于SqlSessionFactory -->
         <property name="sqlSessionTemplateBeanName" value="com.hyc.mapper" />
         <!-- 当包下的类被这个注解@Repository标示的时候才会被扫描 -->
         <property name="annotationClass" value="org.springframework.stereotype.Repository" />
 </bean>

配置属性的意义已在注释中说明，需要注意的是如果要使用SqlSessionFactory，就要注释掉属性sqlSessionTemplateBean，否则sqlSessionFactory的配置将不会生效。注意⚠️：上面的配置中，basePackage的值必须是接口所在的包，而不是mapper文件所在的包

下面将测试这种配置的实现方式，我将不再一步一步进行配置，而是直接贴出最终的配置文件。

一、Spring-mybatis配置文件spring-mybatis.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:context="http://www.springframework.org/schema/context"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     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.0.xsd">

     <!-- 第一种：简单数据库－－使用数据库连接池 -->
     <!-- <bean id="dataSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSource">
         <property name="driverClassName" value="org.postgresql.Driver" /> <property
         name="url" value="jdbc:postgresql://localhost:5433/postgres" /> <property
         name="username" value="postgres" /> <property name="password" value="hyc123"
         /> </bean> -->
     <!--第二种：通过jndi方式配置 -->
     <!-- <bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
         <property name="jndiName" value="jdbc/pg"></property> </bean> -->

     <!-- 第一步：配置数据源－－使用数据库连接池 -->
     <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
         <property name="driverClassName" value="org.postgresql.Driver" />
         <property name="url" value="jdbc:postgresql://localhost:5433/postgres" />
         <property name="username" value="postgres" />
         <property name="password" value="hyc123" />
         <!-- 最大数据库连接数 -->
         <property name="maxActive" value="100" />
         <!-- 最大空闲数，即等待连接数 -->
         <property name="maxIdle" value="5" />
         <!-- 最大等待连接时间 -->
         <property name="maxWait" value="10000" />
     </bean>

     <!--第二步：配置SqlSessionFactory -->
     <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
         <!-- 配置数据源 -->
         <property name="dataSource" ref="dataSource" />
         <!-- 配置mybatis -->
         <property name="configLocation" value="classpath:mybatis-config2.xml" />
     </bean>

     <!--第三步：配置sqlSessionTemplate：通过带参数的构造方法创建对象 -->
     <!-- <bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
         以sqlSessionFactory为参数传入构造函数中
         <constructor-arg ref="sqlSessionFactory" />
         mybatis执行器，取值范围是SIMPLE/REUSE/BATCH三种类型
         <constructor-arg value="SIMPLE" />
     </bean> -->

     <!--第三步：通过MapperFactoryBean配置SqlSessionFactory -->
     <!-- <bean id="productMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
         配置mapper接口
         <property name="mapperInterface" value="com.hyc.dao.ProductMapper" />
         配置SqlSessionFactory
         <property name="sqlSessionFactory" ref="sqlSessionFactory" />
         如果同时配置sqlSessionTemplate和SqlSessionFactory，将优先使用sqlSessionTemplate
         <property name="sqlSessionTemplate" ref="sqlSessionTemplate" />
     </bean> -->

     <!--第三步：通过MapperScannerConfigurer的配置方式 -->
     <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
         <!-- 配置要扫描的包路径，这样就会扫描该包及其子包 -->
         <property name="basePackage" value="com.hyc.dao" />
         <!-- 指定SqlSessionFactory的bean名称 -->
         <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
         <!-- 指定SqlSessionTemplate的bean名称，优先级高于SqlSessionFactory -->
         <!-- <property name="sqlSessionTemplateBeanName" value="com.hyc.mapper"
             /> -->
         <!-- 当包下的类被这个注解@Repository标示的时候才会被扫描 -->
         <property name="annotationClass" value="org.springframework.stereotype.Repository" />
     </bean>

     <bean id="product" class="com.hyc.pojo.Product">
         <property name="id" value="28"></property>
         <property name="productName" value="皮鞋1"></property>
         <property name="productPrice" value="208"></property>
         <property name="productType" value="男鞋"></property>
     </bean>

 </beans>

上述配置种包括数据源、sqlSessionFactory、MapperScannerConfigurer的配置，还有注释部分的另外两种数据源配置方式和另外两种MyBatis-Spring的配置方式。

二、mybatis配置文件

数据源配置种的mybatis-config2.xml文件配置如下：

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE configuration
   PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
   "http://mybatis.org/dtd/mybatis-3-config.dtd">
 <!-- mybatis的基本配置文件：主要配置基本的上下文参数和运行环境 -->
 <configuration>
     <!--设置 -->
     <settings>
         <!--缓存配置的全局开关：如果这里设置成false，那么即便在映射器中配置开启也无济于事 -->
         <setting name="cacheEnabled" value="true" />
         <!--延时加载的全局开关 -->
         <setting name="lazyLoadingEnabled" value="false" />
         <!-- 是否允许单一语句返回多结果集 -->
         <setting name="multipleResultSetsEnabled" value="false" />
         <!-- 使用列标签代替列名，需要兼容驱动 -->
         <setting name="useColumnLabel" value="true" />
         <!-- 允许JDBC自动生成主键，需要驱动兼容。如果设置为true，则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍能正常工作 -->
         <setting name="useGeneratedKeys" value="false" />
         <!-- 指定MyBatis该如何自动映射列到字段或属性：NONE表示取消自动映射；PARTIAL表示只会自动映射，没有定义嵌套结果集和映射结果集；FULL会自动映射任意复杂的结果集，无论是否嵌套 -->
         <setting name="autoMappingBehavior" value="PARTIAL" />
         <!-- 配置默认的执行器：SIMPLE是普通的执行器；REUSE会重用预处理语句；BATCH会重用语句并执行批量更新 -->
         <setting name="defaultExecutorType" value="SIMPLE" />
         <!--设置超时时间：它决定驱动等待数据库响应的秒数,任何正整数 -->
         <!-- <setting name="defaultStatementTimeout" value="25"/> -->
         <!--设置数据库驱动程序默认返回的条数限制，此参数可以重新设置,任何正整数 -->
         <!-- <setting name="defaultFetchSize" value="100" /> -->
         <!-- 允许在嵌套语句中使用分页（RowBounds） -->
         <setting name="safeRowBoundsEnabled" value="false" />
         <!-- 是否开启自动驼峰命名规则，即从a_example到aExample的映射 -->
         <setting name="mapUnderscoreToCamelCase" value="true" />
         <!-- 本地缓存机制，防止循环引用和加速重复嵌套循环 -->
         <setting name="localCacheScope" value="SESSION" />
         <!-- 当没有为参数提供特定JDBC类型时，为空值指定JDBC类型。某些驱动需要指定列的JDBC类型，多数情况直接用一般类型即可，如NULL/VARCHAR/OTHER -->
         <setting name="jdbcTypeForNull" value="OTHER" />
         <!-- 指定触发延迟加载的方法，如equals/clone/hashCode/toString -->
         <setting name="lazyLoadTriggerMethods" value="equals" />
     </settings>
     <!--类型命名 -->
     <!--别名：pojo对象的别名 -->
     <typeAliases>
         <!-- 对包进行扫描，可以批量进行别名设置，设置规则是：获取类名称，将其第一个字母变为小写 -->
         <package name="com.hyc.pojo" />
         <package name="com.hyc.objectfactory" />
         <package name="com.hyc.bean" />
         <package name="com.hyc.dao" />
     </typeAliases>
     <!--插件 -->
     <!-- <plugins /> -->
     <!-- 映射器 -->
     <mappers>
         <mapper resource="com/hyc/mapper/ProductMapper.xml" />
     </mappers>

 </configuration>

三、创建映射器

1⃣️创建接口，增加@Repository注解标示

 @Repository
 public interface ProductMapper {

     int insertProduct(Product product);

     int deleteByPrimaryKey(String id);

     int updateByPrimaryKey(Product product);

     List<Product> selectProducts(String name);

 }

注意使用注解，否则将不会被扫描到，在spring种往往使用注解@Repository表示数据访问层（DAO）

2⃣️创建对应的mapper文件

 <?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.hyc.dao.ProductMapper">
     <resultMap id="BaseResultMap" type="com.hyc.pojo.Product">
         <id column="id" jdbcType="VARCHAR" property="id" />
         <result column="product_name" jdbcType="VARCHAR" property="productName" />
         <result column="product_price" jdbcType="VARCHAR" property="productPrice" />
         <result column="product_type" jdbcType="VARCHAR" property="productType" />
     </resultMap>
     <sql id="Base_Column_List">
         id, product_name, product_price, product_type
     </sql>

     <!-- 查询所有产品 -->
     <select id="selectProducts" resultMap="BaseResultMap" parameterType="String">
         select * from product where product_name like concat('%',#{name},'%')
     </select>

     <!-- 插入产品 -->
     <insert id="insertProduct" parameterType="com.hyc.pojo.Product">
         insert into product
         (id,
         product_name, product_price,
         product_type)
         values
         (#{id,jdbcType=VARCHAR}, #{productName,jdbcType=VARCHAR},
         #{productPrice,jdbcType=VARCHAR},
         #{productType,jdbcType=VARCHAR})
     </insert>

     <!-- 根据ID删除产品 -->
     <delete id="deleteByPrimaryKey" parameterType="java.lang.String">
         delete from
         product
         where id = #{id,jdbcType=VARCHAR}
     </delete>

     <!--修改产品 -->
     <update id="updateByPrimaryKey" parameterType="com.hyc.pojo.Product">
         update product
         set
         product_name = #{productName,jdbcType=VARCHAR},
         product_price =
         #{productPrice,jdbcType=VARCHAR},
         product_type =
         #{productType,jdbcType=VARCHAR}
         where id = #{id,jdbcType=VARCHAR}
     </update>
 </mapper>

四、单元测试

1⃣️基本类

用来初始化ClassPathXmlAppicationContext，从而获取bean、mapper等

 public class BaseTest {

     public SqlSessionTemplate template = null;
     ClassPathXmlApplicationContext context = null;

     @Before
     public void before() {
         context = new ClassPathXmlApplicationContext("classpath:spring-mybatis.xml");
         template = context.getBean(SqlSessionTemplate.class);
     }
 }

通过传入spring-mybatis的配置文件初始化ClassPathXmlApplicationContext

2⃣️测试类

 public class TestMapperFactoryBean extends BaseTest {

     @Test
     public void testInsert() {
         ProductMapper pm = super.context.getBean(ProductMapper.class);
         Product product = super.context.getBean(Product.class);
         int add = pm.insertProduct(product);
         System.out.println(add > 0 ? "插入成功" : "插入失败");
     }

     @Test
     public void testDelete() {
         ProductMapper pm = super.context.getBean(ProductMapper.class);
         int del = pm.deleteByPrimaryKey("8cb4fc3a-dd71-46e9-a0de-0e8b967a127c");
         System.out.println(del > 0 ? "删除成功" : "删除失败");
     }

     @Test
     public void testUpdate() {
         ProductMapper pm = super.context.getBean(ProductMapper.class);
         Product product = super.context.getBean(Product.class);
         product.setProductName("测试修改");
         product.setProductPrice("修改后价格");
         product.setProductType("修改后分类");
         int update = pm.updateByPrimaryKey(product);
         System.out.println(update > 0 ? "修改成功" : "修改失败");
     }

     @Test
     public void testSelect() {
         ProductMapper pm = super.context.getBean(ProductMapper.class);
         List<Product> pl = pm.selectProducts("T");
         System.out.println(pl.size());
     }
 }

测试结果都是成功，将不再贴出。

至此，MyBatis-Spring项目的搭建过程总结完毕。