MyBatis中文帮助文档

简介什么是MyBatis?MyBatis是支持普通SQL查询,存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis使用简单的XML或注解用于配置和原始映射,将接口和Java的POJOs(PlainOldJavaObjects,普通的Java对象)映射成数据库中的记录。Helpmakethisdocumentationbetter…如果你发现了本文档的遗漏之处,或者丢失MyBatis特性的说明时,那么最好的方法就是了解一下这个遗漏之处然后把它记录下来。Sourcesofthismanualareavailableinxdocformatatproject'sGitForktherepository,updatethemandsendapullrequest.你也是本文档的最佳作者,其他用户也会来阅读它的。入门InstallationTousetheMyBatisyoujustneedtoincludethefileintheclasspath.IfyouareusingMavenjustaddthefollowingdependencytoyourpom.xml:从XML中构建SqlSessionFactory每一个MyBatis的应用程序都以一个SqlSessionFactory对象的实例为核心。SqlSessionFactory对象的实例可以通过SqlSessionFactoryBuilder对象来获得。SqlSessionFactoryBuilder对象可以从XML配置文件,或从Configuration类的习惯准备的实例中构建SqlSessionFactory对象。从XML文件中构建SqlSessionFactory的实例非常简单。这里建议你使用类路径下的资源文件来配置,但是你可以使用任意的Reader实例,这个实例包括由文字形式的文件路径或URL形式的文件路径file://来创建。MyBatis包含了一些工具类,称作为资源,这些工具类包含一些方法,这些方法使得从类路径或其他位置加载资源文件更加简单。XML配置文件包含对MyBatis系统的核心设置,包含获取数据库连接实例的数据源和决定事务范围和控制的事务管理器。关于XML配置文件的详细内容可以在文档后面找到,这里给出一个简单的示例:当然,XML配置文件中还有很多可以配置的,在上面的示例指出的则是最关键的部分。要注意XML头部的声明,需要用来验证XML文档正确性。environment元素体中包含对事务管理和连接池的环境配置。mappers元素是包含所有mapper映射器)(的列表,这些mapper的XML文件包含SQL代码和映射定义信息。不使用XML构建SqlSessionFactory如果你喜欢从Java程序而不是XML文件中直接创建配置实例,或创建你自己的配置构建器,MyBatis也提供完整的配置类,提供所有从XML文件中加载配置信息的选项。注意这种情况下配置是添加映射类。映射类是Java类,这些类包含SQL映射语句的注解从而避免了XML文件的依赖,XML映射仍然在大多数高级映射(比如:嵌套Join映射)时需要。出于这样的原因,如果存在XML配置文件的话,MyBatis将会自动查找和加载一个对等的XML文件(这种情况下,基于类路径下的BlogMapper.class类的类名,那么BlogMapper.xml将会被加载)。后面我们会了解更多。从SqlSessionFactory中获取SqlSession现在,我们已经知道如何获取SqlSessionFactory对象了,基于同样的启示,我们就可以获得SqlSession的实例了。SqlSession对象完全包含以数据库为背景的所有执行SQL操作的方法。你可以用SqlSession实例来直接执行已映射的SQL语句。例如:这种方法起到的作用,和我们使用之前的MyBatis版本是相似的,现在有一种更简洁的方法。使用合理描述参数和SQL语句返回值的接口(比如BlogMapper.class),这样现在就可以至此那个更简单,更安全的代码,没有容易发生的字符串文字和转换的错误。例如:现在我们来探究一下这里到底执行了什么。探究已映射的SQL语句这里你也许想知道通过SqlSession和Mapper对象到底执行了什么操作。已映射的SQL语句是一个很大的主题,而且这个主题会贯穿本文档的大部分内容。为了给出一个宏观的概念,这里有一些示例。上面提到的任何一个示例,语句是通过XML或注解定义的。我们先来看看XML。使用基于XML的映射语言,在过去的几年中使得MyBatis非常流行,他为MyBatis提供所有的特性设置。如果你以前用过MyBatis,这个概念应该很熟悉了,但是XML映射文件也有很多的改进,后面我们会详细来说。这里给出一个基于XML映射语句的示例,这些语句应该可以满足上述示例中SqlSession对象的调用。这个简单的例子中看起来有很多额外的东西,但是也相当简洁了。你可以在一个单独的XML映射文件中定义很多的映射语句,除XML头部和文档类型声明之外,你可以得到很多方便之处。在文件的剩余部分是很好的自我解释。在命名空间“com.mybatis.example.BlogMapper”中,它定义了一个名为“selectBlog”的映射语句,这样它允许你使用完全限定名“org.mybatis.example.BlogMapper.selectBlog”来调用映射语句,我们下面示例中所有的写法也是这样的。要注意这个使用完全限定名调用Java对象的方法是相似的,这样做是有原因的。这个命名可以直接给相同命名空间下的的映射类,使用一个名称,参数和返回值和已映射的查询语句都一样的方法即可。这就允许你非常容易地调用映射器接口中的方法,这和你前面看到的是一样的,下面这个示例中它又出现了。第二种方式有很多有点,首先它不是基于文字的,那就更安全了。第二,如果你的IDE有代码补全功能,那么你可以利用它来操纵已映射的SQL语句。第三,不需要强制类型转换,同时BlogMapper接口可以保持简洁,返回值类型很安全(参数类型也很安全)。重要命名空间的一点注释命名空间在之前版本的MyBatis中是可选项,非常混乱也没有帮助。现在,命名空间是必须的,而且有一个目的,它使用更长的完全限定名来隔离语句。命名空间使得接口绑定成为可能,就像你看到的那样,如果之前不了解,那么现在你就会使用它们了,你应该按照下面给出示例的来练习,以免改变自己的想法。使用命名空间,并将它放在合适的Java包空间之下,将会使你的代码变得简洁,在很长的时间内提高MyBatis的作用。命名解析:为了减少输入量,MyBatis对所有的命名配置元素使用如下的命名解析规则,包括语句,结果映射,缓存等。直接查找完全限定名(比如“com.mypackage.MyMapper.selectAllThings”,如果)发现就使用。短名称(比如“selectAllThings”)可以用来引用任意含糊的对象。而如果有两个或两个以上的(比如“com.foo.selectAllThings”和“com.bar.selectAllThings”),那么就会得到错误报告,说短名称是含糊的,因此就必须使用完全限定名。如BlogMapper这样的映射器类来说,还有一个妙招。它们中间映射的语句可以不需要在XML中来写,而可以使用Java注解来替换。比如,上面的XML示例可以如下来替换:对于简单语句来说,使用注解代码会更加清晰,然而Java注解对于复杂语句来说就会混乱,应该限制使用。因此,如果你不得不做复杂的事情,那么最好使用XML来映射语句。当然这也取决于你和你的项目团队的决定,看哪种更适合你来使用,还有以长久方式来使用映射语句的重要性。也就是说,不要将自己局限在一种方式中。你可以轻松地将注解换成XML映射语句,反之亦然。范围和生命周期理解我们目前已经讨论过的不同范围和生命周期类是很重要的。不正确的使用它们会导致严重的并发问题。SqlSessionFactoryBuilder这个类可以被实例化,使用和丢弃。一旦你创建了SqlSessionFactory后,这个类就不需要存在了。因此SqlSessionFactoryBuilder实例的最佳范围是方法范围(也就是本地方法变量)。你可以重用SqlSessionFactoryBuilder来创建多个SqlSessionFactory实例,但是最好的方式是不需要保持它一直存在来保证所有XML解析资源,因为还有更重要的事情要做。SqlSessionFactory一旦被创建,SqlSessionFactory应该在你的应用执行期间都存在。没有理由来处理或重新创建它。使用SqlSessionFactory的最佳实践是在应用运行期间不要重复创建多次。这样的操作将被视为是非常糟糕的。因此SqlSessionFactory的最佳范围是应用范围。有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。SqlSession每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能被共享,也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段甚至是实例字段中。也绝不能将SqlSession实例的引用放在任何类型的管理范围中,比如Serlvet架构中的HttpSession。如果你现在正用任意的Web框架,要考虑SqlSession放在一个和HTTP请求对象相似的范围内。换句话说,基于收到的HTTP请求,你可以打开了一个SqlSession,然后返回响应,就可以关闭它了。关闭Session很重要,你应该确保使用finally块来关闭它。下面的示例就是一个确保SqlSession关闭的基本模式:在你的代码中一贯地使用这种模式,将会保证所有数据库资源都正确地关闭(假设你没有通过你自己的连接关闭,这会给MyBatis造成一种迹象表明你要自己管理连接资源)。Mapper实例映射器是你创建绑定映射语句的接口。映射器接口的实例可以从SqlSession中获得。那么从技术上来说,当被请求时,任意映射器实例的最宽范围和SqlSession是相同的。然而,映射器实例的最佳范围是方法范围。也就是说,它们应该在使用它们的方法中被请求,然后就抛弃掉。它们不需要明确地关闭,那么在请求对象中保留它们也就不是什么问题了,这和SqlSession相似。你也许会发现,在这个水平上管理太多的资源的话会失控。保持简单,将映射器放在方法范围内。下面的示例就展示了这个实践:重要ObjectlifecycleandDependencyInjectionFrameworksDependencyInjectionframeworkscancreatethreadsafe,transactionalSqlSessionsandmappersandinjectthemdirectlyintoyourbeanssoyoucanjustforgetabouttheirlifecycle.YoumaywanttohavealookatMyBatis-SpringorMyBatis-Guicesub-projectstoknowmoreaboutusingMyBatiswithDIframeworks.XML映射配置文件MyBatis的XML配置文件包含了影响MyBatis行为甚深的设置和属性信息。XML文档的高层级结构如下:configuration配置oproperties属性osettings设置otypeAliases类型命名otypeHandlers类型处理器oobjectFactory对象工厂oplugins插件oenvironments环境environment环境变量transactionManager事务管理器dataSource数据源odatabaseIdProvid