正文

揭秘Java开源框架MyBatis：高效ORM实战指南，轻松入门与进阶技巧

/0 浏览量
0422

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

MyBatis 简介

MyBatis 本是 Apache 的一个开源项目，后来迁移到了 Google Code，并由 MyBatis 社区维护。它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。

MyBatis 的核心特性

  • 半自动化映射：MyBatis 会自动将 SQL 语句的结果集映射到 Java 对象。
  • 灵活的映射规则：MyBatis 提供了丰富的映射规则，包括一对一、一对多、多对多等。
  • 插件支持：MyBatis 支持插件，如分页插件、日志插件等。
  • 动态 SQL：MyBatis 支持动态 SQL，可以根据不同的条件生成不同的 SQL 语句。

MyBatis 入门

环境搭建

  1. 添加依赖：在项目的 pom.xml 文件中添加 MyBatis 依赖。
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.7</version>
</dependency>
  1. 配置文件：创建 mybatis-config.xml 文件，配置数据源、事务管理器等。
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.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/myapp/mapper/UserMapper.xml"/>
    </mappers>
</configuration>
  1. Mapper 文件：创建 UserMapper.xml 文件，定义 SQL 语句。
<mapper namespace="com.myapp.mapper.UserMapper">
    <select id="selectById" resultType="com.myapp.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>
  1. 接口文件：创建 UserMapper 接口。
package com.myapp.mapper;

public interface UserMapper {
    User selectById(Integer id);
}
  1. 测试：编写测试代码，测试 MyBatis 是否正常工作。
package com.myapp;

import com.myapp.mapper.UserMapper;
import com.myapp.entity.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class MyBatisTest {
    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 进阶

动态 SQL

MyBatis 支持动态 SQL，可以根据不同的条件生成不同的 SQL 语句。以下是一个使用动态 SQL 的例子：

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

插件

MyBatis 支持插件，可以扩展其功能。以下是一个分页插件的例子：

package com.myapp.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) invocation.getTarget();
        // 获取当前 SQL 语句
        String sql = statementHandler.getBoundSql().getSql();
        // 添加分页 SQL
        String paginationSql = sql + " LIMIT #{offset}, #{limit}";
        // 设置新的 SQL 语句
        statementHandler.getBoundSql().setSql(paginationSql);
        return invocation.proceed();
    }

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

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

在 mybatis-config.xml 文件中配置插件：

<configuration>
    <plugins>
        <plugin interceptor="com.myapp.plugin.PaginationInterceptor"/>
    </plugins>
</configuration>

高级映射

MyBatis 支持高级映射，如一对一、一对多、多对多等。以下是一个一对一映射的例子：

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

总结

MyBatis 是一个功能强大的 ORM 框架，可以帮助开发者快速开发 Java 应用程序。通过本文的介绍，相信你已经对 MyBatis 有了一定的了解。在实际开发中，你可以根据自己的需求选择合适的 MyBatis 功能，提高开发效率。

-- 展开阅读全文 --