Mybatis的介绍

来源:互联网 发布:云宝网是网络传销吗 编辑:程序博客网 时间:2024/05/21 15:49
MyBatis的前身就是iBatis,iBatis本是apache的一个开源项目,2010年这个项目由apahce sofeware foundation 迁移到了google code,并且改名为MyBatis。

iBATIS一词来源于“internet”和“abatis”的组合,是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects(DAO),同时还提供一个利用这个框架开发的 JPetStore实例。(来源于百度)

总体来说 MyBatis 主要完成两件事情

  1. 根据 JDBC 规范建立与数据库的连接;
  2. 通过Annotaion/XML+JAVA反射技术,实现 Java 对象与关系数据库之间相互转化。

一、原理介绍

Mybatis的应用是围绕着一个SqlSessionFactory实例展开的。SqlSessionFactoryBuilder根据XML映射文件创建SqlSessionFactory。

SqlSessionFactory由名字可以联想到,可以通过它获取一个SqlSession。SqlSession包含了执行sql所需要的所有方法,可以通过SqlSession实例直接运行映射的sql语句:

Java代码 复制代码 收藏代码
  1. SqlSession session = sqlSessionFactory.openSession();
  2. try {
  3. Blog blog = session.selectOne("org.mybatis.example.BlogMapper.selectBlog",101);
  4. } finally {
  5. session.close();
  6. }

上面的方法是基于Mybatis的旧版本,在最新的版本中有更清晰的方法,通过一个java接口作为参数(e.g. BlogMapper.class)返回一个给定的sql映射。

Java代码 复制代码 收藏代码
  1. SqlSession session = sqlSessionFactory.openSession();
  2. try {
  3. BlogMapper mapper = session.getMapper(BlogMapper.class);
  4. Blog blog = mapper.selectBlog(101);
  5. } finally {
  6. session.close();
  7. }

看到这里,您可能会对什么才是SqlSession和Mapper类真正执行的sql语句非常好奇。下面我们看一下例子.

Xml代码 复制代码 收藏代码
  1. <?xml version="1.0"encoding="UTF-8"?>
  2. <!DOCTYPE mapper
  3. PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="org.mybatis.example.BlogMapper">
  6. <select id="selectBlog"parameterType="int"resultType="Blog">
  7. select * from Blog where id = #{id}
  8. </select>
  9. </mapper>

这个例子非常简单,是轻量级的。您可以定义众多类似这样的sql语句。这个文件在命名空间"org.mybatis.example.BlogMapper"中,定义了一个叫做"selectBlog"的sql语句。这样就可以使用一个绝对唯一路径“org.mybatis.example.BlogMapper.selectBlog”定位到这个sql语句上。如下所示:

Java代码 复制代码 收藏代码
  1. Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog",101);

注意这是一个绝对唯一的Java类调用方法如何类似这个名字可以直接映射到命名空间映射,以及具有相匹配的名称、参数返回类型映射select语句方法这使得您可以简单地调用映射接口方法这里例子

Java代码 复制代码 收藏代码
  1. BlogMapper mapper = session.getMapper(BlogMapper.class);
  2. Blog blog = mapper.selectBlog(101);

如您所见,第二种方法更简洁,不需要返回值的cast。

到目前为止,我们已经了解Mybatis如何将xml映射文件与Java类映射去执行sql语句的,具体xml映射文件的含义请查询mybatis官方网站的资料,再此不在介绍。

二、spring的集成

在基本的 MyBatis 中,session 工厂可以使用 SqlSessionFactoryBuilder 来创建。而在MyBatis-Spring 中,则使用 SqlSessionFactoryBean 来替代。

要创建工厂 bean,放置下面的代码在 Spring 的 XML 配置文件中:

Xml代码 复制代码 收藏代码
  1. <bean id="sqlSessionFactory"class="org.mybatis.spring.SqlSessionFactoryBean">
  2. <property name="dataSource"ref="dataSource"/>
  3. </bean>

要注意 SqlSessionFactoryBean 实现了 Spring 的 FactoryBean 接口(请参考Spring文档的3.8 章节)这就说明了由Spring最终创建的bean不是SqlSessionFactoryBean本身。而是工厂类的getObject()返回的方法的结果。这种情况下,Spring将会在应用启动时为你创建SqlSessionFactory对象,然后将它以SqlSessionFactory为名来存储。在 Java中,相同的代码是:

