【谷粒学院】001-项目概述、Mybatis Plus入门

怼烎@ 2023-10-05 14:41 63阅读 0赞

**目录**

一、项目概述

1、项目来源

2、功能简介

3、技术架构

二、Mybatis-Plus概述

1、简介

2、特性

三、Mybatis-Plus入门

1、创建数据库

2、创建 User 表

表结构：

建表SQL语句：

插入数据SQL语句：

3、初始化一个SpringBoot工程

4、在Pom.xml文件中引入SpringBoot和Mybatis-Plus相关依赖

5、第一次使用lombok需要在IDEA中安装lombok插件

6、配置

mysql8这么写：

mysql5这么写：

注意：

7、编写代码

主类：

实体类：

mapper：

8、开始使用

查询所有用户，代码测试：

UserMapper（加注解）：

运行结果：

9、配置日志

四、Mybatis-Plus添加操作

1、代码

2、控制台输出

3、数据库

--------------------

# 一、项目概述 #

## 1、项目来源 ##

来自尚硅谷教程，学习地址[尚硅谷\_谷粒学苑-微服务+全栈在线教育实战项目\_哔哩哔哩\_bilibili][-_bilibili]

## 2、功能简介 ##

谷粒学院，是一个B2C模式的职业技能在线教育系统，分为前台用户系统和后台运营平台；

![20200709114118929.png][]

## 3、技术架构 ##

系统开发阶段使用了**前后端分离**架构，部署阶段使用了容器技术；

![20200709114151565.png][]

# 二、Mybatis-Plus概述 #

## 1、简介 ##

官网：[Redirect][]

参考教程：[http://mp.baomidou.com/guide/][http_mp.baomidou.com_guide]

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生；

快速开始参考：[http://mp.baomidou.com/guide/quick-start.html][http_mp.baomidou.com_guide_quick-start.html]

## 2、特性 ##

**无侵入：**只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑；

**损耗小：**启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作；

**强大的 CRUD 操作：**内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分CRUD 操作，更有强大的条件构造器，满足各类使用需求；

**支持 Lambda 形式调用：**通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错

**支持多种数据库：**支持MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer等多种数据库；

**支持主键自动生成：**支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题；

**支持 XML 热加载：**Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML启动；

**支持 ActiveRecord 模式：**支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作；

**支持自定义全局通用操作：**支持全局通用方法注入（ Write once, use anywhere ）；

**支持关键词自动转义：**支持数据库关键词（order、key......）自动转义，还可自定义关键词；

**内置代码生成器：**采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller层代码，支持模板引擎，更有超多自定义配置等您来使用；

**内置分页插件：**基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询；

**内置性能分析插件：**可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询；

**内置全局拦截插件：**提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作；

**内置 Sql 注入剥离器：**支持 Sql 注入剥离，有效预防 Sql 注入攻击；

# 三、Mybatis-Plus入门 #

## 1、创建数据库 ##

mybatis\_plus

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70][]

## 2、创建 User 表 ##

### 表结构： ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 1][]

### 建表SQL语句： ###

CREATE TABLE USER (
    	id BIGINT ( 20 ) NOT NULL COMMENT '主键ID',
    	NAME VARCHAR ( 30 ) NULL DEFAULT NULL COMMENT '姓名',
    	age INT ( 11 ) NULL DEFAULT NULL COMMENT '年龄',
    	email VARCHAR ( 50 ) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY ( id ) 
    );

### 插入数据SQL语句： ###

INSERT INTO USER ( id, NAME, age, email )
    VALUES
    	( 1, 'Jone', 18, 'test1@baomidou.com' ),
    	( 2, 'Jack', 20, 'test2@baomidou.com' ),
    	( 3, 'Tom', 28, 'test3@baomidou.com' ),
    	( 4, 'Sandy', 21, 'test4@baomidou.com' ),
    	( 5, 'Billie', 24, 'test5@baomidou.com' );

## 3、初始化一个SpringBoot工程 ##

使用 Spring Initializr 快速初始化一个 Spring Boot 工程；

Group：com.zibo；

Artifact：mybatis-plus；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 2][]

版本：2.4.0（年少轻狂的我选择了最新版本！）

![20201128185240124.png][]

## 4、在Pom.xml文件中引入SpringBoot和Mybatis-Plus相关依赖 ##

<?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.0</version>
            <relativePath/> 
        </parent>
        <groupId>com.zibo</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>mybatis-plus</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</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.4.0</version>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差异导致的问题；

## 5、第一次使用lombok需要在IDEA中安装lombok插件 ##

（恰好我需要更新，就顺便更新一下！）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 3][]

## 6、配置 ##

