正文

Java开源框架MyBatis入门与实践：高效SQL查询的利器，新手快速上手指南

/0 浏览量
0707

MyBatis 是一个优秀的持久层框架，它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射，将接口和 Java 的 POJOs（Plain Old Java Objects，普通的 Java 对象）映射成数据库中的记录。

MyBatis 简介

MyBatis 遵循约定大于配置的原则，让开发者能够更加专注于业务逻辑的实现。它支持自定义 SQL、存储过程以及高级映射。MyBatis 的设计哲学是“懒加载”，即数据库连接、查询等操作都是在需要时才进行，这样可以提高应用程序的性能。

MyBatis 的优势

  1. 简化数据库操作：MyBatis 将数据库操作封装在接口中，开发者只需编写接口和 XML 配置文件，即可实现数据库操作。
  2. 灵活的 SQL 映射：MyBatis 支持复杂的 SQL 映射，包括动态 SQL、条件语句、循环语句等。
  3. 插件机制：MyBatis 提供了插件机制，允许开发者自定义一些功能，如分页、日志等。
  4. 易于集成：MyBatis 可以与各种持久层框架集成，如 Spring、Hibernate 等。

MyBatis 入门

1. 环境搭建

首先，你需要安装 Java 开发环境（JDK）和 Maven 仓库管理器。然后，在 Maven 项目中添加以下依赖：

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
</dependencies>

2. 配置文件

创建一个名为 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.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/your_database"/>
                <property name="username" value="root"/>
                <property name="password" value="your_password"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

3. Mapper 文件

创建一个名为 UserMapper.xml 的 Mapper 文件，用于定义 SQL 映射。

<?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.example.mapper.UserMapper">
    <select id="selectById" resultType="com.example.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

4. 接口定义

创建一个名为 UserMapper 的接口，用于定义数据库操作。

package com.example.mapper;
public interface UserMapper {
    User selectById(Integer id);
}

5. 使用 MyBatis

在 Java 代码中，使用 SqlSessionFactoryBuilder 创建 SqlSessionFactory，然后通过 SqlSessionFactory 创建 SqlSession，最后通过 SqlSession 执行数据库操作。

package com.example.mapper;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class UserMapperTest {
    public static void main(String[] args) {
        try {
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build("mybatis-config.xml");
            SqlSession sqlSession = sqlSessionFactory.openSession();
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = userMapper.selectById(1);
            System.out.println(user);
            sqlSession.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

MyBatis 实践

1. 动态 SQL

MyBatis 支持动态 SQL，可以通过 <if>、<choose>、<foreach> 等标签实现复杂的 SQL 逻辑。

<select id="selectByCondition" resultType="com.example.entity.User">
    SELECT * FROM user
    <where>
        <if test="name != null and name != ''">
            AND name = #{name}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
    </where>
</select>

2. 关联查询

MyBatis 支持多表关联查询，可以通过 <resultMap> 标签实现复杂的关联关系。

<resultMap id="userResultMap" type="com.example.entity.User">
    <id property="id" column="id"/>
    <result property="name" column="name"/>
    <result property="age" column="age"/>
    <association property="address" javaType="com.example.entity.Address">
        <id property="id" column="address_id"/>
        <result property="province" column="province"/>
        <result property="city" column="city"/>
        <result property="district" column="district"/>
    </association>
</resultMap>

<select id="selectUserById" resultMap="userResultMap">
    SELECT u.id, u.name, u.age, a.id as address_id, a.province, a.city, a.district
    FROM user u
    LEFT JOIN address a ON u.address_id = a.id
    WHERE u.id = #{id}
</select>

3. 插件开发

MyBatis 提供了插件机制，允许开发者自定义一些功能，如分页、日志等。

package com.example.plugin;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;

import java.sql.Connection;
import java.util.Properties;

@Intercepts({
    @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class PaginationInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 获取 StatementHandler
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        // 获取原始 SQL 语句
        String sql = (String) invocation.getArgs()[0];
        // 添加分页 SQL
        String paginationSql = sql + " LIMIT 0, 10";
        // 替换原始 SQL 语句
        invocation.getArgs()[0] = paginationSql;
        // 执行拦截
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

在 mybatis-config.xml 文件中注册插件：

<plugins>
    <plugin interceptor="com.example.plugin.PaginationInterceptor"/>
</plugins>

总结

MyBatis 是一个功能强大的持久层框架，可以帮助开发者快速实现数据库操作。通过本文的介绍，相信你已经对 MyBatis 有了一定的了解。在实际项目中，你可以根据自己的需求，灵活运用 MyBatis 的各种特性，提高开发效率。

-- 展开阅读全文 --