MyBatis的相关api以及配置解析

Posted 2022-06-23 流楚丶格念

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了MyBatis的相关api以及配置解析相关的知识，希望对你有一定的参考价值。

文章目录

MyBatis的相关api
MyBatis 映射配置文件
Mybatis核心配置文件介绍
Mybatis传统方式开发
- 5.1 Dao 层传统实现方式
- 5.2 LOG4J的配置和使用

MyBatis的相关api

1.1 Resources

org.apache.ibatis.io.Resources：加载资源的工具类。

核心方法

1.2 构建器SqlSessionFactoryBuilder

org.apache.ibatis.session.SqlSessionFactoryBuilder：获取 SqlSessionFactory 工厂对象的功能类

核心方法

通过加载mybatis的核心文件的输入流的形式构建一个SqlSessionFactory对象

String resource = "org/mybatis/builder/mybatis-config.xml"; 
InputStream inputStream = Resources.getResourceAsStream(resource); 
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); 
SqlSessionFactory factory = builder.build(inputStream);

其中， Resources 工具类，这个类在 org.apache.ibatis.io 包中。Resources 类帮助你从类路径下、文件系统或一个 web URL 中加载资源文件。

1.3 工厂对象SqlSessionFactory

org.apache.ibatis.session.SqlSessionFactory：获取 SqlSession 构建者对象的工厂接口。

核心api

1.4 SqlSession会话对象

org.apache.ibatis.session.SqlSession：构建者对象接口。用于执行 SQL、管理事务、接口代理。

核心api

SqlSession 实例在 MyBatis 中是非常强大的一个类。在这里你会看到所有执行语句、提交或回滚事务和获取映射器实例的方法。

1.5 相关api应用示例

/**
 * 查询全部数据
 * @throws Exception
 */
@Test
public void selectAll() throws Exception
    //1.加载核心配置文件
    //InputStream is = Resources.getResourceAsStream("MyBatisConfig.xml");
    InputStream is = StudentTest01.class.getClassLoader().getResourceAsStream("MyBatisConfig.xml");

    //2.获取SqlSession工厂对象
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);

    //3.通过SqlSession工厂对象获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();

    //4.执行映射配置文件中的sql语句，并接收结果
    List<Student> list = sqlSession.selectList("StudentMapper.selectAll");

    //5.处理结果
    for (Student stu : list) 
        System.out.println(stu);
    

    //6.释放资源
    sqlSession.close();
    is.close();

MyBatis 映射配置文件

2.1 映射配置文件介绍

映射配置文件包含了数据和对象之间的映射关系以及要执行的 SQL 语句

<?xml version="1.0" encoding="UTF-8" ?>
<!--MyBatis的DTD约束-->
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!--
    mapper：核心根标签
    namespace属性：名称空间
-->
<mapper namespace="StudentMapper">
    <!--
        select：查询功能的标签
        id属性：唯一标识
        resultType属性：指定结果映射对象类型
        parameterType属性：指定参数映射对象类型
    -->
    <select id="selectAll" resultType="student">
        SELECT * FROM student
    </select>
</mapper>

2.2 查询功能

<select>：查询功能标签。

属性

id：唯一标识，配合名称空间使用。
parameterType：指定参数映射的对象类型。
resultType：指定结果映射的对象类型。
SQL 获取参数: #属性名

示例

<select id="selectById" resultType="com.yyl.bean.Student" parameterType="int">
    SELECT * FROM student WHERE id = #id
</select>

2.3 新增功能

<insert>：新增功能标签。

属性

id：唯一标识，配合名称空间使用。
parameterType：指定参数映射的对象类型。
resultType：指定结果映射的对象类型。
SQL 获取参数: #属性名

示例

