MyBatis操作数据库步骤

最新推荐文章于 2025-07-10 19:16:37 发布

原创最新推荐文章于 2025-07-10 19:16:37 发布 · 7.8k 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #mybatis-generator

MyBatis3 专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍了如何使用MyBatis框架，从XML配置文件创建SqlSessionFactory对象，理解SqlSessionFactory和SqlSessionFactoryBuilder的结构，利用MyBatis Generator工具进行数据库逆向工程，以及使用SqlSession在MySQL中插入数据的步骤。同时，文中还提及了针对不同数据库的注意事项，如SQL Server和Oracle的主键处理策略。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

MyBatis框架的核心是SqlSessionFactory对象，从SqlSessionFactory类的名称来看，它是用来创建SqlSession对象的工厂。但SqlSessionFactory对象的创建来自于SqlSessionFactoryBuilder类，也就是使用SqlSessionFactoryBuilder类创建SqlSessionFactory对象。使用SqlSessionFactoryBuilder类创建SqlSessionFactory对象的方式可以来自于一个XML配置文件，也可来自于一个实例化的Configuation对象。
要使用 MyBatis，只需将 mybatis的jar文件置于 classpath 中即可。我们用maven来构建项目，我们以3.3.0版本为例。则需将下面的 dependency 代码置于 pom.xml 文件中：

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.3.0</version>
</dependency>

项目结构如下:

使用XML配置文件创建SqlSessionFactory对象

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。但是也可以使用任意的输入流(InputStream)实例，包括字符串形式的文件路径或者 file:// 的 URL 形式的文件路径来配置。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，可使从 classpath 或其他位置加载资源文件更加容易。XML 配置文件（configuration XML）中包含了对 MyBatis 系统的核心设置，包含获取数据库连接实例的数据源（DataSource）和决定事务作用域和控制方式的事务管理器（TransactionManager）。在项目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.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://127.0.0.1:3306/sample" />
                <property name="username" value="root" />
                <property name="password" value="123456" />
            </dataSource>
        </environment>
    </environments>
</configuration>

下面获取SqlSessionFactory工厂对象

package shan_mybatis_test;

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

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

public class Test {
    public static void main(String[] args) {
        String resource = "mybatis-config.xml";
        try {
            InputStream resourceAsStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
            System.out.println(sqlSessionFactory);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
}

运行程序后没有出现异常，输出信息如下：
这里写图片描述
到此，SqlSessionFactory对象成功的从xml配置文件中创建

SqlSessionFactory 和 SqlSessionFactoryBuilder类的结构

SqlSessionFactory类的结构如下
这里写图片描述
SqlSessionFactoryBuilder类的结构如下

两者的类结构中基本全是重载方法，主要是为了获取SqlSessionFactory对象和SqlSession对象。

使用MyBatis Generator工具逆向

在eclipse中安装MyBatis Generator逆向工具插件

安装介绍
进入页面找到如下install按钮

点击install进入下个页面找到如下区域

红色区域介绍如何安装插件到eclipse，就是点击并按住鼠标按钮,拖动安装按钮图标在Eclipse工作区,然后在工作区释放按钮就会弹出如下窗口

等插件下载完以后接受安装协议进行确认安装。安装完成后重启eclipse。

重启后新建普通java项目MybatisGeneratorJava然后选中src右击新建一个MyBatis生成ORM文件的配置文件。

点击next会出现保持默认不需要修改然后finish.

此时项目中会生成一个generatorConfig.xml配置文件，修改文件配置如下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <context id="context1">
        <jdbcConnection connectionURL="jdbc:mysql://localhost:3306/sample"
            driverClass="com.mysql.jdbc.Driver" password="123456" userId="root" />
        <javaModelGenerator targetPackage="com.user.pojo"
            targetProject="MybatisGeneratorJava" />
        <sqlMapGenerator targetPackage="com.user.mapper"
            targetProject="MybatisGeneratorJava" />
        <javaClientGenerator targetPackage="com.user.mapper"
            targetProject="MybatisGeneratorJava" type="XMLMAPPER" />
        <table schema="" tableName="user">
            <!-- <columnOverride column="???" property="???" /> -->
        </table>
    </context>
</generatorConfiguration>

需要在逆向项目中添加sql的驱动包

这个文件是MyBatis Generator插件必备的文件通过此文件可以从数据表的结构逆向出对应的java类和mapper。在数据库中建立user表。
准备完成后，选择generatorConfig.xml文件点击Generate MyBatis/iBATIS Artifacts,便会生成ORM映射文件
这里写图片描述
项目结构如图

把com.user包中的内容复制到项目的src目录中，结构如下
这里写图片描述
至此，Mybatis的基础类文件已经准备完毕。

使用SqlSession对象在MySql数据库中新建记录

下面就开始把一条记录插入user数据表中吧。在项目的resource目录下创建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.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://127.0.0.1:3306/sample" />
                <property name="username" value="root" />
                <property name="password" value="123456" />
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="com/user/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

接下来用Junit进行一下简单的测试，在pom文件中引入junit的dependency,当然不要忘记引入mysql驱动的dependency。pom文件如下

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.shan</groupId>
    <artifactId>shan_mybatis_test</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.32</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

然后在src/test/java目录下新建com.user.test包然后新建测试类TestCase.java代码如下

package com.user.test;

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

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 org.junit.Before;
import org.junit.Test;

import com.user.pojo.User;

public class TestCase {
    private static SqlSession sqlSession;
    @Before
    public void before(){
        String resource = "mybatis-config.xml";
        try {
            InputStream resourceAsStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
            sqlSession = sqlSessionFactory.openSession();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
    @Test
    public void addInfo(){
        User user = new User();
        user.setUsername("test");
        user.setPassword("123456");

        sqlSession.insert("insert", user);
        sqlSession.commit();
        sqlSession.close();
    }
}

运行junit测试方法，成功的在数据库中填入一条数据。
这里写图片描述

注意事项

注意事项
如果使用的是sqlserver数据库，MyBatis不能识别user表中主键id的自增情况，解决办法是在用逆向工程生成代码的generatorConfig.xml的配置中修改如下代码

        <table schema="" tableName="user">
            <generatedKey column="id" sqlStatement="sqlserver" identity="true"></generatedKey>
            <!-- <columnOverride column="???" property="???" /> -->
        </table>

如果使用的是oracle数据库，由于oracle数据库使用序列来获取ID主键值，因此需要在用逆向工程生成代码的generatorConfig.xml的配置中修改如下代码

    <table schema="" tableName="user">
            <generatedKey column="id" sqlStatement="select idauto.nextval from dual" identity="false"></generatedKey>
        </table>