Java代码 复制代码 收藏代码
  1. SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
  2. SqlSessionFactory sessionFactory = factoryBean.getObject();

在一般的MyBatis-Spring 用法中,你不需要直接使用 SqlSessionFactoryBean或和其对应的SqlSessionFactory。相反,session工厂将会被注入到MapperFactoryBean或其它扩展了SqlSessionDaoSupport 的DAO(Data Access Object,数据访问对象,译者注)中。

下面给出一个完成的Mybatis-spring集成的例子:

Xml代码 复制代码 收藏代码
  1. <context:property-placeholderlocation="classpath*:jdbc.properties"ignore-unresolvable="true"/>
  2. <!-- enable component scanning (beware that this does not enable mapper scanning!) -->
  3. <context:component-scanbase-package="com.buybal.rxhuirr.db"/>
  4. <!-- scan for mappers and let them be autowired -->
  5. <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
  6. <property name="basePackage"value="com.buybal.rxhuirr.db.data"/>
  7. </bean>
  8. <!-- enable autowire -->
  9. <context:annotation-config/>
  10. <bean id="testDb"class="org.apache.commons.dbcp.BasicDataSource"
  11. destroy-method="close">
  12. <property name="driverClassName"value="${driver}"/>
  13. <property name="url"value="jdbc:mysql://10.0.0.20:3306/mybatis_demodb?defaultBatchValue=1000"/>
  14. <property name="username"value="reportnew"/>
  15. <property name="password"value="reportnew"/>
  16. <property name="validationQuery"value="SELECT count(*) FROM users"/>
  17. <property name="initialSize"value="10"/>
  18. <property name="minIdle"value="5"/>
  19. <property name="maxIdle"value="5"/>
  20. </bean>
  21. <bean id="sqlSessionFactoryTestDb"class="org.mybatis.spring.SqlSessionFactoryBean">
  22. <property name="configLocation"value="classpath:mybatis-config.xml"/>
  23. <property name="dataSource"ref="testDb"/>
  24. </bean>

如有疑问,请查看Mybatis-spring集成的官方文档。

三、代码生成工具

经过前面的两章,我们已经掌握了Mybatis的映射原理,并且可以集成进入到spring中使用了。但是童鞋们肯定会感觉Mybatis的配置文件和映射类的工作也十分的巨大,并且繁琐,简直就是望而生畏。

不过我们有强大的代码生成工具帮我们自动生成xml映射文件和java映射类,它大大减轻了我们使用Mybatis的工作负担!

首先,建议在eclipse上安装Mybatis代码生成工具的插件。插件地址请点击我。

安装完毕,就可以在eclipse上自动生成Mybatis的文件了,程序员可以把自己的精力专注在业务逻辑上的开发,而不是Mybatis配置文件和映射类上面。

Mybatis代码生成工具的原理是使用xml配置文件驱动的代码生成工具。 配置文件解决了如下问题:

  1. 如何连接数据库
  2. 生成哪些对象如何生成
  3. 哪些表要用来生成对象

详细内容请查看官网的文档。

自动生成如下文件包括下面四个类型的组件:

Module类 数据库的对象POJO(没有实现Serializable接口,如使用缓存需要添加)
Example 用于拼动态sql的帮助类
XXXMapper.xml 映射文件(包括自动生成的动态sql部分)
XXXMapper.java 与映射文件对应的DAO接口

四、缓存

缓存技术是一种“以空间换时间”的设计理念,利用内存空间资源来提高数据检索速度的有效手段之一。
MyBatis默认情况下是没有开启缓存的,除了局部的 session 缓存。要开启二级缓存,你需要在你的 SQL映射文件中添加一行:

Xml代码 复制代码 收藏代码
  1. <cache/>

这样配置会开启二级缓存,并且加载缺省的缓存配置。下面的例子说明了如何更改缓存策略和配置:

Xml代码 复制代码 收藏代码
  1. <cache
  2. eviction="FIFO"
  3. flushInterval="60000"
  4. size="512"
  5. readOnly="true"/>

