创建 Maven 项目
1. 菜单上选择新建项目
File | New | Project
2. 选择左侧的Maven
Maven
由于我们只是创建一个普通的项目, 此处点击 Next即可。
3. 输入GroupId和ArtifactId
在我的项目中,
GroupId 填 com.homejim.mybatis
ArtifactId 填 helloMybatis
点击 Next。
4. Finish
通过以上步骤, 一个普通的Maven项目就创建好了。
Maven配置
为了让mybatis在项目上跑起来,需要进行如下配置。
pom.xml
1. 配置 JDK 版本和编码方式
org.apache.maven.plugins
maven-compiler-plugin
2.3.2
1.8
1.8
UTF-8
设置后, 编码方式为 UTF-8, JDK 版本为 1.8
2. 设置资源文件路径
Maven 中默认是只会打包 resource下的资源文件。如果我们的文件不放在resource, 则需要通过配置告知Maven。
src/main/java
**/*.properties
**/*.xml
false
2. 添加 mybatis 依赖
org.mybatis
mybatis
3.4.5
本项目的 mybatis版本为3.4.5。
3. 添加数据库驱动依赖
mysql
mysql-connector-java
5.1.45
本项目使用的是mysql数据库。
4. 添加日志依赖
org.slf4j
slf4j-api
1.7.25
org.slf4j
slf4j-log4j12
1.7.25
org.apache.logging.log4j
log4j-core
2.10.0
添加日志是为了在测试时可以输出sql语句。
5. 添加测试依赖
junit
junit
4.12
test
添加junit是为了测试更加方便。
6. 导入依赖
右键 pom.xml | Maven | Reimport
导入依赖
创建数据库
1. 创建数据库
CREATE DATABASE IF NOT EXISTS `mybatis` DEFAULT CHARSET utf8 COLLATE utf8_general_ci;
指定编码为 UTF8
2. 创建数据库表
创建一个 student 表。
DROP TABLE IF EXISTS `student`;
CREATE TABLE `student` (
`student_id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '编号',
`name` VARCHAR(20) DEFAULT NULL COMMENT '姓名',
`phone` VARCHAR(20) DEFAULT NULL COMMENT '电话',
`email` VARCHAR(50) DEFAULT NULL COMMENT '邮箱',
`sex` TINYINT(4) DEFAULT NULL COMMENT '性别',
`locked` TINYINT(4) DEFAULT NULL COMMENT '状态(0:正常,1:锁定)',
`gmt_created` DATETIME DEFAULT CURRENT_TIMESTAMP COMMENT '存入数据库的时间',
`gmt_modified` DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改的时间',
PRIMARY KEY (`student_id`)
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='学生表';
3. 插入测试数据
插入一些测试数据。
INSERT INTO `student`(`name`, phone, email, sex, locked)
VALUES
('小明', 13821378270, 'xiaoming@mybatis.cn', 1, 0),
('小丽', 13821378271, 'xiaoli@mybatis.cn', 0, 0),
('小刚', 13821378272, 'xiaogang@mybatis.cn', 1, 0),
('小花', 13821378273, 'xiaohua@mybatis.cn', 0, 0),
('小强', 13821378274, 'xiaoqiang@mybatis.cn', 1, 0),
('小红', 13821378275, 'xiaohong@mybatis.cn', 0, 0);
配置Mybatis
配置mybatis的XML文件
XML 配置文件(configuration XML)中包含了对 MyBatis 系统的核心设置。
1. 复制框架
从官网中复制最基本的配置:
2. 配置 environments
environments 对应的是数据库相关的属性。我们可以配置多个环境,但每个 SqlSessionFactory 实例只能选择其一。在本项目中, 我们只配置一个即可。数据库时刚刚我们创建的mybatis。
3. 配置 settings
在本项目中, 主要是为了配置日志输出。 pom.xml中配置的是 log4j, 因此此处的日志实现值是 LOG4J。
4. 配置 typeAliases
类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关,存在的意义仅在于用来减少类完全限定名的冗余。
如果我们这样配置
<--项目中不是这样配置的-->
那么在mybatis中, Student可以用在任何使用com.homejim.mybatis.entity.Student的地方。
但一般来说entity都会有很多, 因此这样配置太繁琐了, mybatis支持指定包名, 会使用类的首字母小写的类限定名作为别名。
本项目中, 如下配置
5. 配置 mappers
同理, 可以单个配置, 也可以通过扫描包来识别。
该配置会扫描指定包中的所有 .xml 文件,这些文件包含着mybatis的 SQL 语句和映射配置文件。后续会创建。
创建实体类和对应的Mapper.xml
1. 创建实体类
实体类, 属性需要与数据库表中的字段一一对应, 并有对应的getter和setter。
package com.homejim.mybatis.entity;
import java.util.Date;
public class Student {
private Integer studentId;
private String name;
private String phone;
private String email;
private Byte sex;
private Byte locked;
private Date gmtCreated;
private Date gmtModified;
/**
* 以下部分为setter和getter, 省略
*/
}
2. 创建 Mapper 接口和 Mapper.xml
StudentMapper.java
package com.homejim.mybatis.mapper;
import com.homejim.mybatis.entity.Student;
import java.util.List;
public interface StudentMapper {
/**
*
* @return
*/
List
selectAll();
}
StudentMapper.xml
student_id, name, phone, email, sex, locked, gmt_created, gmt_modified
配置了结果映射和 sql 语句, 其中 sql 中的 id 与Mapper中的方法名一致。
测试
public class StudentMapperTest {
private static SqlSessionFactory sqlSessionFactory;
@BeforeClass
public static void init() {
try {
Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
} catch (IOException e) {
e.printStackTrace();
}
}
@Test
public void testSelectList() {
SqlSession sqlSession = null;
try {
sqlSession = sqlSessionFactory.openSession();
List students = sqlSession.selectList("selectAll");
for (int i = 0; i < students.size(); i++) {
System.out.println(students.get(i));
}
} catch (Exception e) {
e.printStackTrace();
} finally {
if (sqlSession != null) {
sqlSession.close();
}
}
}
}
通过 Resources 工具类读取 mybatis-config.xml, 存入 Reader;
SqlSessionFactoryBuilder使用上一步获得的reader创建SqlSessionFactory对象;
通过 sqlSessionFactory 对象获得SqlSession;
SqlSession对象通过selectList方法找到对应的“selectAll”语句, 执行SQL查询。
底层通过 JDBC 查询后获得ResultSet, 对每一条记录, 根据resultMap的映射结果映射到Student中, 返回List。
最后记得关闭 SqlSession。
获得的结果如下
结果
有SQL输出, 以及SQL的执行情况
源码
请访问我的 Github 主页获取。https://www.cnblogs.com/homejim/p/9613205.html