一文搞懂MyBatis

学习 MyBatis

当你需要在 Java 项目中操作数据库时，MyBatis 是一个非常好的选择。MyBatis 是一种开源的持久层框架，它可以帮助我们轻松地实现数据库操作，并且还提供了很多高级功能，如动态 SQL、事务管理和缓存等。

这篇文章将介绍 MyBatis 的基本概念、配置方式以及示例代码。

---

基本概念

映射器（Mapper）

映射器是 MyBatis 中定义数据操作的接口。一个映射器对应一个 XML 文件，其中定义了 SQL 语句和参数映射信息。

SqlSessionFactory

SqlSessionFactory 是 MyBatis 的核心接口之一，它用于创建 SqlSession 对象。SqlSession 是 MyBatis 中用于执行 SQL 语句并返回结果的对象。

配置文件

MyBatis 的配置文件包含了 MyBatis 的所有配置信息，用于配置 SqlSessionFactory 和其他属性。配置文件通常是一个 XML 文件，也可以使用 Java 代码进行配置。

配置方式

配置文件方式

1. 添加依赖：

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>${mybatis.version}</version>
</dependency>

2. 编写 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>
    <typeAliases>
        <package name="cn.yoursite.dto"/>
    </typeAliases>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>

            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driverClassName}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <!-- 指定映射器的位置 -->
        <mapper resource="cn/yoursite/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

其中，<typeAliases> 标签用于指定别名，可以简化 XML 文件中的类名；<environments> 标签则用于指定数据库环境；<dataSource> 标签用于指定数据源。

3. 编写映射器

public interface UserMapper {
    User findById(Long id);
}

4. 编写 SQL 映射文件 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="cn.yoursite.mapper.UserMapper">
    <select id="findById" parameterType="long" resultMap="userMap">
        SELECT * FROM user WHERE id = #{id}
    </select>

    <resultMap id="userMap" type="cn.yoursite.dto.User">
        <id column="id" property="id"/>
        <result column="username" property="username"/>
        <result column="password" property="password"/>
    </resultMap>
</mapper>

其中，<select> 标签用于定义查询语句，parameterType 属性指定入参类型，resultMap 属性指定映射器对应的结果集。

注解方式

MyBatis 还支持使用注解来配置映射器。例如：

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{id}")
    User findById(Long id);
}

示例代码

public static void main(String[] args) throws IOException {
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        User user = mapper.findById(1L);
        System.out.println(user);
    }
}

上述代码中，通过 SqlSessionFactoryBuilder 类的 build() 方法创建了一个 SqlSessionFactory 对象，然后通过 SqlSessionFactory 对象打开了一个 SqlSession 对象并获取了 UserMapper 接口的实现。最终使用 findById() 查询方法查询了 id 为 1 的用户，并输出到控制台。

结论

对象，然后通过SqlSessionFactory对象打开了一个SqlSession对象并获取了UserMapper接口的实现。最终使用findById()` 查询方法查询了 id 为 1 的用户，并输出到控制台。

结论

MyBatis 是一种非常好用的持久层框架，它提供了很多高级功能以及丰富的配置方式。在实际项目开发中，我们可以结合具体业务场景选择不同的配置方式来使用 MyBatis，更加灵活地进行数据库操作。