使用 MyBatis 新增数据并返回新增数据的 ID

2023-08-07 22:13:14

在 MyBatis 中轻松实现数据新增与 ID 获取

前言

在现代应用程序开发中，持久层操作至关重要。MyBatis 作为一款备受推崇的持久层框架，以其简洁易用、配置灵活等优势，帮助开发者高效便捷地处理数据库交互任务。本文将深入探讨如何在 MyBatis 中实现数据新增操作，并获取新增数据的 ID，以满足实际开发需求。

数据新增与 ID 获取详解

在 MyBatis 中，新增数据并获取 ID 的过程主要包括以下步骤：

1. 编写 XML 映射文件

XML 映射文件用于定义 SQL 语句与 Java 对象之间的映射关系。对于新增操作，我们需要在映射文件中配置相应的 SQL 语句。假设我们要新增一条名为 user 的记录，其结构为 id、username 和 password 三个字段，则 XML 映射文件内容如下：

<insert id="insertUser" parameterType="com.example.User">
  INSERT INTO `user` (`username`, `password`)
  VALUES (#{username}, #{password})
</insert>

2. 创建 Java 代码

在 Java 代码中，我们需要使用 MyBatis 提供的 API 执行新增操作。下面是一个示例代码片段：

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

import java.io.IOException;
import java.io.InputStream;

public class InsertUserExample {

    public static void main(String[] args) {
        // 初始化 MyBatis
        InputStream inputStream = ... // 获取 MyBatis 配置文件输入流
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        // 获取 SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 准备新增数据
        User user = new User();
        user.setUsername("zhangsan");
        user.setPassword("123456");

        // 执行新增操作并获取主键值
        sqlSession.insert("insertUser", user);
        Long id = (Long) sqlSession.selectOne("selectLastInsertId");

        // 打印新增数据的 ID
        System.out.println("新增数据的 ID 为：" + id);

        // 关闭 SqlSession
        sqlSession.close();
    }
}

3. 调用 MyBatis API

调用 MyBatis API insert() 方法执行新增操作。在上面的 Java 代码中，我们使用了 insert("insertUser", user) 语句进行新增操作。

4. 获取新增数据的 ID

在某些情况下，我们可能需要获取新增数据的 ID。MyBatis 提供了 selectOne() 方法来查询单个值。在上面的 Java 代码中，我们使用了 selectOne("selectLastInsertId") 语句获取了新增数据的 ID。

代码示例

以下是一个完整的代码示例，演示了如何使用 MyBatis 新增数据并获取 ID：

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

import java.io.Reader;

public class InsertUserExample {

    public static void main(String[] args) {
        // 初始化 MyBatis
        String resource = "mybatis-config.xml"; // MyBatis 配置文件路径
        Reader reader = null;
        try {
            reader = Resources.getResourceAsReader(resource);
        } catch (IOException e) {
            e.printStackTrace();
        }
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);

        // 获取 SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 准备新增数据
        User user = new User();
        user.setUsername("zhangsan");
        user.setPassword("123456");

        // 执行新增操作并获取主键值
        sqlSession.insert("insertUser", user);
        Long id = (Long) sqlSession.selectOne("selectLastInsertId");

        // 打印新增数据的 ID
        System.out.println("新增数据的 ID 为：" + id);

        // 关闭 SqlSession
        sqlSession.close();
    }
}