简介
1、什么是 MyBatis?
MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录;mybatis本来是Apache下的一个开源项目iBatis,2010年项目迁移到google code,并且将iBatis3.0更名为Mybatis
2、持久化
持久化就是将程序的数据在持久状态和瞬时状态转化的过程,早期数据持久化采用io将数据存储到文件,后来将数据存储到数据库。
3、持久层
在java开发中,可以简单的理解为完成持久化工作的代码块。
1、第一个mybatis程序
(1)新建一个maven项目
(2)删除src目录,将该工程作为一个父工程,以后再里面创建子工程
(3)导入mybatis依赖及mysql驱动依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.francis</groupId>
<artifactId>mybatis</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
(4)创建子工程
完成后整个项目结构如下
(5)编写mybatis核心配置文件
在resource目录下创建文件mybatis-config.xml
<?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.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
</configuration>
根据官方的描述,我们要想使用mybatis,首先得获取SqlSessionFactory,为了以后使用方便,我们把获取SqlSessionFactory对象的代码封装为工具类。
工具类
package com.francis.common.utils;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
/**
* @author ZQ
* @create 2021-04-29-15:10
*/
//获取sqlsessionFactory
public class MybatisUtil {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
//读取配置文件,默认在resources目录下,如果在其他目录下,还要带上路径。
String resource="mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}catch (IOException e){
e.printStackTrace();
}
}
//获取sqlSession对象,类似于JDBC里的connection对象
public static SqlSession getSqlSession(){
SqlSession sqlSession = sqlSessionFactory.openSession();
return sqlSession;
}
}
(6)根据数据库表创建对应的实体类,同时编写操作实体类的接口
package com.francis.pojo;
/**
* @author ZQ
* @create 2021-04-29-15:32
*/
public class User {
private int id;
private String name;
private String password;
public User(int id, String name, String password) {
this.id = id;
this.name = name;
this.password = password;
}
public User() {
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", password='" + password + '\'' +
'}';
}
}
package com.francis.dao;
/**
* @author ZQ
* @create 2021-04-29-15:52
*/
public interface UserDao {
List<User> getUserList();
}
(7)编写接口实现类的xml配置文件
<?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绑定一个对应的mapper接口-->
<mapper namespace="com.francis.dao.UserDao">
<!--resutlType,返回值类型,需要实体类的全限定类名,以后加了别名之后可以只用写类名-->
<select id="getUserList" resultType="com.francis.pojo.User">
select *
from mybatis.user
</select>
</mapper>
(8)编写测试文件
package com.francis.dao;
import com.francis.common.utils.MybatisUtil;
import com.francis.pojo.User;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;
/**
* @author ZQ
* @create 2021-04-29-16:11
*/
public class UserDaoTest {
@Test
public void getUserList(){
//获取dao
SqlSession sqlSession = MybatisUtil.getSqlSession();
/**
* 方式一
*/
//获取mapper对象
UserDao userDao = sqlSession.getMapper(UserDao.class);
//调用方法
List<User> userList = userDao.getUserList();
/**
* 方式二,不推荐使用
*/
//List<User> userList= sqlSession.selectList("com.francis.dao.UserDao.getUserList");
for (int i = 0; i < userList.size(); i++) {
System.out.println(userList.get(i));
}
sqlSession.close();
}
}
此时会报错误
这是因为我们在mybatis的核心配置文件中没有注册对应的xml文件导致的,在核心配置文件中加入如下配置
mybatis-config.xml
<?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.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<!--每一个mapper.xml文件都需要在mybatis的配置文件中注册-->
<mapper resource="com/francis/dao/UserMapper.xml"/>
</mappers>
</configuration>
难道这就万事大吉了?不,还会产生资源过滤错误
这个错误的原因是在target目录中没有生成对应的文件,更深层次的原因是maven无法生成或导出配置文件,需要在pom.xml中将maven的打包目录将java目录包含进去
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.francis</groupId>
<artifactId>mybatis</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>mybatis_01</module>
</modules>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
</dependencies>
<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>
</project>
成功!
2、CRUD及一些注意事项
接口UserDao
package com.francis.dao;
import com.francis.pojo.User;
import java.util.List;
/**
* @author ZQ
* @create 2021-04-29-15:52
*/
public interface UserDao {
List<User> getUserList();
User getUserById(int id);
User getUserByNmae(String name);
int insertUser(User user);
int updateUser(User user);
int deleteUserById(int id);
}
userMapper.xml
<?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绑定一个对应的mapper接口-->
<mapper namespace="com.francis.dao.UserDao">
<!--resutlType,返回值类型,需要实体类的全限定类名,以后加了别名之后可以只用写类名-->
<select id="getUserList" resultType="com.francis.pojo.User">
select *
from mybatis.user
</select>
<select id="getUserByNmae" resultType="com.francis.pojo.User" parameterType="String">
select *
from user
where name = #{name}
</select>
<select id="getUserById" resultType="com.francis.pojo.User" parameterType="int">
select *
from user
where id = #{id}
</select>
<insert id="insertUser" parameterType="com.francis.pojo.User">
<!--对象的属性可以直接取出来使用-->
insert into user (id,name,password) values (#{id},#{name,jdbcType=VARCHAR},#{password,jdbcType=VARCHAR})
</insert>
<update id="updateUser" parameterType="com.francis.pojo.User">
update user
set name=#{name},
password=#{password}
where id=#{id};
</update>
<delete id="deleteUserById" parameterType="int">
delete from user where id=#{id}
</delete>
</mapper>
测试类
package com.francis.dao;
import com.francis.common.utils.MybatisUtil;
import com.francis.pojo.User;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;
/**
* @author ZQ
* @create 2021-04-29-16:11
*/
public class UserDaoTest {
@Test
public void getUserList(){
//获取dao
SqlSession sqlSession = MybatisUtil.getSqlSession();
/**
* 方式一
*/
//获取mapper对象
UserDao userDao = sqlSession.getMapper(UserDao.class);
//调用方法
List<User> userList = userDao.getUserList();
/**
* 方式二,不推荐使用
*/
//List<User> userList= sqlSession.selectList("com.francis.dao.UserDao.getUserList");
for (int i = 0; i < userList.size(); i++) {
System.out.println(userList.get(i));
}
sqlSession.close();
}
@Test
public void getUserById(){
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserDao userDao = sqlSession.getMapper(UserDao.class);
User user = userDao.getUserById(1);
System.out.println(user);
sqlSession.close();
}
@Test
public void getUserByName(){
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserDao userDao = sqlSession.getMapper(UserDao.class);
User user = userDao.getUserByNmae("张三");
System.out.println(user);
sqlSession.close();
}
@Test
public void insertUser(){
User user = new User(4, "王五", "abc123");
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserDao mapper = sqlSession.getMapper(UserDao.class);
int i = mapper.insertUser(user);
//增删改需要提交事务,不然数据库里的数据不会变
sqlSession.commit();
sqlSession.close();
System.out.println(i);
}
@Test
public void updateUser(){
User user = new User(4, "师志磊", "000000");
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserDao mapper =sqlSession .getMapper(UserDao.class);
int i = mapper.updateUser(user);
sqlSession.commit();
sqlSession.close();
}
@Test
public void deleteUserById(){
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserDao mapper = sqlSession.getMapper(UserDao.class);
int i = mapper.deleteUserById(3);
sqlSession.commit();
sqlSession.close();
}
}
值得注意的是,增删改必须得提交事务,不然数据库不会发生改变,操作完成后,务必记得关闭sqlSession。
3、map作为参数及模糊查询
当一个实体类的属性变得庞大的时候,我们用实体类来传参就显得格外麻烦,比如,更新一个用户的密码,这个用户肯能拥有一百条属性,而且很多属性是不能为空的,这样在new对象的时候就会很鸡肋,此时,我们可以使用map来传参,这样不仅可以减少代码,而且还可以提高定制化,参数的名称可以不用跟实体类的属性值相同,只需要与map的键相同即可。
接口:
int updateUserByMapId(Map<String,Object> map);
xml
<update id="updateUserByMapId" parameterType="map" >
update user set password=#{mapPwd} where id =#{mapId}
</update>
测试方法
@Test
public void updateUserByMapId() {
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserDao mapper = sqlSession.getMapper(UserDao.class);
Map<String, Object> map = new HashMap<>();
map.put("mapId", 2);
map.put("mapPwd", "000000");
mapper.updateUserByMapId(map);
sqlSession.commit();
sqlSession.close();
}
执行成功
将模糊查询的字符串在java代码里拼接,可能存在sql注入问题,所以建议涉及模糊查询的代码拼接部分写在查询语句中
UserDao
List<User> selectUserLike(String str);
xml
<select id="selectUserLike" resultType="com.francis.pojo.User">
select * from user where name like "%"#{str}"%"
</select>
测试方法
@Test
public void selectUserLike() {
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserDao mapper = sqlSession.getMapper(UserDao.class);
List<User> users = mapper.selectUserLike("张");
for (User user : users) {
System.out.println(user);
}
sqlSession.commit();
sqlSession.close();
}