MyBatis的技术简介

最新推荐文章于 2024-04-10 16:18:47 发布

粒粒lililili

最新推荐文章于 2024-04-10 16:18:47 发布

阅读量2.2k

点赞数

分类专栏： Java开发文章标签： mybatis xml java

本文链接：https://blog.csdn.net/tvxqwanne/article/details/75354895

版权

Java开发专栏收录该内容

7 篇文章 0 订阅

订阅专栏

1. 简介

MyBatis避免了几乎所有的JDBC代码和手动设置参数及获取结果集
对配置和原生Map使用简单的XML或注解，将接口和Java的POJOs映射成数据库中的记录
- > ORM, Object Relation Mapping 对象关系映射
- > XML, eXtensible Markup Language 可扩展标记语言
- > POJO, Plain Ordinary Java Object 简单Java对象

2. 入门

　　使用Maven构建项目，将以下代码之余pom.xml文件中。

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>

2.1 从XML中构建SqlSessionFactory

　　每个Mybatis应用的中心 -> 一个SqlSessionFactory实例 -> 通过SqlSessionFactoryBuilder获得 -> XML配置文件或预先定制的Configuration实例构建SqlSessionFactory实例。　　所以此部分介绍SqlSessionFactoryBuilder通过XML配置文件构建SqlSessionFactory实例的方法。

建议使用类路径下的资源文件进行配置
也可以使用任意的输入流(InputStream)实例，包括字符串形式的文件路径或者 file:// 的 URL 形式的文件路径来配置

String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

XML配置文件(configuration XML)：包含对 MyBatis 系统的核心设置
- 获取数据库连接实例的数据源（DataSource）
- 决定事务作用域和控制方式的事物管理器（TransactionManager）

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/> //事物管理器
      <dataSource type="POOLED">  // 数据源
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers> // 包含一组mapper映射器
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

2.2 不使用XML构建SqlSessionFactory - From Java

DataSource dataSource = BlogDataSourceFactory.getBlogDataSource(); // 数据源
TransactionFactory transactionFactory = new JdbcTransactionFactory(); // 事务管理器
Environment environment = new Environment("development", transactionFactory, dataSource);  // 环境元素体
Configuration configuration = new Configuration(environment); // 配置类
configuration.addMapper(BlogMapper.class); // 映射器类
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

映射器类是 Java 类，它们包含 SQL 映射语句的注解从而避免了 XML 文件的依赖。
如果存在一个对等的 XML 配置文件的话，MyBatis 会自动查找并加载它（这种情况下， BlogMapper.xml 将会基于类路径和 BlogMapper.class 的类名被加载进来）。

2.3 从SqlSessionFactory中获取SqlSession

　　SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法。可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。
旧方法：　　

SqlSession session = sqlSessionFactory.openSession();
try {
  Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
} finally {
  session.close();
}

新方法：

SqlSession session = sqlSessionFactory.openSession();
try {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  Blog blog = mapper.selectBlog(101);
} finally {
  session.close();
}

已映射SQL语句

旧方法是基于XML定义的：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper 
// 在命名空间"org.mybatis.example.BlogMapper"中定义了一个名为"selectBlog"的映射语句
//调用时使用完全指定名“org.mybatis.example.BlogMapper.selectBlog”
namespace="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

3. XML映射配置文件　

configuration 配置
- properties 属性
- settings 设置
- typeAliases 类型命名
- typeHandlers 类型处理器
- objectFactory 对象工厂
- plugins 插件
- environments 环境
  - environment 环境变量
    - transactionManager 事务管理器
    - dataSource 数据源
- databaseIdProvider 数据库厂商标识
- mappers 映射器

3.1 properties 属性

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

属性可以在整个配置文件中使用，来替换需要动态配置的属性值：

<dataSource type="POOLED">
// driver和url属性由config.properties中对应的值替换
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
// username和password由properties元素中设置的值替换
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

属性也可以被传递到SqlSessionFactoryBuilder.build()方法中

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props);
// ... or ...
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);

属性配置优先级：
- properties元素体 < properties元素中的resource属性读取类路径下属性文件 / 根据url属性指定路径读取属性文件 < 作为方法参数传递的属性

3.2 settings 设置

<settings>
  <setting name="cacheEnabled" value="true"/>
  <setting name="lazyLoadingEnabled" value="true"/>
  <setting name="multipleResultSetsEnabled" value="true"/>
  <setting name="useColumnLabel" value="true"/>
  <setting name="useGeneratedKeys" value="false"/>
  <setting name="autoMappingBehavior" value="PARTIAL"/>
  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <setting name="defaultStatementTimeout" value="25"/>
  <setting name="defaultFetchSize" value="100"/>
  <setting name="safeRowBoundsEnabled" value="false"/>
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <setting name="localCacheScope" value="SESSION"/>
  <setting name="jdbcTypeForNull" value="OTHER"/>
  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>

