本篇主要分享使用“映射器实例(Mapper Instances)”
首先来看一个简单的例子:
以上代码的执行过程比较清晰,在第4步执行sql语句时采用映射xml文件方式。
Brand brand = sqlSession.selectOne("test.findBrandById", 10);
以上语句能够正确执行的前提:
- 成功找到"test.findBrandById"对应的BrandMapper.xml映射文件。
风险分析
sqlSession.selectOne(“test.findBrandById”, 10); 中test.findBrandById 有可能会写错。
映射器实例(Mapper Instances)
映射器是创建用来绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。因此从技术层面讲,映射器实例的最大范围是和 SqlSession 相同的,因为它们都是从 SqlSession 里被请求的。
尽管如此,映射器实例的最佳范围是方法范围。也就是说,映射器实例应该在调用它们的方法中被请求,用过之后即可废弃。并不需要显示的关闭映射器实例,尽管在整个请求范围(request scope)保持映射器实例也不会有什么问题,像 SqlSession 一样,在这个范围上管理太多的资源的话会难于控制。所以要保持简单,最好把映射器映射器放在方法范围(method scope)内。下面的示例就展示了这个实践:
SqlSession session = sqlSessionFactory.openSession();
try {
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// do work
Brand brand = brandMapper.findBrandById(10);
} finally {
session.close();
}
以上代码更新如下所示:
@Test
public void testMybatis() throws Exception {
//1. 加载核心配置文件
String resource = "config/sqlMapConfig.xml";
//getResourceAsStream这个函数寻找文件的起点是JAVA项目编译之后的根目录
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
//3. 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//4. 执行Sql语句
try {
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
Brand brand = brandMapper.findBrandById(10);
System.out.println(brand);
} finally {
sqlSession.close();
}
}
!!!配置文件也做了相应更新(重要的事说三遍!)
1. sqlMapConfig.xml
<!-- Mapper的位置 Mapper.xml 写Sql语句的文件的位置 -->
<mappers>
<!-- <mapper resource="cn/mapper/BrandMapper.xml"/> -->
<package name="cn.mapper"/>
</mappers>
原来是指定具体的Mapper.xml路径,现在则是指定对应的包路径。
2. BrandMapper
2.1 新建 BrandMapper.java (Interface)
public interface BrandMapper {
public Brand findBrandById(Integer id);
}
2.2 BrandMapper.xml 与 BrandMapper.java 放在"src/cn/mapper"目录下。
<!-- 写Sql语句 -->
<mapper namespace="cn.mapper.BrandMapper">
<!-- 通过ID查询一个用户 -->
<select id="findBrandById" parameterType="Integer" resultType="cn.bean.product.Brand">
select * from bbs_brand where id = #{v}
</select>
</mapper>
本篇小结
映射器实例有2个特点:
- 不是基于字符串常量的,就会更安全;
- 如果IDE 有代码补全功能,在有了已映射的 SQL 语句之后利补全方法,提高效率。
通过这个例子的学习能够加深对MyBatis的理解,作为MyBatis入门小白,希望这篇分享能够让你得到收获。