正文

Java开源框架MyBatis入门指南：快速上手，高效构建持久层

/0 浏览量
0418

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

以下是一份详细的MyBatis入门指南，帮助你快速上手并高效构建持久层。

1. MyBatis 简介

MyBatis 遵循约定优于配置（ Convention Over Configuration）的原则，这意味着你只需要关注 SQL 的编写，而不需要手动管理 JDBC 连接、事务和结果集等繁琐的工作。

2. 环境搭建

2.1 系统要求

  • Java 8 或更高版本
  • Maven 3.3 或更高版本

2.2 创建 Maven 项目

  1. 打开 Maven IDE 或命令行工具。
  2. 输入以下命令创建新项目：
mvn archetype:generate -DgroupId=com.example -DartifactId=mybatis-example -DarchetypeArtifactId=maven-archetype-quickstart
  1. 根据提示输入项目信息。

2.3 添加依赖

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

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.7</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.26</version>
    </dependency>
</dependencies>

3. 配置 MyBatis

3.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"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

3.2 配置 Mapper 接口

在 src/main/java 目录下创建一个 com.example.mapper 包，并在该包中创建一个 UserMapper.java 接口。

package com.example.mapper;

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

public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{id}")
    User getUserById(int id);
}

3.3 配置 Mapper XML

在 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">
    <resultMap id="userMap" type="com.example.entity.User">
        <id property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="age" column="age"/>
    </resultMap>
    <select id="getUserById" resultMap="userMap">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

4. 使用 MyBatis

4.1 创建 SqlSessionFactory

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

import java.io.IOException;

public class MyBatisUtil {
    public static SqlSessionFactory getSqlSessionFactory() throws IOException {
        String resource = "mybatis-config.xml";
        return new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream(resource));
    }
}

4.2 使用 Mapper 接口

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

public class Main {
    public static void main(String[] args) {
        try (SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory();
             SqlSession sqlSession = sqlSessionFactory.openSession()) {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = userMapper.getUserById(1);
            System.out.println(user);
        }
    }
}

以上就是一个简单的 MyBatis 入门示例。通过这个示例，你可以了解到如何配置 MyBatis、创建 Mapper 接口和 XML、使用 Mapper 接口等方法。希望这份指南能帮助你快速上手 MyBatis 并高效构建持久层。

-- 展开阅读全文 --