02. Mybatis 环境搭建

曾经终败给现在 2024-04-17 14:56 66阅读 0赞

Mybatis 是一个持久层的半自动化ORM框架, 所以Mybatis的基础环境搭建一个JavaSE 环境即可. 而已笔者认为, 搭建一个JavaSE 环境, 更利于深入学习和研究Mybatis 的特性. 在此基础之上, 应该细读Mybatis 官方文档, 多动手实践. 笔者使用Maven 构建工具, 因此搭建一个基于Maven 的JavaSE 环境.

## 1. 创建表 ##

*  mybatis 是操作关系型数据库的, 所以首先要在本地安装一个数据库,笔者安装的是mysql.
 *  首先创建数据库schema: learn-mybatis3, 再创建表t\_person

CREATE TABLE `t_employee` (
      `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键ID, 自增',
      `name` varchar(120) DEFAULT NULL COMMENT '姓名',
      `sex` varchar(45) DEFAULT NULL COMMENT '性别',
      `age` int(11) DEFAULT NULL COMMENT '年龄',
      `entryDate` dateDEFAULT NULL COMMENT '入职日期',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;

## 2. 集成Mybatis 配置 ##

### 2.1 引入maven 依赖 ###

*  引入数据库驱动: 笔者使用的数据库为mysql
 *  引入Mybatis 依赖, 只有一个jar包
 *  引入logback 依赖, 开启日志功能
 *  引入junit 依赖, 集成单元测试

<properties>
        <junit.version>4.12</junit.version>
        <mysql.version>6.0.5</mysql.version>
        <mybatis.version>3.4.6</mybatis.version>
        <logback.version>1.2.3</logback.version>
    </properties>
    
    <dependencies>
      
        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
            <scope>runtime</scope>
        </dependency>
    
        
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>${mybatis.version}</version>
        </dependency>
    
        
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>${logback.version}</version>
        </dependency>
    
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>${logback.version}</version>
        </dependency>
        
         
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
        </dependency>
    </dependencies>
    
    <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>

### 2.2 配置日志 ###

*  Mybatis 支持SLF4J, Appache Common Logging, Log4j 等日志, 笔者选择的是Logback. 只需要引入logback依赖即可.
 *  文件位置: src/main/resources/logback.xml
 *  将日志级别设置为DEBUG, 运行时会输出sql 语句

<?xml version="1.0"?>
    <configuration debug="false">
    
        
        <contextName>learn-mybatis3-l01</contextName>
    
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                
                <pattern>[%d{yyyy-MM-dd HH:mm:ss:SSS}][%thread][%-5level][%logger{36}]- %msg%n</pattern>
            </encoder>
        </appender>
    
        
        <root level="DEBUG">
            <appender-ref ref="STDOUT"/>
        </root>
    </configuration>

### 2.3 创建数据库配置属性文件 ###

*  将数据库配置提取为属性文件, 这样在Mybatis全局配置文件中可以使用$\{\}提取属性中值.
 *  文件位置: src/main/resources/jdbc.properties

jdbc.driver=com.mysql.cj.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/learn-mybatis3?serverTimezone=UTC
    jdbc.username=root
    jdbc.password=root

### 2.4 创建Mybatis全局配置文件 ###

*  全局配置文件是Mybatis的核心配置文件, 用于配置Mybatis数据源, 插件,别名等, 还可以修改Mybatis 的核心运行参数, 改变Mybatis 的运行行为.
 *  文件位置: src/main/resources/mybatis-config.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>
            <package name="org.zongf.learn.mybatis3.l01.po" />
        </typeAliases>
    
        
        <environments default="development">
    
            
            <environment id="development">
    
                
                <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>
    
        
        <mappers>
            <mapper resource="mappers/EmployeeMapper.xml"/>
        </mappers>
    </configuration>

## 3. 持久层开发 ##

### 3.1 创建实体 ###

在java 工程中创建与表对应的po 类, 笔者省略了setter/getter方法和toString()方法.

public class EmployeePO { 
    
        private Long id;
    
        private String name;
    
        private Integer age;
    
        private String sex;
    
        private LocalDate entryDate;
        
        // 省略无参构造器, 有参构造器, setter/getter 方法, toString 方法
    }

### 3.2 创建数据库操作接口Mapper ###

*  使用Mybatis 只需要定义接口即可, 无须开发实现类. 因为Mybatis在运行时, 会自动为接口创建动态代理.
 *  文件位置: org.zongf.learn.mybatis3.l01.mapper.PersonMapper

public interface EmployeeMapper { 
    
        // 定义通过id 获取返回值的方法, 参数为id, 返回值为PersonPO
        PersonPO findById(Long id);
    }

### 3.3 创建sql 映射文件 ###

在Mybatis 中, 通常会为一个Mapper 接口类, 编写一个Mapper sql 映射文件, Mapper 接口中每个方法, 在xml 配置文件中都有一个id为方法名的xml 片段与之对应. 当调用Mapper 接口中的方法时, 会执行sql 映射文件中对应的sql语句.

*  文件位置: src/main/resources/mappers/EmployeeMapper.xml
 *  注意namespace 的值为对应的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="org.zongf.learn.mybatis3.l01.mapper.EmployeeMapper">
    
         
        <select id="findById" resultType="EmployeePO">
            select * from t_employee where id = #{id}
        </select>
    
    </mapper>

## 4. 测试 ##

Mybatis 执行数据库操作有两种方式, 一种是通过sqlID,无须借助与Mapper接口, 只开发sql 映射文件即可; 另一种是通过接口, 需要为每个sql 映射文件开发一个与之对应的Mapper 接口. 通常, 我们都会选择接口方式, 因为接口方式会有类型校验和类型限制.

*  SqlSessionFactoryBuilder: 通过解析全局配置文件, 构建SqlSessionFactory对象
 *  SqlSessionFactory: sqlSession工厂, 用户获取sqlSession对象
 *  SqlSession: 相当于数据库连接, 非线程安全的, 因此每次数据库操作都需要新打开一个连接, 用完再关闭.

### 4.1 接口方式 ###

// 接口方式
    @Test
    public void test01() throws IOException { 
        // 全局配置文件
        String globalConfigFile = "mybatis-config.xml";
    
        // 1. 使用配置文件构建SqlSessionFactory 工厂对象
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                .build(Resources.getResourceAsStream(globalConfigFile));
    
        // 2. 获取sqlSession,相当于数据库连接, sqlSession 是非线程安全的, 所以每次数据库操作都需要重新获取sqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
    
        // 3. 获取Mapper接口对应的代理对象
        EmployeeMapper employeeMapper = sqlSession.getMapper(EmployeeMapper.class);
    
        // 4. 执行mapper 对应的方法
        EmployeePO employeePO = employeeMapper.findById(1L);
    
        // 5. 关闭连接
        sqlSession.close();
    
        System.out.println(employeePO);
    }

### 4.2 sqlId方式 ###

@Test
    public void test02() throws IOException { 
    
        // 全局配置文件
        String globalConfigFile = "mybatis-config.xml";
    
        // 1. 使用配置文件构建SqlSessionFactory 工厂对象
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                .build(Resources.getResourceAsStream(globalConfigFile));
    
        // 2. 获取sqlSession,相当于数据库连接, sqlSession 是非线程安全的, 所以每次数据库操作都需要重新获取sqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
    
        // 3. 执行sql
        EmployeePO employeePO = (EmployeePO) sqlSession.selectOne("org.zongf.learn.mybatis3.l01.mapper.EmployeeMapper.findById", 1);
    
        // 4. 关闭连接
        sqlSession.close();
    
        System.out.println(employeePO);
    }