首先来说一下什么是Mybatis,MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
下面我们来做个Mybatis的简单入门(项目使用Idea进行构建)
准备工作,创建对应的数据库和表
create database test;
create table users(id int primary key, username varchar(20), password varchar(10));
- 创建一个maven工程
命名mybatis-start
整体项目结构如图
2.引入mybatis
的jar包,为了方便给实体类创建set/get方法我们引入lombok
工具包,为了方便测试我们引入junit
<?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>mybatis-start</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
- 首先我们来创建实体类User
@Data
注解可以帮我们自动创建get/set方法,@ToString
注解可以帮我们创建toString方法
@Data
@ToString
public class User {
private Integer id;
private String username;
private String password;
}
- 创建User 的Mapper接口
里面包含三个方法,两个查询,一个添加,如果需要可以自己添加更多方法
public interface IUserDao {
List<User> getUserList();
User getUserById(Integer userId);
void addUser(User user);
}
- 创建User实体的映射文件
userMapper.xml
注意
- 这里resultType我们使用了user这个名字,是因为我们在mybatis的配置文件中起了别名,如果没有起别用,要使用
User.java
的全路径 - namespace要和我们的
IUserDao.java
全路径一直 - 标签select以及insert中的id要和
IUserDao.java
中定义的方法名保持一致
<?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.wtf.dao.IUserDao">
<select id="getUserList" resultType="user">
select * from users
</select>
<select id="getUserById" parameterType="integer" resultType="user">
select * from users where id = #{id}
</select>
<insert id="addUser" parameterType="user">
insert into users values (#{id}, #{username}, #{password})
</insert>
</mapper>
- 创建Mybatis的配置文件
sqlMapConfig.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 resource="jdbc.properties"/>
<typeAliases>
<!--起别名 别名不区分大小写-->
<typeAlias type="com.wtf.domain.User" alias="user"/>
</typeAliases>
<!--配置环境 default:默认使用的环境-->
<environments default="dev">
<!--id环境的唯一标识-->
<environment id="dev">
<!--当前事务交给jdbc处理 指定事务类型-->
<transactionManager type="jdbc" />
<!--使用mybatis提供的连接池 type指定当前数据源类型-->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.ur}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<!--引入mappers-->
<mappers>
<mapper resource="userMapper.xml"/>
</mappers>
</configuration>
这里为了不对数据库配置硬编码,我们引入了jdbc.properties
配置文件,专门针对jdbc参数做配置
- 创建
jdbc.properties
配置文件
jdbc.driver=com.mysql.jdbc.Driver
jdbc.ur=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=root
8.接下来我们创建测试类来进行测试
public class IUserDaoTest {
private SqlSession sqlSession;
private IUserDao userDao;
@Before
public void getMapper() {
InputStream resourceAsStream = null;
try {
resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
} catch (IOException e) {
System.out.println("加载配置失败");
}
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
this.sqlSession = sqlSessionFactory.openSession();
this.userDao = sqlSession.getMapper(IUserDao.class);
}
@Test
public void addUser() {
User user = new User();
user.setId(1);
user.setUsername("zhangSan");
user.setPassword("123456");
userDao.addUser(user);
//提交事务
sqlSession.commit();
}
@Test
public void getUserList() {
List<User> userList = userDao.getUserList();
for (User user : userList) {
System.out.println(user);
}
}
@Test
public void getUserById() {
User user = userDao.getUserById(1);
System.out.println(user);
}
}
我们可以先插入一条数据,然后查询数据是否插入成功
日志正常打印,我们可以看到插入的数据已经在数据库中了