Mybatis（一）：环境搭建

以你之姓@ 2023-09-28 13:43 18阅读 0赞

### Mybatis（一）：环境搭建 ###

*  前言
 *  一、MyBatis简介
 *   *  1、MyBatis历史
     *  2、MyBatis特性
     *  3、MyBatis下载
     *  4、和其它持久化层技术对比
 *  二、搭建MyBatis
 *   *  1、开发环境
     *  2、创建maven工程
     *   *  2.1 打包方式：jar
         *  2.2 引入依赖
     *  3、创建MyBatis的核心配置文件
     *  4、创建mapper接口
     *  5、创建MyBatis的映射文件
     *  6、通过junit测试功能
     *  7、优化
     *   *  7.1 优化一：自动提交事务
         *  7.2 优化二:加入log4j日志功能
 *  三、核心配置文件详解
 *  四、idea中设置文件模板
 *   *  1、在idea中设置核心配置文件的模板
     *  2、在idea中设置映射文件的模板

--------------------

# 前言 #

本博主将用CSDN记录软件开发求学之路上亲身所得与所学的心得与知识，有兴趣的小伙伴可以关注博主！也许一个人独行，可以走的很快，但是一群人结伴而行，才能走的更远！

# 一、MyBatis简介 #

## 1、MyBatis历史 ##

> `MyBatis`最初是`Apache`的一个开源项目`iBatis`, 2010年6月这个项目由`Apache Software Foundation`迁移到了`Google Code`。随着开发团队转投`Google Code`旗下，`iBatis3.x`正式更名为`MyBatis`。代码于2013年11月迁移到`Github`。

> `iBatis`一词来源于“`internet`”和“`abatis`”的组合，是一个基于`Java`的持久层框架。 `iBatis`提供的持久层框架包括`SQL Maps`和`Data Access Objects（DAO`）。

## 2、MyBatis特性 ##

> ⭕ `MyBatis` 是支持定制化 `SQL`、存储过程以及高级映射的优秀的持久层框架  
> ⭕ `MyBatis` 避免了几乎所有的 `JDBC`代码和手动设置参数以及获取结果集  
> ⭕ `MyBatis`可以使用简单的XML或注解用于配置和原始映射，将接口和`Java`的`POJO`（`Plain Old Java Objects`，普通的`Java`对象）映射成数据库中的记录  
> ⭕ `MyBatis` 是一个 半自动的`ORM`（`ObjectRelation Mapping`）框架

## 3、MyBatis下载 ##

[点击跳转下载页面][Link 1]  
![在这里插入图片描述][0a012a0cdd47407cbf19ef26f1addd1e.png]

## 4、和其它持久化层技术对比 ##

> ⭕ **`JDBC`**
> 
> ● `SQL` 夹杂在`Java`代码中耦合度高，导致硬编码内伤  
> ● 维护不易且实际开发需求中 `SQL` 有变化，频繁修改的情况多见  
> ● 代码冗长，开发效率低

> ⭕ **`Hibernate`** 和 **`JPA`**  
> ● 操作简便，开发效率高  
> ● 程序中的长难复杂 `SQL` 需要绕过框架  
> ● 内部自动生产的 `SQL`，不容易做特殊优化  
> ● 基于全映射的全自动框架，大量字段的 `POJO` 进行部分映射时比较困难  
> ● 反射操作太多，导致数据库性能下降

> ⭕ **`MyBatis`**
> 
> ●轻量级，性能出色 `SQL` 和 `Java` 编码分开，功能边界清晰  
> ●`Java`代码专注业务、`SQL`语句专注数据  
> ●开发效率稍逊于`HIbernate`，但是完全能够接受

# 二、搭建MyBatis #

## 1、开发环境 ##

> ⭕ `IDEA`：`idea 2019.2`  
> ⭕ 构建工具：`maven 3.5.4`  
> ⭕ `MySQL`版本：`MySQL 5.7`  
> ⭕ `MyBatis`版本：`MyBatis 3.5.7`

## 2、创建maven工程 ##

### 2.1 打包方式：jar ###

### 2.2 引入依赖 ###

<dependencies>
      
      <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.7</version>
      </dependency>
     
      
      <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
      </dependency>
     
      
      <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.3</version>
      </dependency>
    </dependencies>

## 3、创建MyBatis的核心配置文件 ##

> ⭕ 习惯上命名为`mybatis-config.xml`，这个文件名仅仅只是建议，并非强制要求。  
> ⭕ 将来整合`Spring`之后，这个配置文件可以省略，所以大家操作时可以直接复制、粘贴。  
> ⭕ 核心配置文件主要用于配置连接数据库的环境以及`MyBatis`的全局配置信息

