求知 文章 文库 Lib 视频 iPerson 课程 认证 咨询 工具 讲座 Modeler   Code  
会员   
 
  
 
 
     
   
分享到
Spring数据库访问之iBatis
 

作者:sarin,发布于2012-2-2

 

为了丰富博客专栏【Spring数据库访问系列】的内容,完善Spring数据库访问的体系,现在我们介绍Spring对iBatis的支持。

相对于Hibernate等ORM框架的全自动SQL,那么iBatis则属于半自动化的ORM框架,我们需要编写SQL语句,由iBatis进行数据库访问,返回结果。而iBatis可以为我们做的更多,比如对查询结果的封装等等。虽然不如全自动SQL方便,但是SQL的主动权却在我们开发人员的手中,对SQL优化的掌控则是很直接的。对于Hibernate和iBatis的其它讨论,不是我们探究的范围。

当前iBatis的版本为3,其名称也已经更改为MyBatis。而Spring更新到3.1都没有对MyBatis进行支持,但是MyBatis团队已经自行开发了Spring的支持。我们以Spring为主,仍然使用对iBatis2的支持来进行说明。

首先是构建开发环境,我们仍然使用Maven作为构建环境,创建项目,本文的示例基于“联系人管理”功能来展示:

package org.ourpioneer.contact.bean;

public class Contact {

    private Long id;

    private String name;

    private String gender;

    private String mobile;

    private String address;

    //省略getter和setter方法

    @Override

    public String toString() {

        return "Contact [id=" + id + ", name=" + name + ", gender=" + gender

        + ", mobile=" + mobile + ", address=" + address + "]";

    }

}

编写一个Contact类来描述联系人的一些特征,为了简便,我们使用5个字段就够了,实体类是很简单的。下面是添加类库了,要访问数据库,不能少了数据库驱动,我们使用MySQL数据库,在pom.xml中添加依赖:

<dependency>

    <groupId>mysql</groupId>

    <artifactId>mysql-connector-java</artifactId>

    <version>5.1.14</version>

    <type>jar</type>

    <scope>compile</scope>

</dependency>

同时在数据库中建表,因为iBatis还没有自动建表的功能:

CREATE TABLE `contact` (

`ID` int(11) NOT NULL AUTO_INCREMENT ,

`NAME` varchar(20) CHARACTER SET latin1 COLLATE latin1_swedish_ci NOT NULL ,

`GENDER` varchar(10) CHARACTER SET latin1 COLLATE latin1_swedish_ci NOT NULL ,

`MOBILE` varchar(11) CHARACTER SET latin1 COLLATE latin1_swedish_ci NOT NULL ,

`ADDRESS` varchar(100) CHARACTER SET latin1 COLLATE latin1_swedish_ci NOT NULL ,

PRIMARY KEY (`ID`)

)

ENGINE=InnoDB

DEFAULT CHARACTER SET=latin1 COLLATE=latin1_swedish_ci

AUTO_INCREMENT=1

ROW_FORMAT=COMPACT

;

加好驱动,创建好数据库表,那么程序访问需要配置连接池,这里我们使用BoneCP连接池,在pom.xml中加入相关依赖:

<repositories>

    <repository>

        <releases>

            <updatePolicy>always</updatePolicy>

        </releases>

        <snapshots>

            <updatePolicy>always</updatePolicy>

        </snapshots>

        <id>Jolbox</id>

        <name>Jolbox Repositories</name>

        <url>http://jolbox.com/bonecp/downloads/maven</url>

    </repository>

</repositories>

