【MyBatis-Puls】入门快速搭建及案例、主键自动生成、自动填充的使用

2023-12-16 15:12
文章标签 使用 入门 快速 搭建 生成 自动 案例 填充 主键 mybatis puls

本文主要是介绍【MyBatis-Puls】入门快速搭建及案例、主键自动生成、自动填充的使用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一、引言

1、什么是MyBatis-Plus

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。它提供了一些常用功能的增强，使得开发者可以更加便捷地进行数据库访问操作。

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

2、特点

  Mybatis-Plus简化了Mybatis的开发流程，提高了开发效率。它提供了一些常用功能的增强，使得开发者无需编写繁琐的SQL语句，即可完成常见的数据库操作。同时，它也提供了一些附加功能，如条件构造器、自动分页、代码生成器等，进一步提升了开发效率和代码质量。

  1. 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
  2. 损耗小：启动即会自動注入基本CURD，性能基本无损耗，直接面向对象操作。
  3. 强大的CRUD操作：内置通用Mapper、通用Service，仅仅通过少量配置即可实现单表大部分CRUD操作，更有强大的条件构造器，满足各类使用需求。
  4. 支持Lambda形式调用：通过Lambda表达式，方便的编写各类查询条件，无需再担心字段写错。
  5. 支持主键自动生成：支持多达4种主键策略（内含分布式唯一ID生成器- Sequence），可自由配置，完美解决主键问题。
  6. 支持ActiveRecord模式：支持ActiveRecord形式调用，实体类只需继承Model类即可进行强大的CRUD操作。
  7. 支持自定义全局通用操作：支持全局通用方法注入（Write once, use anywhere）。
  8. 内置代码生成器：采用代码或者Maven插件可快速生成Mapper、Model、Service、Controller层代码，支持模板引擎，更有超多自定义配置等您来使用。
  9. 内置分页插件：基于MyBatis物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通List查询。
  10. 分页插件支持多种数据库：

    1. MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb，informix，TDengine，redshift。

    2. 达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库，优炫数据库。

  11. 内置性能分析插件：可输出Sql语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询。
  12. 内置全局拦截插件：提供全表delete、update操作智能分析阻断，也可自定义拦截规则，预防误操作。

3、结构

  1. MyBatis-Plus内核：这是MyBatis-Plus的核心部分，它包括了对MyBatis的基础增强功能，例如简化CRUD操作、支持Lambda表达式等。
  2. 代码生成器：MyBatis-Plus提供了一个代码生成器，可以快速生成Mapper、Model、Service和Controller层的代码，大大提高了开发效率。
  3. 分页插件：MyBatis-Plus内置了一个分页插件，基于MyBatis的物理分页，可以让开发者无需关心具体的分页操作。
  4. 性能分析插件：MyBatis-Plus提供了一个性能分析插件，可以输出Sql语句以及其执行时间，帮助开发者快速找到慢查询。
  5. 全局拦截插件：MyBatis-Plus提供了一个全局拦截插件，可以对全表delete、update操作进行智能分析并阻断，预防误操作。

二、MyBatis-Puls快速搭建

使用Spring Initializer快速初始化一个 Spring Boot 工程（工程将以 MySQL 作为默认数据库）

1、导入依赖

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>com.mysql</groupId><artifactId>mysql-connector-j</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><!--导入mybatis-plus依赖--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.2</version></dependency><!--导入mybatis-plus生成器依赖--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-generator</artifactId><version>3.5.2</version></dependency><!--    引入freemarker    --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-freemarker</artifactId></dependency></dependencies>

2、配置

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

server:port: 8080
spring:datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://localhost:3306/bookshop?useUnicode=true&characterEncoding=utf8username: rootpassword: 123456
mybatis-plus:# Mybatis Mapper所对应的XML位置mapper-locations: classpath:mapper/*.xml# 别名包扫描路径 实体类type-aliases-package: com.wfzl.demopuls.model# 是否开启自动驼峰命名规则（camel case）映射configuration:map-underscore-to-camel-case: true
logging:level:com.wfzl.demopuls.mapper: debug

需要注意的地方

3、代码生成

导入我们的代码生成类MySQLGenerator.java

