SpringBoot集成Mybatis保姆级教程（完整版）

最新推荐文章于 2024-06-16 09:00:00 发布

程序员青戈

最新推荐文章于 2024-06-16 09:00:00 发布

阅读量2.7w

点赞数 219

分类专栏： SpringBoot 文章标签： SpringBoot Mybatis

本文链接：https://blog.csdn.net/xqnode/article/details/113079010

版权

SpringBoot 专栏收录该内容

6 篇文章 98 订阅

订阅专栏

文章目录

前言

大家好，我是程序员青戈。今天是周末，在家里想出一个教学视频，这个视频的内容是关于SpringBoot搭建Web应用的，既然是Web应用，那么肯定要访问数据库，我这里用的是Mybatis持久层框架。因为之前没做笔记，我也是折腾了半天，在网上一顿搜索，总算完成了脚手架的搭建，一个程序员老鸟搞了这么久，哈哈确实有点尴尬。

既然已经完成了，那么索性我把这个SpringBoot集成Mybatis的教程分享出来，帮助更多的小伙伴去学习，也方便自己日后查看。因为搭建的过程是我自己手撸的，所以基本没什么坑，同学们大可放心copy😆

项目搭建

新建项目，在IDEA中，点击File -> new -> Project

进入这个页面，选择Spring Initializr，注意你要提前自己配置一下JDK环境，我这里使用的JDK版本是 1.8。

点击 Next，进入下面这个页面，因为我使用的IDEA版本是2020.3，不同的版本看到的页面可能不一样，不过应该都大同小异。注意选择的Java version是8，其他的默认就行了，然后点击Next。

这里是选择工程的依赖，为了简单我们这里使用Lombok插件，同学们在使用的时候注意安装Lombok对应的idea插件哦，要不然代码会报错。核心的依赖是Spring web（也就是SpringMVC，用来提供Web接口）、MyBatis和Mysql的驱动。

完成上面的配置之后，最后一步需要选择文件的位置，我们可以使用它默认的名称demo，注意下面的Project location选择的路径是指包含你工程内部文件的路径。完成之后点击Finish。

项目配置

完成上面的步骤之后，你的工程就已经出来了，删除一些不需要的文件，大概是这样的一个结构，工程名和包名我自己改了一下。

pom配置

首先是pom文件，我们来看一下：

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

注意：Springboot版本是 2.4.2。

这是一个maven的项目，所以你需要自己去配置一下maven，打开settings，搜索maven，配置Maven Home和settings file，当然，你也可以使用默认的配置。配置完成后点击OK即可。

如果你的依赖下载速度很慢，我推荐你使用阿里云仓库，在pom文件中加入这个配置：

<repositories>
    <repository>
        <id>nexus-aliyun</id>
        <name>nexus-aliyun</name>
        <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

<pluginRepositories>
    <pluginRepository>
        <id>public</id>
        <name>aliyun nexus</name>
        <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </pluginRepository>
</pluginRepositories>

创建mapper文件夹

你需要在java包和resources包下各创建一个文件夹，来存放mapper接口和mapper.xml文件。

数据源和mybatis配置

为了演示，我在本地创建了一个test数据库，在application.properties文件中配置数据源和mapper接口的位置：

spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis.mapper-locations=classpath:mapper/*.xml

启动类配置

启动类只需要加入一个注解指定mapper接口的位置即可：
@MapperScan("com.example.mapper")

@SpringBootApplication
@MapperScan("com.example.mapper")
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

配置到此结束。

Mapper接口和XML自动生成

这里给大家推荐一款非常好用的idea插件：better-mybatis-generator，在idea的插件仓库可以直接下载。

下载好之后，你需要配置一下datasource插件，位置在界面的右侧栏。

依次点击 + 号，选择Data Source下的Mysql数据库。

在这个页面，先下载Mysql驱动（注意，一定要下载），然后配置下面四项即可。

配置完成之后点击Test Connection，如果出现下面这样的，就表示你配置完成了。

注意，这里有个小坑。idea的datasource插件配置完成之后默认是不会显示你的数据库表的，需要设置一下。
在Schemas这一栏，勾选All 即可。

配置完成之后，我们就可以使用插件自动生成接口了：
为了方便演示，我在本地的test库创建了一个user表，结构如下：

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '账号',
  `nickname` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '昵称',
  `password` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '密码',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

在user表上右键选择 mybatis-generator：

进入自动生成页面之后，需要配置的地方有3处，设置名称和选择项目的对应文件夹即可。如果你跟我的目录结构一样，可以按照下面这样配置：

点击ok之后，Mapper接口、User实体类和Mapper.xml文件就都生成好了，我们看下生成的结果：

UserMapper：

你看，是不是非常方便。

测试

好了，完成上面的步骤，就表示你的项目已经成功集成了Mybatis，那么我们现在可以对集成的结果进行一个测试，看看还有没有问题，是不是可以投入使用。话不多说，Show me the code。

我写了一个UserController接口用来查询user表的数据：

package com.example.controller;

import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.List;

@RestController
@RequestMapping("/user")
public class UserController {
    @Resource
    private UserMapper userMapper;

    @GetMapping
    public List<User> findAll() {
        return userMapper.selectAll();
    }

}

当然这里写的不是很规范哈，为了方便，我偷懒直接在controller里面引入了UserMapper，同学们可不要学我哦，一般要建一个service层做数据处理使用的。

UserMapper的selectAll接口：

UserMapper.xml:

<sql id="Base_Column_List">
  id, username, nickname, `password`
</sql>
  
<select id="selectAll" resultType="com.example.entity.User">
 select <include refid="Base_Column_List" /> from user order by id desc
</select>