可以说每个MyBatis都是以一个SqlSessionFactory实例为中心的。SqlSessionFactory实例可以通过SqlSessionFactoryBuilder来构建。一是可以通过XML配置文件的方式来构建SqlSessionFactory,二是可以通过Java API的方式来构建。但不管通过什么方式都有一个Configuration贯穿始终,各种配置正是通过Configuration实例来完成实现。
此篇文章旨在通过编码实现MyBatis3.4.1 User Guide所提到的作用域和生命周期指导建议。为什么要了解作用域和生命周期呢?在作用域内正确地使用SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession会让我们避免多线程环境下并发所带来的问题。当然如果使用依赖(DI)注入框架(Spring)可不用在代码中关心作用域问题,因为依赖注入框架会为我们做好几乎一切工作。
首先我们来看User Guide对SqlSessionFactoryBuilder作用域以及生命周期的指导意见。
SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃,一旦创建了 SqlSessionFactory,就不再需要它了。因此 SqlSessionFactoryBuilder 实例的***范围是方法范围(也就是局部方法变量)。你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例,但是***还是不要让其一直存在以保证所有的 XML 解析资源开放给更重要的事情。
SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由对它进行清除或重建。使用 SqlSessionFactory 的***实践是在应用运行期间不要重复创建多次,多次重建 SqlSessionFactory 被视为一种代码“坏味道(bad smell)”。因此 SqlSessionFactory 的***范围是应用范围。有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。
SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的***的范围是请求或方法范围。绝对不能将 SqlSession 实例的引用放在一个类的静态域,甚至一个类的实例变量也不行。也绝不能将 SqlSession 实例的引用放在任何类型的管理范围中,比如 Serlvet 架构中的 HttpSession。如果你现在正在使用一种 Web 框架,要考虑 SqlSession 放在一个和 HTTP 请求对象相似的范围中。换句话说,每次收到的 HTTP 请求,就可以打开一个 SqlSession,返回一个响应,就关闭它。这个关闭操作是很重要的,你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。
通过User Guide可以看到官方对SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession的作用域范围分别是:方法范围、应用范围、请求或方法范围。初学者很容易将SqlSessionFactory的作用域范围忽略,而将其和SqlSessionFactoryBuilder和SqlSession都置于方法范围内,这样本身并不会带来程序代码错误(只有在将SqlSession置于应用范围才会带来并发性问题),然而这会被认为是“bad smell”。我在第一篇写《MyBatis3入门》时,就没有仔细阅读User Guide以至于代码闻起来有一种“坏味道(bad smell)”。例,代码如下:
1 public class SessionFactory {2 public static SqlSession getSqlSession(String resource) throws IOException{3 InputStream inputStream = Resources.getResourceAsStream(resource);4 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);5 SqlSession sqlSession = sqlSessionFactory.openSession();6 7 return sqlSession;8 }9 }
第4行的代码闻起来就有一个“bad smell”的味道,因为它的作用不是在整个应用范围而是在方法范围。
而什么是较好的代码呢?我们应该如上所说,对SqlSessionFactory使用单例模式。重构后的代码如下:
1 package day_8_mybatis.util; 2
3 import java.io.InputStream; 4 5 import org.apache.ibatis.session.SqlSessionFactory; 6 import org.apache.ibatis.session.SqlSessionFactoryBuilder; 7 8 /** 9 * @author turbo10 *11 * 2016年10月26日12 */13 public class SessionFactory2 {14 private static SqlSessionFactory sqlSessionFactory;15 16 public static synchronized SqlSessionFactory getInstance(InputStream inputStream){17 if (null == sqlSessionFactory){18 sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);19 }20 21 return sqlSessionFactory;22 }23 }
客户端创建SqlSession的代码如下:
1 package day_8_mybatis; 2 3 import java.io.IOException; 4 import java.io.InputStream; 5 6 import org.apache.ibatis.io.Resources; 7 import org.apache.ibatis.session.SqlSession; 8 9 import day_8_mybatis.util.SessionFactory2;10 11 /**12 * 客户端13 * 14 * @author turbo15 *16 * 2016年10月26日17 */18 public class Main {19 20 /**21 * @param args22 * @throws IOException23 */24 public static void main(String[] args) throws Exception {25 String resource = "day_8_mybatis/mybatis-config.xml"; // 获取mybatis配置文件路径26 InputStream inputStream = Resources.getResourceAsStream(resource);27 SqlSession sqlSession = SessionFactory2.getInstance(inputStream).openSession();28 29 }30 31 }
这样的代码是不是就符合标准,并且看起来舒服多,漂亮多了?
本文转自zsdnr 51CTO博客,原文链接:http://blog.51cto.com/12942149/1929702,如需转载请自行联系原作者