陆续来写Mybatis的相关文章,本文是第一篇,搭建一个可以运行的最简环境。
后续在此基础上叠加。
什么是Mybatis
Mybatis是一款优秀的持久层框架,它支持自定义SQL/存储过程以及高级映射。
Mybatis免除了几乎所有的JDBC代码以及设置参数和获取结果集的工作。 Mybatis可以通过简单的 XML
或注解来配置和映射原始类型、接口和Java POJO为数据库中的记录。
使用入门
如果使用Maven来构建项目,需要将下面的以来代码至于pom.xml文件中:
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.4</version>
</dependency>
我们用一个最简单的例子来把mybatis的环境搭建起来。
pom.xml中还需要加入:mysql、lombok和Junit的依赖
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<version>8.0.32</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>RELEASE</version>
<scope>test</scope>
</dependency>
我们在本地mysql数据库创建一个名为tool的数据库,
然后新建一张名为t_device的表,表中有两个字段:id和sn。
CREATE TABLE `t_device` (
`id` int(11) NOT NULL,
`sn` varchar(45) CHARACTER SET latin1 DEFAULT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `sn_UNIQUE` (`sn`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4
Mybatis有一个全局的配置文件,mybatis-config.xml,位于资源路径下。
我们使用properties配置文件来记录数据库连接信息。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<properties resource="db.properties"></properties>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="mapper/DeviceMapper.xml"/>
</mappers>
</configuration>
db.properties 配置文件内容:
driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql:///tool?useUnicode=true&characterEncoding=utf8
username=root
password=root
我们创建一个实体类与数据库t_device的字段进行映射。
package com.lk.tool.bean;
import lombok.Builder;
import lombok.Data;
@Data
@Builder
public class Device {
private int id;
private String sn;
}
与映射文件对应的数据库操作接口:
package com.lk.tool.mapper;
import com.lk.tool.bean.Device;
public interface DeviceMapper {
int insert(Device device);
Device queryBySn(Device device);
}
对应DeviceMapper.xml文件如下:
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.lk.tool.mapper.DeviceMapper">
<resultMap type="com.lk.tool.bean.Device" id="DeviceResult">
<id column="id" property="id"/>
<result column="sn" property="sn"/>
</resultMap>
<select id="queryBySn" resultMap="DeviceResult" parameterType="com.lk.tool.bean.Device">
select * from t_device
where sn = #{sn}
</select>
<insert id="insert">
insert into t_device (id, sn) values (
#{id}, #{sn}
)
</insert>
</mapper>
以上代码结构如下图所示:
接下来的测试代码中,
我们是通过getMapper的方式来使用的。
需要注意的是,要将DeviceMapper.xml中namespace 声明为DeviceMapper的全路径名;
同时对应的sql标签的id和方法名称要一致。如下图所示:
测试代码
package com.lk.tool.mapper;
import com.lk.tool.bean.Device;
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;
class DeviceMapperTest {
@org.junit.jupiter.api.Test
void insert() throws IOException {
InputStream in = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
SqlSession sqlSession = factory.openSession();
DeviceMapper deviceMapper = sqlSession.getMapper(DeviceMapper.class);
int result = deviceMapper.insert(Device.builder().id(2).sn("2234567").build());
sqlSession.commit();
System.out.println(result);
}
@org.junit.jupiter.api.Test
void queryBySn() throws IOException {
InputStream in = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
SqlSession sqlSession = sqlSessionFactory.openSession();
DeviceMapper deviceMapper = sqlSession.getMapper(DeviceMapper.class);
Device device = deviceMapper.queryBySn(Device.builder().sn("1234567").build());
System.out.println(device);
}
}
执行新增和查询测试类,可以看到相应效果。
代码已上传,请自行 下载示例源码。
如上是搭建了一个mybatis的最简易环境。
接下来我们在下篇文章中,来看下全局配置文件的各个配置项,以及映射文件中的配置内容。