MyBatis持久层框架使用总结
Posted 火雨(Nick)
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了MyBatis持久层框架使用总结相关的知识，希望对你有一定的参考价值。
MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。
2013年11月迁移到Github，MyBatis的Github地址：https://github.com/mybatis/mybatis-3。
iBATIS一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects（DAO）。
MyBatis 是支持普通 SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis 消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Old Java Objects，普通的 Java对象）映射成数据库中的记录。
每个MyBatis应用程序主要都是使用SqlSessionFactory实例的，一个SqlSessionFactory实例可以通过SqlSessionFactoryBuilder获得。SqlSessionFactoryBuilder可以从一个xml配置文件或者一个预定义的配置类的实例获得。
1.使用Generator自动生成Dao层，Model层和Mapper层。
MyBatis Generator下载地址：http://www.mybatis.org/generator/
MyBatis Generator中文介绍：http://generator.sturgeon.mopaas.com/
以下用mybatis-generator-core-1.3.2.jar插件加jdbc数据库连接包自动导出持久层dao包，model包和mapper包。
需要用到的Java包有：
mybatis-generator-core-1.3.2.jar，
mysql-connector-java-5.1.34.jar，
ojdbc14-10.2.0.1.0.jar，
sqljdbc4-4.0.jar。
配置文件: generator.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> 3 <generatorConfiguration> 4 <!-- 配置属性文件 用来在配置文件中引入变量 El表达式 --> 5 <!-- 如果是用cmd方式运行 这里应该写url方式写全路径 因为找不到classpath 对于resource来说 --> 6 <!-- 7 <properties url="file:///D:/workspaces/mybatisGen/bin/generatorConfig.properties"/> 8 --> 9 10 <!-- 数据库驱动包位置 --> 11 12 <!-- SQL Server数据驱动包 --> 13 14 <classPathEntry location="D:\\JavaProject\\generator\\sqljdbc4-4.0.jar" /> 15 16 <!-- Oracle数据驱动包 --> 17 <!-- 18 <classPathEntry location="D:\\Java\\m2\\repository\\com\\oracle\\ojdbc14\\10.2.0.1.0\\ojdbc14-10.2.0.1.0.jar" /> 19 --> 20 21 <!-- MySQL数据驱动包 --> 22 <!-- 23 <classPathEntry location="D:\\JavaProject\\generator\\mysql-connector-java-5.1.34.jar" /> 24 --> 25 26 <!-- 此处指定生成针对MyBatis3的DAO--> 27 <!-- 28 id: 必须配置。这个上下文的惟一标识符。该值将被用在一些错误消息。 29 defaultModelType:用来定义生成模型类型策略。 30 1.conditional 默认策略，为每个表生成一个Model class 31 2.flat:将所有的表中生成一个Model class，即这个类将保存所有表中字段 32 3.hierarchical ：如果表有一个主键，该模型将生成一个主键类,另一个类,用于容纳任何BLOB列在表中,和另一个类,用于容纳其余的字段。这个是一个适当的继承类之间的关系。 33 34 targetRuntime：此属性用于指定运行时目标生成的代码。 35 1.MyBatis3 默认值 将生成对象兼容MyBatis版本3.0和更高版本,和JSE 5.0和更高版本 36 (例如Java模型和mapper接口将使用泛型类型)。 37 “by example”方法在这些生成的对象支持几乎无限的动态where子句。 38 此外,Java对象与这些生成器生成支持许多JSE 5.0特性包括参数化的类型和注释。 39 2.Ibatis2Java2 40 3.Ibatis2Java5 41 --> 42 43 <context id="MySQLTables" targetRuntime="MyBatis3" defaultModelType="conditional"> 44 45 <!-- 46 <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" /> 47 --> 48 49 <!-- 50 用来生成注释 51 1. suppressAllComments 默认是false 此属性用于指定在生成的代码是否将包括任何注释。如果设置为true 则不生成注释 52 2. suppressDate 默认是false 此属性用于指定在生成的注释是否将包括MBG代时间戳。 53 --> 54 55 <commentGenerator> 56 <property name="suppressAllComments" value="true" /> 57 </commentGenerator> 58 59 <!-- 数据库链接URL、用户名、密码 --> 60 61 <!-- MySQL数据库链接URL、用户名、密码 --> 62 <!-- 63 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3310/test" userId="test" password="1234"> 64 </jdbcConnection> 65 --> 66 67 <!-- Oracle数据库链接URL、用户名、密码 --> 68 <!-- 69 <jdbcConnection driverClass="oracle.jdbc.driver.OracleDriver" connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:orcl" userId="test" password="1234"> 70 </jdbcConnection> 71 --> 72 73 <!-- SQL Server数据库链接URL、用户名、密码 --> 74 <jdbcConnection driverClass="com.microsoft.sqlserver.jdbc.SQLServerDriver" connectionURL="jdbc:sqlserver://127.0.0.1:1433;DatabaseName=test" userId="test" password="1234"> 75 </jdbcConnection> 76 77 <!-- H2 78 <entry key="jdbc.url">jdbc:h2:tcp://localhost/test</entry> 79 <entry key="jdbc.driver">org.h2.Driver</entry> 80 --> 81 82 <!-- SQLServer2000 83 <entry key="jdbc.url">jdbc:microsoft:sqlserver://localhost:1433;DatabaseName=[database]</entry> 84 <entry key="jdbc.driver">com.microsoft.jdbc.sqlserver.SQLServerDriver</entry> 85 --> 86 87 <!-- SQLServer2005 88 <entry key="jdbc.url">jdbc:sqlserver://192.168.0.98:1433;DatabaseName=[database]</entry> 89 <entry key="jdbc.driver">com.microsoft.sqlserver.jdbc.SQLServerDriver</entry> 90 --> 91 92 <!-- JTDs for SQLServer 93 <entry key="jdbc.url">jdbc:jtds:sqlserver://192.168.0.102:1433/[database];tds=8.0;lastupdatecount=true</entry> 94 <entry key="jdbc.driver">net.sourceforge.jtds.jdbc.Driver</entry> 95 --> 96 97 <!-- PostgreSql 98 <entry key="jdbc.url">jdbc:postgresql://localhost/[database]</entry> 99 <entry key="jdbc.driver">org.postgresql.Driver</entry> 100 --> 101 102 <!-- Sybase 103 <entry key="jdbc.url">jdbc:sybase:Tds:localhost:5007/[database]</entry> 104 <entry key="jdbc.driver">com.sybase.jdbc.SybDriver</entry> 105 --> 106 107 <!-- DB2 108 <entry key="jdbc.url">jdbc:db2://localhost:5000/[database]</entry> 109 <entry key="jdbc.driver">com.ibm.db2.jdbc.app.DB2Driver</entry> 110 --> 111 112 <!-- HsqlDB 113 <entry key="jdbc.url">jdbc:hsqldb:mem:generatorDB</entry> 114 <entry key="jdbc.driver">org.hsqldb.jdbcDriver</entry> 115 --> 116 117 <!-- Derby 118 <entry key="jdbc.url">jdbc:derby://localhost/databaseName</entry> 119 <entry key="jdbc.driver">org.apache.derby.jdbc.ClientDriver</entry> 120 --> 121 122 <!-- java类型解析器 可选配置 --> 123 <!-- 124 <javaTypeResolver type=""> 125 type属性： 这可用于指定一个用户提供的Java类型解析器。这个类必须实现接口org.mybatis.generator.api。 126 JavaTypeResolver,必须有一个公共的默认构造函数。属性还可以接受特殊的值默认在这种情况下,将使用默认的实现(这同样的效果不指定类型)。 127 该标签支持的属性： 128 forceBigDecimals：默认是false 是否强制使用BigDecimal来表示所有的十进制和数值字段。 129 •如果规模很大，长度大于18,将使用BigDecimal类型。 130 •如果其长度为10到18,则Java类型解析器将java.lang.Long来代替了。 131 •如果长度为5到9,然后Java类型解析器将替换为一个Java.lang.integer。 132 •如果其长度小于5,则Java类型解析器将以java.lang.Short替代。 133 --> 134 135 <javaTypeResolver> 136 <property name="forceBigDecimals" value="false" /> 137 </javaTypeResolver> 138 139 <!-- 生成vo对象 --> 140 <!-- 141 < javaModelGenerator >元素用于定义Java模型生成的属性。 142 Java模型生成器建立主键类,记录类,和查询示例类相匹配的表进行自省。这个元素是所需的子元素<上下文>元素。 143 支持的属性： 144 constructorBased： 145 此属性用于选择是否MyBatis生成器将生成一个类的构造函数,它接受一个值类中的每个字段。同时,SQL结果地图将建成投入使用构造函数而不是“setter”每个字段。 146 这个属性是只适用于MyBatis3和将被忽略了iBATIS2。 147 默认值是false。 148 immutable: 149 不可变，此属性用于选择是否MyBatis生成器将产生不可变模型类——这意味着类不会有“setter”方法和构造函数会接受类中每个字段的值。默认为false。 150 trimStrings: 151 此属性用于选择MyBatis生成器是否添加代码来修剪的字符字段从数据库返回的空白空间。 152 这很有用,如果您的数据库将数据存储在字符字段而不是VARCHAR字段。MyBatis生成器将插入代码来削减字符字段。 153 默认值是false。 154 --> 155 <!-- 生成实体类的包名和位置，这里配置将生成的实体类放在com.ouc.model这个包下 --> 156 <javaModelGenerator targetPackage="com.ouc.model" targetProject="D:\\JavaProject\\generator\\src"> 157 <property name="enableSubPackages" value="true" /> 158 <property name="trimStrings" value="true" /> 159 </javaModelGenerator> 160 161 <!-- 生成用于查询的mapping对象 --> 162 <!-- 生成的SQL映射文件包名和位置，这里配置将生成的SQL映射文件放在com.ouc.mapping这个包下 --> 163 <sqlMapGenerator targetPackage="com.ouc.mapping" targetProject="D:\\JavaProject\\generator\\src"> 164 <property name="enableSubPackages" value="true" /> 165 </sqlMapGenerator> 166 167 <!-- 生成DAO的类文件以及配置文件 --> 168 <!-- 169 < javaClientGenerator >元素是用来定义Java客户机代码生成器的属性。 170 Java客户机生成器用来建立Java接口和类,以便可以方便地使用生成的Java模型和XML映射文件。 171 对于iBATIS2目标环境,这些生成的对象采用形式的DAO接口和实现类。 172 对于MyBatis,生成的对象采用mapper形式的接口。 173 这个元素是一个可选的子元素。 174 如果你不指定这个元素,MyBatis生成器(MBG)不会生成Java客户端接口和类。 175 其中的type属性： 176 如果targetRuntime 为MyBatis3 177 XMLMAPPER：生成的对象将Java接口MyBatis 3.x mapper基础设施。接口将会依赖生成的XML映射器文件。一般都是使用这个XMLMAPPER. 178 --> 179 <!-- 生成DAO的包名和位置，这里配置将生成的dao类放在com.ouc.dao这个包下 --> 180 <javaClientGenerator type="XMLMAPPER" targetPackage="com.ouc.dao" targetProject="D:\\JavaProject\\generator\\src"> 181 <property name="enableSubPackages" value="true" /> 182 </javaClientGenerator> 183 184 <!-- 185 <table>元素用于选择数据库中的一个表。选择的表将导致为每个表生成以下对象: 186 •一个MyBatis / iBATIS•格式化的SQL的映射文件 187 •一组类,形成了“模型”表包括: 188 •一个类来匹配•表的主键(如果表有一个主键)。 189 •表中字段匹配的,不是在主键,而非BLOB字段。这个类将扩展主键,如果有一个。 190 •一个类来持有任何表中的BLOB字段(如果有的话)。这个类将扩展其中一个的前面两个类取决于表的配置。 191 •一个类,用于生成动态where子句,在不同的“by Example”方法(selectByExample,deleteByExample)。 192 •(可选)DAO接口和类 193 194 tableName:必须配置 指定表的名称 195 domainObjectName：生成javabean对象的基本名称。如果未指定,MBG将自动基于表名生成。 196 这个名字(无论是在这里指定,或自动生成)将被用来作为域类名和DAO类的名字。 197 enableInsert：是否生成插入语句。默认是true 198 enableSelectByPrimaryKey：是否通过主键生成选择语句。不管是否有这种设置,如果该表没有一个主键将不会生成。 199 enableUpdateByPrimaryKey：是否通过主键生成更新语句。如果该表没有主键，不管是否设置该属性,语句将不会生成。 200 enableDeleteByPrimaryKey：是否通过主键生成删除语句。如果该表没有主键，不管这种设置该属性,语句将不会生成。 201 enableDeleteByExample：是否通过example对象生成删除语句。这个声明使得许多不同的动态删除在运行时生成。 202 enableCountByExample：是否通过example对象生成计算行数语句。该语句将返回一个表中的行数相匹配的example。 203 enableUpdateByExample：是否通过example对象生成更新语句。该语句将更新一个表中相匹配的记录。 204 205 selectByPrimaryKeyQueryId：这个值将被添加到选择列表中选择通过主键的声明在本表格:“\' <值>作为QUERYID”。这可以用于识别查询在DBA在运行时跟踪工具。如果你需使用,你应该指定一个唯一的id为每个不同的查询生成MBG。 206 selectByExampleQueryId：这个值将被添加到选择列表中选择通过例子的声明在本表格:“\' <值>作为QUERYID”。这可以用于识别查询在DBA在运行时跟踪工具。如果你需使用,你应该指定一个唯一的id为每个不同的查询生成MBG。 207 enableSelectByExample:是否应该生成通过example的选择语句。这个声明使得许多不同的动态查询是在运行时生成。 208 209 modelType：此属性用于覆盖默认的模型类型,如果你想对这张表这么做。如果未指定,MBG将生成的域对象基于上下文默认的模型类型。 210 该模型类型定义了如何将生成MBG域类。 211 一些模型类型MBG将生成一个单一的域类为每个表,和其他可能产生不同的类MBG取决于表的结构。 212 escapeWildcards：排除通配符。这意味着无论SQL通配符(\' _ \'和\' % \')的模式和表名都应该避免在搜寻列。 213 这是一些驱动要求如果模式或表包含一个SQL通配符(例如,如果一个表的名字是MY_TABLE,一些驱动要求的下划线字符进行转义)。 214 --> 215 216 <!-- 要生成那些表(更改tableName和domainObjectName就可以) --> 217 <table tableName="V_SupplyUser" domainObjectName="VSupplyUser" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false" /> 218 <table tableName="WJ_GateList" domainObjectName="WJGateList" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false" /> 219 </context> 220 </generatorConfiguration>
打开cmd命令行，转到配置文件所在的文件下，执行如下生成语句：
java -jar mybatis-generator-core-1.3.2.jar -configfile generator.xml -overwrite
命令执行完毕，可以看到对应路径下生成dao包，model包和mapper包文件。
2.MyBatis框架整合
1）MyBatis使用参数配置：sqlMapConfig.xml。
① 缓存配置(Cache)：cacheEnabled：全局开关：默认是true，如果它配成false，其余各个Mapper XML文件配成支持cache也没用。
② 延迟加载：
lazyLoadingEnabled：true使用延迟加载，false禁用延迟加载，默认为true，当禁用时, 所有关联对象都会即时加载。
aggressiveLazyLoading：true启用时，当延迟加载开启时访问对象中一个懒对象属性时，将完全加载这个对象的所有懒对象属性。false，当延迟加载时，按需加载对象属性（即访问对象中一个懒对象属性，不会加载对象中其他的懒对象属性）。默认为true。
③ multipleResultSetsEnabled：允许和不允许单条语句返回多个数据集（取决于驱动需求）。默认为true。
④ useColumnLabel：使用列标签代替列名称。不同的驱动器有不同的做法。参考一下驱动器文档，或者用这两个不同的选项进行测试一下。
⑤ useGeneratedKeys：允许JDBC生成主键。需要驱动器支持。如果设为了true，这个设置将强制使用被生成的主键，有一些驱动器不兼容不过仍然可以执行。
⑥ autoMappingBehavior：指定MyBatis 是否并且如何来自动映射数据表字段与对象的属性。PARTIAL将只自动映射简单的，没有嵌套的结果。FULL 将自动映射所有复杂的结果。
⑦ defaultExecutorType：配置和设定执行器，SIMPLE执行器执行其它语句。REUSE执行器可能重复使用prepared statements语句，BATCH执行器可以重复执行语句和批量更新。
⑧ defaultStatementTimeout：设置一个时限，以决定让驱动器等待数据库回应的多长时间为超时。
完整sqlMapConfig.xml配置文件如下：
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 6 <configuration> 7 <settings> 8 <setting name="cacheEnabled" value="true" /> 9 <setting name="lazyLoadingEnabled" value="true" /> 10 <setting name="multipleResultSetsEnabled" value="true" /> 11 <setting name="useColumnLabel" value="true" /> 12 <setting name="useGeneratedKeys" value="false" /> 13 <setting name="autoMappingBehavior" value="PARTIAL" /> 14 <setting name="defaultExecutorType" value="SIMPLE" /><!-- SIMPLE REUSE BATCH --> 15 <!-- <setting name="defaultExecutorType" value="BATCH" /> --> 16 <setting name="defaultStatementTimeout" value="25000" /> 17 <setting name="safeRowBoundsEnabled" value="false" /> 18 <setting name="mapUnderscoreToCamelCase" value="false" /> 19 <setting name="localCacheScope" value="SESSION" /> 20 <!-- <setting name="jdbcTypeForNull" value="OTHER" /> --> 21 <setting name="jdbcTypeForNull" value="NULL" /> 22 <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString" /> 23 </settings> 24 <typeAliases> 26 <!-- 模块 --> 37 <typeAlias alias="User" type="com.ouc.mkhl.platform.authority.model.User"/> 39 <typeAlias alias="Role" type="com.ouc.mkhl.platform.authority.model.Role"/> 73 <typeAlias alias="Equipment" type="com.ouc.mkhl.platform.basedata.model.Equipment"/> 74 <typeAlias alias="Factory" type="com.ouc.mkhl.platform.basedata.model.Factory"/> 152 </typeAliases> 153 154 <typeHandlers> 155 <typeHandler handler="com.ouc.openplatform.dao.mybatis.SerializableTypeHandler"/> 156 </typeHandlers> 157 </configuration>
序列化特殊值处理：SerializableTypeHandler
1 package com.ouc.openplatform.dao.mybatis; 2 3 import java.io.Serializable; 4 import java.sql.CallableStatement; 5 import java.sql.PreparedStatement; 6 import java.sql.ResultSet; 7 import java.sql.SQLException; 8 9 import org.apache.ibatis.type.BaseTypeHandler; 10 import org.apache.ibatis.type.JdbcType; 11 12 /** 13 * @author WuPing 14 */ 15 public class SerializableTypeHandler extends BaseTypeHandler<Serializable> { 16 17 @Override 18 public void setNonNullParameter(PreparedStatement ps, int i, Serializable parameter, JdbcType jdbcType) 19 throws SQLException { 20 ps.setObject(i, parameter); 21 } 22 23 @Override 24 public Serializable getNullableResult(ResultSet rs,以上是关于MyBatis持久层框架使用总结的主要内容，如果未能解决你的问题，请参考以下文章