MyBatis配置总结

2024-04-03 15:15:04

环境说明：

jdk 8 +
MySQL 5.7.19
maven-3.6.0
IDEA

学习前需要掌握：

JDBC
MySQL
Java 基础
Maven
Junit（调试挺重要的，可以在配置文件配置阶段将错误解决）

什么是Mybatis

MyBatis 是一款优秀的持久层框架，
MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。-
MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

Mybatis官方文档

GitHub地址

名词解释

持久化

持久化是将程序数据在持久状态和瞬时状态间转换的机制。

把数据（如内存中的对象）保存到可永久保存的存储设备中（如磁盘）。持久化的主要应用是将内存中的对象存储在数据库中，或者存储在磁盘文件中、XML数据文件中等等。 JDBC就是一种持久化机制。文件IO也是一种持久化机制。

为什么需要持久化服务呢？那是由于内存本身的缺陷引起的
- 内存断电后数据会丢失，但有一些对象是无论如何都不能丢失的，比如银行账号等，遗憾的是，人们还无法保证内存永不掉电。
- 内存过于昂贵，与硬盘、光盘等外存相比，内存的价格要高2~3个数量级，而且维持成本也高，至少需要一直供电吧。所以即使对象不需要永久保存，也会因为内存的容量限制不能一直呆在内存中，需要持久化来缓存到外存

持久层

什么是持久层
- 完成持久化工作的代码块 . ----> dao层【DAO (Data Access Object) 数据访问对象】
- 大多数情况下特别是企业级应用，数据持久化往往也就意味着将内存中的数据保存到磁盘上加以固化，而持久化的实现过程则大多通过各种关系数据库来完成。
- 不过这里有一个字需要特别强调，也就是所谓的“层”。对于应用系统而言，数据持久功能大多是必不可少的组成部分。也就是说，我们的系统中，已经天然的具备了“持久层”概念？也许是，但也许实际情况并非如此。之所以要独立出一个“持久层”的概念,而不是“持久模块”，“持久单元”，也就意味着，我们的系统架构中，应该有一个相对独立的逻辑层面，专著于数据持久化逻辑的实现.
- 与系统其他部分相对而言，这个层面应该具有一个较为清晰和严格的逻辑边界。【说白了就是用来操作数据库存在的！】

为什么需要学习Mybatis

传统的jdbc操作 , 有很多重复代码块 .比如 : 数据取出时的封装 , 数据库的建立连接等等… , 通过框架可以减少重复代码,提高开发效率 .
MyBatis 是一个半自动化的ORM框架 (Object Relationship Mapping) -->对象关系映射
优点
- 简单易学：本身就很小且简单。没有任何第三方依赖，最简单安装只要两个jar文件+配置几个 sql映射文件就可以了，易于学习，易于使用，通过文档和源代码，可以比较完全的掌握它的设计思路和实现。
- 灵活：mybatis不会对应用程序或者数据库的现有设计强加任何影响。 sql写在xml里，便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求。
- 解除sql与程序代码的耦合：通过提供DAO层，将业务逻辑和数据访问逻辑分离，使系统的设计更清晰，更易维护，更易单元测试。sql和代码的分离，提高了可维护性。
- 提供xml标签，支持编写动态sql。

构建Mybatis项目需要导入的依赖

由于使用Maven使得导包这件事情变得异常简单，只需要在pom.xml中配置一下语句即可

<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>

配置核心配置文件

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<!--核心配置文件-->
<configuration>
    <!--引入外部配置文件-->
    <properties resource="db.properties" />

    <!--配置日志logImpl
            SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING
    标准的日志工厂：STDOUT_LOGGING
    LOG4J
    -->

    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
        <!--配置驼峰命名规则打开-->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <!--配置二级缓存-->
        <setting name="cacheEnabled" value="true"/>
    </settings>
    <!--可以给实体类取别名-->
    <!--<typeAliases>-->
    <!--    <typeAlias type="top.nz.pojo.User" alias="User"/>-->
    <!--</typeAliases>-->
    <!--扫描包，别名建议使用小写，大写也能跑。可以通过注解给类取别名@Alias("user")-->
    <typeAliases>
        <package name="top.nz.pojo"/>
    </typeAliases>
    <!--可以配置多套环境，但是默认使用default指定的环境-->
    <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>
        <!--使用Dao层接口自动匹配，优点可以同时使用注解和配置文件的形式-->
        <mapper class="top.nz.dao.UserMapper" />
        <!--直接绑定对应的xml源-->
        <mapper resource="top/nz/dao/UserMapper.xml"/>
    </mappers>
</configuration>

从上往下将配置文件中需要自己配置的文件进行罗列

db.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&serverTimezone=Hongkong&characterEncoding=utf8
username=root
password=123456

log4j

可以自己配置一些日志信息，如info,error等，也可以使用STDOUT_LOGGING不需要进行配置

首先导入依赖的包

<!-- https://mvnrepository.com/artifact/log4j/log4j -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

使用log4j首先需要在Mybatis的核心配置文件的setting中配置日志类型，注意value不要带空格，以免错误

<settings>
        <setting name="logImpl" value="LOG4J"/>
</settings>

需要在resources下书写配置文件

log4j.properties

#将等级为DEBUG的日志信息输出到console和file这两个目的地，console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file

#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/nz.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG

在需要进行日志书写的类中添加如下代码

// 在要输出日志的类中加入相关语句：导入包别出错 import org.apache.log4j.Logger;
    static Logger logger = Logger.getLogger(UserDaoTest.class);

// 可以在需要原本在控制台中输出的信息输出到日志中
logger.info("测试,进入getUserById方法成功");

ehcache.xml

首先说明可以不配置二级缓存，只需要在核心配置文件中加入

<settings>
        <!--配置二级缓存-->
        <setting name="cacheEnabled" value="true"/>
</settings>

然后在需要缓存的mapper.xml文件中加上

<cache
            eviction="FIFO"
            flushInterval="60000"
            size="512"
            readOnly="true"/>

当然可以使用ehcache.xml，就和log4j一样，自定义的东西会更多一些。

首先导入依赖

<!-- https://mvnrepository.com/artifact/org.mybatis.caches/mybatis-ehcache -->
        <dependency>
            <groupId>org.mybatis.caches</groupId>
            <artifactId>mybatis-ehcache</artifactId>
            <version>1.1.0</version>
        </dependency>

然后在resources中编写ehcache.xml

<?xml version="1.0" encoding="UTF-8" ?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"
         updateCheck="false">

    <diskStore path="./tmpdir/Tmp_EhCache"/>

    <defaultCache
            eternal="false"
            maxElementsInMemory="10000"
            overflowToDisk="false"
            diskPersistent="false"
            timeToIdleSeconds="1800"
            timeToLiveSeconds="259200"
            memoryStoreEvictionPolicy="LRU"/>

    <cache
            name="cloud_user"
            eternal="false"
            maxElementsInMemory="5000"
            overflowToDisk="false"
            diskPersistent="false"
            timeToIdleSeconds="1800"
            timeToLiveSeconds="1800"
            memoryStoreEvictionPolicy="LRU"/>
</ehcache>

缓存现阶段只需要了解，因为暂时还无法在到具体的业务中使用到。

其他核心配置文件中也加上了注释，基本没有问题。

编写MybatisUtils，用于构建sqlSession

package top.nz.utils;

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;

// sqlSessionFactory 生产 sqlSession
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;
    static {
        try {
            // 使用Mybatis第一步获取sqlSessionFactory
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    //  既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
    // SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
    public static SqlSession getSqlSession(){
        // 自动提交
        return  sqlSessionFactory.openSession();
    }

}

码农公寓