在 application.properties 配置文件中添加 MySQL 数据库的相关配置：

（我用的是mysql8版本）

### mysql8这么写： ###

#mysql数据库连接
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
    spring.datasource.username=root
    spring.datasource.password=******（隐藏）

### mysql5这么写： ###

#mysql数据库连接
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus
    spring.datasource.username=root
    spring.datasource.password=123456

### 注意： ###

1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：java.sql.SQLException: The server time zone value 'ÖÐ¹ú±ê×¼Ê±¼ä' is unrecognized or representsmore；

2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息；

## 7、编写代码 ##

### 主类： ###

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication
    @MapperScan("com.zibo.mybatisplus.mapper")
    public class MybatisPlusApplication {
     ......
    }

注意：扫描的包名可根据实际情况修改；

### 实体类： ###

创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）：

package com.zibo.mybatisplus.entity;
    
    import lombok.Data;
    
    @Data
    public class User {
        private Long id;
        private String name;
        private Integer age;
        private String email;
    }

Lombok使用参考：[Lombok 介绍\_motui的博客-CSDN博客\_lombok][Lombok _motui_-CSDN_lombok]

### mapper： ###

创建包 mapper 编写Mapper 接口UserMapper：

package com.zibo.mybatisplus.mapper;
    
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.zibo.mybatisplus.entity.User;
    
    public interface UserMapper extends BaseMapper<User> {
        
    }

## 8、开始使用 ##

### 查询所有用户，代码测试： ###

这里我们使用项目初始化时自动生成的测试类进行测试：

### UserMapper（加注解）： ###

package com.zibo.mybatisplus.mapper;
    
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.zibo.mybatisplus.entity.User;
    import org.springframework.stereotype.Repository;
    
    @Repository
    public interface UserMapper extends BaseMapper<User> {
    
    }

### 运行结果： ###

……
    
    User(id=1, name=Jone, age=18, email=test1@baomidou.com)
    User(id=2, name=Jack, age=20, email=test2@baomidou.com)
    User(id=3, name=Tom, age=28, email=test3@baomidou.com)
    User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
    User(id=5, name=Billie, age=24, email=test5@baomidou.com)
    
    ……

通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！

## 9、配置日志 ##

查看sql输出日志：

#mybatis日志
    mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 4][]

# 四、Mybatis-Plus添加操作 #

（参考官方文档：[https://baomidou.com/guide/crud-interface.html\#insert][https_baomidou.com_guide_crud-interface.html_insert]）

## 1、代码 ##

package com.zibo.mybatisplus;
    
    import com.zibo.mybatisplus.entity.User;
    import com.zibo.mybatisplus.mapper.UserMapper;
    import org.junit.jupiter.api.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    
    import java.util.List;
    
    @SpringBootTest
    public class MybatisPlusApplicationTests {
    
        //注意：
        //IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。
        //为了避免报错，可以在 dao 层 的接口上添加 @Repository 注解
        @Autowired
        private UserMapper userMapper;
    
        //查询操作
        @Test
        public void contextLoads() {
            System.out.println(("----- selectAll method test ------"));
            //UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper
            //所以不填写就是无任何条件
            List<User> users = userMapper.selectList(null);
            users.forEach(System.out::println);
        }
    
        //添加操作
        @Test
        public void add(){
            //组织user对象
            User user = new User();
            user.setName("zibo");
            user.setAge(24);
            user.setEmail("18838186892@163.com");
            //添加到数据库
            int insert = userMapper.insert(user);
            System.out.println("insert：" + insert);//影响的行数
            System.out.println(user);//id自动回填
        }
    
    }

## 2、控制台输出 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 5][]

## 3、数据库 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 6][]

注意：数据库插入id值默认为：全局唯一id；

[-_bilibili]: https://www.bilibili.com/video/BV1dQ4y1A75e
[20200709114118929.png]: https://img-blog.csdnimg.cn/20200709114118929.png
[20200709114151565.png]: https://img-blog.csdnimg.cn/20200709114151565.png
[Redirect]: http://mp.baomidou.com/
[http_mp.baomidou.com_guide]: http://mp.baomidou.com/guide/
[http_mp.baomidou.com_guide_quick-start.html]: http://mp.baomidou.com/guide/quick-start.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201128184055719.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201128184337764.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201128185119868.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[20201128185240124.png]: https://img-blog.csdnimg.cn/20201128185240124.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201128190606906.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[Lombok _motui_-CSDN_lombok]: https://blog.csdn.net/motui/article/details/79012846
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201128194857340.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[https_baomidou.com_guide_crud-interface.html_insert]: https://baomidou.com/guide/crud-interface.html#insert
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20201128195654739.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20201128195805735.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70