一 . 概念
MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。 (来自官网)
二 . 入门
1. 安装
在maven中引入依赖即可
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
2 . 构建配置文件
配置文件内容如下
<?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>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="admin"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/ycm/dao/UserMapper.xml"/>
</mappers>
</configuration>
在这个配置文件有如下几个重要的信息
1.property:数据库的配置,包括驱动名字,数据库账户等信息
2.environment:一个environment代表一个数据库,可以有多个数据库
3.mapper:字面意思是映射,当创建一个实体类映射的xml文件的时候都必须在这个文件注册
3 .构建sessionFactory
通常情况下我会建一个工具类来获取,需要sqlsession的时候直接调用就可以
public class MyBatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
//获取SqlSessionFactory 对象
try {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//既然有了 SqlSessionFactory,顾名思义,我们可以从中获得 SqlSession 的实例。
// SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
// 你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句
public static SqlSession getSqlSessionFactory(){
SqlSession sqlSession = sqlSessionFactory.openSession();
return sqlSession;
}
}
三 . 实例
这里做的是数据库的CIUD操作
1.创建实体类
实体类中的属性和数据库的字段要对应
private Integer id;
private String name;
private String password;
2 . 编写接口
public interface UserMapper {
//查询全部用户
List<User> getUserList();
//根据id查询
User getUserById(int id);
//新增一个用户
int addUser(User user);
//删除一个用户
int deleteUser(int id);
//修改用户信息
int updateUser(User user);
}
之前我们习惯叫UserDao,但是现在叫UserMapper,因为在mybatis中不需要去写接口的实现类,而是直接通过配置文件类操作数据库,所以这里成为映射要形象些
3 . 编写配置文件
<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--namespace:绑定一个对应的Dap/Mapper接口-->
<mapper namespace="com.ycm.dao.UserMapper">
<select id="getUserList" resultType="com.ycm.pojo.User">
select * from mybatis.user
</select>
<select id="getUserById" resultType="com.ycm.pojo.User" parameterType="int">
select * from mybatis.user where id=#{id}
</select>
<insert id="addUser" parameterType="com.ycm.pojo.User">
insert into mybatis.user(id,name,password) values (#{id},#{name},#{password})
</insert>
<delete id="deleteUser" parameterType="int" >
delete from mybatis.user where id=#{id}
</delete>
<update id="updateUser" parameterType="com.ycm.pojo.User">
update mybatis.user set name=#{name},password=#{password} where id=#{id}
</update>
</mapper>
这个配置文件主要有以下几部分组成:
1.声明部分不需要管,都是一样
2.namespace:对应这个接口,需要写全包名路径
3.数据库操作语句,其中id表示的是接口的方法,resultType:返回值的类型,也是需要写全包名路径,parameterType:参数类型(除了select需要指明返回值类型,其他都不需要,因为select返回的是一个结果集)
这里我出现了一个小bug,也是很无奈的地方
就是原本的配置文件是这样的开头
那么在运行的时候就会产生这样的错误
java.lang.ExceptionInInitializerError
Caused by: org.apache.ibatis.exceptions.PersistenceException:
### Error building SqlSession.
### The error may exist in com/ycm/dao/UserMapper.xml
### Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: org.apache.ibatis.builder.BuilderException: Error creating document instance. Cause: org.xml.sax.SAXParseException; lineNumber: 5; columnNumber: 14; 1 字节的 UTF-8 序列的字节 1 无效。
at org.apache.ibatis.exceptions.Exc
说 UTF-8 序列的字节 1 无效,后面查了很久,只需要把UTF-8改成UTF8就可以,这也是很坑爹的地方。
出现配置文件无法识别的bug
原因是在maven中,约定大于配置的问题,导致文件无法识别打包到target中,只需要在配置文件中加入以下代码就可以了
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
测试
新建一个测试类,采用单元测试来看下这些方法的实现
public class UserDaoTest {
@Test
public void selectUserList(){
//获取sqlSession对象
SqlSession sqlSession = MyBatisUtils.getSqlSessionFactory();
//执行
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
List<User> userList = mapper.getUserList();
for (User user : userList) {
System.out.println(user);
}
sqlSession.close();
}
@Test
public void getUserById(){
//获取sqlSession对象
SqlSession sqlSession = MyBatisUtils.getSqlSessionFactory();
//执行
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.getUserById(2);
System.out.println(user);
sqlSession.close();
}
@Test
public void addUser(){
//获取sqlSession对象
SqlSession sqlSession = MyBatisUtils.getSqlSessionFactory();
//执行
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = new User(5, "猪八戒", "123456");
int i = mapper.addUser(user);
if (i>0){
System.out.println("插入成功");
}
sqlSession.commit();
sqlSession.close();
}
@Test
public void updateUser(){
//获取sqlSession对象
SqlSession sqlSession = MyBatisUtils.getSqlSessionFactory();
//执行
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = new User(5, "孙悟空", "12345678");
mapper.updateUser(user);
sqlSession.commit();
sqlSession.close();
}
@Test
public void deleteUser(){
//获取sqlSession对象
SqlSession sqlSession = MyBatisUtils.getSqlSessionFactory();
//执行
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.deleteUser(5);
sqlSession.commit();
sqlSession.close();
}
}
基本的步骤都差不多:
1.获取sqlsession
2.获取mapper
3.执行
需要指出的是,如果是查询操作不需要使用事务也可以,但是如果是增,删,改的操作就需要在后面提交事务才可以,否则根据事务的原子性,操作是还没完成的。