详解MyBatis配置文件开发与注解式开发

首先呢，五一快来啦！提前祝各位宝子们五一玩得开心，然后讲解一下MyBatis框架呀!!!

一.框架介绍

MyBatis 的主要特点

二.MyBatis工作流程

1. 初始化和配置

2. 创建 SqlSessionFactory

3. 获取 SqlSession

4. 映射器绑定

5. 执行操作

6. 处理结果

7. 提交或回滚事务

8. 释放资源

示例

注意事项

 三.核心配置文件

四.配置文件开发

五.注解式开发

1. 配置 Mapper 扫描

2. 使用注解定义 Mapper

3. 使用注解定义结果映射

4. 示例

5. 配置 MyBatis

6. 启动类配置

一.框架介绍

MyBatis 是一款优秀的持久层框架，它提供了一个对象关系映射层，用于将 Java 对象与 SQL 数据库交互操作简化。MyBatis 允许开发者直接使用 SQL 语句（包括存储过程）操作数据库，并且可以通过 XML 或注解的方式来配置 SQL 语句，从而实现数据的增删改查操作。

MyBatis 的主要特点

1. SQL 与 Java 对象映射：MyBatis 通过映射文件将 SQL 语句与 Java 对象关联起来，支持将数据库表字段映射到 Java 对象的属性中。

2. 灵活的 SQL 编写：MyBatis 允许开发者编写动态 SQL，可以根据不同的需求灵活地构造查询语句。

3. 简单易用：MyBatis 的 API 设计简洁，使用起来直观方便。

4. 插件化：MyBatis 提供了丰富的插件接口，如分页、性能分析等，可以通过编写自己的插件来扩展框架的功能。

5. 事务管理：MyBatis 支持声明式事务管理，可以与 Spring 框架无缝集成。

6. 映射器：MyBatis 使用映射器（Mapper）接口和 XML 文件来定义数据库操作。

7. 结果类型：支持将 SQL 结果集映射到 Java 对象的简单类型、自动包装类型、复杂类型等。

8. 动态 SQL：MyBatis 提供了强大的动态 SQL 功能，可以根据不同条件动态地生成 SQL 语句。

9. 缓存机制：MyBatis 提供了一级缓存（SqlSession 级别）和二级缓存（SqlSessionFactory 级别），可以显著提高应用程序的性能。

二.MyBatis工作流程

MyBatis 是一个流行的持久层框架，它提供了一个对象关系映射层，用于简化 JDBC 的数据库操作。MyBatis 的执行过程涉及几个关键步骤，下面是一个高层次的概述：

1. 初始化和配置

在 MyBatis 启动时，它会读取配置文件（如 mybatis-config.xml），解析出数据库连接信息、事务管理方式、映射文件位置等信息。

2. 创建 SqlSessionFactory

使用配置信息创建一个 SqlSessionFactory 实例。这个实例是数据库操作的入口点，可以通过它来获取操作数据库所需的 SqlSession。

3. 获取 SqlSession

从 SqlSessionFactory 获取 SqlSession 实例。SqlSession 允许你直接执行已映射的 SQL 语句。

4. 映射器绑定

在获取 SqlSession 时，可以同时传入一个映射器接口（比如 UserMapper），MyBatis 会自动将接口中定义的方法与 SQL 语句进行绑定。

5. 执行操作

通过 SqlSession 调用映射器接口的方法执行数据库操作，如插入、查询、更新或删除。

6. 处理结果

MyBatis 将数据库返回的结果集映射到 Java 对象中。这可以是自动映射到简单类型，也可以是映射到复杂的 POJO（Plain Old Java Object）对象。

7. 提交或回滚事务

MyBatis 可以根据配置进行事务管理。在操作完成后，可以提交或回滚事务。

8. 释放资源

操作完成后，应该关闭 SqlSession 以释放数据库连接资源。

示例

以下是 MyBatis 执行过程的一个简单示例：

// 1. 配置和初始化
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactoryBuilder factoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = factoryBuilder.build(inputStream);