这个配置创建了一个 FIFO 缓存,并每隔 60 秒刷新,存取512 个结果对象或列表的引用,而且返回的对象为只读,因此在不同线程中的调用者之间修改它们会导致冲突。

注意:二级缓存是支持事物的,这意味着只有在SqlSession结束和提交的时候,或者当回滚结束并且插入、删除、更新操作没有配置flushCache=true,才会更新缓存内容。

除了Mybatis自己提供的缓存,也可以使用第三方的分布式缓存。要使用第三方的缓存需要实现Mybatis的缓存接口:

Java代码 复制代码 收藏代码
  1. public interface Cache {
  2. String getId();
  3. int getSize();
  4. void putObject(Object key, Object value);
  5. Object getObject(Object key);
  6. boolean hasKey(Object key);
  7. Object removeObject(Object key);
  8. void clear();
  9. ReadWriteLock getReadWriteLock();
  10. }

然后只要在xml映射文件中,缓存配置的部分使用自己的实现类。

Xml代码 复制代码 收藏代码
  1. <cache type="com.domain.something.MyCustomCache">
  2. <property name="cacheFile"value="/tmp/my-custom-cache.tmp"/>
  3. </cache>

更详细的内容请直接查看官方网站的说明文档。

幸运的是,针对很多著名的第三方分布式缓存,已经有了开源的插件,已经不需要我们自己开发缓存接口的实现了。下面拿我们公司DAL使用的Memcached为例,已经有了开源的实现。如果使用maven管理项目,可以添加如下项目到maven的配置文件中引入Mybatis-Memcached框架:

Xml代码 复制代码 收藏代码
  1. <dependency>
  2. <groupId>org.mybatis.caches</groupId>
  3. <artifactId>mybatis-memcached</artifactId>
  4. <version>1.0.0-beta1</version>
  5. </dependency>

然后在xml映射文件指定定制的Memcached缓存实现类:

Xml代码 复制代码 收藏代码
  1. <mapper namespace="org.acme.FooMapper">
  2. <cache type="org.mybatis.caches.memcached.MemcachedCache"/>
  3. ...
  4. </mapper>

具体的使用方法还请阅读Mybatis-Memcached项目文档。

五、分库

现在大型网站都有自己的分布式DAL(Data access layer)层。如何在Mybatis上构建DAL,实现分库表的配置,路由规则定制都有现实的实际应用价值。下面简介一个Mybatis的分库插件。

shardbatis是一个由国人贡献的,Mybatis分库分表插件。Shardbatis的名称由shard(ing)+mybatis组合得到。诣在为ibatis实现数据水平切分的功能。

Shardbatis0.9是在mybatis 2.3.5代码的基础上进行一些扩展实现数据水平切分功能。 数据的水平切分包括多数据库的切分和多表的数据切分。目前shardbatis已经实现了单数据库的数据多表水平切分。

Shardbatis2.0可以以插件的方式和mybatis3.x进行整合,对mybatis的代码无侵入,不改变用户对mybatis的使用习惯。Shardbatis2.0支持的功能和Shardbatis0.9基本相同。

shardbatis的使用与原生的mybatis3没有区别,使用者只需要将shardbatis以Mybatis插件的方式引入进来,实现路由策略接口,实现自己的路由策略即可,此外还需要一个shard_config.xm配置文件,定义哪些sql映射操作需要使用路由策略。

更详细的内容可以参考shardbatis官方文档。以及iteye资料

六、其它基于Mybatis的项目和资料

1.CobarClient主要针对现有网站应用中使用iBatis做数据访问层这一情况而设计开发,如果你的应用程序最初使用了Spring提供的SqlMapClientTemplate的话, 那迁移到CobarClient实际上仅仅是稍微改一下应用程序的配置而已.

项目地址:http://code.alibabatech.com/wiki/display/CobarClient/Home

2.http://blog.mybatis.org/

3.http://code.google.com/p/mybatis/

Mybatis从出生到现在已经有10岁了,最新的Mybatis项目是Mybatis for scala,相信在并行计算大行其道的今天,Mybatis一定会跟上时代的潮流,与时俱进,继续保持在ORM框架里面的霸主地位。

0 0