正文

手把手教你掌握Java开源框架MyBatis：快速上手实践指南

/0 浏览量
0331

引言

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

在这个指南中，我们将一步步教你如何快速上手 MyBatis，从环境搭建到实际应用。

第一部分：环境搭建

1.1 系统要求

  • Java Development Kit (JDK) 1.6 或更高版本
  • Maven 3.0 或更高版本（用于依赖管理）

1.2 创建 Maven 项目

  1. 打开 Maven 安装目录下的 bin 文件夹，运行 mvn archetype:generate 命令。
  2. 按照提示输入项目信息，选择 maven-archetype-quickstart 作为项目模板。
  3. 选择项目的保存路径，并等待 Maven 创建项目。

1.3 添加依赖

在项目的 pom.xml 文件中添加以下依赖：

<dependencies>
    <!-- MyBatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.22</version>
    </dependency>
    <!-- 数据库连接池 -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.10</version>
    </dependency>
</dependencies>

第二部分：配置 MyBatis

2.1 创建配置文件

在项目的 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?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value=""/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

2.2 创建 Mapper 文件

在项目的 src/main/resources/com/example/mapper 目录下创建 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="com.example.mapper.UserMapper">
    <select id="selectById" resultType="com.example.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

2.3 创建实体类

在项目的 src/main/java/com/example/entity 目录下创建 User.java 文件，并添加以下内容：

package com.example.entity;

public class User {
    private Integer id;
    private String name;
    private Integer age;

    // getters and setters
}

2.4 创建接口

在项目的 src/main/java/com/example/mapper 目录下创建 UserMapper.java 文件，并添加以下内容：

package com.example.mapper;

import com.example.entity.User;

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

第三部分：编写代码

3.1 创建 MyBatis 会话工厂

在项目的 src/main/java/com/example 目录下创建 MyBatisUtil.java 文件，并添加以下内容：

package com.example;

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

public class MyBatisUtil {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(MyBatisUtil.class.getClassLoader().getResourceAsStream("mybatis-config.xml"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}

3.2 编写测试代码

在项目的 src/test/java/com/example 目录下创建 UserMapperTest.java 文件，并添加以下内容：

package com.example;

import com.example.mapper.UserMapper;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

public class UserMapperTest {
    @Test
    public void testSelectById() {
        try (SqlSession sqlSession = MyBatisUtil.getSqlSession()) {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = userMapper.selectById(1);
            System.out.println(user);
        }
    }
}

总结

通过以上步骤，你已经成功搭建了 MyBatis 开发环境，并编写了简单的查询代码。接下来，你可以继续学习 MyBatis 的更多高级功能，如动态 SQL、缓存等。祝你学习愉快！

-- 展开阅读全文 --