// 2. 获取 SqlSession
SqlSession session = factory.openSession();

try {
    // 3. 映射器绑定
    UserMapper userMapper = session.getMapper(UserMapper.class);

    // 4. 执行操作
    User user = userMapper.findUserById(1);

    // 5. 处理结果
    // ...

    // 6. 提交事务
    session.commit();
} catch (Exception e) {
    // 7. 回滚事务
    session.rollback();
    // 处理异常
} finally {
    // 8. 释放资源
    session.close();
}

注意事项

• MyBatis 支持配置文件和注解两种方式来绑定 SQL 语句和 Java 方法。
• MyBatis 允许使用强大的 XML 映射文件或注解来编写 SQL 语句。
• MyBatis 支持一级缓存（SqlSession 级别）和二级缓存（SqlSessionFactory 级别）来提高性能。
• MyBatis 支持插件机制，允许开发者插入自定义的拦截器进行逻辑处理，如分页插件、日志插件等。

这往往是初学者用来测试使用的代码步骤，了解即可。

 三.核心配置文件

MyBatis 框架主要使用两种类型的配置文件：

1. 核心配置文件 (mybatis-config.xml)：这是 MyBatis 的主要配置文件，包含了影响 MyBatis 行为的设置和属性信息。它位于 MyBatis 应用的 classpath 根路径下，通常命名为 mybatis-config.xml。这个文件涵盖了包括数据库连接信息、事务管理、日志配置、类型别名、类型处理器、对象工厂设置、映射器、插件等配置项。

2. 映射配置文件 (*Mapper.xml)：这些文件包含了 SQL 语句和 Java 类的映射关系。它们通常与 Mapper 接口一一对应，定义了数据库操作（如 select、insert、update、delete）的 SQL 语句。映射文件可以放在 mappers 标签内指定的位置，也可以通过注解的方式直接在 Mapper 接口上指定。

3. 结构如下：
4. <configuration>：根元素。
   • <properties>：外部化配置，如数据库连接信息。
   • <settings>：包含多个 <setting> 元素，用于调整 MyBatis 的行为。
   • <typeAliases>：定义类型别名，简化 XML 配置。
   • <typeHandlers>：自定义类型处理器。
   • <objectFactory>：指定对象工厂。
   • <objectWrapperFactory>：指定对象包装器工厂。
   • <plugins>：定义插件，如分页插件。
   • <environments>：定义多种数据库环境的配置，包括事务管理和数据源。
     • <environment>：具体的环境配置。
       • <transactionManager>：事务管理器配置。
       • <dataSource>：数据源配置。
   • <databaseIdProvider>：数据库厂商标识提供者。
   • <mappers>：指定映射文件的位置。
5. <mapper>：根元素，定义映射空间和命名空间。
   • <select>、<insert>、<update>、<delete>：定义 SQL 语句和映射规则。

6. 映射配置文件的结构通常包括：

7. <mapper>：根元素，定义映射空间和命名空间。
   • <select>、<insert>、<update>、<delete>：定义 SQL 语句和映射规则

四.配置文件开发

MyBatis 在启动时会解析其配置文件，以初始化和配置自身的运行环境。解析这些配置文件的顺序对框架的行为至关重要。以下是 MyBatis 解析配置文件的一般顺序：

1. 加载核心配置文件 (mybatis-config.xml)：

   MyBatis 首先加载其核心配置文件，这个文件包含了框架的全局配置，如事务管理器、数据源、类型别名、类型处理器、对象工厂、插件等。

2. 解析 <properties> 部分：

   在核心配置文件中，<properties> 部分通常会被首先解析，因为其他配置可能会引用这些属性。这些属性可以来自外部文件或直接在 XML 文件中定义。

3. 解析 <settings> 部分：

   紧接着，MyBatis 解析 <settings> 部分，这里定义了影响 MyBatis 行为的全局参数，如缓存配置、延迟加载设置等。

4. 解析 <typeAliases> 和 <typeHandlers>：

   这些部分定义了类型别名和类型处理器，它们可以让开发者在映射文件中使用简化的类名而非全限定名。