戳 -> 完整设置参数查询

3.3 typeAliases 类型命名

减少类完全限定名称的冗余

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  // Blog可用在任何使用domain.blog.Blog的地方
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
</typeAliases>

可指定包名，搜索需要的Java Bean

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

默认Bean的首字母小写的非限定类名作为别名（没有注解时）
- 如domain.blog.Author的别名为author

3.4 typeHandlers 类型处理器

　　MyBatis在预处理语句（PreparedStatement）中设置参数，或从结果集中取出值，都会使用类型处理器将值转换成Java类型。
　　戳 -> 默认类型处理器

重写类型处理器或自创：
- 实现org.apache.ibatis.type.TypeHandler 接口
- 或继承 org.apache.ibatis.type.BaseTypeHandler类

// ExampleTypeHandler.java
@MappedJdbcTypes(JdbcType.VARCHAR)
public class ExampleTypeHandler extends BaseTypeHandler<String> {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
    ps.setString(i, parameter);
  }

  @Override
  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
    return rs.getString(columnName);
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    return rs.getString(columnIndex);
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    return cs.getString(columnIndex);
  }
}

<!-- mybatis-config.xml -->
<typeHandlers>
  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>

3.5 objectFactory 对象工厂

　　MyBatis 使用对象工厂（ObjectFactory）实例来创建结果对象的实例。默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认构造方法，要么在参数映射存在的时候通过参数构造方法来实例化。如果想覆盖对象工厂的默认行为，则可以通过创建自己的对象工厂来实现。比如：
　　

// ExampleObjectFactory.java
public class ExampleObjectFactory extends DefaultObjectFactory {
  // 默认构造方法
  public Object create(Class type) {
    return super.create(type);
  }
  // 带参数构造方法
  public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {
    return super.create(type, constructorArgTypes, constructorArgs);
  }
  // setProperties方法用来配置ObjectFactory
  public void setProperties(Properties properties) {
    super.setProperties(properties);
  }
  public <T> boolean isCollection(Class<T> type) {
    return Collection.class.isAssignableFrom(type);
  }}

<!-- mybatis-config.xml -->
<objectFactory type="org.mybatis.example.ExampleObjectFactory">
  <property name="someProperty" value="100"/>
</objectFactory>

3.6 plugins 插件

　　MyBatis 允许在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

Executor (update, query, flushStatements, commit, rollback,　getTransaction, close, isClosed)
ParameterHandler　(getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)

　　通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。

// ExamplePlugin.java
@Intercepts({@Signature(
  //拦截Executor实例中所有update方法的调用
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  public Object intercept(Invocation invocation) throws Throwable {
    return invocation.proceed();
  }
  public Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }
  public void setProperties(Properties properties) {
  }
}

<!-- mybatis-config.xml -->
<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

上面的插件将会拦截在 Executor 实例中所有的 “update” 方法调用，这里的 Executor 是负责执行低层映射语句的内部对象。

NOTE 覆盖配置类

除了用插件来修改 MyBatis 核心行为之外，还可以通过完全覆盖配置类来达到目的。只需继承后覆盖其中的每个方法，再把它传递到 SqlSessionFactoryBuilder.build(myConfig) 方法即可。再次重申，这可能会严重影响 MyBatis 的行为，务请慎之又慎。

3.7 environments 环境

MyBatis可以配置多个环境，但每个 SqlSessionFactory实例只能选择其一
每个数据库对应一个 SqlSessionFactory实例
指定创建的环境 -> 参数传递给SqlSessionFactoryBuilder

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment,properties);
// 省略环境参数时，加载默认环境
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader,properties);

配置环境的环境元素：

// 默认环境ID
<environments default="development">
  // 环境元素定义的环境ID
  <environment id="development">
    // 事务管理器
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    // 数据源
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

3.7.1 事务管理器

两种类型
- JDBC：直接使用JDBC的提交和回滚设置，依赖于从数据源得到的连接来管理事务作用域
- MANAGED：从来不提交或回滚连接，通过容器管理事务的整个生命周期（如JEE应用服务器的上下文容器），默认关闭连接。

NOTE：使用Spring+MyBatis不需要配置事务管理器

3.7.2 数据源

　　dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