package com.wfzl.demopuls.config;import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import lombok.extern.slf4j.Slf4j;import java.util.Arrays;
import java.util.Collections;
import java.util.List;@Slf4j
public class MySQLGenerator {private final static String URL = "jdbc:mysql://localhost:3306/bookshop";private final static String USERNAME = "root";private final static String PASSWORD = "123456";private final static DataSourceConfig.Builder DATA_SOURCE_CONFIG =new DataSourceConfig.Builder(URL, USERNAME, PASSWORD);public static void main(String[] args) {FastAutoGenerator.create(DATA_SOURCE_CONFIG).globalConfig((scanner, builder) ->// builder.author(scanner.apply("请输入作者名称?"))builder.author("wfzldr")
//                                        指定输出目录 System.getProperty("user.dir")：当前用户的项目名.outputDir(System.getProperty("user.dir") + "\\src\\main\\java").commentDate("yyyy-MM-dd").dateType(DateType.TIME_PACK))
//                包配置.packageConfig((builder) ->
//                        对应的项目名路径builder.parent("com.wfzl.demopuls")
//                                        实体类.entity("model").service("service").serviceImpl("service.impl").mapper("mapper").xml("mapper.xml").pathInfo(Collections.singletonMap(OutputFile.xml, System.getProperty("user.dir") + "\\src\\main\\resources\\mapper"))).injectionConfig((builder) ->builder.beforeOutputFile((a, b) -> log.warn("tableInfo: " + a.getEntityName()))).strategyConfig((scanner, builder) ->
//                                builder.addInclude(getTables(scanner.apply("请输入表名,多个英文逗号分隔?所有输入 all")))
//                                如果要生成这个数据库所有的表填写：all 即可builder.addInclude(getTables("sys_user_post"))//                                过滤表前缀.addTablePrefix("tb_", "t_", "lay_", "meeting_", "sys_").entityBuilder().enableChainModel().enableLombok().enableTableFieldAnnotation().controllerBuilder().enableRestStyle().enableHyphenStyle().build()).templateEngine(new FreemarkerTemplateEngine()).execute();}protected static List<String> getTables(String tables) {return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));}}

在类中的数据库名、数据库账号密码、作者及包名、表名即可

4、注意

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

在Mapper类里面添加@Repository注解。

以上添加成功才能运行你的Controller层。

三、综合案例

在我们的Controller 层编写我们的方法。

我们的Mapper层的CRUD方法和我们的Service的CRUD方法是不一样的。

package com.wfzl.demopuls.controller;import com.github.yitter.idgen.YitIdHelper;
import com.wfzl.demopuls.model.Book;
import com.wfzl.demopuls.service.IBookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;/*** <p>* 前端控制器* </p>** @author wfzldr* @since 2023-12-15*/
@RestController
@RequestMapping("/book")
public class BookController {@Autowiredprivate IBookService bookService;@RequestMapping("/list")public Object list() {return bookService.list();}@RequestMapping("/save")public Object save(Book book) {return bookService.save(book);}@RequestMapping("/edit")public Object edit(Book book) {return bookService.updateById(book);}@RequestMapping("/del")public Object del(Book book) {return bookService.removeById(book);}}

四、主键生成策略

1、@TableId注解属性

在我们的实体类上有一个@TableId的注解。

@TableId是MyBatis-Plus中用于标识表主键的注解。它用于指定实体类属性与数据库表主键字段的映射关系。

属性类型必须指定默认值描述
valueString否""主键字段名
typeEnum否IdType.NONE指定主键类型

@TableId注解type属性IdType主键生成策略介绍

值描述
AUTO数据库 ID 自增
NONE无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT）
INPUTinsert 前自行 set 主键值
ASSIGN_ID分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
ASSIGN_UUID分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法)

2、雪花ID的使用

①导依赖

        <dependency><groupId>com.github.yitter</groupId><artifactId>yitter-idgenerator</artifactId><version>1.0.6</version></dependency>

②使用

在我们的Controller层的增加的方法里面添加我们的雪花ID。

我们在调用的时候需要在实体里面的这个属性改成Long类型，我们的数据库也是Long类型，比如我们的MySQL就是要改成bigint类型

import com.github.yitter.idgen.YitIdHelper;
import com.wfzl.demopuls.model.Book;
import com.wfzl.demopuls.service.IBookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;/*** <p>* 前端控制器* </p>** @author wfzldr* @since 2023-12-15*/
@RestController
@RequestMapping("/book")
public class BookController {@Autowiredprivate IBookService bookService;@RequestMapping("/save")public Object save(Book book) {
//         YitIdHelper.nextId(); 雪花id  需实体改long类型book.setId(YitIdHelper.nextId());return bookService.save(book);}}

在测试结果可以看到我们的ID已经增加进去了。

五.自动填充

@TableField字段注解（非主键），其中fill字段自动填充策略，具体策略如下

值描述
DEFAULT默认不处理
INSERT插入时填充字段
UPDATE更新时填充字段
INSERT_UPDATE插入和更新时填充字段

注解则是指定该属性在对应情况下必有值,如果无值则入库会是null。

添加我们的自定义实现类。