5. 解析 <objectFactory> 和 <objectWrapperFactory>：

   这些部分定义了对象工厂和对象包装器工厂，它们用于创建和处理结果对象。

6. 解析 <plugins>：

   插件定义在此部分，插件可以改变 MyBatis 的默认行为，例如实现分页查询。

7. 解析 <environments> 部分：

   环境配置定义了不同的运行环境，包括数据库连接信息和事务管理设置。

8. 解析 <mappers> 部分：

   最后，MyBatis 解析 <mappers> 部分，这里指定了映射文件的位置。映射文件包含了 SQL 语句和映射规则，它们通常与 Mapper 接口相关联。

9. 加载映射文件 (*Mapper.xml)：

   映射文件包含了具体的 SQL 映射语句，MyBatis 会根据 <mappers> 部分的配置加载这些文件。

10. 整合所有配置信息：

    所有配置信息被加载和解析后，MyBatis 会整合这些信息以构建其内部的数据结构，准备接受数据库操作请求。

五.注解式开发

MyBatis 注解式开发是一种使用注解（Annotations）来配置 MyBatis 映射，从而减少 XML 配置文件的使用。注解式开发可以简化配置，使代码更加清晰，同时保持 MyBatis 的强大功能。以下是使用注解的一些关键点：

1. 配置 Mapper 扫描

首先，需要配置 MyBatis 扫描 Mapper 接口和注解的 Mapper 文件。可以在核心配置文件 mybatis-config.xml 中使用 @MapperScan 注解指定包扫描路径，或者在 Spring 配置中指定。

2. 使用注解定义 Mapper

Mapper 接口中可以使用 MyBatis 提供的注解来定义 SQL 映射。以下是一些常用的注解：

• @Select：用于定义查询操作的 SQL 语句。
• @Insert：用于定义插入操作的 SQL 语句。
• @Update：用于定义更新操作的 SQL 语句。
• @Delete：用于定义删除操作的 SQL 语句。
• @Results：用于定义结果映射。
• @Param：用于指定方法参数的别名。

3. 使用注解定义结果映射

@Results 注解用于定义如何将 SQL 结果映射到 Java 对象的属性上。

4. 示例

假设有一个 User 实体类和一个对应的 UserMapper 接口：

public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User getUserById(@Param("id") int id);
    
    @Insert("INSERT INTO users(name, age) VALUES(#{name}, #{age})")
    int insertUser(User user);
    
    // 其他数据库操作...
}

在这个例子中：

• @Select 注解定义了一个查询操作，使用 #{id} 作为参数占位符。
• @Param 注解指定了方法参数 id 的别名，这样 MyBatis 就知道 #{id} 对应的是方法的哪个参数。
• @Insert 注解定义了一个插入操作，整个 User 对象将被用作参数。

5. 配置 MyBatis

在 mybatis-config.xml 中，可以配置扫描注解 Mapper：

<configuration>
    ...
    <mappers>
        <mapper class="com.example.UserMapper"/>
    </mappers>
    ...
</configuration>

或者，如果你使用的是 Spring 框架，可以在 Spring 配置中使用 @MapperScan 注解：

@Configuration
@MapperScan("com.example.mapper") // 指定 Mapper 接口所在的包
public class MyBatisConfig {
    // 其他 MyBatis 配置
}

6. 启动类配置

在 Spring Boot 应用中，通常不需要 mybatis-config.xml 文件，而是通过启动类和配置类来配置 MyBatis：

@SpringBootApplication
@MapperScan("com.example.mapper") // 指定 Mapper 接口所在的包
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

注解式开发是 MyBatis 的一种灵活的配置方式，尤其适合与 Spring 框架结合使用，可以减少 XML 配置的冗余，使项目结构更加清晰。

希望对宝子们有用哈，有什么需求评论即可，点个关注感谢🙏！！文章来源地址https://www.toymoban.com/news/detail-860296.html

到了这里，关于详解MyBatis配置文件开发与注解式开发的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！