正文

学会MyBatis：高效Java开源框架入门与应用实践

/0 浏览量
0521

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

MyBatis 简介

MyBatis 遵循约定优于配置的原则，通过 XML 或注解的方式配置 SQL 映射，使得开发者可以更加专注于业务逻辑的实现。它支持自定义 SQL、存储过程以及高级映射，如关联、集合等。

入门指南

1. 环境搭建

首先，需要搭建一个 Java 开发环境。以下是搭建 MyBatis 开发环境的步骤：

  1. 安装 JDK：下载并安装 JDK，配置环境变量。
  2. 安装 Maven：下载并安装 Maven，配置环境变量。
  3. 创建 Maven 项目：使用 Maven 创建一个 Java Web 项目。
  4. 添加依赖：在项目的 pom.xml 文件中添加 MyBatis 以及数据库驱动的依赖。
<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.22</version>
    </dependency>
</dependencies>

2. 配置 MyBatis

在项目的 src/main/resources 目录下创建 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/mydb"/>
                <property name="username" value="root"/>
                <property name="password" value=""/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

3. 创建 Mapper 接口

在项目的 src/main/java 目录下创建一个 Mapper 接口，定义 SQL 映射语句。

package com.example.mapper;

public interface UserMapper {
    List<User> findAll();
}

4. 创建 Mapper XML 文件

在项目的 src/main/resources 目录下创建 UserMapper.xml 文件，配置 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="findAll" resultType="com.example.entity.User">
        SELECT * FROM user
    </select>
</mapper>

5. 使用 MyBatis

在 Java 代码中，通过 SqlSessionFactory 和 SqlSession 使用 MyBatis。

package com.example.mapper;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

public class UserMapperTest {
    public static void main(String[] args) {
        try {
            SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory();
            SqlSession sqlSession = sqlSessionFactory.openSession();
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            List<User> users = userMapper.findAll();
            for (User user : users) {
                System.out.println(user);
            }
            sqlSession.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

应用实践

1. 高级映射

MyBatis 支持多种高级映射，如关联、集合等。以下是一个关联映射的示例：

<mapper namespace="com.example.mapper.UserMapper">
    <resultMap id="userResultMap" type="com.example.entity.User">
        <id property="id" column="id"/>
        <result property="username" column="username"/>
        <result property="email" column="email"/>
        <association property="address" javaType="com.example.entity.Address">
            <id property="id" column="address_id"/>
            <result property="street" column="street"/>
            <result property="city" column="city"/>
        </association>
    </resultMap>
    <select id="findUserById" resultMap="userResultMap">
        SELECT u.id, u.username, u.email, a.id AS address_id, a.street, a.city
        FROM user u
        LEFT JOIN address a ON u.address_id = a.id
        WHERE u.id = #{id}
    </select>
</mapper>

2. 动态 SQL

MyBatis 支持动态 SQL，可以根据条件动态拼接 SQL 语句。以下是一个动态 SQL 的示例：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="findUsersByCondition" resultType="com.example.entity.User">
        SELECT * FROM user
        <where>
            <if test="username != null">
                AND username = #{username}
            </if>
            <if test="email != null">
                AND email = #{email}
            </if>
        </where>
    </select>
</mapper>

3. 插件

MyBatis 提供了插件机制，可以自定义插件来实现一些功能，如分页、日志等。以下是一个分页插件的示例：

package com.example.plugin;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;

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) invocation.getTarget();
        MetaObject metaObject = SystemMetaObject.forObject(statementHandler);
        // 获取原始 SQL 语句
        String originalSql = (String) metaObject.getValue("delegate.boundSql.sql");
        // 添加分页 SQL
        String pageSql = originalSql + " LIMIT #{offset}, #{limit}";
        // 设置新的 SQL 语句
        metaObject.setValue("delegate.boundSql.sql", pageSql);
        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 提供的各种功能。

-- 展开阅读全文 --