三种数据源类型
- UNPOOLED：这个数据源的实现只是每次被请求时打开和关闭连接。仅仅需要配置以下 5 种属性：
  - driver – JDBC 驱动的 Java 类的完全限定名（并不是JDBC驱动中可能包含的数据源类）
  - url – 数据库的 JDBC URL 地址
  - username – 登录数据库的用户名
  - password – 登录数据库的密码
  - defaultTransactionIsolationLevel – 默认的连接事务隔离级别
- POOLED– 利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时的初始化和认证时间，使并发 Web 应用快速响应请求。除UNPOOLED外的属性：
  - poolMaximumActiveConnections – 任意时间的最大活动连接数量，默认值：10
  - poolMaximumIdleConnections – 任意时间的最大空闲连接数。
  - poolMaximumCheckoutTime - 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000ms（即 20 秒）
  - poolTimeToWait – 这是一个底层设置，如果获取连接花费的相当长的时间，它会给连接池打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直安静的失败），默认值：20000ms（即 20 秒）。
  - poolPingQuery – 发送到数据库的侦测查询，用来检验连接是否处在正常工作秩序中并准备接受请求。默认是“NO PING QUERY SET”。
  - poolPingEnabled – 是否启用侦测查询。若开启，也必须使用一个可执行的 SQL 语句设置 poolPingQuery 属性（最好是一个非常快的 SQL），默认值：false。
  - poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的使用频度。这可以被设置成匹配具体的数据库连接超时时间，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测）
- JNDI – 这个数据源的实现在 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性：
  - initial_context – 在 InitialContext 中寻找上下文（即initialContext.lookup(initial_context)）。可选属性，如果忽略，那么 data_source 属性将会直接从 InitialContext 中寻找。
  - data_source – 引用数据源实例位置的上下文的路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。

3.8 databaseIdProvider 数据库厂商标识

支持多厂商特性（基于映射语句中的databaseId属性）：在mybatis-config.xml文件中加入：

<databaseIdProvider type="DB_VENDOR" />

DB_VENDOR通过DatabaseMetaData#getDatabaseProductName() 返回的字符串进行设置

<databaseIdProvider type="DB_VENDOR">
  <property name="SQL Server" value="sqlserver"/>
  <property name="DB2" value="db2"/>        
  <property name="Oracle" value="oracle" />
</databaseIdProvider>

3.9 mappers 映射器

定义SQL映射语句

相对类路径的资源引用

<!-- Using classpath relative resources -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
</mappers>

完全限定资源定位符

<!-- Using url fully qualified paths -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
</mappers>

类名

<!-- Using mapper interface classes -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
</mappers>

包名

<!-- Register all interfaces in a package as mappers -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

Mapper的使用

public static void main(String[] args) {
    // 准备工作
    InputStream inputStream = null;
    try {
        // CONFIG_LOCATION的值即为MyBatis配置文件的路径
        inputStream = Resources.getResourceAsStream(CONFIG_LOCATION);
    } catch (IOException e) {
        e.printStackTrace();
    }
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    SqlSession sqlSession = sqlSessionFactory.openSession();

    try {
        // 获取mapper            
        QuestionMapper questionMapper = sqlSession.getMapper(QuestionMapper.class);
        // 调用mapper方法
        Question question = questionMapper.findOne((long) 1);
        System.out.println(question);
    } finally {
        // 最后一定关闭SqlSession
        sqlSession.close();
    }
}

// 定义Mapper接口
package com.tianmaying.qa.mapper;
import com.tianmaying.qa.model.Question;
import org.apache.ibatis.annotations.Param;
public interface QuestionMapper {
// @Param是MyBatis提高的一个标注，表示id会解析成SQL语句（SQL语句会在XML配置或者标注中）的参数
        Question findOne(@Param("id") Long id);    
}

　　对应于Mapper接口，还需要通过XML来给出Mapper的实现。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.tianmaying.qa.mapper.QuestionMapper">  
  <select id="findOne" resultType="com.tianmaying.qa.model.Question">
    SELECT * FROM question WHERE question.id = #{id}
  </select>
</mapper>

对应于每一个Mapper的Java接口方法，XML配置中有对应的一个元素来描述其SQL语句
resultType元素定义了数据库返回（一行记录）如何映射到一个Java对象

粒粒lililili

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
1
评论
MyBatis的技术简介

1. 简介MyBatis避免了几乎所有的JDBC代码和手动设置参数及获取结果集对配置和原生Map使用简单的XML或注解，将接口和Java的POJOs映射成数据库中的记录 > ORM, Object Relation Mapping 对象关系映射 > XML, eXtensible Markup Language 可扩展标记语言 > POJO, Plain Ordinary
复制链接

扫一扫