`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>
    
      
      <environments default="development">
        <environment id="development">
          <transactionManager type="JDBC"/>
          <dataSource type="POOLED">
            <property name="driver" value="com.mysql.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql://localhost:3306/MyBatis"/>
            <property name="username" value="root"/>
            <property name="password" value="0523"/>
          </dataSource>
        </environment>
      </environments>
      
      
      <mappers>
        <mapper resource="mappers/UserMapper.xml"/>
      </mappers>
    </configuration>

## 4、创建mapper接口 ##

> `MyBatis`中的`mapper`接口相当于以前的`dao`，我们可以理解为与之前我们学习的`DAO`类相呼应。但是区别在于，`mapper`仅仅是接口，我们不需要提供它的实现类。

public interface UserMapper {
         
      /**
      * 添加用户信息
      */
      int insertUser();
    }

## 5、创建MyBatis的映射文件 ##

> ⭕ 相关概念：`ORM（Object Relationship Mapping）`对象关系映射。  
> ● 对象：`Java`的实体类对象  
> ● 关系：关系型数据库  
> ● 映射：二者之间的对应关系

> ⭕ 一张数据库的表对应一个`DAO`类，即一张表对应一个`Mapper`接口，一个`Mapper`接口对应一个映射文件，所有有此对应关系：  
> 一张数据库表`<===>`一个实体类`<===>`一个`DAO`类`/Mapper`接口`<===>`一个映射文件

<table> 
 <thead> 
  <tr> 
   <th>Java概念</th> 
   <th>数据库概念</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类</td> 
   <td>表</td> 
  </tr> 
  <tr> 
   <td>属性</td> 
   <td>字段/列</td> 
  </tr> 
  <tr> 
   <td>对象</td> 
   <td>记录/行</td> 
  </tr> 
 </tbody> 
</table>

> ⭕ 映射文件的命名规则： 表所对应的实体类的类名+`Mapper.xml`  
> 例如：表`t_user`，映射的实体类为`User`，所对应的映射文件为`UserMapper.xml`  
> 因此一个映射文件对应一个实体类，对应一张表的操作

> ⭕ `MyBatis`映射文件用于编写`SQL`，访问以及操作表中的数据

> ⭕ `MyBatis`映射文件存放的位置是`src/main/resources/mappers`目录下

> ⭕ `MyBatis`中可以面向接口操作数据，要保证两个一致：  
> ● `mapper`接口的全类名和映射文件的命名空间（`namespace`）保持一致  
> ● `mapper`接口中方法的方法名和映射文件中编写`SQL`的标签的id属性保持一致

`User`类：

public class User {
         
        private Integer id;
    
        private String username;
    
        private String password;
    
        private Integer age;
    
        private String sex;
    
        private String email;
        ...
    }

`UserMapper.java`：

public interface UserMapper {
         
        /**
         * MyBatis面向接口编程的两个一致：
         * 1.映射文件的 namespace 要和 mapper 接口的全类名保持一致
         * 2.映射文件中的SQL语句的id要和 mapper 接口中的方法名保持一致
         */
    
        /**
         *添加用户信息
         */
        int insertUser();
    }

`UserMapper.xml`:

<?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.ir.mybatis.mapper.UserMapper">
    
              
              <insert id="insertUser">
                    insert into t_user values(null,'张三','123',23,'女')
              </insert>
              
    </mapper>

## 6、通过junit测试功能 ##

测试：

package com.ir.mybaits.test;
    
    import com.ir.mybatis.mapper.UserMapper;
    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 org.junit.Test;
    
    import java.io.IOException;
    import java.io.InputStream;
    
    /**
     * @author shkstart
     * @create 2022-07-02 15:36
     */
    public class MyBatisTest {
         
        @Test
        public void testMyBatis() throws IOException {
         
            //加载核心配置文件---->制作建筑图纸
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            //获取SqlSessionFactoryBuilder---->招募工人
            SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
            //通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory，生产SqlSession对象---->图纸给工人，去造工厂
            SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
            //创建SqlSession对象，此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务---->工厂生产出产品
            SqlSession sqlSession = sqlSessionFactory.openSession();
            //调用UserMapper接口中的方法，就可以根据UserMapper的全类名匹配元素文件，通过调用的方法名匹配映射文件中的SQL标签，并执行标签中的SQL语句---->产品的功能
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            //测试
            int result = mapper.insertUser();
            //提交事务
            sqlSession.commit();
            System.out.println("result:"+result);
        }
    }

知识点：

> ⭕ `SqlSession`：代表`Java`程序和数据库之间的会话。（`HttpSession`是`Java`程序和浏览器之间的会话）

> ⭕ `SqlSessionFactory`：是“生产”`SqlSession`的“工厂”。

> ⭕工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象。

## 7、优化 ##

### 7.1 优化一：自动提交事务 ###

> `SqlSession`默认不自动提交事务，若需要自动提交事务，可以使用`SqlSessionFactory.openSession（true);`

### 7.2 优化二:加入log4j日志功能 ###

（1）加入依赖

<dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.17</version>
    </dependency>

（2）加入`log4j`的配置文件

> ⭕ `log4j`的配置文件名为`log4j.xml`，存放的位置是`src/main/resources`目录下

> ⭕日志的级别:`FATAL`(致命)>`ERROR`(错误)>`WARN`(警告)>`INFO`(信息)>`DEBUG`(调试)  
> 从左到右打印的内容越来越详细

`log4j.xml`：

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
     
    <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
     
      <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Encoding" value="UTF-8" />
        <layout class="org.apache.log4j.PatternLayout">
          <param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS}
    %m (%F:%L) \n" />
        </layout>
      </appender>
      <logger name="java.sql">
        <level value="debug" />
      </logger>
      <logger name="org.apache.ibatis">
        <level value="info" />
      </logger>
      <root>
        <level value="debug" />
        <appender-ref ref="STDOUT" />
      </root>
    </log4j:configuration>

# 三、核心配置文件详解 #

`jdbc.properties`：

jdbc.driver=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/mybatis
    jdbc.username=root
    jdbc.password=0523

`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="com.ir.mybatis.pojo"/>
            </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>
    
                    <environment id="test">
                            <transactionManager type="JDBC"/>
                            <dataSource type="POOLED">
                                    <property name="driver" value="com.mysql.jdbc.Driver"/>
                                    <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
                                    <property name="username" value="root"/>
                                    <property name="password" value="123456"/>
                            </dataSource>
                    </environment>
            </environments>
            
            <mappers>
                    
                    
                    <package name="com.ir.mybatis.mapper"/>
            </mappers>
    </configuration>

