正文

Java开源框架MyBatis快速入门指南：从搭建环境到实战应用

/0 浏览量
0524

引言

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

本文将带领你从搭建 MyBatis 环境开始，逐步深入到实战应用，让你快速掌握 MyBatis 的使用。

搭建MyBatis环境

1. 环境准备

  • Java开发环境：确保你的电脑上已经安装了 Java 开发环境，并配置好环境变量。
  • IDE：推荐使用 IntelliJ IDEA 或 Eclipse 作为开发工具。
  • Maven：Maven 是一个项目管理工具，可以帮助你管理项目依赖。

2. 创建Maven项目

  1. 打开你的 IDE，创建一个新的 Maven 项目。
  2. 在 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>
    <!-- Log4j 日志依赖 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.13.3</version>
    </dependency>
</dependencies>

3. 配置MyBatis

  1. 在 src/main/resources 目录下创建一个名为 mybatis-config.xml 的文件。
  2. 在该文件中配置数据源、事务管理器、映射器等：
<?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="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>
  1. 在 src/main/java 目录下创建一个名为 com/example/mapper 的包，并在该包下创建一个名为 UserMapper.java 的接口：
package com.example.mapper;

import com.example.entity.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{id}")
    User getUserById(int id);
}
  1. 在 src/main/java 目录下创建一个名为 com/example/entity 的包，并在该包下创建一个名为 User.java 的类：
package com.example.entity;

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

    // 省略 getter 和 setter 方法
}

实战应用

1. 编写Mapper接口

在上面的示例中，我们已经创建了一个名为 UserMapper 的接口，它包含一个方法 getUserById，该方法用于根据用户 ID 查询用户信息。

2. 编写Mapper XML

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

3. 使用MyBatis

  1. 在你的 Java 类中，创建一个 SqlSessionFactory 对象：
package com.example;

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

public class MyBatisDemo {
    public static void main(String[] args) {
        try {
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(
                    Resources.getResourceAsStream("mybatis-config.xml"));
            // 使用 SqlSessionFactory 创建 SqlSession
            SqlSession sqlSession = sqlSessionFactory.openSession();
            // 使用 Mapper 接口
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            // 调用方法
            User user = userMapper.getUserById(1);
            System.out.println(user);
            // 关闭 SqlSession
            sqlSession.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
  1. 运行程序，输出结果：
User{id=1, name='张三', age=20}

总结

通过本文的介绍，你现在已经掌握了 MyBatis 的基本使用方法。在实际开发中，你可以根据自己的需求，进一步学习 MyBatis 的更多高级特性，如动态 SQL、插件等。

希望本文能帮助你快速入门 MyBatis，祝你学习愉快！

-- 展开阅读全文 --