  • 参数二：你的字段名
  • 参数三：你字段的数据类型
  • 参数四：你要自动添加的数据
package com.wfzl.demopuls.config;import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;import java.time.LocalDateTime;@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {log.info("开始新增操作自动填充 ....");this.strictInsertFill(metaObject, "booktype", String.class, "玄幻");}@Overridepublic void updateFill(MetaObject metaObject) {log.info("开始更新操作自动填充 ....");this.strictUpdateFill(metaObject, "booktype", String.class, "悬疑");}
}

如果我们没添加这个字段的数据，则它自己默认添加提前设置好的数据进去。

我的分享就到这里！

这篇关于【MyBatis-Puls】入门快速搭建及案例、主键自动生成、自动填充的使用的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/500918。

相关文章

Mybatis拦截器如何实现数据权限过滤

Mybatis拦截器如何实现数据权限过滤

《Mybatis拦截器如何实现数据权限过滤》本文介绍了MyBatis拦截器的使用,通过实现Interceptor接口对SQL进行处理,实现数据权限过滤功能,通过在本地线程变量中存储数据权限相关信息,并... 目录背景基础知识MyBATis 拦截器介绍代码实战总结背景现在的项目负责人去年年底离职，导致前期规
阅读更多...
使用 Python 和 LabelMe 实现图片验证码的自动标注功能

使用 Python 和 LabelMe 实现图片验证码的自动标注功能

《使用Python和LabelMe实现图片验证码的自动标注功能》文章介绍了如何使用Python和LabelMe自动标注图片验证码,主要步骤包括图像预处理、OCR识别和生成标注文件,通过结合Pa... 目录使用 python 和 LabelMe 实现图片验证码的自动标注环境准备必备工具安装依赖实现自动标注核心
阅读更多...
springcloud之FeignClient使用详解

springcloud之FeignClient使用详解

《springcloud之FeignClient使用详解》Feign是一种声明式、模板化的HTTP客户端,可以简化微服务之间的远程过程调用,通过Feign,开发者可以像调用本地方法一样调用远程服务,而... 目录前言业务场景架构说明调用逻辑1、A-FeignClient2、A微服务3、B微服务小结前言在微
阅读更多...
C# Task Cancellation使用总结

C# Task Cancellation使用总结

《C#TaskCancellation使用总结》本文主要介绍了在使用CancellationTokenSource取消任务时的行为,以及如何使用Task的ContinueWith方法来处理任务的延... 目录C# Task Cancellation总结1、调用cancellationTokenSource.
阅读更多...
使用Python实现生命之轮Wheel of life效果

使用Python实现生命之轮Wheel of life效果

《使用Python实现生命之轮Wheeloflife效果》生命之轮Wheeloflife这一概念最初由SuccessMotivation®Institute,Inc.的创始人PaulJ.Meyer... 最近看一个生命之轮的视频，让我们珍惜时间，因为一生是有限的。使用python创建生命倒计时图表，珍惜时间
阅读更多...
C# dynamic类型使用详解

C# dynamic类型使用详解

《C#dynamic类型使用详解》C#中的dynamic类型允许在运行时确定对象的类型和成员,跳过编译时类型检查,适用于处理未知类型的对象或与动态语言互操作,dynamic支持动态成员解析、添加和删... 目录简介dynamic 的定义dynamic 的使用动态类型赋值访问成员动态方法调用dynamic 的
阅读更多...
使用Vue.js报错：ReferenceError: “Vue is not defined“ 的原因与解决方案

使用Vue.js报错：ReferenceError: “Vue is not defined“ 的原因与解决方案

《使用Vue.js报错：ReferenceError:“Vueisnotdefined“的原因与解决方案》在前端开发中,ReferenceError:Vueisnotdefined是一个常见... 目录一、错误描述二、错误成因分析三、解决方案1. 检查 vue.js 的引入方式2. 验证 npm 安装3.
阅读更多...
使用Python检查CPU型号并弹出警告信息

使用Python检查CPU型号并弹出警告信息

《使用Python检查CPU型号并弹出警告信息》本教程将指导你如何编写一个Python程序,该程序能够在启动时检查计算机的CPU型号,如果检测到CPU型号包含“I3”,则会弹出一个警告窗口,感兴趣的小... 目录教程目标方法一所需库步骤一：安装所需库步骤二：编写python程序步骤三：运行程序注意事项方法二
阅读更多...
MyBatis框架实现一个简单的数据查询操作

MyBatis框架实现一个简单的数据查询操作

《MyBatis框架实现一个简单的数据查询操作》本文介绍了MyBatis框架下进行数据查询操作的详细步骤,括创建实体类、编写SQL标签、配置Mapper、开启驼峰命名映射以及执行SQL语句等,感兴趣的... 基于在前面几章我们已经学习了对MyBATis进行环境配置，并利用SqlSessionFactory核
阅读更多...
QT实现TCP客户端自动连接

QT实现TCP客户端自动连接

《QT实现TCP客户端自动连接》这篇文章主要为大家详细介绍了QT中一个TCP客户端自动连接的测试模型,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录版本 1:没有取消按钮 测试效果测试代码版本 2:有取消按钮测试效果测试代码版本 1:没有取消按钮 测试效果缺陷：无法手动停
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2