本文目标
- 掌握MyBatis基础组件及其使用、MyBatis的使用方法
- 掌握基础组件的生命周期及其实现方法
- 掌握入门实例
MyBatis优点
- 不屏蔽SQL,可以对其进行优化和改造
- 提供强大、灵活的映射机制。提供动态SQL的功能
- 提供了使用Mapper的接口编程,只要一个接口和一个XML就能创建映射器
MyBatis的核心组件
- SqlSessionFactoryBuilder(构造器): 它会根据配置或者代码来生成SqlSessionFactory,采用的是分步构建的Builder模式
- SqlSessionFactory(工厂接口):依靠它来生成SqlSession,使用的是工厂模式
- SqlSession(会话):一个既可以发送SQL执行返回结果,也可以获取Mapper的接口
- SQL Mapper(映射器): 它由一个Java接口和XML文件(或注解)构成。
SqlSessionFactory
在MyBatis中,即可以通过读取配置的XML文件也可以通过Java代码的形式去生成SqlSessionFactory。
XML构建SqlSessionFactory
生成SqlSessionFactory
String resource = "com/whyalwaysmea/config/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
Java代码创建SqlSessionFactory
// 数据库连接池信息
PooledDataSource dataSource = new PooledDataSource();
dataSource.setDriver("com.mysql.jdbc.Driver");
dataSource.setUsername("root");
dataSource.setPassword("root");
dataSource.setUrl("jdbc:mysql://127.0.0.1:3306/test");
// 是否自动提交
dataSource.setDefaultAutoCommit(false);
JdbcTransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
// 创建Configuration对象
Configuration configuration = new Configuration(environment);
// 注册一个MyBatis上下文别名
configuration.getTypeAliasRegistry().registerAlias("role", Role.class);
// 加入一个映射器
configuration.addMapper(RoleMapper.class);
// 使用SqlSessionFactoryBuilder构建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration)
通过比较两种方式,可以发现使用Java代码生成SqlSessionFactory的方式代码冗长,如果发生修改,需要重新编译代码才能继续。
所以一般推荐使用XML的方式进行配置。
SqlSession
在MyBatis中有两个实现类,DefaultSqlSession
和 SqlSessionManager
。DefaultSqlSession
是单线程使用的,而SqlSessionManager
在多线程环境下使用。SqlSession的作用类似于一个JDBC的Connection对象,它的作用有3个:
- 获取Mapper接口
- 发送SQL给数据库
- 控制数据库事务
基本使用:
// 定义SqlSession
SqlSession sqlSession = null;
try {
// 打开SqlSession会话
sqlSession = SqlSessionFactory.openSession();
// some code..
sqlSession.commit(); // 提交事务
} catch(Exception ex) {
sqlSession.rollback(); // 回滚事务
} finally {
// 在finally语句中确保资源被顺利关闭
if(sqlSession != null) {
sqlSession.close();
}
}
映射器
映射器它由一个接口和对应的XML文件(或注解组成)。它可以配置以下内容:
- 描述映射规则
- 提供SQL语句,并可以配置SQL参数类型、返回类型、缓存刷新等
- 配置缓存
- 提供动态SQL
在进行具体的映射器实现之前,我们先建立一个POJO(Plain Ordinary Java Object)。映射器的主要作用就是将SQL查询到的结果映射成为一个POJO,或者将POJO的数据插入到数据库中,并定义一些关于缓存等的内容。
package com.whyalwaysmea.pojo;
public class Role {
private Long id;
private String roleName;
private String note;
/** setter and getter **/
}
用XML实现映射器
用xml定义映射器分为两个部分:接口和xml。
// 映射器接口
public interface RoleMapper {
public Role getRole(Long id);
}
这里需要注意的是,xml文件的路径要与配置SqlSessionFactory时添加的映射文件路径相对应。
注解实现映射器
public interface RoleMapper2 {
@Select("select id, role_name as roleName, note from t_role where id=#{id}")
public Role getRole(Long id);
}
当然也需要在mybatis-config.xml文件中配置了
使用注解的方式也许会让你觉得比XML方式要简单得多。如果它和XML方式同时定义,XML方式将会覆盖掉注解方式,所以MyBatis官方推荐使用的是XML方式。
因为在平常的工作中,SQL的会比较复杂,比如有一些动态条件,所以使用XML的方式会更灵活。
SqlSession发送SQL
有了映射器就可以通过SqlSession发送SQL了。
SqlSession session = SqlSessionFactoryUtils.openSqlSession();
// selectOne表示查询并且只返回一个对象,参数是一个String对象和一个Object对象
// String对象是由一个命名空间加上SQL id组合而成的。
// Role role = session.selectOne("com.whyalwaysmea.mapper.RoleMapper.getRole", 1L);
// 如果在MyBatis中只有一个id为getRole的SQL,那么可以简写
Role role = session.selectOne("getRole", 1L);
System.out.println(role.toString());
用Mapper接口发送SQL
SqlSession session = SqlSessionFactoryUtils.openSqlSession();
RoleMapper roleMapper = session.getMapper(RoleMapper.class);
Role role = roleMapper.getRole(1L)
对比两种发送SQL方式
个人建议采用SqlSession获取Mapper的方式:
- 使用Mapper接口编程可以消除SqlSession带来的功能性代码,提高可读性,而SqlSession发送SQL,需要一个SQL id去匹配SQL。
-
- 使用Mapper.getRole(1L)的方式,IDE会提示错误和校验
生命周期
所谓生命周期就是每一个对象应该存活的时间,比如一些对象一次用完后就要关闭,使它们被Java虚拟机销毁,以避免继续占用资源。
SqlSessionFactoryBuilder
SqlSessionFactoryBuilder 的作用在于创建SqlSessionFactory,创建成功后,SqlSessionFactoryBuilder 就失去了作用,所以它只能存在于创建SqlSessionFactoryBuilder 的方法中,而不要让其长期存在
SqlSessionFactory
SqlSessionFactory可以被认为是一个数据库连接池,它的作用是创建SqlSession接口对象。因为MyBatis的本质就是Java对数据库的操作,所以SqlSessionFactory的生命周期应该存在于整个MyBatis应用之中。
由于SqlSessionFactory是一个对数据库的连接池,所以它占据着数据库的连接资源。如果创建多个SqlSessionFactory,那么就存在多个数据库连接池,这样不利于对数据库资源的控制。因为在一般的应用中我们希望SqlSessionFactory作为一个单例
SqlSession
如果说SqlSessionFactory相当于数据库连接池,那么SqlSession就相当于一个数据库连接(Connection对象)。所以它应该存活在一个业务请求中,处理完整个请求后,应该关闭这条连接。
Mapper
Mapper是一个接口,它由SqlSession所创建,所以它的最大生命周期至多和SqlSession保持一致。
实例
在经过了简单的了解之后,我们完成一个对角色表的增、删、改、查。 这里就直接给出代码地址好了
代码
初始MyBatis