mybatis:一、初识mybatis
1 mybatis依赖配置
依赖如下:
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.7</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
额外的依赖如:
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.14</version>
</dependency>
整个pom.xml如下:
<?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>org.example</groupId>
<artifactId>Ymybatis</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.7</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.14</version>
</dependency>
</dependencies>
<build>
<!-- 资源插件,用于处理src/main/java目录中的xml -->
<resources>
<resource>
<directory>src/main/java</directory><!--所在的目录-->
<includes><!--包括目录下的.properties,.xml文件都会扫描到-->
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
</build>
</project>
2 创建数据库和相应的表
数据库环境为mysql8,在workbench上连接本地的mysql,新建数据库和数据表,创建myuser表(表名只能是小写)
查看具体的表结构信息:
插入测试数据:
3 创建User实体类
tips:domain意思,和pojo、entity都是实体类的意思
package com.xiaoxu.domain;
import lombok.Data;
import java.math.BigDecimal;
/**
* @author xiaoxu
* @date 2021-12-15
* Ymybatis:com.xiaoxu.domain.User
*/
@Data
public class User {
//属性名和列名一样
private int id;
private String name;
private byte age;
private BigDecimal money;
@Override
public String toString() {
return "用户实体信息{" +
"id=" + id +
", name='" + name + '\'' +
", age=" + age +
", money=" + money +
'}';
}
}
mybatis文档如下:https://mybatis.net.cn/getting-started.html
4 创建UserDao接口和UserDao.xml:
UserDao.xml放在UserDao一个目录下:
UserDao接口:
package com.xiaoxu.dao;
import com.xiaoxu.domain.User;
/**
* @author xiaoxu
* @date 2021-12-15
* Ymybatis:com.xiaoxu.dao.UserDao
*/
public interface UserDao {
User selectUserById(int id);
}
UserDao.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">
<!--
1.约束文件:http://mybatis.org/dtd/mybatis-3-mapper.dtd,访问可以下载该文件,还有http://mybatis.org/dtd/mybatis-3-config.dtd
作用:定义和限制当前文件中可以使用的标签和属性,以及标签出现的顺序
2.mapper是根标签,必须有;namespace:命名空间,必须有,不能为空,唯一值。
作用:参与识别sql语句
3.在mapper里可以写<select>\<insert>\<delete>\<update>语句
4.namespace填写UserDao接口的全限定名,select等各个标签的id,是唯一值,且最好选择接口的方法名称;
resultType:告诉mybatis,执行sql语句,把数据赋值给那个类型的java对象,所以是UserDao接口中该方法对应的返回值类型,也是全限定名
-->
<mapper namespace="com.xiaoxu.dao.UserDao">
<select id="selectUserById" resultType="com.xiaoxu.domain.User">
select id,name,age,money from myuser where id=1
</select>
</mapper>
拷贝接口的全限定类名称如下操作:
5 创建mybatis主配置文件
resource目录下新建mybatis.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>
<!-- 引入外部properties文件 -->
<properties resource="jdbc.properties"/>
<!-- 和spring整合之后,environments配置会废除 -->
<environments default="development">
<environment id="development">
<!-- 使用JDBC事务管理 -->
<transactionManager type="JDBC"/>
<!-- 配置数据源:创建Connection对象(数据库连接池) -->
<dataSource type="POOLED">
<!-- driver:驱动的内容 -->
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!-- 指定其它mapper文件的位置
目的:找到其它文件的sql语句
-->
<mappers>
<!--
使用mapper的resource属性指定mapper文件的路径
这个路径是从target/classes路径开启的
使用注意:resource="mapper文件的路径,使用 / 分割路径"
一个mapper resource 指定一个mapper文件,多个就多个mapper标签
-->
<mapper resource="com/xiaoxu/dao/UserDao.xml"/>
</mappers>
</configuration>
注意:mapper的resource使用的UserDao.xml是src/main/java目录下的,pom.xml中一定要配置资源插件!
resource目录下新建jdbc.properties文件:
driver=com.mysql.jdbc.Driver
#如果数据库连接直接写在xml中,是:jdbc:mysql://localhost:3306/xiaoxu?useUnicode=true&characterEncoding=utf8mb4
url=jdbc:mysql://localhost:3306/xiaoxu?useUnicode=true&characterEncoding=utf8mb4
username=root
password=******
6 测试类
import com.xiaoxu.domain.User;
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 org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
/**
* @author xiaoxu
* @date 2021-12-15
* Ymybatis:PACKAGE_NAME.MyTest
*/
public class MyTest {
@Test
public void test_select() throws IOException {
//调用mybatis某个对象的方法,执行mapper文件中的sql语句
//mybatis核心类:SqlSessionFactory
//1.定义mybatis主配置文件的位置,从类路径开始的相对路径
String conf="mybatis.xml";
//2.读取主配置文件,使用mybatis框架中的Resources类
InputStream inputStream=Resources.getResourceAsStream(conf);
//3.创建SqlSessionFactory对象,使用SqlSessionFactoryBuilder类
SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
//4.获取SqlSession对象
SqlSession session=sqlSessionFactory.openSession();
//5.指定要执行的sql语句的id
//sql的id = namespace+"."+select|update|insert|delete标签的id属性值
String sqlId = "com.xiaoxu.dao.UserDao"+"."+"selectUserById";
//6.通过SqlSession的方法,执行sql语句:
User u=session.selectOne(sqlId);
System.out.println("查询用户如下所示:"+u);
//7.关闭SqlSession对象
session.close();
}
}
执行单测抛错:
需要在pom.xml中添加上资源插件,用于处理src/main/java目录中的xml:
<build>
<!-- 资源插件,用于处理src/main/java目录中的xml -->
<resources>
<resource>
<directory>src/main/java</directory><!--所在的目录-->
<includes><!--包括目录下的.properties,.xml文件都会扫描到-->
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
</build>
再次执行:
修改配置文件:
driver=com.mysql.cj.jdbc.Driver
#如果数据库连接直接写在xml中,是:jdbc:mysql://localhost:3306/xiaoxu?useUnicode=true&characterEncoding=utf8mb4
url=jdbc:mysql://localhost:3306/xiaoxu?useUnicode=true&characterEncoding=utf8mb4
username=root
password=******
再次执行:
原因是mybatis不支持数据库的编码是utf8mb4,但是可以改为utf-8(这样配置可以连接数据库编码是utf8mb4的):
driver=com.mysql.cj.jdbc.Driver
#如果数据库连接直接写在xml中,是:jdbc:mysql://localhost:3306/xiaoxu?useUnicode=true&characterEncoding=utf8mb4
url=jdbc:mysql://localhost:3306/xiaoxu?useUnicode=true&characterEncoding=utf-8
username=root
password=******
重新执行单测结果如下:
7 编写Mybatis工具类
在com.xiaoxu.utils下新建Mybatis的工具类:
package com.xiaoxu.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 xiaoxu
* @date 2021-12-23
* Ymybatis:com.xiaoxu.utils.MybatisUtil
*/
public class MybatisUtil {
private static SqlSessionFactory factory=null;
private static Boolean auto_commit=null;
static {
String config="mybatis.xml";
try {
InputStream inputStream = Resources.getResourceAsStream(config);
factory = new SqlSessionFactoryBuilder().build(inputStream);
auto_commit=false;
} catch (IOException e) {
e.printStackTrace();
}
}
public static SqlSession getSqlSession(){
SqlSession sqlSession=null;
if(factory!=null){
sqlSession=factory.openSession(auto_commit);
}
return sqlSession;
}
public static SqlSession getAutoCommitSqlSession(){
SqlSession sqlSession=null;
if(factory!=null){
sqlSession = factory.openSession(true);
}
return sqlSession;
}
}
上面的Mybatis获取sqlSession的工具类,在openSession中可以传入布尔值决定事务是否自动提交(如果为true,则为自动提交事务),mybatis在使用除了select语句外的其他语句(如insert、update、delete)时,事务自动提交是关闭的,要真正执行这些sql语句,需要使用如下语句:
sqlSession.commit();
但是在使用SqlSeesion工厂创建SqlSeesion时,openSession(true)效果等同于执行了sqlSession.commit()。
增加dao.UserDao接口方法:
package com.xiaoxu.dao;
import com.xiaoxu.domain.User;
import java.util.List;
/**
* @author xiaoxu
* @date 2021-12-15
* Ymybatis:com.xiaoxu.dao.UserDao
*/
public interface UserDao {
User selectUserById(int id);
List<User> selectUsers();
int insertUsers(List<User> userList);
}
修改Mapper(UserDao.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">
<!--
1.约束文件:http://mybatis.org/dtd/mybatis-3-mapper.dtd,访问可以下载该文件,还有http://mybatis.org/dtd/mybatis-3-config.dtd
作用:定义和限制当前文件中可以使用的标签和属性,以及标签出现的顺序
2.mapper是根标签,必须有;namespace:命名空间,必须有,不能为空,唯一值。
作用:参与识别sql语句
3.在mapper里可以写<select>\<insert>\<delete>\<update>语句
4.namespace填写UserDao接口的全限定名,select等各个标签的id,是唯一值,且最好选择接口的方法名称;
resultType:告诉mybatis,执行sql语句,把数据赋值给那个类型的java对象,所以是UserDao接口中该方法对应的返回值类型,也是全限定名
-->
<mapper namespace="com.xiaoxu.dao.UserDao">
<select id="selectUserById" resultType="com.xiaoxu.domain.User">
select id,name,age,money from myuser where id=#{my_id}
</select>
<select id="selectStudents" resultType="com.xiaoxu.domain.User">
select * from myuser
</select>
<!-- open="(" close=")" 这两个属性是在foreach的最外面再加上的,与这里的批量insert插入不符
因为批量插入的insert语句应该是 insert into 表名(字段1,字段2,字段3) values(?,?,?),(?,?,?)-->
<insert id="insertUsers">
insert into myuser(name,age,money) values
<foreach collection="list" item="item" separator=",">
(#{item.name},#{item.age},#{item.money})
</foreach>
</insert>
</mapper>
UserDaoImpl实现UserDao的接口方法:
package com.xiaoxu.impl;
import com.xiaoxu.dao.UserDao;
import com.xiaoxu.domain.User;
import com.xiaoxu.utils.MybatisUtil;
import org.apache.ibatis.session.SqlSession;
import org.springframework.stereotype.Repository;
import java.util.List;
/**
* @author xiaoxu
* @date 2021-12-27
* Ymybatis:com.xiaoxu.impl.UserDaoImpl
*/
@Repository
public class UserDaoImpl implements UserDao {
@Override
public User selectUserById(int id) {
SqlSession s= MybatisUtil.getSqlSession();
String sqlId="com.xiaoxu.dao.UserDao.selectUserById";
User u=s.selectOne(sqlId,id);
System.out.println(u);
s.close();
return u;
}
@Override
public List<User> selectUsers() {
SqlSession s= MybatisUtil.getSqlSession();
String sqlId = "com.xiaoxu.dao.UserDao.selectStudents";
List<User> userList = s.selectList(sqlId);
userList.forEach(System.out::println);
s.close();
return userList;
}
@Override
public int insertUsers(List<User> userList) {
SqlSession s = MybatisUtil.getAutoCommitSqlSession();
String sqlId = "com.xiaoxu.dao.UserDao.insertUsers";
int rows = s.insert(sqlId,userList);
System.out.println("插入的数据的行数为:"+rows);
s.close();
return rows;
}
}
新建spring的配置类:
com.xiaoxu.config包中:
package com.xiaoxu.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
/**
* @author xiaoxu
* @date 2021-12-27
* Ymybatis:com.xiaoxu.config.MyConfig
*/
@Configuration
@ComponentScan(basePackages = {"com.xiaoxu"})
public class MyConfig {
}
新建Mybatis工具类的使用测试类:
import com.xiaoxu.config.MyConfig;
import com.xiaoxu.dao.UserDao;
import com.xiaoxu.domain.User;
import com.xiaoxu.impl.UserDaoImpl;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
/**
* @author xiaoxu
* @date 2021-12-24
* Ymybatis:PACKAGE_NAME.MybatisUtilTest
*/
public class MybatisUtilTest {
@Test
public void test_01(){
ApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
UserDao u = context.getBean("userDaoImpl",UserDaoImpl.class);
u.selectUserById(2);
u.selectUserById(1);
}
@Test
public void test_02(){
ApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
UserDao u = context.getBean("userDaoImpl", UserDaoImpl.class);
u.selectUsers();
}
@Test
public void test_03(){
ApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
UserDao u = context.getBean("userDaoImpl",UserDaoImpl.class);
User u1 = new User();
u1.setName("小王");
u1.setAge((byte) 28);
u1.setMoney(new BigDecimal("9.99"));
User u2 = new User();
u2.setName("小张");
u2.setAge((byte) 55);
u2.setMoney(new BigDecimal("12.89"));
List<User> my_user_list = new ArrayList<User>(){{
add(u1);
add(u2);
}};
u.insertUsers(my_user_list);
}
}
在执行测试类前,开启Mybatis的sql日志打印出来:
修改mybatis.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>
<!-- 引入外部properties文件 -->
<properties resource="jdbc.properties"/>
<!-- 将sql语句等日志打印出来 -->
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
<!-- 和spring整合之后,environments配置会废除 -->
<environments default="development">
<environment id="development">
<!-- 使用JDBC事务管理 -->
<transactionManager type="JDBC"/>
<!-- 配置数据源:创建Connection对象(数据库连接池) -->
<dataSource type="POOLED">
<!-- driver:驱动的内容 -->
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!-- 指定其它mapper文件的位置
目的:找到其它文件的sql语句
-->
<mappers>
<!--
使用mapper的resource属性指定mapper文件的路径
这个路径是从target/classes路径开启的
使用注意:resource="mapper文件的路径,使用 / 分割路径"
一个mapper resource 指定一个mapper文件,多个就多个mapper标签
-->
<mapper resource="com/xiaoxu/dao/UserDao.xml"/>
</mappers>
</configuration>
预备数据库数据:
测试类执行效果如下:
test_01:
test_02:
test_03:
插入后,表中新增自增id为9和10的数据: