什么是 MyBatis?
MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 的 POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
引入Mybatis
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>x.x.x</version>
</dependency>
从 XML 中构建 SqlSessionFactory
SqlSessionFactory是MyBatis的核心。实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例。
从 XML 文件中构建 SqlSessionFactory 的实例非常简单
不使用 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);.
构建SqlSessionFactory
注意该例中,configuration 添加了一个映射器类(mapper class)。映射器类是 Java 类,它们包含 SQL 映射语句的注解从而避免依赖 XML 文件。不过,由于 Java 注解的一些限制以及某些 MyBatis 映射的复杂性,要使用大多数高级映射(比如:嵌套联合映射),仍然需要使用 XML 配置。有鉴于此,如果存在一个同名 XML 配置文件,MyBatis 会自动查找并加载它(在这个例子中,基于类路径和 BlogMapper.class 的类名,会加载 BlogMapper.xml)。具体细节稍后讨论。
从 SqlSessionFactory 中获取 SqlSession
既然有了 SqlSessionFactory,顾名思义,我们就可以从中获得 SqlSession 的实例了。SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如:
Mapper映射的方式去操作
有一个mapper类。然后在mapper.xml中的<mapper>标签中的 namespace来绑定mapper接口。mapper接口类中定义了查询的接口
mapper.xml中通过以下方式进行绑定
此时就可以通过session获取mapper,然后通过mapper去获取查询语句
select标签中的id要与mapper中的接口名称一样。
对命名空间的一点说明
在之前版本的 MyBatis 中,命名空间(Namespaces)的作用并不大,是可选的。 但现在,随着命名空间越发重要,你必须指定命名空间。
命名空间的作用有两个,一个是利用更长的完全限定名来将不同的语句隔离开来,同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定,你也应该遵循这里的规定,以防哪天你改变了主意。 长远来看,只要将命名空间置于合适的 Java 包命名空间之中,你的代码会变得更加整洁,也有利于你更方便地使用 MyBatis。
命名解析:为了减少输入量,MyBatis 对所有的命名配置元素(包括语句,结果映射,缓存等)使用了如下的命名解析规则。
完全限定名(比如 “com.mypackage.MyMapper.selectAllThings)将被直接用于查找及使用。
短名称(比如 “selectAllThings”)如果全局唯一也可以作为一个单独的引用。 如果不唯一,有两个或两个以上的相同名称(比如 “com.foo.selectAllThings” 和 “com.bar.selectAllThings”),那么使用时就会产生“短名称不唯一”的错误,这种情况下就必须使用完全限定名。
使用注解的方式操作sql语句
使用注解来映射简单语句会使代码显得更加简洁,然而对于稍微复杂一点的语句,Java 注解就力不从心了,并且会显得更加混乱。 因此,如果你需要完成很复杂的事情,那么最好使用 XML 来映射语句。
选择何种方式来配置映射,以及认为映射语句定义的一致性是否重要,这些完全取决于你和你的团队。 换句话说,永远不要拘泥于一种方式,你可以很轻松的在基于注解和 XML 的语句映射方式间自由移植和切换。
作用域(Scope)和生命周期
SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃,一旦创建了 SqlSessionFactory,就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例,但是最好还是不要让其一直存在,以保证所有的 XML 解析资源可以被释放给更重要的事情。
SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次,多次重建 SqlSessionFactory 被视为一种代码“坏味道(bad smell)”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。
SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域,甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中,比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架,要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。 换句话说,每次收到的 HTTP 请求,就可以打开一个 SqlSession,返回一个响应,就关闭它。 这个关闭操作是很重要的,你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。 下面的示例就是一个确保 SqlSession 关闭的标准模式:
映射器实例
映射器是一些由你创建的、绑定你映射的语句的接口。映射器接口的实例是从 SqlSession 中获得的。因此从技术层面讲,任何映射器实例的最大作用域是和请求它们的 SqlSession 相同的。尽管如此,映射器实例的最佳作用域是方法作用域。 也就是说,映射器实例应该在调用它们的方法中被请求,用过之后即可丢弃。 并不需要显式地关闭映射器实例,尽管在整个请求作用域保持映射器实例也不会有什么问题,但是你很快会发现,像 SqlSession 一样,在这个作用域上管理太多的资源的话会难于控制。 为了避免这种复杂性,最好把映射器放在方法作用域内。下面的示例就展示了这个实践:
类型处理器TypeHandler
持久层框架其中比较重要的工作就是处理数据的映射转换,把java 类型转换成jdbc 类型的参数,又需要把jdbc 类型的结果集转换成java 类型。在mybatis 中是通过 TypeHandler 接口来实现的。
有三种方式可以实现java和mybatis之间的数据类型转换。
自定义的类需要实现TypeHandler 实现以下几个方法
或者还可以继承与实现的方式是一样的。
然后mybaits.xml 中需要配置一下。
<typeHandlers>
<typeHandler handler="org.mybatis.example.ExampleTypeHandler" javaType=“long” jdbcType=“TIMESTAMP” />
</typeHandlers>
这是第一种方式,第二种方式就是在方法上加注解如下图,通过注解的形式指定MappedJdbcTypes和MappedTypes类型
mappers映谢器
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
<mapper url="http://www.xxx.com/xml/BlogMapper.xml"/>
<mapper class="org.mybatis.builder.BlogMapper"/>
<package name="org.mybatis.builder"/>
加载方式:
resource 基于classPath 加载xml文件
url:基于资源定位加载xml 文件
class:基于接口加载
package :扫描包下所有class 然后进行加载
Mapper中的元素
cache – 对给定命名空间的缓存配置。
resultMap – 结果集映射。
sql – 可被其他语句引用的可重用语句块。
insert – 插入语句
update – 更新语句
delete –删除语句
select – 查询语句
select属性
id="selectById" <!-- 语句块的唯一标识 与接口中方法名称对应 -->
parameterType="User" <!--参数java类型-->
resultType="hashmap" <!--返回结果java类型-->
resultMap="userResultMap" <!--返回结果映射-->
flushCache="false" <!--true 每次调用都会刷新 一二级缓存-->
useCache="true" <!--true 是否保存至二级缓存当中去-->
timeout="10"
statementType= PREPARED">
insert&update&delete用法
id="addUser" <!-- 语句块的唯一标识 与接口中方法名称对应 -->
parameterType="User" <!--参数java类型-->
flushCache="true" <!--true 每次调用都会刷新 一二级缓存-->
statementType="PREPARED" <执行类型>
keyProperty="" <!--主键对应的java 属性,多个用 逗号分割-->
keyColumn="" <!--主键列,多个用 逗号分割-->
useGeneratedKeys="" <!--插入成功后将 将值回设至 原参数->
timeout="20"
resultSet
将resultSet中内容封装转换成java对像调用resultSet的getXXX(columnName) 来获取属性并封装。
resultType
在select中指定 resultType=“” 后无需要任何配置 myBatis 会基于 resultType中的JAVa类型及属性自动推断生成 一个隐示的resultMap 从而完成结果映谢
resultMap
但有时jdbc 并不是与java Bean 完全贴合这时就需要手动设置resultMap
基本元素与属性
ID:用于结果集中的唯一标识
result:设置一个某通过字段
property:
jdbcType:
javaType:
column:
typeHandler:
完。。。
.
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
<mapper url="http://www.xxx.com/xml/BlogMapper.xml"/>
<mapper class="org.mybatis.builder.BlogMapper"/>
<package name="org.mybatis.builder"/>
[if !supportLists]l [endif]cache – 对给定命名空间的缓存配置。
[if !supportLists]l [endif]resultMap – 结果集映射。
[if !supportLists]l [endif]sql – 可被其他语句引用的可重用语句块。
[if !supportLists]l [endif]insert – 插入语句
[if !supportLists]l [endif]update – 更新语句
[if !supportLists]l [endif]delete –删除语句
[if !supportLists]l [endif]select – 查询语句
id="addUser" <!-- 语句块的唯一标识 与接口中方法名称对应 -->
parameterType="User" <!--参数java类型-->
flushCache="true" <!--true 每次调用都会刷新 一二级缓存-->
statementType="PREPARED" <执行类型>
但有时jdbc 并不是与java Bean 完全贴合这时就需要手动设置resultMap
[if !supportLists]l [endif]ID:用于结果集中的唯一标识
[if !supportLists]l [endif] result:设置一个某通过字段
[if !supportLists]à [endif]property:
[if !supportLists]à [endif]jdbcType:
[if !supportLists]à [endif]javaType: