文章目录
Mybatis 简介
原始 jdbc 操作的分析
原始jdbc开发存在的问题如下:
① 数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能
② sql 语句在代码中硬编码,造成代码不易维护,实际应用 sql 变化的可能较大,sql 变动需要改变java代码。
③ 查询操作时,需要手动将结果集中的数据手动封装到实体中。插入操作时,需要手动将实体的数据设置到sql语句的占位
符位置
应对上述问题给出的解决方案:
① 使用数据库连接池初始化连接资源
② 将sql语句抽取到xml配置文件中
③ 使用反射、内省等底层技术,自动将实体与表进行属性与字段的自动映射
什么是 Mybatis ?
- mybatis 是一个优秀的基于java的持久层框架,它内部封装了jdbc,使开发者只需要关注sql语句本身,而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程。
- mybatis通过xml或注解的方式将要执行的各种 statement配置起来,并通过java对象和statement中sql的动态参数进行映射生成最终执行的sql语句。
- 最后mybatis框架执行sql并将结果映射为java对象并返回。采用ORM思想解决了实体和数据库映射的问题,对jdbc 进行了封装,屏蔽了jdbc api 底层访问细节,使我们不用与jdbc api打交道,就可以完成对数据库的持久化操作。
Mybatis的快速入门
MyBatis官网地址:http://www.mybatis.org/mybatis-3/
MyBatis开发步骤:
① 添加MyBatis的坐标
<dependencies>
<!--mybatis坐标-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<!--mysql驱动坐标-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
<scope>runtime</scope>
</dependency>
<!--单元测试坐标-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!--日志坐标-->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
</dependencies>
② 创建user数据表
③ 编写User实体类
public class User {
private int id;//用户id
private String username;//用户名
private String password;//密码
//省略setter和getter方法。。。
}
④ 编写映射文件UserMapper.xml
注意这里要使用 mapper 文件约束头
<?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">
<mapper namespace="userMapper">
<!-- resultType 配置的是反回的结果集封装的实体-->
<select id="findAll" resultType="com.xiafanjun.domain.User">
select * from user
</select>
</mapper>
⑤ 编写核心文件SqlMapConfig.xml
注意这里要使用 config 约束头
<?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>
<!--jdbc配置文件-->
<properties resource="jdbc.properties"/>
<!--配置数据库环境-->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<!--配置映射-->
<mappers>
<mapper resource="com/xiafanjun/mapper/userMapper.xml"/>
</mappers>
</configuration>
⑥ 编写测试类
@org.junit.Test
public void test01() throws IOException {
//加载核心配置文件
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
//获取sqlSession工厂对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
//获取session对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//执行sql语句 参数:namespace + id
List<User> user = sqlSession.selectList("userMapper.findAll");
//打印结果
System.out.println(user);
//释放资源
sqlSession.close();
}
/*
运行结果:
[User{id=1, username='tom', password='123456'}, User{id=2, username='lucy', password='abcde'}, User{id=3, username='xiafanjun', password='123def'}]
*/
知识小结
MyBatis开发步骤:
① 添加MyBatis的坐标
② 创建user数据表
③ 编写User实体类
④ 编写映射文件UserMapper.xml
⑤ 编写核心文件SqlMapConfig.xml
⑥ 编写测试类
MyBatis的映射文件概述
MyBatis的增删改查操作
MyBatis的插入数据操作
- 编写UserMapper映射文件
<!--插入操作-->
<!-- parameterType 配置的是要插入的数据类型-->
<mapper namespace="userMapper">
<insert id="save" parameterType="com.xiafanjun.domain.User">
insert into user value (#{id}, #{username}, #{password})
</insert>
</mapper>
- 编写插入实体User的代码
@org.junit.Test
public void test02() throws IOException {
//传入的User对象
User user = new User();
user.setUsername("tony");
user.setPassword("56789");
//加载核心配置文件
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
//获取sqlSession工厂对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
//获取session对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//执行sql语句
sqlSession.insert("userMapper.save",user);
//注意: Mybatis 执行更新操作需要提交事务
sqlSession.commit();
//释放资源
sqlSession.close();
}
- 运行结果
插入操作注意问题
- 插入语句使用insert标签
- 在映射文件中使用parameterType属性指定要插入的数据类型
- Sql语句中使用#{实体属性名}方式引用实体中的属性值
- 插入操作使用的API是sqlSession.insert(“命名空间.id”,实体对象);
- 插入操作涉及数据库数据变化,所以要使用sqlSession对象显示的提交事务,
即sqlSession.commit()
MyBatis的修改数据操作
- 编写UserMapper映射文件
<mapper namespace="userMapper">
<!--修改操作-->
<update id="update" parameterType="com.xiafanjun.domain.User">
update user set username = #{username}, password = #{password} where id = #{id}
</update>
</mapper>
- 编写修改实体User的代码
//修改操作
@org.junit.Test
public void test03() throws IOException {
//传入的User对象
User user = new User();
user.setId(3);
user.setUsername("jack");
user.setPassword("xyz");
//加载核心配置文件
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
//获取sqlSession工厂对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
//获取session对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//执行sql语句
sqlSession.update("userMapper.update",user);
//注意: Mybatis 执行更新操作需要提交事务
sqlSession.commit();
//释放资源
sqlSession.close();
}
- 运行结果
修改操作注意问题
- 修改语句使用update标签
- 修改操作使用的API是sqlSession.update(“命名空间.id”,实体对象);
MyBatis的删除数据操作
- 编写UserMapper映射文件
<mapper namespace="userMapper">
<!--删除操作-->
<delete id="delete" parameterType="java.lang.Integer">
delete from user where id = #{id}
</delete>
</mapper>
- 编写删除数据的代码
//删除操作
@org.junit.Test
public void test04() throws IOException{
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
sqlSession.delete("userMapper.delete",4);
sqlSession.commit();
sqlSession.close();
}
删除操作注意问题
- 删除语句使用delete标签
- Sql语句中使用#{任意字符串}方式引用传递的单个参数
- 删除操作使用的API是sqlSession.delete(“命名空间.id”,Object);
知识小结
增删改查映射配置与API:
<mapper namespace="userMapper">
<!--插入操作 sqlSession.insert("userMapper.save",user);-->
<!-- parameterType 配置的是要插入的数据类型-->
<insert id="save" parameterType="com.xiafanjun.domain.User">
insert into user value (#{id}, #{username}, #{password})
</insert>
<!--删除操作 sqlSession.delete("userMapper.delete",4);-->
<delete id="delete" parameterType="java.lang.Integer">
delete from user where id = #{id}
</delete>
<!--修改操作 sqlSession.update("userMapper.update",user);-->
<update id="update" parameterType="com.xiafanjun.domain.User">
update user set username = #{username}, password = #{password} where id = #{id}
</update>
<!--查询操作 List<User> user = sqlSession.selectList("userMapper.findAll");-->
<!-- resultType 配置的是反回的结果集封装的实体-->
<select id="findAll" resultType="com.xiafanjun.domain.User">
select * from user
</select>
</mapper>
MyBatis的核心配置文件概述
MyBatis核心配置文件层级关系
- configuration(配置)
- properties(属性)
- settings(设置)
- typeAliases(类型别名)
- typeHandlers(类型处理器)
- objectFactory(对象工厂)
- plugins(插件)
- environments(环境配置)
- environment(环境变量)
- transactionManager(事务管理器)
- dataSource(数据源)
- environment(环境变量)
- databaseIdProvider(数据库厂商标识)
- mappers(映射器)
MyBatis常用配置解析
- environments标签
数据库环境的配置,支持多环境配置
其中,事务管理器(transactionManager)类型有两种:
- JDBC:这个配置就是直接使用了JDBC 的提交和回滚设置,它依赖于从数据源得到的连接来管理事务作用域。
- MANAGED:这个配置几乎没做什么。它从来不提交或回滚一个连接,而是让容器来管理事务的整个生命周期(比如JEE
应用服务器的上下文)。 默认情况下它会关闭连接,然而一些容器并不希望这样,因此需要将 closeConnection 属性设置
为 false 来阻止它默认的关闭行为。其中,数据源(dataSource)类型有三种:
- UNPOOLED:这个数据源的实现只是每次被请求时打开和关闭连接。
- POOLED:这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来。
- JNDI:这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用,容器可以集中或在外部配置数据源,然后放置
一个 JNDI 上下文的引用。
- mapper标签
该标签的作用是加载映射的,加载方式有如下几种:
- 使用相对于类路径的资源引用,例如:< mapper resource=“org/mybatis/builder/AuthorMapper.xml”/ >
- 使用完全限定资源定位符(URL),例如:< mapper url=“file:///var/mappers/AuthorMapper.xml”/ >
- 使用映射器接口实现类的完全限定类名,例如:< mapper class=“org.mybatis.builder.AuthorMapper”/ >
- 将包内的映射器接口实现全部注册为映射器,例如:< package name=“org.mybatis.builder”/ >
- Properties标签
实际开发中,习惯将数据源的配置信息单独抽取成一个properties文件,该标签可以加载额外配置的properties文件
- typeAliases标签
类型别名是为Java 类型设置一个短的名字。原来的类型名称配置如下
配置typeAliases,为com.itheima.domain.User定义别名为user
注意,配置的时候要按顺序配置:(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)
typeAliases 应该配置在 properties 后面
配置后 select 标签可以这样写:
<select id="findAll" resultType="user">
select * from user
</select>
同理其他标签也一样,可以将 resultType 改为 user
上面我们是自定义的别名,mybatis框架已经为我们设置好的一些常用的类型的别名
别名 | 数据类型 |
---|---|
string | String |
long | Long |
int | Integer |
double | Double |
boolean | Boolean |
… | … |
所以可将删除操作的代码修改为:
<delete id="delete" parameterType="int">
delete from user where id = #{id}
</delete>
知识小结
核心配置文件常用配置:
- properties标签:该标签可以加载外部的properties文件
<properties resource="jdbc.properties"/>
- typeAliases标签:设置类型别名
<typeAliases>
<typeAlias type="com.xiafanjun.domain.User" alias="user"/>
</typeAliases>
- mappers标签:加载映射配置
<mappers>
<mapper resource="com/xiafanjun/mapper/userMapper.xml"/>
</mappers>
- environments标签:数据源环境配置标签
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
MyBatis的相应API
SqlSession工厂构建器SqlSessionFactoryBuilder
常用API:SqlSessionFactory build(InputStream inputStream)
通过加载mybatis的核心文件的输入流的形式构建一个SqlSessionFactory对象
String resource = "org/mybatis/builder/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(inputStream);
其中, Resources 工具类,这个类在 org.apache.ibatis.io 包中。Resources 类帮助你从类路径下、文件系统或
一个 web URL 中加载资源文件。
SqlSession工厂对象SqlSessionFactory
SqlSessionFactory 有多个方法创建 SqlSession 实例。常用的有如下两个:
方法 | 解释 |
---|---|
openSession() | 会默认开启一个事务,但事务不会自动提交,也就意味着需要手动提交该事务,更新操作数据才会持久化到数据库中 |
openSession(booleanautoCommit) | 参数为是否自动提交,如果设置为true,那么不需要手动提交事务 |
SqlSession会话对象
SqlSession 实例在 MyBatis中是非常强大的一个类。在这里你会看到所有执行语句、提交或回滚事务和获取映射器实例的方法。
执行语句的方法主要有:
- T selectOne(String statement, Object parameter):查询单个数据
- List selectList(String statement, Object parameter):查询所有
- int insert(String statement, Object parameter):插入
- int update(String statement, Object parameter):更新
- int delete(String statement, Object parameter):删除
操作事务的方法主要有:
- void commit():提交事务
- void rollback():回滚事务
这里演示一下查询单个数据操作
- 编写UserMapper映射文件
<!--查询单个-->
<select id="findById" resultType="user" parameterType="int">
select * from user where id = #{id}
</select>
- 编写查询单个数据的代码
//查询单个
@org.junit.Test
public void test05() throws IOException {
//加载核心配置文件
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
//获取sqlSession工厂对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
//获取session对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//执行sql语句
User user = sqlSession.selectOne("userMapper.findById",1);
//打印结果
System.out.println(user);
//释放资源
sqlSession.close();
}
/*
查询结果:
User{id=1, username='tom', password='123456'}
*/
Mybatis的Dao层实现
传统开发方式
- 编写UserDao接口
public interface UserDao {
List<User> findAll() throws IOException;
}
- 编写UserDaoImpl实现
public class UserDaoImpl implements UserDao {
public List<User> findAll() throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = sqlSessionFactoryBuilder.build(resourceAsStream);
SqlSession sqlSession = build.openSession();
List<User> userList = sqlSession.selectList("userMapper.findAll");
sqlSession.close();
return userList;
}
}
- 测试传统方式
public class UserService {
public static void main(String[] args) throws IOException {
UserDao userDao = new UserDaoImpl();
List<User> users = userDao.findAll();
System.out.println(users);
}
}
/*
测试结果:
[User{id=1, username='tom', password='123456'}, User{id=2, username='lucy', password='abcde'}, User{id=3, username='jack', password='xyz'}]
*/
代理开发方式
- 代理开发方式介绍
采用 Mybatis 的代理开发方式实现 DAO 层的开发,这种方式是我们后面进入企业的主流。
Mapper 接口开发方法只需要程序员编写Mapper 接口(相当于Dao 接口),由Mybatis 框架根据接口定义创建接
口的动态代理对象,代理对象的方法体同上边Dao接口实现类方法。
Mapper 接口开发需要遵循以下规范:
- Mapper.xml文件中的namespace与mapper接口的全限定名相同
- Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
- Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同
- Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
- 编写UserMapper接口
- 编写接口
public interface UserMapper {
User findById(int id);
}
- 编写映射文件
<mapper namespace="com.xiafanjun.dao.UserMapper">
<!--查询单个数据-->
<select id="findById" resultType="user" parameterType="int">
select * from user where id = #{id}
</select>
</mapper>
注意:接口与映射文件的一些名称要一一对应
- 测试代理方式
public class TestProxyDao {
public static void main(String[] args) throws IOException {
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = sqlSessionFactoryBuilder.build(resourceAsStream);
SqlSession sqlSession = build.openSession();
// 获得 MyBatis 框架生成的 UserMapper 接口的实现类
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.findById(1);
System.out.println(user);
sqlSession.close();
}
}
/*
测试结果:
User{id=1, username='tom', password='123456'}
*/
知识小结
MyBatis的Dao层实现的两种方式:
- 手动对Dao进行实现:传统开发方式
- 代理方式对Dao进行实现:
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);