Mybatis总结（一）

Mybatis

1.    认识：

MyBatis是一个简化和实现了 Java 数据持久化层(persistence layer)的开源框架，它抽象了大量的JDBC冗余代码，并提供了一个简单易用的API和数据库交互。

MyBatis的前身是iBATIS，iBATIS于2002年由ClintonBegin创建。MyBatis3是iBATIS的全新设计，支持注解和Mapper。

MyBatis流行的主要原因在于它的简单性和易使用性。在Java应用程序中，数据持久化层涉及到的工作有：将从数据库查询到的数据生成所需要的Java对象；将Java对象中的数据通SQL持久化到数据库中。

MyBatis通过抽象底层的JDBC代码，自动化SQL结果集产生Java对象、Java对象的数据持久化数据库中的过程使得对SQL的使用变得容易。

2.流行起来的原因：

1)        它消除了大量的JDBC冗余代码

2)        它有低的学习曲线

3)        它能很好地与传统数据库协同工作。有时我们可能需要用不正规形式与传统数据库协同工作，使用成熟的ORM框架(例如大家熟知的Hibernate)有可能、但是很难跟传统数据库很好地协同工作，因为他们尝试将Java对象静态地映射到数据库的表上.而MyBatis是将查询的结果与Java对象映射起来，这使得MyBatis可以很好地与传统数据库协同工作。你可以根据面相对象的模型创建Java域对象，执行传统数据库的查询，然后将结果映射到对应的Java对象上。

4)        它可以接受SQL语句。成熟的ORM框架鼓励使用实体对象和在其底层自动产生SQL语句。由于这种的SQL生成方式，我们有可能不能够利用到数据库的一些特有的特性。Hibernate允许执行本地SQL，但是这样会打破持久层和数据库独立的原则。MyBatis框架接受SQL语句，而不是将其对开发人员隐藏起来。由于MyBatis不会产生任何的SQL语句，所以开发人员就要准备SQL语句，这样就可以充分利用数据库特有的特性并且可以准备自定义的查询。另外，MyBatis 对存储过程也提供了支持。

5)        它提供了与Spring框架的集成支持。

6)        它提供了与第三方缓存类库的集成支持

7)        它引入了更好的性能

2.       mybatis的jar包

 

3.       mybatis的配置文件：mybatis-config.xml

 

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

                   <!DOCTYPEconfiguration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"

                   "http://mybatis.org/dtd/mybatis-3-config.dtd">

                   <configuration>

                     <properties resource="application.properties">

                            <propertyname="username" value="db_user" />

                            <propertyname="password" value="verysecurepwd" />

                     </properties>

                     <settings>

                            <settingname="cacheEnabled" value="true" />

                     </settings>

                     <typeAliases>

                            <typeAliasalias="Student" type="com.briup.pojo.Student" />

                            <packagename="com.briup.pojo" />

                     </typeAliases>

                     <typeHandlers>

                            <typeHandlerhandler="com.mybatis3.typehandlers.PhoneTypeHandler" />

                            <packagename="com.briup.typehandlers" />

                     </typeHandlers>

                     <environmentsdefault="development">

                            <environmentid="development">

                              <transactionManager type="JDBC"/>

                              <dataSource type="POOLED">

                                     <propertyname="driver" value="${jdbc.driverClassName}" />

                                     <propertyname="url" value="${jdbc.url}" />

                                     <propertyname="username" value="${jdbc.username}" />

                                     <propertyname="password" value="${jdbc.password}" />

                              </dataSource>

                            </environment>

                            <environmentid="production">

                              <transactionManagertype="MANAGED" />

                              <dataSource type="JNDI">

                                     <propertyname="data_source" value="java:comp/jdbc/MyBatisDemoDS"/>

                              </dataSource>

                            </environment>

                     </environments>

                     <mappers>

                            <mapperresource="com/briup/mappers/StudentMapper.xml" />

                            <mapperurl="file:///D:/mybatisdemo/mappers/StudentMapper.xml" />

                            <mapperclass="com.briup.mappers.StudentMapper" />

                     </mappers>

                   </configuration>

 

注：

1）environments是配置mybatis当前工作的数据库环境的地方

MyBatis可以支持配置多个dataSource环境，可以将应用部署到不同的环境上，如DEV(开发环境)，TEST（测试环境），QA（质量评估环境）,UAT(用户验收环境),PRODUCTION（生产环境），可以通过将默认environments值设置成想要的environment的id值。

