文章目录
简介
1、什么是 MyBatis？
MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。
入门
1、安装
如果我们使用的是Maven来管理我们的项目，那么我们只需要引入对应的pom依赖，就可以安装MyBatis
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>x.x.x</version>
</dependency>
2、从 XML 中构建 SqlSessionFactory
SqlSessionFactory 和 SqlSessionFactoryBuilder
每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
批注：
在明白了获取SqlSessionFactory的逻辑之后，我们常见的通过SqlSessionFactoryBuilder获取SqlSessionFactory的做法是，编写一个工具类，后期使用改为直接调用该方法即可。
public class MybatisUtil {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
// 1.获取对应数据
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (Exception e) {
e.printStackTrace();
}
}
// 2. 提供给外部一个静态的调用方法
public static SqlSession getSqlSession() {
// 3. 方法内部调用SqlSession的方法
return sqlSessionFactory.openSession();
}
public class Test {
@Test
public void test() {
// 1、获得SqlSession对
SqlSession sqlSession = MybatisUtil.getSqlSession();
try {
// 2、方法一：getMapper(推荐使用)
UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.getUserList();
// 2、方法二：
List<User> userList1 = sqlSession.selectList("pers.mobian.dao.UserDao.getUserList");
// 3、遍历数据，打印输出
for (User user : userList) {
System.out.println(user.toString());
}
} catch (Exception e) {
e.printStackTrace();
} finally {
// 4、关闭资源
sqlSession.close();
}
}
}
1、SqlSessionFactoryBuilder.build(X)
2、SqlSessionFactoryBuilder.build(X).openSession()
但当我们真正结合Spring进行项目的搭建时，我们则是将该资源以Bean的方式注入到Spring的容器中。如下所示的代码：（只展示了重点代码）
由于Spring配置实例都是以Bean的方式进行，比较灵活。所以我们配置dataSource即可以在MyBatis-config.xml文件中，也可以是在applicationContext.xml中
<!--配置Mybatis工厂SqlSessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 注入数据源-->
<property name="dataSource" ref="dataSource"/>
<!--指定该MyBatis配置文件位置-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
</bean>
---- dataSource ：数据源，配置连接的数据库的相关信息 ----
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="com.mysql.jdbc.Driver"/>
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/managementsystem?characterEncoding=utf8" />
<property name="user" value="root" />
<property name="password" value="123456" />
<!-- 最大连接数 -->
<property name="maxPoolSize" value="30"/>
<!-- 最小连接数 -->
<property name="minPoolSize" value="10"/>
<!-- 初始化连接数 -->
<property name="initialPoolSize" value="5"/>
</bean>
---- mybatis-config.xml ：MyBatis的配置文件 ----
<?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>
<!-- 别名定义 -->
<typeAliases>
<package name="pers.mobian.entity" />
</typeAliases>
<mappers>
<!-- 映射文件的位置 -->
<mapper resource="mapper/AdminDao.xml"/>
</mappers>
</configuration>
3、不使用 XML 构建 SqlSessionFactory
如果你更愿意直接从 Java 代码而不是 XML 文件中创建配置，或者想要创建你自己的配置建造器，MyBatis 也提供了完整的配置类，提供了所有与 XML 文件等价的配置项。
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);
注意该例中，configuration 添加了一个映射器类（mapper class）。映射器类是 Java 类，它们包含 SQL 映射注解从而避免依赖 XML 文件。不过，由于 Java 注解的一些限制以及某些 MyBatis 映射的复杂性，要使用大多数高级映射（比如：嵌套联合映射），仍然需要使用 XML 配置。有鉴于此，如果存在一个同名 XML 配置文件，MyBatis 会自动查找并加载它（在这个例子中，基于类路径和 BlogMapper.class 的类名，会加载 BlogMapper.xml）。具体细节稍后讨论。
4、域（Scope）和生命周期
SqlSessionFactoryBuilder 、SqlSessionFactory、SqlSession
对象生命周期和依赖注入框架：
依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器，并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。 如果对如何通过依赖注入框架使用 MyBatis 感兴趣，可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。
SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。
SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。
SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式：
批注：
我们前文有描述过一个工具类，它包含了SqlSessionFactoryBuilder创建SqlSessionFactory的方式，并且将对应的创建的SqlSession的操作也封装进去了，所以我们在使用工具类的时候，可以直接获取到SqlSession
public class Test {
@Test
public void test() {
SqlSession sqlSession = MybatisUtil.getSqlSession();
try {
UserDao userDao = sqlSession.getMapper(UserDao.class);
// 你的应用逻辑代码
} catch (Exception e) {
e.printStackTrace();
} finally {
sqlSession.close();
}
}
}
官方文档的做法和我的做法略有差异，但道理相通！
// 1、先构建SqlSessionFactory对象
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2、在try中获取对应的SqlSession
try (SqlSession session = sqlSessionFactory.openSession()) {
BlogMapper mapper = session.getMapper(BlogMapper.class);
// 你的应用逻辑代码
}
5、探究已映射的 SQL 语句
一个简单的执行SQL案例
<?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="org.mybatis.example.BlogMapper">
<select id="selectBlog" resultType="Blog">
select * from Blog where id = #{id}
</select>
</mapper>
调用方式一：
try (SqlSession session = sqlSessionFactory.openSession()) {
Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
}
调用方式二：
try (SqlSession session = sqlSessionFactory.openSession()) {
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);
}
第二种方法有很多优势，首先它不依赖于字符串字面值，会更安全一点；其次，如果你的 IDE 有代码补全功能，那么代码补全可以帮你快速选择到映射好的 SQL 语句。
命名空间
在之前版本的 MyBatis 中，**命名空间（Namespaces）**的作用并不大，是可选的。 但现在，随着命名空间越发重要，你必须指定命名空间。
命名空间的作用有两个，一个是利用更长的全限定名来将不同的语句隔离开来，同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定，你也应该遵循这里的规定，以防哪天你改变了主意。 长远来看，只要将命名空间置于合适的 Java 包命名空间之中，你的代码会变得更加整洁，也有利于你更方便地使用 MyBatis。
**命名解析：**为了减少输入量，MyBatis 对所有具有名称的配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。
- 全限定名（比如 “com.mypackage.MyMapper.selectAllThings）将被直接用于查找及使用。
- 短名称（比如 “selectAllThings”）如果全局唯一也可以作为一个单独的引用。 如果不唯一，有两个或两个以上的相同名称（比如 “com.foo.selectAllThings” 和 “com.bar.selectAllThings”），那么使用时就会产生“短名称不唯一”的错误，这种情况下就必须使用全限定名。
批注：
命名空间的命名规则没有过多的要求，但一定要做到全局唯一。
使用注解配置SQL
常规的SQL映射集，我们都是先编写一个Mapper接口，然后根据对应的Mapper接口创建一个Mapper.xml的SQL映射文件，在映射文件中编写我们的SQL。但是如果我们的SQL知识一条十分简单的操作，那么我们就可以省去新建Mapper.xml文件的繁琐操作，直接使用注解的方式在Mapper接口中进行编写。如：
public interface BlogMapper {
@Select("SELECT * FROM blog WHERE id = #{id}")
Blog selectBlog(int id);
}
使用注解来映射简单语句会使代码显得更加简洁，但对于稍微复杂一点的语句，Java 注解不仅力不从心，还会让你本就复杂的 SQL 语句更加混乱不堪。 因此，如果你需要做一些很复杂的操作，最好用 XML 来映射语句。
选择何种方式来配置映射，以及认为是否应该要统一映射语句定义的形式，完全取决于你和你的团队。 换句话说，永远不要拘泥于一种方式，你可以很轻松的在基于注解和 XML 的语句映射方式间*移植和切换。