Mybatis 配置杂谈

Question

生命周期

组件的生命周期

理解我们之前讨论过的不同作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题

SqlSessionFactoryBuilder

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

SqlSessionFactory

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

SqlSession

每个线程都应该有它自己的 SqlSession 实例, 因为 SqlSession 的实例不是线程安全的，是不能被共享的，所以它的最佳的作用域是请求或方法作用域。

绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。

也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。

如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。

• servlet -> ThreadLocal
• Vert.x -> Context

这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式：

try (SqlSession session = sqlSessionFactory.openSession()) {
  // 你的应用逻辑代码
}

在所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。

对于传统的一请求一线程的模型，你可以直接使用 ThreadLocal 来储存隔离

mapper 实例

mapper 是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。 也就是说，映射器实例应该在调用它们的方法中被获取，使用完毕之后即可丢弃。 映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题，但是你很快会发现，在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。 因此，最好将映射器放在方法作用域内。就像下面的例子一样：

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(UserMapper.class);
  // 你的应用逻辑代码
}

自定义数据源

自定义数据源是常见的需求 为了防止用多了 SpringBoot 不会自己在其他项目中使用 这里我给出一套 Vert.x 中使用 MyBatis+Hikari CP 的代码

这几个依赖目的是用虚拟线程+jbdc+mybatis 给 Vert.x 项目糊数据库映射层，目标数据库是 MySQL 系

mariadb-jdbc 是因为实现的比较好而且是使用 j.u.c 的 lock 实现的并发保护，对虚拟线程友好

HikariCP 这个版本是做了兼容的版本 所以要使用这个版本以及以上版本

        <dependency>
            <groupId>org.mariadb.jdbc</groupId>
            <artifactId>mariadb-java-client</artifactId>
            <version>3.1.4</version>
        </dependency>
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>5.0.1</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.10</version>
        </dependency>

然后我们看看 Verticle 怎么写

public class HttpVerticle extends AbstractVerticle {

    private  SqlSessionFactory sessionFactory;

    private static String SESSION = "_mybatis_mapper_session_";

    public HttpVerticle( SqlSessionFactory sessionFactory) {
        this.sessionFactory = sessionFactory;
    }

    @Override
    public void start() throws Exception {
        // ....省略 Web 其他操作 只看一个 Handler
        router.get()
                .handler(rc -> {
                    SqlSession session = sessionFactory.openSession();
                    //context 就是 Request 作用域的
                    context.putLocal(SESSION,  session);
                    Demo.UserMapper userMapper = session.getMapper(Demo.UserMapper.class);
                    executor(userMapper::findAll)
                            .onComplete(ar -> session.close())
                            .onSuccess(rc::json);
                });
        // ....省略 Web 其他操作 只看一个 Handler
    }

    private <T> Future<T> executor(Supplier<T> mapperFn) {
        Context current = vertx.getOrCreateContext();
        Promise<T> promise = Promise.promise();
        Thread.startVirtualThread(() -> {
            T res = mapperFn.get();
            current.runOnContext((__) -> promise.complete(res));
        });
        return promise.future();
    }

}

最后配置为

     public static void main(String[] args) throws InterruptedException {
        HikariConfig config = new HikariConfig();
        //..省略 HikariConfig 配置
        HikariDataSource source = new HikariDataSource(config);
        SqlSessionFactory sqlSessionFactory = createFactory(source);
        Vertx vertx = Vertx.vertx();
        for (int __ = 0; __ < Runtime.getRuntime().availableProcessors(); __++) {
            vertx.deployVerticle(new HttpVerticle(sqlSessionFactory));
        }
    }

    public static SqlSessionFactory createFactory(DataSource dataSource) {
        JdbcTransactionFactory factory = new JdbcTransactionFactory();
        Environment environment = new Environment("vertx", factory, dataSource);
        Configuration configuration = new Configuration(environment);
        configuration.setLogImpl(StdOutImpl.class);
        configuration.addMapper(UserMapper.class);
        configuration.addMapper(CourseRecordMapper.class);
        configuration.setMapUnderscoreToCamelCase(true);
        return new SqlSessionFactoryBuilder()
                .build(configuration);
    }