什么是MyBatis?
MyBatis本是apache的一个开源项目iBatis,2010年这个项目由apache software foundation迁移到了google,并且改名为mybatis。2013年11月迁移到了GitHub。
MyBatis是一个优秀的持久型框架,他对JDBC的操作数据库的过程进行封装,让开发者只关注于SQL本身(没错,我们大概只需要写点SQL),而不需要费精力去处理例如注册驱动、创建Connection、创建statement、手动设置参数、结果集检索等复杂的JDBC过程代码。
MyBatis通过XML文件或者注解的方式将要执行的各种statement配置起来,并通过Java对象和statement中的SQL进行映射生成了最后执行的SQL语句,最后由MyBatis框架执行SQL并将结果映射成Java对象并返回。
先来一个Demo
0.准备核心和依赖
1.准备pojo类(也有叫JavaBean的)
package com.mybatis_demo.pojo;
import java.io.Serializable;
import java.util.Date;
public class User implements Serializable {
private static final long serialVersionUID = 1L;
private Integer id;
private String username;
private String sex;
private Date birthday;
private String address;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", sex=" + sex
+ ", birthday=" + birthday + ", address=" + address + "]";
}
}
2.准备SqlMapConfig.xml文件用来准备构建SqlSessionFactory
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 指定连接池配置,用过spring整合jdbc的大概都知道这是个什么意思了。这是和配置文件后面的数
据库连接池datasource合作的,指定了数据库连接池配置数据的相对路径。为了看得更明白,我只更改了两个
perproties文件的值,改用OGNL表示式传值。
-->
<properties resource="db.perproties"></properties>
<!-- mapper.xml中的类型别名,让返回值类型更加简单 -->
<typeAliases>
<!-- 针对某一确定路径的文件 -->
<!-- <typeAlias type="com.mybatis_demo.pojo.User" alias="User"/> -->
<!-- 针对该包下的文件,但是这种用法要保证pojo包下都是pojo文件 -->
<package name="com.mybatis_demo.pojo"/>
</typeAliases>
<!-- 和spring整合后 environments配置将废除 -->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事务管理 -->
<transactionManager type="JDBC" />
<!-- 数据库连接池 -->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driverClass}" />
<property name="url" value="${jdbc.jdbcUrl}" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
<!-- 告诉mybatis,mapper映射文件在哪 -->
<mappers>
<!-- 指定的相对src路径文件 -->
<!-- <mapper resource="com/mybatis_demo/mapper/UserMapper.xml"></mapper> -->
<!-- 直接指定包下所有文件,但是这种情况要保障mapper.java文件和mapper.xml映射文件名称相同,在一个包下 -->
<package name="com.mybatis_demo.mapper"/>
</mappers>
</configuration>
3.sql映射文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- namespace:命名空间,用于隔离sql -->
<!-- mapper标签写sql语句 -->
<mapper namespace="com.mybatis_demo.mapper.UserMapper">
<!-- 通过id查询用户
parameterType指定传入参数数据类型
resultType用来sql映射文件中定义返回值类型,要求写全路径。但前面配置了别名可以使用别名
#的替代形参自动携带''
-->
<select id="findUserById" parameterType="Integer" resultType="User">
select * from user where id = #{value}
</select>
<!-- 根据用户名称模糊查询用户列表
$查询时里面的形参必须是value
$的替代形参不带''
-->
<select id="findUserByUsername" parameterType="String" resultType="com.mybatis_demo.pojo.User">
select * from user where username like '%${value}%'
<!-- 防止sql语句注入的写法select * from user where username like "%"#{value}"%" -->
</select>
<!-- 添加用户 -->
<insert id="insertUser" parameterType="com.mybatis_demo.pojo.User">
<!-- 同时返回最新产生的id -->
<selectKey keyProperty="id" resultType="Integer" order="AFTER">
select LAST_INSERT_ID()
</selectKey>
insert into user (username,birthday,address,sex)
values (#{username},#{birthday},#{address},#{sex})
</insert>
<!-- 更新用户 -->
<update id="updateUserById" parameterType="com.mybatis_demo.pojo.User">
update user
set username = #{username},sex = #{sex},birthday = #{birthday},
address = #{address} where id = #{id}
</update>
<!-- 删除用户 -->
<delete id="deleteUserById" parameterType="Integer">
delete from user where id = #{id}
</delete>
</mapper>
4.userMapper接口文件,和sql映射文件相对应。甚至可以说和sql映射文件的sql语句相对应
mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类(后面的TestDemo会看到,只需要使用SqlSession.getMapper就可以获得实现类),使用mapper代理方法时,输入参数可以使用pojo包装对象或map对象,保证dao的通用性。
package com.mybatis_demo.mapper;
import com.mybatis_demo.pojo.User;
/**
* Mapper接口相当于Dao接口,由MyBatis框架根据接口定义创建接口的动态代理对象
* @author 33452
*
*/
public interface UserMapper {
/**
* 配置Mapper的四个原则
* 1.*Mapper.xml文件的namespace要和Mapper接口的类路径(此处就是返回值)相同,也就是命名空间要绑定这个接口
* 2.*Mapper.xml中定义的每个statement的id要和Mapper接口方法名相同
* 3.*Mapper.xml中定义的每个sql的输入值类型parameterType要和Mapper接口方法的输入参数类型相同
* 4.*Mapper.xml中定义的每个sql的返回值类型resultType要和Mapper接口方法的输出参数类型相同
*/
//根据id查询,这里就只写了一个查询的例子
public User findUserById(Integer id);
}
5.测试类
package com.mybatis_demo.test;
public class MyBatisMapperTest {
@Test
public void demo() throws IOException {
/*
* 在mybatis官网上写的,只有通过流。但其实只能通过字符流reader或者字节流stream执行生成,文件流是不行的
//加载核心配置文件
InputStream in = Resources.getResourceAsStream("sqlMapConfig.xml");
//创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
*/
//加载核心配置文件
Reader asFile = Resources.getResourceAsReader("sqlMapConfig.xml");
//创建sqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(asFile);
//创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
try {
//sqlSession帮助*Mapper.java接口生成一个实现类
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.findUserById(10);
System.out.println(user);
} finally {
//最好是执行结束关闭
sqlSession.close();
}
}
}
6.执行结果
经过了上面的Demo程序以后可能就对MyBatis有了一个基本的印象了。那么先来看看Mybatis的架构。
1.SqlMapConfig.xml文件作为MyBatis的全局配置文件,配置了MyBatis的运行环境等等,*Mapper.xml文件即sql映射文件,文件中配置了操作数据库的sql语句。当然,此文件需要在SqlMapConfig.xml中加载。通过MyBatis的环境信息配置,就可以完成构造SqlSessionFactory即会话工厂。
2.然后由会话工厂创建SqlSession即会话。操作数据库需要通过SqlSession进行。
3.MyBatis底层定义了Executor执行器接口来操作数据库,该接口其实有两个实现。一个是基本执行器,一个是缓存执行器。
Mapped Statement是MyBatis一个底层封装对象,他包装了mybatis配置信息及sql映射信息等。*mapper.xml文件中一个sql对应一个Statement对象,sql的id即是Mapped statement的id。
接下来就是Executor和Mapped Statement的联合协作。Mapped Statement对sql执行输入参数进行定义,包括hashmap、基本类型、pojo,Executor通过Mapped Statement在执行sql前将输入的Java对象映射到sql语句中。查询以后Mapped Statement对sql的输出结果进行定义,当然也包括hashmap、基本类型、pojo,Executor通过Mapped Statement在执行sql后将输出结果映射到Java对象中。然后我们就可以顺理成章的处理数据咯。
SqlSessionFactoryBuilder
但是会话工厂究竟具体如何代码创建呢?通过SqlSessionFactoryBuilder即可。这个类可以被实例化、使用和丢弃。一旦创建了会话工厂就不需要它了。因此最佳作用域就是创建会话工厂的方法体内。
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(asFile);
SqlSessionFactory
SqlSessionFactory一般被创建,在运行期间就一直存在,没有理由重建或者清除。
SqlSession
每一句sql语句对应一个线程更,每一个线程都有自己的sqlsession实例。但是SqlSession并不是线程安全的,不应该被共享所以作用域应该是请求或者方法作用域。为了避免当出现相似作用域时发生混淆,关闭操作是更好的。
SqlSession session = sqlSessionFactory.openSession();
try {
// do work
} finally {
session.close();
}
经历以上这以上内容,想必对MyBatis已经有了一定的了解。假如想学习更多可以去MyBatis的参考文档学习。