对于environments,我们可以在其中配置多个environment子元素,同时还需要在environment中配置dataSource和transactionManager元素。

2）dataSource表示的是数据源:至少会包括该连接数据库的各种信息

dataSource的类型type属性可以配置成其内置类型之一，如UNPOOLED，POOLED，JNDI。

                   如果将类型设置成UNPOOLED，MyBatis会为每一个数据库操作创建一个新的连接，使用完了并关闭它，该方式适用于只有小规模数量并发用户的简单应用程序上。

                   如果将属性设置成POOLED，MyBatis会创建一个数据库连接池，连接池中的一个连接将会被用作数据库操作。一旦数据库操作完成，MyBatis会将此连接返回给连接池。在开发或测试环境中，经常使用此种方式。

                   如果将类型设置成JNDI(Java Naming and Directory Interface ,Java命名和目录接口, 是SUN公司提供的一种标准的Java命名系统接口)，MyBatis从在应用服务器向配置好的JNDI数据源dataSource获取数据库连接。在生产环境中，优先考虑这种方式。

3）transactionManager元素 :事务管理器

                   MyBatis支持两种类型的事务管理器：JDBC 和 MANAGED.

                   JDBC事务管理器的使用，是在【jdbc程序】负责管理数据库连接的生命周期（提交、回退等等）的时候。如果将TransactionManager 属性设置成JDBC，MyBatis内部将使用JdbcTransactionFactory类创建TransactionManager。例如，部署到ApacheTomcat的应用程序，需要应用程序自己管理事务。

                   MANAGED事务管理器的使用，是在【应用服务器】负责管理数据库连接生命周期的时候。如果将TransactionManager属性设置成MANAGED时，MyBatis内部使用ManagedTransactionFactory 类创建事务管理器TransactionManager。例如，当一个Java EE的应用程序部署在类似JBoss，WebLogic，GlassFish应用服务器上时，它们会使用EJB进行应用服务器的事务管理能力。在这些管理环境中，你可以使用MANAGED事务管理器。

                   注：Managed 是托管的意思，即我们编写的应用程序本身不去管理事务，而是把事务管理交给应用所在的服务器进行管理。

4）属性配置元素properties可以将配置值写死到mybatis-config.xml中,也可以具体到一个属性文件中,并且使用属性文件的key名作为占位符.

                   在上述的配置中，我们将数据库连接属性配置到了application.properties文件中，并且为driver，URL等属性使用了占位符.

                   在applications.properties文件中配置数据库连接参数，如下所示：

                   jdbc.driverClassName=oracle.jdbc.driver.OracleDriver

                   jdbc.url=jdbc:oracle:thin:@127.0.0.1:1521:XE

                   jdbc.username=test

                   jdbc.password=test

5）typeAliases元素: 类型别名

                   在SQLMapper配置文件中，对于resultType和parameterType属性值，我们需要使用JavaBean 的完全限定名。

parameterType表示将来调用这个sql语句的时候所传的参数的类型(参数值或者参数对象里面的属性值 用来替换sql语句中的占位符)

                   resultType表示将来调用这个sql语句的时候所返回的结果的类型(方便mybatis给我们自动封装结果集)

eg:

                 

  <typeAliases>

                     <type Alias alias="Student"type="com.briup.pojo.Student" />

                     <type Alias alias="Teacher"type="com.briup.pojo.Teacher" />

  </typeAliases>

可以不用为每一个JavaBean单独定义别名,你可以为配置出需要取别名的类的所在的包(package)，MyBatis会自动扫描包内定义的类，然后分别为每个类注册一个小写字母开头的简单类名形式的别名。如下所示：

                   <typeAliases>

                     <package name="com.briup.pojo"/>

                   </typeAliases>

还有另外一种方式为JavaBeans起别名，使用注解 @Alias:

                   @Alias("stu")

                   publicclass Student{

                            ....

                   }

                   @Alias注解将会覆盖配置文件中的<typeAliases>定义。

                   注意: @Alias 要和<package name=""/>标签配合使用,Mybatis会自动查看指定包内的类别名注解,如果没有这个注解,那么默认的别名就是类的名字.

6) typeHandlers元素: 类型处理器

                   当MyBatis将一个Java对象作为输入参数执行INSERT语句操作时，它会创建一个PreparedStatement对象，

                   并且使用setXXX()方法对占位符设置相应的参数值 。这里，XXX可以是int，String，Date 等 Java对象属性类型的任意一个。示例如下：

                   <insertid="insertStudent" parameterType="Student">

                            INSERTINTO STUDENTS(STUD_ID,NAME,EMAIL,DOB) 

                            VALUES(#{studId},#{name},#{email},#{dob})

                   </insert>

 

                   为执行这个语句，MyBatis将采取以下一系列动作：

                            创建一个有占位符的PreparedStatement接口，如下：

                            PreparedStatement ps = connection.prepare Statement

                   ("INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL,DOB)VALUES(?,?,?,?)");

                            检查Student对象的属性studId的类型，然后使用合适setXXX方法去设置参数值。这里studId是Integer类型，所以会使用setInt()方法：ps.setInt(1,student.getStudId());

 

                            类似地，对于name和email属性都是String类型MyBatis使用setString()方法设置参数。

                            至于dob属性, MyBatis会使用setDate()方法设置dob处占位符位置的值。

                            MyBaits会将java.util.Date类型转换为java.sql.Timestamp并设值：

                            ps.setTimestamp(4,new Timestamp((student.getDob()).getTime()));

 

                   但MyBatis是怎么知道对于Integer类型属性使用setInt()和String类型属性使用setString()方法呢？

                   其实MyBatis是通过使用类型处理器typeHandlers来决定这么做的。

                  

                   MyBatis对于以下的类型使用内置的类型处理器：

                   所有的基本数据类型、基本类型的包装类型、 byte[]、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java枚举类型等。

                   所以当MyBatis发现属性的类型属于上述类型，他会使用对应的类型处理器将值设置到PreparedStatement中，

                   同样地，当SQL结果集封装成java类对象的时候，也有类似的过程。

 

                   那如果有一个自定义的类型，怎么存储存储到数据库呢？示例如下：假设表STUDENTS 有一个 PHONE 字段，类型为 VARCHAR2(15)，而 Student类有一个自定义类型属性(PhoneNumber类)

                  

                   altertable students add phone varchar2(15);

                   altertable students drop column phone;

 

                   或者:

                   droptable students;

                   createtable students (

                            stud_idnumber primary key,

                            namevarchar2(50) ,

                            emailvarchar2(50) ,

                            dobdate ,

                            phonevarchar2(15)

                   );

 

                   java代码:

                   PhoneNumber类定义类型的 phoneNumber 属性。

 

                   publicclass PhoneNumber{

                            privateString countryCode;

                            privateString stateCode;

                            privateString number;

                            publicPhoneNumber(){

                            }

                            publicPhoneNumber(String countryCode, String stateCode, String number) {

                                     this.countryCode= countryCode;

                                     this.stateCode= stateCode;

                                     this.number= number;

                            }

                            publicString getAsString() {

                                     returncountryCode + "-" + stateCode + "-" + number;

                            }

                            //Setters and getters

                   }

                    

                   publicclass Student{

                            privateInteger id;

                            privateString name;

                            privateString email;

                            privatePhoneNumber phone;

                            //Setters and getters

                   }

 

                  

                   xml配置:

                   <insertid="insertStudent" parameter Type="Student">

                            insertinto students(name,email,phone)

                            values(#{name},#{email},#{phone})

                   </insert>

        

                   这里，参数对象中的属性phone的值需要传递给#{phone}；而参数对象的属性phone是 PhoneNumber类型。但是，MyBatis 并不知道该怎样来处理这个类型的对象。

                   为了让MyBatis明白怎样处理这个自定义的Java对象类型，如PhoneNumber，我们可以创建一个自定义的类型处理器,MyBatis提供了抽象类BaseTypeHandler<T> ，我们可以继承此类创建自定义类型处理器。

                   代码如下所示:

                          

  packagecom.briup.typehandlers;

 

                            importjava.sql.CallableStatement;

                            importjava.sql.PreparedStatement;

                            importjava.sql.ResultSet;

                            importjava.sql.SQLException;

 

                            importorg.apache.ibatis.type.BaseTypeHandler;

                            importorg.apache.ibatis.type.JdbcType;

 

                            importcom.briup.pojo.PhoneNumber;

 

                            publicclass PhoneTypeHandler extends BaseTypeHandler<PhoneNumber>{

 

                                     //遇到PhoneNumber参数的时候应该如何在ps中设置值

                                     @Override

                                     publicvoid setNonNullParameter(PreparedStatement ps, int i, PhoneNumber parameter,JdbcType jdbcType)

                                                        throwsSQLException {

                                               ps.setString(i,parameter.getAsString());

                                     }

 

                                     //查询中遇到PhoneNumber类型的应该如何封装(使用列名封装)

                                     @Override

                                     publicPhoneNumber getNullableResult(ResultSet rs, String columnName) throwsSQLException {

                                               returnnew PhoneNumber(rs.getString(columnName));

                                     }

 

                                     //查询中遇到PhoneNumber类型的应该如何封装(使用列的下标)

                                     @Override

                                     publicPhoneNumber getNullableResult(ResultSet rs, int columnIndex) throwsSQLException {

                                               returnnew PhoneNumber(rs.getString(columnIndex));

                                     }

 

                                     //CallableStatement使用中遇到了PhoneNumber类型的应该如何封装

                                     @Override

                                     publicPhoneNumber getNullableResult(CallableStatement cs, int columnIndex) throwsSQLException {

                                               returnnew PhoneNumber(cs.getString(columnIndex));

                                     }

 

                            }

                  

                   注意:使用ps.setString()和rs.getString()方法是 :因为在数据库的表中phone列是VARCHAR类型。

 

                   最后一旦我们实现了自定义的类型处理器，我们需要在mybatis-config.xml中注册它：

                   <?xmlversion="1.0" encoding="utf-8"?>

                   <!DOCTYPEconfiguration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"

                   "http://mybatis.org/dtd/mybatis-3-config.dtd">

                   <configuration>

                     <propertiesresource="application.properties" />

                     <type Handlers>

                            <typeHandler handler="com.briup.typehandlers.PhoneTypeHandler" />

                     </type Handlers>

                   </configuration>

                   注册PhoneTypeHandler后, MyBatis就能够将Phone类型的对象值存储到VARCHAR类型的列上。

7) settings元素: 全局参数设置

                   注意:大多数情况下，【这些参数使用它们的默认值即可】

                   为满足应用特定的需求，MyBatis默认的全局参数设置可以被覆盖掉，如下所示：

 <settings>

                     <setting name="cacheEnabled"value="true" />

                     <settingname="lazyLoadingEnabled" value="true" />

                     <settingname="multipleResultSetsEnabled" value="true" />

                     <setting name="useColumnLabel"value="true" />

                     <setting name="useGeneratedKeys"value="false" />

                     <setting name="autoMappingBehavior"value="PARTIAL" />

                     <settingname="defaultExecutorType" value="SIMPLE" />

                     <settingname="defaultStatementTimeout" value="25000" />

                     <settingname="safeRowBoundsEnabled" value="false" />

                     <setting name="mapUnderscoreToCamelCase"value="false" />

                     <setting name="localCacheScope"value="SESSION" />

                     <setting name="jdbcTypeForNull"value="OTHER" />

                     <settingname="lazyLoadTriggerMethods" value="equals,clone,hash Code ,toString" />

                     <setting name="proxyFactory" value="JAVASSIST"/>

                     <settingname="aggressiveLazyLoading" value="true" />

                     <setting name="logImpl"value="LOG4J " />

                     <setting name="logPrefix"value="LOG4J " />

                     <settingname="callSettersOnNulls" value="false " />

                   </settings>

      <settings>

                     <!-- 这个配置使全局的映射器启用或禁用缓存 -->

                     <setting name="cacheEnabled"value="true" />

 

                     <!-- 全局启用或禁用延迟加载。当禁用时，所有关联对象都会即时加载 -->

                     <settingname="lazyLoadingEnabled" value="true" />

 

                     <!-- 允许或不允许多种结果集从一个单独的语句中返回（需要适合的驱动） -->

                     <setting name="multipleResultSetsEnabled"value="true" />

 

                     <!-- 使用列标签代替列名。不同的驱动在这方便表现不同。参考驱动文档或充分测试两种方法来决定所使用的驱动 -->

                     <setting name="useColumnLabel"value="true" />

 

                     <!-- 允许JDBC支持生成的键。需要适合的驱动。 -->

                     <setting name="useGeneratedKeys"value="false" />

 

                     <!--指定MyBatis如何自动映射列到字段/属性。PARTIAL只会自动映射简单、没有嵌套的结果。FULL会自动映射任意复杂的结果（嵌套的或其他情况） -->

                     <settingname="autoMappingBehavior" value="PARTIAL" />

                    

                     <!-- 配置默认的执行器。SIMPLE执行器没有什么特别之处。REUSE执行器重用预处理语句。BATCH执行器重用语句和批量更新 -->

                     <setting name="defaultExecutorType"value="SIMPLE" />

 

                     !-- 设置超时时间，它决定驱动等待一个数据库响应的时间 -->

                     <settingname="defaultStatementTimeout" value="25000" />

                    

                     <!-- 允许在嵌套语句中使用分页（RowBounds）默认false -->

                     <settingname="safeRowBoundsEnabled" value="false" />

 

                     <!-- 是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。默认false -->

                     <settingname="mapUnderscoreToCamelCase" value="false" />

 

                     <!-- MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。 -->

                     <setting name="localCacheScope"value="SESSION" />

 

                     <!-- 当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。 -->

                     <setting name="jdbcTypeForNull"value="OTHER" />

 

                     <!-- 指定对象的哪个方法触发一次延迟加载。 -->

                     <settingname="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString" />

 

                     <!-- CGLIB | JAVASSIST 默认JAVASSIST(MyBatis 3.3 or above)  -->

                     <!-- 指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。 -->

                     <setting name="proxyFactory"value="JAVASSIST" />

                     <!-- 当启用时，对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性将会按需加载。 -->

                     <settingname="aggressiveLazyLoading" value="true" />

                           

                     <!-- 指定 MyBatis 所用日志的具体实现，未指定时将自动查找。 -->

                     <setting name="logImpl"value="LOG4J " />

 

                     <!-- 指定 MyBatis 增加到日志名称的前缀。值可以是任意字符串 -->

                     <setting name="logPrefix"value="LOG4J " />

 

                     <!-- 指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型（int、boolean等）是不能设置成 null 的。默认false-->

                     <settingname="callSettersOnNulls" value="false " />

                   </settings>

8) mappers元素: SQL映射

                   SQLMapper文件中包含的SQL映射语句将会被应用通过使用其标签中的id值来执行。我们需要在mybatis-config.xml文件中配置SQLMapper文件的位置。

                   <mappers>

                     <mapperresource="com/briup/mappers/StudentMapper.xml" />

                     <mapperurl="file:///D:/mybatisdemo/app/mappers/StudentMapper.xml" />

                     <mapperclass="com.briup.mappers.StudentMapper" />

                     <packagename="com.briup.mappers" />

                   </mappers>

 

                   以上每一个<mapper> 标签都可以从不同类型的资源中加载映射mapper：

                   resource属性用来指定在classpath中的mapper文件。

                   url属性用来通过完全文件系统路径或者web URL地址来指向mapper文件

                   class属性用来指向一个mapper接口

                   package属性用来指向可以找到Mapper接口的包名

4.       mybatis的映射文件：XXXXMapper.xml

<?xmlversion="1.0" encoding="utf-8"?>

            <!DOCTYPEmapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"

            "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

            <mappernamespace="com.briup.mappers.StudentMapper">

              <select id="findStudentById"parameterType="int" resultType="Student">

                     selectstud_id as studId, name, email, dob 

                     fromstudents where stud_id=#{studId}

              </select>

           </mapper>

5.       mybatisz中的接口：SqlSession接口和SqlSessionFactory接口

InputStream inputStream =Resources.getResourceAsStream("mybatis-config.xml");

SqlSessionFactory sqlSessionFactory = newSqlSessionFactoryBuilder().build(inputStream);

SqlSession sqlSession =sqlSessionFactory.openSession();

StudentMapper studentMapper =sqlSession.getMapper(StudentMapper.class);

6.       配置log4j.properties文件中的日志输出:

位置src下面

                     内容:

                 

    log4j.rootLogger=DEBUG,stdout

                      log4j.appender.stdout=org.apache.log4j.ConsoleAppender

                     log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

                     log4j.appender.stdout.layout.ConversionPattern=%d[%-5p] %c - %m%n

                     #showsql

                     log4j.logger.java.sql.ResultSet=INFO 

                     log4j.logger.org.apache=INFO 

                     log4j.logger.java.sql.Connection=DEBUG 

                     log4j.logger.java.sql.Statement=DEBUG 

                    log4j.logger.java.sql.PreparedStatement=DEBUG