Ibatis使用

部分参考：https://blog.csdn.net/shixiaoguo90/article/details/49949445

Apache iBatis是当前IT项目中使用很广泛的一个半自动ORM框架，区别于Hibernate之类的全自动框架，iBatis对数据库的操作拥有更加灵活的控制，对于那些经常需要调用本地数据库函数自定义SQL语句，或是喜欢自己优化SQL执行效率的开发者来说，iBatis是一个非常不错的选择。而得到广泛应用的开源企业架构SpringFramework，也很好的将其进行了集成，使得iBatis在 SpringFramework中的使用更加便利、快捷。

 

使用Ibatis的步骤：

1、Dao层（实现层）继承SqlMapClientDaoSupport

Dao层（实现层）继承SpringFramework中提供的 SqlMapClientDaoSupport类

// 其中TestDAO是自己业务中定义的接口
public class IbatisTestDAO extends SqlMapClientDaoSupport implements TestDAO 
    @Override
    public List<TestDO> getList(TestDO testDO) {
        return getSqlMapClientTemplate().queryForList("testsss.select",testDO);
    }
    .....
}

 

2、Dao层定义成bean

将上​面的Dao层方法定义成bean

 <bean id="xxxxxDAO"
          class="com.alipay.xxxxx.common.dal.xxxx.order.ibatis.IbatisScenicTicketDAO"
          parent="orderBaseDao"/>

其中parent是数据库连接的通用配置，从代码复用性的角度考虑，将通用的部分写成独立的一块。下面是和parent先关：

3、数据库连接配置(SqlMapClientFactoryBean 的装配)

SqlMapClientFactoryBean是SqlMapClientTemplate使用的基础，如果在SpringFramework应用中没有装配SqlMapClientFactoryBean，那么SqlMapClientTemplate将不可用，报空指针错误。

  <!-- 订单datasource -->
    <bean id="orderDataSource" class="com.alipay.zdal.client.jdbc.ZdalDataSource"
          init-method="init" destroy-method="close">
        <property name="appName" value="bstsoldb"/>
        <property name="appDataSourceName" value="bstsoldb_order"/>
        <property name="version" value="${config_version}"/>
    </bean>

    <!--指定xml文件的位置-->
    <bean id="orderSqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean">
        <property name="dataSource" ref="orderDataSource"/>
        <property name="configLocations">
            <list>
                <value>classpath:sqlmap/xxxxx/order/*.xml</value>
            </list>
        </property>
    </bean>

    <bean id="orderBaseDao" abstract="true">
        <property name="dataSource" ref="orderDataSource"/>
        <property name="sqlMapClient" ref="orderSqlMapClient"/>
    </bean>

如何没有提炼出parent， 书写风格如下：

 <bean id="xxxxxDAO"
          class="com.alipay.xxxxx.common.dal.xxxxx.order.ibatis.IbatisScenicTicketDAO">
   <!-- iBatis sqlmap config 文件位置 -->
   <property name="configLocation" value="classpath:sqlmap/xxxxx/order/*.xml"/>
   <!-- 在SpringFramework配置文件中使用的数据源 -->
   <property name="dataSource" ref="orderDataSource"/>
</bean>

 

4、SqlMapClientTemplate API

getSqlMapClientTemplate()的主要API:

 

4.1 使用SqlMapClientTemplate查询

重要：如果查询的结果是List, 不能使用queryForObject在把结果转回List

 

当执行没有参数的查询时：

List result = getSqlMapClientTemplate().queryForList("TestSpace.qryTest");

"TestSpace"为iBatis SqlMap文件的命名空间；"qryTest"为iBatis SqlMap的查询方法id

​

当按照主键获取某条记录信息时：

Long id = new Long("2");

Object resultObj = getSqlMapClientTemplate().queryForObject("TestSpace.getTest", id);

 

当按照某些条件查询时：

ObjectA objA = new ObjectA();

objA.setParam1("test1");

objA.setParam2("test2");

......

List result = getSqlMapClientTemplate().queryForList("TestSpace.qryTestByParam", objA);

如果需要取4~40条数据：

List result = getSqlMapClientTemplate().queryForList("TestSpace.qryTestByParam", objA, 4, 40);

也可以返回Map

Map result = getSqlMapClientTemplate().queryForMap("TestSpace.qryTestByParam", objA, "MapKey");

 

4.2 使用SqlMapClientTemplate添加数据

Java代码：

ObjectA objA = new ObjectA();

objA.setParam1("test1");

objA.setParam2("test2");

......

getSqlMapClientTemplate().insert("TestSpace.insertTest", objA);

 

4.3 使用SqlMapClientTemplate更新数据

Java代码：

ObjectA objA = new ObjectA();

objA.setParam1("test1");

objA.setParam2("test2");

......

getSqlMapClientTemplate().update("TestSpace.updateTest", objA);

更新前20条记录：

getSqlMapClientTemplate().update("TestSpace.updateTest", objA, 20);

 

4.4 使用SqlMapClientTemplate删除数据

Java代码：

Long id = new Long("2");

getSqlMapClientTemplate().delete("TestSpace.deleteTest", id);

 

5、数据库事务实现

事务模板需要配置到某个具体的数据库上，如果一个系统中涉及多个数据库，要特别注意事务模板是否和需要的数据库是对应的。

  <!--事务模板 -->
    <bean id="bsTransactionTemplate" class="com.alipay.xxxx.common.dal.common.transaction.BsTransactionTemplateImpl">
        <property name="innerTransactionTemplate">
            <bean class="org.springframework.transaction.support.TransactionTemplate">
                <property name="transactionManager">
                    <bean class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
                       <!--对应配置的dataSource-->
                        <property name="dataSource" ref="orderDataSource"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>

   <!--将自己配置的bean发布为服务-->
    <sofa:service ref="bsTransactionTemplate" interface="com.alipay.xxxx.common.dal.common.transaction.BsTransactionTemplate" />

public class BsTransactionTemplateImpl implements BsTransactionTemplate {
    // 内部使用的事务模板
    private TransactionOperations innerTransactionTemplate;

    @Override
    public <T> T execute(TransactionCallback<T> action) throws TransactionException {
        return innerTransactionTemplate.execute(action);
    }

    /**
     * Setter method for property <tt>innerTransactionTemplate</tt>.
     *
     * @param innerTransactionTemplate value to be assigned to property innerTransactionTemplate
     */
    public void setInnerTransactionTemplate(TransactionOperations innerTransactionTemplate) {
        this.innerTransactionTemplate = innerTransactionTemplate;
    }
}

------------------
import org.springframework.transaction.support.TransactionOperations;    
public interface BsTransactionTemplate extends TransactionOperations {
    
}

 

在需要使用事务的类中，引入发布的服务 bsTransactionTemplate 就可以了。