安装mybatis
maven工程下,直接在pom.xml文件中,添加如下依赖即可。
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis.version}</version>
</dependency>
其中,${mybatis.version}表示mybatis的版本号。
创建一个数据表
打开数据库,执行如下SQL代码创建一个user表。
create table user
(
id int auto_increment primary key,
username varchar(32) not null comment '用户名称',
birthday datetime null comment '生日',
sex char null comment '性别',
address varchar(256) null comment '地址'
)charset = utf8;
给表中插入数据,执行如下SQL代码:
insert into
`user`(`id`,`username`,`birthday`,`sex`,`address`)
values
(41,'老王','2018-02-27 17:47:08','男','北京'),
(42,'小二王','2018-03-02 15:09:37','女','北京金燕龙'),
(43,'小二王','2018-03-04 11:34:34','女','北京金燕龙'),
(45,'传智播客','2018-03-04 12:04:06','男','北京金燕龙'),
(46,'老王','2018-03-07 17:37:26','男','北京'),
(48,'小马宝莉','2018-03-08 11:44:00','女','北京修正');
创建一个普通的maven工程
分别在maven工程中创建两个包,分别为dao和domain,其中dao用来存放Java工程对数据表访问接口,而domain存放数据表经过ORM转换后得到得实体类。
其工程目录结构如下:
配置pom.xml文件,导入依赖,其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>20201111-cache</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<mybatis.version>3.5.6</mybatis.version>
<mysql.jdbc.version>8.0.20</mysql.jdbc.version>
<log4j.version>1.2.17</log4j.version>
<junit.version>4.13</junit.version>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<dependencies>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis.version}</version>
</dependency>
<!-- mysql jdbc-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.jdbc.version}</version>
</dependency>
<!-- log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<!-- junit test-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
再在resources文件夹目录下创建如下三个文件,如下图所示:
其中log4j.properties文件内容如下所示:
# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE debug info warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE
# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE
# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=d:\axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
此文件内容一般是写成这样就OK了,主要用来在控制台打印日志。(log4j.properties文件名不能改)
JDBCconfig.properties文件内容主要是自己对JDBC数据连接信息得配置,可以根据自己得喜好命名文件名,其文件内容一般如下所示:
# 这是mysql数据库
jdbc.driver = com.mysql.cj.jdbc.Driver
jdbc.url = jdbc:mysql://localhost:3306/mydb?serverTimezone=UTC
jdbc.username = root
jdbc.password = root
mybatisConfig.xml文件为mybatis的主要配置文件,要想用mybatis框架,就必须配置此文件。其文件名可以根据自己的喜好随便命名,不过作者强力建议命名为mybatisConfig.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>
<!-- 引入jdbc 配置文件-->
<properties resource="JDBCconfig.properties"/>
<!-- 配置环境-->
<environments default="mysql">
<!-- 配置MySQL的环境-->
<environment id="mysql">
<!-- 配置事务类型-->
<transactionManager type="JDBC"/>
<!-- 配置数据源-->
<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>
<!-- 导入文件的mapper-->
<mappers>
<mapper resource="com/liangmu66/dao/UserMapper.xml"/>
</mappers>
</configuration>
再到dao文件夹下创建UserDao.java文件和再在domain文件夹下创建User.java实体类,其文件夹结构如下所示:
UserDao.java文件内容如下所示:
package com.liangmu66.dao;
import com.liangmu66.domain.User;
import java.util.List;
public interface UserDao {
User findById(Integer id);
List<User> findAll();
}
User.java文件内容如下所示:
package com.liangmu66.domain;
import java.io.Serializable;
import java.util.Date;
public class User implements Serializable {
private Integer id;
private String username;
private String sex;
private String address;
private Date birthday;
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 String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", sex='" + sex + '\'' +
", address='" + address + '\'' +
", birthday=" + birthday +
'}';
}
}
再到resources文件夹创建如下文件夹结构,其目录结构和dao文件夹在java包下的目录结构是一样的。
其文件夹结构必须要与dao文件夹在Java包下的目录结构一样。其中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">
<mapper namespace="com.liangmu66.dao.UserDao">
<select id="findAll" resultType="com.liangmu66.domain.User">
<!-- resultType是必填的,表示其封装到的实体类类型-->
select * from user;
</select>
</mapper>
再到UserDao.java文件下,找到findAll()方法,在idea中选中此方法,右键单击,点击菜单项中的go to 选项,然后在点击test选项,生成测试类。其测试类的目录结构和代码如下所示:
UserDaoTest.java
package com.liangmu66.dao;
import com.liangmu66.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.After;
import org.junit.Before;
import org.junit.Test;
import java.io.InputStream;
import java.util.List;
import static org.junit.Assert.*;
public class UserDaoTest {
InputStream inputStream;
SqlSessionFactoryBuilder builder;
SqlSessionFactory factory;
SqlSession session;
UserDao userDao;
// berfore表示每次运行测试方法时,先执行此方法体。
@Before
public void setUp() throws Exception {
inputStream = Resources.getResourceAsStream("mybatisConfig.xml");
builder = new SqlSessionFactoryBuilder();
factory = builder.build(inputStream);
session = factory.openSession(true);
userDao = session.getMapper(UserDao.class);
}
// after表示每次运行测试方法后,调用此方法体。
@After
public void tearDown() throws Exception {
inputStream.close();
session.close();
}
// test表示此方法时一个测试方法,可以在idea中右键点击此方法,在右键方法中选择
// run test()运行此方法。
@Test
public void findAll() {
List<User> users = userDao.findAll();
for (var u : users) {
System.out.println(u.toString());
}
}
}
运行结果:
"D:\Program Files\Java\jdk-11.0.7\bin\java.exe" -ea -Didea.test.cyclic.buffer.size=1048576 "-javaagent:D:\IntelliJ IDEA 2020.2.1\lib\idea_rt.jar=52535:D:\IntelliJ IDEA 2020.2.1\bin" -Dfile.encoding=GBK -classpath "D:\IntelliJ IDEA 2020.2.1\lib\idea_rt.jar;D:\IntelliJ IDEA 2020.2.1\plugins\junit\lib\junit5-rt.jar;D:\IntelliJ IDEA 2020.2.1\plugins\junit\lib\junit-rt.jar;C:\Users\良木\Desktop\learning\20201111-cache\target\test-classes;C:\Users\良木\Desktop\learning\20201111-cache\target\classes;D:\maven\maven_repo\org\mybatis\mybatis\3.5.6\mybatis-3.5.6.jar;D:\maven\maven_repo\mysql\mysql-connector-java\8.0.20\mysql-connector-java-8.0.20.jar;D:\maven\maven_repo\com\google\protobuf\protobuf-java\3.6.1\protobuf-java-3.6.1.jar;D:\maven\maven_repo\log4j\log4j\1.2.17\log4j-1.2.17.jar;D:\maven\maven_repo\junit\junit\4.13\junit-4.13.jar;D:\maven\maven_repo\org\hamcrest\hamcrest-core\1.3\hamcrest-core-1.3.jar" com.intellij.rt.junit.JUnitStarter -ideVersion5 -junit4 com.liangmu66.dao.UserDaoTest,findAll
2020-11-12 15:56:45,422 0 [ main] DEBUG ache.ibatis.logging.LogFactory - Logging initialized using 'class org.apache.ibatis.logging.log4j.Log4jImpl' adapter.
2020-11-12 15:56:45,498 76 [ main] DEBUG source.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2020-11-12 15:56:45,498 76 [ main] DEBUG source.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2020-11-12 15:56:45,499 77 [ main] DEBUG source.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2020-11-12 15:56:45,499 77 [ main] DEBUG source.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2020-11-12 15:56:45,735 313 [ main] DEBUG ansaction.jdbc.JdbcTransaction - Opening JDBC Connection
2020-11-12 15:56:48,214 2792 [ main] DEBUG source.pooled.PooledDataSource - Created connection 349259569.
2020-11-12 15:56:48,240 2818 [ main] DEBUG .liangmu66.dao.UserDao.findAll - ==> Preparing: select * from user;
2020-11-12 15:56:48,285 2863 [ main] DEBUG .liangmu66.dao.UserDao.findAll - ==> Parameters:
2020-11-12 15:56:48,333 2911 [ main] DEBUG .liangmu66.dao.UserDao.findAll - <== Total: 6
User{id=41, username='老王', sex='男', address='北京', birthday=Wed Feb 28 01:47:08 CST 2018}
User{id=42, username='小二王', sex='女', address='北京金燕龙', birthday=Fri Mar 02 23:09:37 CST 2018}
User{id=45, username='传智播客', sex='男', address='北京金燕龙', birthday=Sun Mar 04 20:04:06 CST 2018}
User{id=46, username='老王', sex='男', address='北京', birthday=Thu Mar 08 01:37:26 CST 2018}
User{id=48, username='小马宝莉', sex='女', address='北京修正', birthday=Thu Mar 08 19:44:00 CST 2018}
User{id=55, username='刘粮源', sex='男', address='陕西省宝鸡市', birthday=Thu Nov 05 13:15:51 CST 2020}
2020-11-12 15:56:48,360 2938 [ main] DEBUG ansaction.jdbc.JdbcTransaction - Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@14d14731]
2020-11-12 15:56:48,360 2938 [ main] DEBUG source.pooled.PooledDataSource - Returned connection 349259569 to pool.
Process finished with exit code 0
总结
一个mybatis项目要包含四个部分,分别是数据库表对应的实体类,此实体类对应的操作方法接口,此接口所匹配的映射文件mapper.xml,同时还要有一个掌控全局的主配置文件mybatisConfig.xml。
mybatis的持久化过程如下所示:
先创建一个SqlSessionFactoryBuilder ,再利用SqlSessionFactoryBuilder 创建一个SqlSessionFactory(此步要传入mybatis的主配置文件),利用SqlSessionFactory创建一个SqlSession会话,再利用此会话获得操作接口代理类,操作完成后,关闭。