接上章源码阅读:开源项目环境搭建,按官方文档运行一个示例项目,再用 H2 内存库验证 SQL 映射。
项目结构
项目源代码:mybatis-learning-01
mybatis-learning/mybatis-learning-01
├── mybatis-learning-01.iml
├── pom.xml # 项目依赖管理 1
└── src
├── main
│ ├── java
│ │ ├── cn
│ │ │ └── z201
│ │ │ └── mybatis
│ │ │ └── learning
│ │ │ ├── SetUpSessionFactory.java # mybatis 初始化 3
│ │ │ ├── User.java # 实体 5
│ │ │ └── UserDao.java # 实体 dao 6
│ │ └── package-info.java
│ └── resources
│ ├── init_table.sql # h2 数据库初始化 sql 4
│ ├── mybatis
│ │ └── UserDao.xml # dao 对应的 mapper 7
│ └── mybatis-config.xml # mybatis 配置文件 2
└── test
└── java
└── cn
└── z201
└── mybatis
└── test
├── MybatisTest01.java # 单元测试 8
└── package-info.java
15 directories, 11 files
按注释中的顺序逐段介绍项目代码。
0x01 项目依赖管理
<?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>cn.z201</groupId>
<artifactId>mybatis-learning-01</artifactId>
<version>1.0-SNAPSHOT</version>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>8</source>
<target>8</target>
</configuration>
</plugin>
</plugins>
</build>
<properties>
<mybatis.version>3.5.0</mybatis.version>
<junit.version>4.12</junit.version>
<lombok.version>1.18.4</lombok.version>
<mysql.version>5.1.47</mysql.version>
<h2.version>1.4.197</h2.version>
<!-- pom 文件需要指定打包编码集,否则会提示 File encoding has not been set -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis.version}</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>${h2.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
0x02 MyBatis 配置文件
<?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="org.h2.Driver"/>
<property name="url" value="jdbc:h2:mem:mybatis_learning_01_db;MODE=MYSQL;INIT=RUNSCRIPT FROM './src/main/resources/init_table.sql'"/>
<property name="username" value="root"/>
<property name="password" value=""/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="mybatis/UserDao.xml"/>
</mappers>
</configuration>
0x03 MyBatis 初始化
package cn.z201.mybatis.learning;
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;
public class SetUpSessionFactory {
public SqlSession initSessionFactory() throws IOException {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
return sqlSessionFactory.openSession();
}
}
0x04 H2 数据库初始化 SQL
CREATE TABLE `user`(
id SMALLINT PRIMARY KEY AUTO_INCREMENT ,
name VARCHAR(50),
age SMALLINT,
gender SMALLINT
);
INSERT INTO `user`(name , age , gender) VALUES('TOM' , 12 , 0 );
INSERT INTO `user`(name , age , gender) VALUES('JON' , 13 , 1 );
INSERT INTO `user`(name , age , gender) VALUES('King' , 11 , 0 );
0x05 实体 Bean
package cn.z201.mybatis.learning;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.ToString;
@Data
@AllArgsConstructor
@ToString
public class User {
private Integer id;
private String name;
private Integer age;
private Integer gender;
}
0x06 实体 Dao
package cn.z201.mybatis.learning;
import java.util.List;
public interface UserDao {
List<User> list();
}
0x07 实体 Dao 对应的 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="cn.z201.mybatis.learning.UserDao">
<select id="list" resultType="cn.z201.mybatis.learning.User">
SELECT * FROM `user`
</select>
</mapper>
0x08 单元测试
package cn.z201.mybatis.test;
import cn.z201.mybatis.learning.SetUpSessionFactory;
import cn.z201.mybatis.learning.User;
import cn.z201.mybatis.learning.UserDao;
import org.apache.ibatis.session.SqlSession;
import org.junit.Assert;
import org.junit.Test;
import java.io.IOException;
import java.util.List;
public class MybatisTest01 {
@Test
public void test01() throws IOException {
SetUpSessionFactory setUpSessionFactory = new SetUpSessionFactory();
SqlSession sqlSession = setUpSessionFactory.initSessionFactory();
UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.list();
sqlSession.close();
Assert.assertNotNull(userList);
userList.forEach(System.out::println);
}
}
结果:
User(id=1, name=TOM, age=12, gender=0)
User(id=2, name=JON, age=13, gender=1)
User(id=3, name=King, age=11, gender=0)
0x09 接入 Slf4j 与 Logback
上面的测试只打印查询结果,看不到实际执行的 SQL。按官方日志文档接入 Slf4j 与 Logback 后,测试控制台会多输出 Preparing、Parameters、Total 三类日志。
示例项目:mybatis-learning-02
在 pom.xml 中补充依赖与版本属性:
<properties>
<mybatis.version>3.5.0</mybatis.version>
<junit.version>4.12</junit.version>
<lombok.version>1.18.4</lombok.version>
<mysql.version>5.1.47</mysql.version>
<h2.version>1.4.197</h2.version>
<!-- 新增内容 -->
<slf4j.version>1.7.25</slf4j.version>
<logback.version>1.2.3</logback.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>${logback.version}</version>
</dependency>
新增 logback.xml 配置,把 root 级别设为 debug:
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>z201.github.cn %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="STDOUT" />
</root>
</configuration>
再次运行单元测试,输出中可以看到 MyBatis 选用的日志实现与实际 SQL:
z201.github.cn 15:08:30.046 [main] DEBUG org.apache.ibatis.logging.LogFactory - Logging initialized using 'class org.apache.ibatis.logging.slf4j.Slf4jImpl' adapter.
z201.github.cn 15:08:30.076 [main] DEBUG o.a.i.d.pooled.PooledDataSource - PooledDataSource forcefully closed/removed all connections.
z201.github.cn 15:08:30.155 [main] DEBUG o.a.i.t.jdbc.JdbcTransaction - Opening JDBC Connection
z201.github.cn 15:08:30.356 [main] DEBUG o.a.i.d.pooled.PooledDataSource - Created connection 1839168128.
z201.github.cn 15:08:30.356 [main] DEBUG o.a.i.t.jdbc.JdbcTransaction - Setting autocommit to false on JDBC Connection [conn0: url=jdbc:h2:mem:mybatis_learning_01_db user=ROOT]
z201.github.cn 15:08:30.358 [main] DEBUG c.z201.mybatis.learning.UserDao.list - ==> Preparing: SELECT * FROM `user`
z201.github.cn 15:08:30.384 [main] DEBUG c.z201.mybatis.learning.UserDao.list - ==> Parameters:
z201.github.cn 15:08:30.411 [main] DEBUG c.z201.mybatis.learning.UserDao.list - <== Total: 3
z201.github.cn 15:08:30.414 [main] DEBUG o.a.i.t.jdbc.JdbcTransaction - Resetting autocommit to true on JDBC Connection [conn0: url=jdbc:h2:mem:mybatis_learning_01_db user=ROOT]
z201.github.cn 15:08:30.415 [main] DEBUG o.a.i.t.jdbc.JdbcTransaction - Closing JDBC Connection [conn0: url=jdbc:h2:mem:mybatis_learning_01_db user=ROOT]
z201.github.cn 15:08:30.415 [main] DEBUG o.a.i.d.pooled.PooledDataSource - Returned connection 1839168128 to pool.
User(id=1, name=TOM, age=12, gender=0)
User(id=2, name=JON, age=13, gender=1)
User(id=3, name=King, age=11, gender=0)
z201.github.cn 15:08:30.416 [main] DEBUG cn.z201.mybatis.test.MybatisTest01 - end...
小结
H2 用 jdbc:h2:mem 配 MODE=MYSQL 与 INIT=RUNSCRIPT 自动建表灌数,JUnit 4 取 mapper 断言即可验证映射;再引入 slf4j-api 与 logback-classic、把 root 级别调到 debug,日志会输出 Preparing、Parameters、Total,排查 SQL 时不必改映射文件。