注意：

> ⭕ 核心配置文件中的标签必须按照固定的顺序：
> 
> 1.  `properties`
> 2.  `settings`
> 3.  `typeAliases`
> 4.  `typeHandlers`
> 5.  `objectFactory`
> 6.  `objectWrapperFactory`
> 7.  `reflectorFactory`
> 8.  `plugins`
> 9.  `environments`
> 10. `databaseIdProvider`
> 11. `mappers`

> ⭕ `<typeAliases> </typeAliases>`
> 
> 支持以包为单位来设置默认类型

> ⭕ `<mappers></mappers>`
> 
> ● 支持以包为单位来引入映射文件  
> ● 在`resources`下创建包名时，由于`resources`下为普通文件，所以并不可以以"`.`“为分隔符的方式来创建嵌套的包名，而应该用以”`/`"的方式来创建

![在这里插入图片描述][3be4d77c409a4926ad1947eb97f1eef9.png]

# 四、idea中设置文件模板 #

## 1、在idea中设置核心配置文件的模板 ##

⭕ `mybatis-config`官方文档模板：

<?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="${driver}"/>
                    <property name="url" value="${url}"/>
                    <property name="username" value="${username}"/>
                    <property name="password" value="${password}"/>
                </dataSource>
            </environment>
        </environments>
        
        <mappers>
            <mapper resource="org/mybatis/example/BlogMapper.xml"/>
        </mappers>
        
    </configuration>

⭕ 设置：  
![17b37fd975d14446830f2819d6db010c.png][]  
![在这里插入图片描述][c824d2ceb5ea41b4aea686520ae833b8.png]

## 2、在idea中设置映射文件的模板 ##

⭕ `mybatis-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.mybatis.example.BlogMapper">
        <select id="selectBlog" resultType="Blog">
            select * from Blog where id = #{id}
        </select>
    </mapper>

⭕ 设置：  
![在这里插入图片描述][0b619f4357d94d04a51a02f45dc6653b.png]  
![在这里插入图片描述][9801b4ca60a848f9833d4fad48963f9f.png]

[Link 1]: https://github.com/mybatis/mybatis-3
[0a012a0cdd47407cbf19ef26f1addd1e.png]: https://img-blog.csdnimg.cn/0a012a0cdd47407cbf19ef26f1addd1e.png
[3be4d77c409a4926ad1947eb97f1eef9.png]: https://img-blog.csdnimg.cn/3be4d77c409a4926ad1947eb97f1eef9.png
[17b37fd975d14446830f2819d6db010c.png]: https://img-blog.csdnimg.cn/17b37fd975d14446830f2819d6db010c.png
[c824d2ceb5ea41b4aea686520ae833b8.png]: https://img-blog.csdnimg.cn/c824d2ceb5ea41b4aea686520ae833b8.png
[0b619f4357d94d04a51a02f45dc6653b.png]: https://img-blog.csdnimg.cn/0b619f4357d94d04a51a02f45dc6653b.png
[9801b4ca60a848f9833d4fad48963f9f.png]: https://img-blog.csdnimg.cn/9801b4ca60a848f9833d4fad48963f9f.png