正文

从小白到高手：MyBatis开源框架入门与实践指南

/0 浏览量
0401

在当今的Java开发领域，MyBatis 是一个极为流行的持久层框架，它简化了数据库操作的复杂性，使得开发人员可以更加专注于业务逻辑的实现。无论你是编程小白还是有一定经验的前端开发者，只要掌握了正确的方法，都能迅速成为 MyBatis 的高手。本文将带你从入门到实践，一步步深入理解 MyBatis。

一、MyBatis 简介

1.1 什么是 MyBatis？

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集，它的半自动化特性让程序员只需关注 SQL 本身，MyBatis 会负责执行和获取结果。

1.2 MyBatis 的优势

  • 易于上手：MyBatis 提供了简单的 API，让开发者快速入门。
  • 灵活的映射：MyBatis 支持复杂的映射，如一对一、一对多、多对多等。
  • 自定义 SQL：支持自定义 SQL，使得开发者可以根据需求编写特定的 SQL 语句。
  • 存储过程：支持存储过程的调用。
  • 插件机制：支持插件，如日志、分页等。

二、MyBatis 入门

2.1 环境搭建

2.1.1 创建项目

首先，我们需要创建一个 Java 项目。可以使用 IDE（如 IntelliJ IDEA、Eclipse）创建，也可以使用 Maven 或 Gradle 来构建项目。

2.1.2 添加依赖

在 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.21</version>
    </dependency>
</dependencies>

2.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/testdb"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

2.3 编写映射文件

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

2.4 编写接口

创建 UserMapper 接口：

package com.example.mapper;

public interface UserMapper {
    User selectById(Integer id);
}

2.5 编写 Java 实体类

创建 User 实体类：

package com.example.entity;

public class User {
    private Integer id;
    private String name;
    // getter 和 setter 方法
}

2.6 编写测试代码

在测试类中，注入 MyBatis 的 SqlSessionFactory，并通过 SqlSession 执行查询：

package com.example.test;

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

public class MyBatisTest {
    public static void main(String[] args) {
        try (SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory()) {
            try (SqlSession session = sqlSessionFactory.openSession()) {
                UserMapper mapper = session.getMapper(UserMapper.class);
                User user = mapper.selectById(1);
                System.out.println(user.getName());
            }
        }
    }
}

三、MyBatis 实践

3.1 高级映射

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

3.1.1 实体类

package com.example.entity;

public class User {
    // ...
    private Department department;
}

public class Department {
    // ...
    private List<User> users;
}

3.1.2 映射文件

<mapper namespace="com.example.mapper.UserMapper">
    <!-- ... -->
    <resultMap id="userMap" type="User">
        <id property="id" column="id"/>
        <result property="name" column="name"/>
        <association property="department" column="department_id" select="selectDepartmentById"/>
    </resultMap>
    
    <select id="selectById" resultMap="userMap">
        SELECT * FROM user WHERE id = #{id}
    </select>
    
    <select id="selectDepartmentById" resultType="Department">
        SELECT * FROM department WHERE id = #{id}
    </select>
</mapper>

3.2 插件与自定义

MyBatis 支持插件机制，开发者可以自定义插件来实现特定的功能，如日志、分页等。以下是一个自定义分页插件的例子：

package com.example.plugin;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;

@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();
        // ... 分页逻辑
        return invocation.proceed();
    }

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

    @Override
    public void setProperties(Map<String, Object> properties) {
        // ... 设置插件属性
    }
}

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

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

四、总结

本文从 MyBatis 的简介、入门到实践进行了详细的讲解。通过本文的学习，相信你已经对 MyBatis 有了一定的了解。接下来，你需要多加实践，不断积累经验，才能成为一名真正的 MyBatis 高手。祝你学习顺利！

-- 展开阅读全文 --