MyBatis快速入门（03）入门例子说明

￡神魔★判官ぃ 2022-12-08 14:22 92阅读 0赞

前面一起写了一个mybatis的入门例子，下面来针对例子进行一些补充说明。

# 使用Java代码 构建 SqlSessionFactory #

如果你更愿意直接从 Java 代码而不是 XML 文件中创建配置，或者想要创建你自己的配置构建器，MyBatis 也提供了完整的配置类，提供所有和 XML 文件相同功能的配置项。示例如下：

![0fb8dec5ae211baa8e393ab48144127d.png][]

上面的例子中每个类代表什么后面会详细说。注意该例中，configuration 添加了一个映射器类（UserMapper.class）。映射器类是 Java 类，它们直接执行带有SQL语句注解的Java方法，从而避免依赖 XML 文件。简单的sql语句是可以直接写在类中的注解上的，例如：

![c818ac8140bce9b2e77e75823cefea9f.png][]

不过，由于 Java 注解的一些限制以及某些 MyBatis 映射的复杂性，要使用大多数高级映射（比如：嵌套查询），仍然需要使用 XML 配置。有鉴于此，功能复杂的情况下最好还是使用xml定义sql。

使用注解来映射简单语句会使代码显得更加简洁，然而对于稍微复杂一点的语句，Java 注解就力不从心了，并且会显得更加混乱。 因此，如果你需要完成很复杂的事情，那么最好使用 XML 来映射语句。

选择何种方式来配置映射，以及认为映射语句定义的一致性是否重要，这些完全取决于你和你的团队。 换句话说，永远不要拘泥于一种方式，你可以很轻松的在基于注解和 XML 的语句映射方式间自由移植和切换。

# 新旧SqlSession的使用方法 #

从SqlSessionFactory中获得 SqlSession 的实例后，可以用来操作数据，SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：

![e7e20ea2482d1f0810982f8cc1e743a5.png][]

诚然，这种方式能够正常工作，并且对于使用旧版本 MyBatis 的用户来说也比较熟悉。不过现在有了一种更简洁的方式 ——使用正确描述每个语句的参数和返回值的接口（比如 UserMapper.class），你现在不仅可以执行更清晰和类型安全的代码，而且还不用担心易错的字符串字面值以及强制类型转换。例如：

![0c2326a1025674e31a70b2cb05d3a7ae.png][]

第二种方法有很多优势，首先它不依赖于字符串字面值，会更安全一点； 其次，如果你的 IDE 有代码补全功能，那么代码补全可以帮你快速选择已映射的 SQL 语句。

> 提示：**对命名空间的一点说明**
> 
> 在之前版本的 MyBatis 中，**命名空间（Namespaces）**的作用并不大，是可选的。 但现在，随着命名空间越发重要，你必须指定命名空间。
> 
> 命名空间的作用有两个，一个是利用更长的完全限定名来将不同的语句隔离开来，同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定，你也应该遵循这里的规定，以防哪天你改变了主意。 长远来看，只要将命名空间置于合适的 Java 包命名空间之中，你的代码会变得更加整洁，也有利于你更方便地使用 MyBatis。
> 
> **命名解析：**为了减少输入量，MyBatis 对所有的命名配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。
> 
> 完全限定名（比如 “com.mypackage.MyMapper.selectAllThings）将被直接用于查找及使用。
> 
> 短名称（比如 “selectAllThings”）如果全局唯一也可以作为一个单独的引用。 如果不唯一，有两个或两个以上的相同名称（比如 “com.foo.selectAllThings” 和 “com.bar.selectAllThings”），那么使用时就会产生“短名称不唯一”的错误，这种情况下就必须使用完全限定名。

# 作用域（Scope）和生命周期 #

> 提示： **对象生命周期和依赖注入框架**
> 
> 依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器，并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。因此在使用spring或者guice整合mybatis的时候，可以忽略生命周期。 如果对如何通过依赖注入框架来使用 MyBatis 感兴趣，可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。

**SqlSessionFactoryBuilder**

SqlSessionFactory 的实例通过 SqlSessionFactoryBuilder 获得。这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但是最好还是不要让其一直存在，以保证所有的 XML 解析资源可以被释放给更重要的事情。

[**SqlSessionFactory**][SqlSessionFactory]

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏味道（bad smell）”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

[SqlSession][SqlSessionFactory]

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。 换句话说，每次收到的 HTTP 请求，就可以打开一个 SqlSession，返回一个响应，就关闭它。 这个关闭操作是很重要的，你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。 下面的示例就是一个确保 SqlSession 关闭的标准模式：

![8aa86fbb794b06e55e0d5a306e1c7b48.png][]

在你的所有的代码中一致地使用这种模式来保证所有数据库资源都能被正确地关闭。

# 映射器（Mapper）实例 #

映射器是一些由你创建的、绑定你映射的语句的接口。映射器接口的实例是从 SqlSession 中获得的。因此从技术层面讲，任何映射器实例的最大作用域是和请求它们的 SqlSession 相同的。尽管如此，映射器实例的最佳作用域是方法作用域。 也就是说，映射器实例应该在调用它们的方法中被请求，用过之后即可丢弃。 并不需要显式地关闭映射器实例，尽管在整个请求作用域保持映射器实例也不会有什么问题，但是你很快会发现，像 SqlSession 一样，在这个作用域上管理太多的资源的话会难于控制。 为了避免这种复杂性，最好把映射器放在方法作用域内。下面的示例就展示了这个实践：

![adf9634c6853d7336c8202e822636db7.png][]

代码地址：[https://gitee.com/blueses/mybatis-demo][https_gitee.com_blueses_mybatis-demo] 02

[0fb8dec5ae211baa8e393ab48144127d.png]: /images/20221123/69e1dd445ffe48ee988469d25fb74db1.png
[c818ac8140bce9b2e77e75823cefea9f.png]: /images/20221123/ac2ad896d420493a9fcce8ccc50fef1c.png
[e7e20ea2482d1f0810982f8cc1e743a5.png]: /images/20221123/7785ad8cca374db9ad675c5ef5e23ffa.png
[0c2326a1025674e31a70b2cb05d3a7ae.png]: /images/20221123/130bb2c35c8840be9f7f0f4db1a5dadf.png
[SqlSessionFactory]: https://www.jianshu.com/writer
[8aa86fbb794b06e55e0d5a306e1c7b48.png]: /images/20221123/e155c05a0a6744e485664b41683de173.png
[adf9634c6853d7336c8202e822636db7.png]: /images/20221123/83ebe1f3903f4acc92f78b67523e9319.png
[https_gitee.com_blueses_mybatis-demo]: https://gitee.com/blueses/mybatis-demo