因为BoneCP的Maven仓库不在Maven的中央仓库中,所以必须加入以上代码到pom.xml中,这点可以在BoneCP的官方网站(http://jolbox.com/)中获得,下面就是加入依赖了,就没有什么多说的了:

<dependency>

    <groupId>com.jolbox</groupId>

    <artifactId>bonecp</artifactId>

    <version>0.7.1.RELEASE</version>

</dependency>

下面配置系统日志,因为引入BoneCP而引入了slf4j,如果自动添加的版本过低,这里我们要重新设置slf4j的版本为1.6.4。那么我们添加logback来设置日志系统:

<dependency>

    <groupId>ch.qos.logback</groupId>

    <artifactId>logback-core</artifactId>

    <version>1.0.0</version>

    <type>jar</type>

    <scope>compile</scope>

</dependency>

<dependency>

    <groupId>ch.qos.logback</groupId>

    <artifactId>logback-classic</artifactId>

    <version>1.0.0</version>

    <type>jar</type>

    <scope>compile</scope>

</dependency>

下面配置logback.xml来配置日志具体项,logback.xml文件需要放置到类路径的根路径下:

<?xml version="1.0" encoding="UTF-8"?>

<configuration>

    <jmxConfigurator />

    <!--输出到控制台,方便调试,应用时切换到文件Log -->

    <appender name="ConsoleAppender" class="ch.qos.logback.core.ConsoleAppender">

        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

            <pattern>%date %-5level [%logger{80}:%L] - %msg%n

            </pattern>

            <charset>UTF-8</charset>

        </encoder>

    </appender>

    <!-- 需要记录日志的包 -->

    <logger name="org.ourpioneer">

        <level value="debug" />

    </logger>

    <logger name="org.springframework">

        <level value="warn" />

    </logger>

    <root>

        <level value="warn" />

        <appender-ref ref="ConsoleAppender" />

    </root>

</configuration>

这里我们只创建了控制台的Appender,其中设置了日志的格式,编码和需要记录日志的包,并配置响应日志的级别,这都很好理解。下面是添加Spring和iBatis的类库:

<dependency>

    <groupId>org.apache.ibatis</groupId>

    <artifactId>ibatis-sqlmap</artifactId>

    <version>2.3.4.726</version>

    <scope>compile</scope>

</dependency>

Spring的类库添加core,beans,context,jdbc和orm模块即可,其它依赖则会自动添加过来,最终的类库如下图所示:

下面就是构建项目的目录结构:

我们采用分层开发的思想,DAO控制访问数据,Service调用DAO方法,同时在Service层做事务,因为我们不是Web项目,这里没有Web层的框架和Action。Bean包下的实体类Contact前面解释过了,common包下的BaseDAO提供操作iBatis的方法,ParameterMap是我们为iBatis提供参数的对象,dao包下就是DAO对象,service包下放置Service类,sqlMaps包下放置iBatis用到的SQL映射文件。App类是我们的测试类。类路径的根目录下的beans.xml是Spring的配置文件,logback.xml是日志配置文件,sqlMapConfig.xml是iBatis的总配置文件,首先来看sqlMapConfig.xml:

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE sqlMapConfig

    PUBLIC "-//iBATIS.com//DTD SQL Map Config 2.0//EN"

    "http://www.ibatis.com/dtd/sql-map-config-2.dtd">

<sqlMapConfig>

    <settings cacheModelsEnabled="true" enhancementEnabled="true"

        lazyLoadingEnabled="true" errorTracingEnabled="true" maxRequests="32"

        maxSessions="10" maxTransactions="5" />

        <sqlMap resource="org/ourpioneer/contact/sqlMaps/contact.xml" />

</sqlMapConfig>

其中就是对iBatis的一些设置,并包含sqlMap文件,很简单,这没有什么可多说的,logback文件前面给出了,下面是Spring的配置文件,首先配置数据源dataSource:

<bean id="dataSource" class="com.jolbox.bonecp.BoneCPDataSource"

    destroy-method="close">

    <property name="driverClass" value="com.mysql.jdbc.Driver" />

    <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/test" />

    <property name="username" value="root" />

    <property name="password" value="123" />

    <property name="maxConnectionsPerPartition" value="30" />

    <property name="minConnectionsPerPartition" value="10" />

    <property name="partitionCount" value="3" />

    <property name="acquireIncrement" value="5" />

    <property name="statementsCacheSize" value="100" />

    <property name="releaseHelperThreads" value="3" />

</bean>

关于BoneCP的介绍网上也有很多,这里不再详细解释各个配置项的含义了,配置好数据源,下面是SqlMapClient,使用Spring的bean工厂来创建,参数是iBatis的总配置文件和数据源,这里我们需要注入配置好的数据源dataSource:

<bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean">

    <property name="configLocation" value="classpath:sqlMapConfig.xml" />

    <property name="dataSource" ref="dataSource" />

</bean>

Spring在对iBatis的支持上提供了SqlMapClientTemplate,也就是操作SqlMapClient的模板,这个jdbcTemplate类似,其中的方法使用方式也是类似的,为我们操作iBatis提供了便捷的接口:

<bean id="sqlMapClientTemplate" class="org.springframework.orm.ibatis.SqlMapClientTemplate">

    <constructor-arg>

        <ref bean="sqlMapClient" />

    </constructor-arg>

</bean>

数据库操作的bean都配置好了,下面是事务模块的配置,我们抽象出Service层,也是为了方便事务操作,可能一组业务需要操作多个DAO,那么显然不能在DAO层做事务,而在业务层做事务是非常合适的,也符合逻辑,我们使用Spring提供的DataSourceTransactionManager来配置事务管理器:

<bean id="transactionManager"

class="org.springframework.jdbc.datasource.DataSourceTransactionManager">

    <property name="dataSource">

        <ref bean="dataSource" />

    </property>

</bean>

下面是事务拦截的方法和AOP切入点:

<tx:advice id="txAdvice" transaction-manager="transactionManager">

    <tx:attributes>

        <tx:method name="get*" read-only="true" />

        <tx:method name="insert*" rollback-for="Exception" />

        <tx:method name="add*" rollback-for="Exception" />

        <tx:method name="addOrUpdate*" rollback-for="Exception" />

        <tx:method name="del*" rollback-for="Exception" />

        <tx:method name="update*" rollback-for="Exception" />

    </tx:attributes>

</tx:advice>

<aop:config proxy-target-class="true">

    <aop:pointcut id="serviceMethod"

        expression="execution(* org.ourpioneer.service.*Service.*(..))" />

    <aop:advisor advice-ref="txAdvice" pointcut-ref="serviceMethod" />

</aop:config>

这样,我们对org.ourpioneer.service.*Service中方法名以insert/add/del/update等开头的方法都做上事务了。因为我们使用Spring作为bean容器,那么将DAO和Service也纳入Spring 的管理之中:

<bean id="baseDAO" class="org.ourpioneer.contact.common.BaseDAO">

    <property name="sqlMapClientTemplate" ref="sqlMapClientTemplate" />

</bean>

<bean id="contactDAO" class="org.ourpioneer.contact.dao.impl.ContactDAOImpl"

    parent="baseDAO" />

这里我们将sqlMapClientTemplate配置到BaseDAO中,而ContactDAO继承BaseDAO即可,同时这里要注意这里我们使用了接口和实现相分离的做法,class中是实现类而不是接口,下面是Service:

<bean id="contactService" class="org.ourpioneer.contact.service.ContactService">

    <property name="contactDAO" ref="contactDAO" />

</bean>

配置文件都没有问题了,我们需要把这些涉及到的类都给写出来:

package org.ourpioneer.contact.dao;

import java.util.Map;

import org.ourpioneer.contact.bean.Contact;

public interface ContactDAO {

    public Contact getContactById(Map<Object, Object> parameterMap);

}

DAO接口仅仅是方法的描述,而实现类中编写具体实现代码:

package org.ourpioneer.contact.dao.impl;

import java.util.Map;

import org.ourpioneer.contact.bean.Contact;

import org.ourpioneer.contact.common.BaseDAO;

import org.ourpioneer.contact.dao.ContactDAO;

public class ContactDAOImpl extends BaseDAO implements ContactDAO {

    public Contact getContactById(Map<Object, Object> parameterMap) {

         return (Contact) getSqlMapClientTemplate().queryForObject("getContactById",

        parameterMap);

    }

}

这里涉及到了BaseDAO,我们来看一下:

package org.ourpioneer.contact.common;

import org.springframework.orm.ibatis.SqlMapClientTemplate;

public class BaseDAO {

    private SqlMapClientTemplate sqlMapClientTemplate;

    public SqlMapClientTemplate getSqlMapClientTemplate() {

        return sqlMapClientTemplate;

    }

    public void setSqlMapClientTemplate(

    SqlMapClientTemplate sqlMapClientTemplate) {

        this.sqlMapClientTemplate = sqlMapClientTemplate;

    }

}

调用DAO的Service代码如下:

package org.ourpioneer.contact.service;

import java.util.Map;

import org.ourpioneer.contact.bean.Contact;

import org.ourpioneer.contact.common.ParameterMap;

import org.ourpioneer.contact.dao.ContactDAO;

public class ContactService {

    private ContactDAO contactDAO;

    public ContactDAO getContactDAO() {

        return contactDAO;

    }

    public void setContactDAO(ContactDAO contactDAO) {

        this.contactDAO = contactDAO;

    }

    public Contact getContactById(long id) {

        Map<Object, Object> parameterMap = new ParameterMap("ID", id);

        return getContactDAO().getContactById(parameterMap);

    }

}

从Spring的配置文件我们不难理解这些代码的真正含义,就不过多解释,这里用到了一个ParameterMap对象,我们来看一下它的定义:

package org.ourpioneer.contact.common;

import java.util.HashMap;

public class ParameterMap extends HashMap<Object, Object> {

    private static final long serialVersionUID = 1L;

    public ParameterMap(Object... parameters) {

        for (int i = 0; i < parameters.length - 1; i += 2) {

            super.put(parameters[i], parameters[i + 1]);

        }

    }

}

非常的简单,这样我们在使用的时候就可以按照[名,值,名,值....]这样的格式来放置参数了。本例中涉及到了一个查询叫“getContactById”,它定义在sqlMaps下的contact.xml中,我们来看一下:

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE sqlMap PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN" "http://ibatis.apache.org/dtd/sql-map-2.dtd" >

<sqlMap>

    <typeAlias alias="parameterMap" type="org.ourpioneer.contact.common.ParameterMap" />

    <typeAlias alias="contact" type="org.ourpioneer.contact.bean.Contact" />

    <select id="getContactById" parameterClass="parameterMap"

        resultClass="contact">

        select *

        from contact

        where ID=#ID:LONG#

    </select>

</sqlMap>

首先对ParameterMap和Contact进行别名,为了下面的方便调用,这里我们有一个查询,SQL语句很好理解,select元素的id属性就是它的标识符了,也是sqlMapClientTemplate的queryForObject方法第一个参数,parameterClass指定了参数类,我们使用的是自定义的ParameterMap,resultClass结果类型是我们的实体类对象,这样我们执行这个查询,iBatis会自动为我们封装成一个bean返回,易于调用。

为了测试,我们首先在数据表中插入一条记录:

INSERT INTO `contact` VALUES ('1', 'Sarin', 'male', '15940912345', 'Dalian');

下面来编写测试代码:

package org.ourpioneer.contact;

import org.ourpioneer.contact.bean.Contact;

import org.ourpioneer.contact.service.ContactService;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class App {

    private static final Logger logger = LoggerFactory.getLogger(App.class);

    public static void main(String[] args) {

        ApplicationContext context = new ClassPathXmlApplicationContext(

        "beans.xml");

        ContactService contactService = (ContactService) context

        .getBean("contactService");

        Contact contact = contactService.getContactById(1);

        logger.info("{}",contact);

    }

}

我们从Spring的ApplicationContext中获取到Service对象,然后调用getContactById方法获取结果,下面是运行的结果:


相关文章

深度解析:清理烂代码
如何编写出拥抱变化的代码
重构-使代码更简洁优美
团队项目开发"编码规范"系列文章
相关文档

重构-改善既有代码的设计
软件重构v2
代码整洁之道
高质量编程规范
相关课程

基于HTML5客户端、Web端的应用开发
HTML 5+CSS 开发
嵌入式C高质量编程
C++高级编程

 
分享到
 
 
     


Java 中的中文编码问题
Java基础知识的三十个经典问答
玩转 Java Web 应用开发
使用Spring更好地处理Struts
用Eclipse开发iPhone Web应用
插件系统框架分析
更多...   


Struts+Spring+Hibernate
基于J2EE的Web 2.0应用开发
J2EE设计模式和性能调优
Java EE 5企业级架构设计
Java单元测试方法与技术
Java编程方法与技术


Struts+Spring+Hibernate/EJB+性能优化
华夏基金 ActiveMQ 原理与管理
某民航公司 Java基础编程到应用开发
某风电公司 Java 应用开发平台与迁移
日照港 J2EE应用开发技术框架与实践
某跨国公司 工作流管理JBPM
东方航空公司 高级J2EE及其前沿技术
更多...