MyBatisPlus —— 1、简介及入门案例

目录

1、简介

2、特性

3、支持数据库

4、框架结构

5、代码及文档地址

6、入门案例

6.1、开发环境

6.2、创建数据库及表

6.2.1、创建表

6.2.2、添加数据

6.3、创建 SpringBoot 工程

6.3.1、初始化工程

6.3.2、引入依赖

6.4、编写代码 

6.4.1、配置 application.yml

6.4.2、添加实体

6.4.3、启动类(主程序类)

6.4.4、添加mapper接口

6.4.5、测试

6.4.6、添加日志功能

---

1、简介

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

愿景

我们的愿景是成为 MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍。

 2、特性

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

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

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

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

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

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

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

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

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

• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库

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

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

3、支持数据库

任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。

• MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb

• 达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库

4、框架结构

 5、代码及文档地址

• 官方地址: Redirect

• 代码发布地址:

  • Github: https://github.com/baomidou/mybatis-plus

  • Gitee: mybatis-plus: mybatis 增强工具包，简化 CRUD 操作。 文档 http://baomidou.com低代码组件库 http://aizuda.com

• 文档发布地址: 简介 | MyBatis-Plus

6、入门案例

6.1、开发环境

IDE：idea 2021.2.1

JDK：JDK8

构建工具：maven 3.6.1

MySQL版本：MySQL 5.7

Spring Boot：2.6.6

MyBatis-Plus：3.5.1

6.2、创建数据库及表

6.2.1、创建表

USE `mybatis_plus`; 
CREATE TABLE `user` ( 
	`id` BIGINT(20) NOT NULL COMMENT '主键ID', 
	`name` VARCHAR(30) DEFAULT NULL COMMENT '姓名', 
	`age` INT(11) DEFAULT NULL COMMENT '年龄', 
	`email` VARCHAR(50) DEFAULT NULL COMMENT '邮箱', 
	PRIMARY KEY (`id`) 
) ENGINE=INNODB DEFAULT CHARSET=utf8;

6.2.2、添加数据

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');

6.3、创建 SpringBoot 工程

6.3.1、初始化工程

使用 Spring Initializer 快速初始化 SpringBoot 工程，不用勾选组件

6.3.2、引入依赖

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

6.4、编写代码 

6.4.1、配置 application.yml

注：

1 、驱动类 driver-class-name

spring boot 2.0 （内置 jdbc5驱动），驱动类使用： driver-class-name: com.mysql.jdbc.Driver

spring boot 2.1 及以上（内置 jdbc8 驱动），驱动类使用： driver-class-name: com.mysql.cj.jdbc.Driver

否则运行测试用例的时候会有 WARN 信息

2 、连接地址 url

MySQL5.7 版本的  url 建议如下 ：

        jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false

MySQL8.0 版本的 url 建议如下(设置时区)：

        jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false

否则运行测试用例报告如下错误：

        java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or represents more

spring:
  # 配置数据源信息
  datasource:
    # 配置数据源类型
    type: com.zaxxer.hikari.HikariDataSource
    # 配置连接数据库的各个信息
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
    username: root
    password: zyj123

6.4.2、添加实体

@Data
@AllArgsConstructor
public class User {
    private long id;
    private String name;
    private Integer age;
    private String email;
}

6.4.3、启动类(主程序类)

@SpringBootApplication
@MapperScan("com.zyj.mapper") //扫描mapper接口所在的包
public class MyBatisPlusProjectApplication {

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

}

6.4.4、添加mapper接口

@Mapper
//@Repository  //将该类或接口标识为持久层组件
public interface UserMapper extends BaseMapper<User> {
}

6.4.5、测试

注：IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。为了避免报错，可以在mapper接口上添加 @Repository 或 @Mapper 注解 

@SpringBootTest
public class MyBatisPlusTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectList(){
        // 通过条件构造器查询一个List集合，若没有条件，可以设置参数为null
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

输出结果：

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)

6.4.6、添加日志功能

在 application.yml 中配置开启

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl  #添加日志功能，StdOutImpl是mybatis-plus自带的

日志输出如下，可以查看 SQL 语句：

==>  Preparing: SELECT id,name,age,email FROM user
==> Parameters: 
<==    Columns: id, name, age, email
<==        Row: 1, Jone, 18, test1@baomidou.com
<==        Row: 2, Jack, 20, test2@baomidou.com
<==        Row: 3, Tom, 28, test3@baomidou.com
<==        Row: 4, Sandy, 21, test4@baomidou.com
<==        Row: 5, Billie, 24, test5@baomidou.com
<==      Total: 5