<insert id="insert" parameterType="student">
    INSERT INTO student VALUES (#id,#name,#age)
</insert>

2.4 修改功能

<update>：修改功能标签。

属性

id：唯一标识，配合名称空间使用。
parameterType：指定参数映射的对象类型。
resultType：指定结果映射的对象类型。
SQL 获取参数: #属性名

示例

<update id="update" parameterType="student">
    UPDATE student SET name = #name,age = #age WHERE id = #id
</update>

2.5 删除功能

：查询功能标签。
属性

id：唯一标识，配合名称空间使用。
parameterType：指定参数映射的对象类型。
resultType：指定结果映射的对象类型。
SQL 获取参数: #属性名

示例

<delete id="delete" parameterType="int">
    DELETE FROM student WHERE id = #id
</delete>

总结：大家可以发现crud操作，除了标签名称以及sql语句不一样之外，其他属性参数基本一致。

Mybatis核心配置文件介绍

3.1 核心配置文件介绍

核心配置文件包含了 MyBatis 最核心的设置和属性信息。如数据库的连接、事务、连接池信息等。

如下代码:

<?xml version="1.0" encoding="UTF-8" ?>
<!--MyBatis的DTD约束-->
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 2.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">

<!--configuration 核心根标签-->
<configuration>

    <!--environments配置数据库环境，环境可以有多个。default属性指定使用的是哪个-->
    <environments default="mysql">
        <!--environment配置数据库环境  id属性唯一标识-->
        <environment id="mysql">
            <!-- transactionManager事务管理。  type属性，采用JDBC默认的事务-->
            <transactionManager type="JDBC"></transactionManager>
            <!-- dataSource数据源信息   type属性 连接池-->
            <dataSource type="POOLED">
                <!-- property获取数据库连接的配置信息 -->
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql:///db1" />
                <property name="username" value="root" />
                <property name="password" value="root" />
            </dataSource>
        </environment>
    </environments>

    <!-- mappers引入映射配置文件 -->
    <mappers>
        <!-- mapper 引入指定的映射配置文件   resource属性指定映射配置文件的名称 -->
        <mapper resource="StudentMapper.xml"/>
    </mappers>
</configuration>

3.2 数据库连接配置文件引入

properties标签引入外部文件

    <!--引入数据库连接的配置文件-->
    <properties resource="jdbc.properties"/>

xml中具体使用，如下配置

  <!-- property获取数据库连接的配置信息 -->
    <property name="driver" value="$driver" />
    <property name="url" value="$url" />
    <property name="username" value="$username" />
    <property name="password" value="$password" />

jdbc.properties文件中配置如下

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

3.3 起别名

<typeAliases>：为全类名起别名的父标签。
<typeAlias>：为全类名起别名的子标签。

属性

type：指定全类名
alias：指定别名

<package>：为指定包下所有类起别名的子标签。(别名就是类名)

如下图：

具体如下配置

  <!--起别名-->
  <typeAliases>
      <typeAlias type="com.yyl.bean.Student" alias="student"/>
      <!--<package name="com.yyl.bean"/>-->
  </typeAliases>

3.4 核心配置文件小总结

核心配置文件包含了MyBatis最核心的设置和属性信息。如数据库的连接、事务、连接池信息等。

<configuration>:核心根标签。
<properties> :引入数据库连接信息配置文件标签。
<typeAliases>:起别名标签。
<environments>:配置数据库环境标签。
<environment>:配置数据库信息标签。
<transactionManager>:事务管理标签。
<dataSource>:数据源标签。
<property> :数据库连接信息标签。
<mappers> : 引入映射配置文件标签。

示例配置文件如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!--MyBatis的DTD约束-->
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 2.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">

<!--configuration 核心根标签-->
<configuration>

    <!--environments配置数据库环境，环境可以有多个。default属性指定使用的是哪个-->
    <environments default="mysql">
        <!--environment配置数据库环境  id属性唯一标识-->
        <environment id="mysql">
            <!-- transactionManager事务管理。  type属性，采用JDBC默认的事务-->
            <transactionManager type="JDBC"></transactionManager>
            <!-- dataSource数据源信息   type属性 连接池-->
            <dataSource type="POOLED">
                <!-- property获取数据库连接的配置信息 -->
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql:///db1" />
                <property name="username" value="root" />
                <property name="password" value="root" />
            </dataSource>
        </environment>
    </environments>

    <!-- mappers引入映射配置文件 -->
    <mappers>
        <!-- mapper 引入指定的映射配置文件   resource属性指定映射配置文件的名称 -->
        <mapper resource="StudentMapper.xml"/>
    </mappers>
</configuration>

Mybatis传统方式开发

5.1 Dao 层传统实现方式

分层思想：控制层(controller)、业务层(service)、持久层(dao)。
调用流程

5.2 LOG4J的配置和使用

在日常开发过程中，排查问题时难免需要输出 MyBatis 真正执行的 SQL 语句、参数、结果等信息，我们就可以借助 LOG4J 的功能来实现执行信息的输出。

使用步骤：

导入jar包

修改核心配置文件

    <!--配置LOG4J-->
    <settings>
        <setting name="logImpl" value="log4j"/>
    </settings>

在src下编写log4j的配置文件

# Global logging configuration
# ERROR WARN INFO DEBUG
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

以上是关于MyBatis的相关api以及配置解析的主要内容，如果未能解决你的问题，请参考以下文章

Mybatis源码解析MyBatis解析全局配置文件

认识MyBatis-总述

MyBatis之启动分析

mybatis与数据库访问相关的配置以及设计

XML的解析方法

Mybatis配置解析以及日志的处理，分页的使用，使用注解开发，Lombok入门