全网最详细地介绍mybatis-plus框架

news2024/9/21 16:24:58

文章目录

1. 简介
2. 特性
3. 支持数据库
4. 框架结构
5. 开始使用
- 5.1 数据源
- 5.2 初始化工程
6. 总结

之前使用mybatis框架时，需要写大量的xml配置文件，维护起来比较繁琐。现在使用mybatis-plus，若是简单的curd操作，可以不用写xml文件，这样便降低了对xml的维护。

如下便详细介绍mybatis-plus。

1. 简介

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

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的数据库，如下所示：

MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb，informix，TDengine，redshift
达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库，优炫数据库

4. 框架结构

在这里插入图片描述

5. 开始使用

如下通过一个简单的 Demo 来阐述MyBatis-Plus的强大功能，在此之前，我们假设您已经：

拥有Java开发环境以及相应IDE
熟悉Spring Boot
熟悉Maven

5.1 数据源

现有一张User表，其表结构如下：

+----+----------+-----------+------+
| id | username | nick_name | age  |
+----+----------+-----------+------+
|  1 | chenxier | 陈希尔    |   18 |
|  2 | zhangsan | 张三      |   22 |
|  3 | lisi     | 李四      |   22 |
|  4 | wanger   | 王二      |   23 |
+----+----------+-----------+------+

其对应的数据库Schema脚本如下：

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  `nickname` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  `age` int(11) NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 5 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

其对应的数据库Data脚本如下：

INSERT INTO `user` VALUES (1, 'chenxier', '陈希尔', 18);
INSERT INTO `user` VALUES (2, 'zhangsan', '张三', 22);
INSERT INTO `user` VALUES (3, 'lisi', '李四', 20);
INSERT INTO `user` VALUES (4, 'wanger', '王二', 23);

5.2 初始化工程

引入jar包

<properties>
 	<java.version>1.8</java.version>
 	<baomidouMybatisPlus.version>3.5.2</baomidouMybatisPlus.version>
</properties>

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>${baomidouMybatisPlus.version}</version>
</dependency>

配置

在application.yml文件中如下配置：

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    password: 123456
    username: root
    url: jdbc:mysql://localhost:3306/superjson?useUnicode=true&characterEncoding=utf8&useSSL=false
#mybatis配置
mybatis-plus:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.superjson.superjsonmanager.mapper
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    # 按下划线转驼峰规则映射数据库字段与java bean属性之间的关系
    map-underscore-to-camel-case: true
    # 关闭一级缓存
    # local-cache-scope: statement
    # 关闭二级缓存
    # cache-enabled: false
  global-config:
    db-config:
      id-type: auto
      logic-delete-value: -1
      logic-not-delete-value: 0

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

/**
 * @author 念兮为美
 * @datetime 2022/8/5 15:16
 * @desc superjson框架的启动类
 */
@SpringBootApplication
@MapperScan("com.**.mapper")
@Slf4j
public class SuperJsonManagerApplication {

  public static void main(String[] args) {
    ConfigurableApplicationContext run =
        SpringApplication.run(SuperJsonManagerApplication.class, args);
    // 输出jwt配置信息
    log.info("jwt config: {}", run.getBean(JwtProperties.class));
  }
}

编码

编写实体类User.java

/**
 * @author 念兮为美
 * @create 2020-05-29 10:00
 */
@AllArgsConstructor
@NoArgsConstructor
@Data
@TableName("user")
public class User implements Serializable {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private int id;
  private String username;
  @TableField(value = "nick_name")
  private String nickname;
  private Integer age;
}

编写Mapper包下的UserMapper接口

/**
 * @author 念兮为美
 * @create 2020-05-29 10:13
 */
@Mapper
public interface UserMapper extends BaseMapper<User> {

}

开始使用

class SuperJsonManagerApplicationTests {

  @Resource
  private UserMapper userMapper;
  
  @Test
  void contextLoads() {
    System.out.println(("----- selectAll method test ------"));

    QueryWrapper queryWrapper = new QueryWrapper();
    queryWrapper.orderByDesc("id");
    List list = userMapper.selectList(queryWrapper);

    list.forEach(System.out::println);
  }

控制台的SQL：

JDBC Connection [com.alibaba.druid.proxy.jdbc.ConnectionProxyImpl@5ac25491] will not be managed by Spring
==>  Preparing: SELECT id,username,nick_name,age FROM user ORDER BY id DESC
==> Parameters: 
<==    Columns: id, username, nick_name, age
<==        Row: 4, wanger, 王二, 23
<==        Row: 3, lisi, 李四, 22
<==        Row: 2, zhangsan, 张三, 22
<==        Row: 1, chenxier, 陈希尔, 18
<==      Total: 4

控制台输出查询结果：

User(id=4, username=wanger, nickname=王二, age=23)
User(id=3, username=lisi, nickname=李四, age=22)
User(id=2, username=zhangsan, nickname=张三, age=22)
User(id=1, username=chenxier, nickname=陈希尔, age=18)