MyBatis-Plus

最新推荐文章于 2024-04-19 15:49:21 发布

x0757

最新推荐文章于 2024-04-19 15:49:21 发布

阅读量441

点赞数

文章标签： spring boot mybatis java

本文链接：https://blog.csdn.net/m0_58380757/article/details/126004112

版权

1 mp介绍

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做==增强不做改变==，为简化开发、提高效率而生。--单表操作的都不需要自己在写sql语句。--

愿景

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

1.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 操作智能分析阻断，也可自定义拦截规则，预防误操作.

1.3 如何使用

快速开始 | MyBatis-Plus

（1）创建数据库和表

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)
);
DELETE FROM user;

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

（2）依赖

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>

(3)创建实体类

package com.xzj.entity;

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;


@Data
//如果表名和实体类名不一致。@TableName(value = "tbl_user")
public class User {

    //标记该属性为主键。 value:标记列名和属性名的对应
    @TableId(value = "id")
    private Integer id;

    //如果属性和列名不一样    @TableField(value = "")
    private String name;

    private Integer age;

    private String email;

}






//后期使用

package com.xzj.entity;

import java.time.LocalDateTime;
import java.io.Serializable;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableLogic;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;

/**
 * <p>
 * 
 * </p>
 *
 * @author xzj
 * @since 2022-07-25
 */
@Data
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
@ApiModel(value="User对象", description="")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "主键ID")
    private Long id;

    @ApiModelProperty(value = "姓名")
    private String name;

    @ApiModelProperty(value = "年龄")
    private Integer age;

    @ApiModelProperty(value = "邮箱")
    private String email;

    @ApiModelProperty(value = "逻辑字段 0表示未删除 1表示删除")
    @TableLogic
    private Boolean isdelete;

    @ApiModelProperty(value = "创建时间")
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime gmtCreated;

    @ApiModelProperty(value = "修改时间")
    @TableField(fill = FieldFill.UPDATE)
    private LocalDateTime gmtUpdated;
    private  String deptid;

    @TableField(exist = false)
   private TblDept dept;

    public User(String name, Integer age, String email, String deptid) {
        this.name = name;
        this.age = age;
        this.email = email;
        this.deptid = deptid;
    }
}

(4)dao

//BaseMapper接口中提供了单表的所有操作。crud.
@Mapper
public interface UserMapper extends BaseMapper<User> {
}

(5)测试

@Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        User user = userMapper.selectById(1);
        System.out.println(user);
    }

2. mp操作

2.1 mp-增加

swagger类

package com.xzj.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.VendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;

/**
 * @author xuan
 */
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xzj.controller"))
                .build();
          return docket;

    }

    public ApiInfo apiInfo(){
        Contact DEFAULT_CONTAT=new Contact("xxx","http://www.aaa.com","111@qq.com");
        ApiInfo apiInfo= new ApiInfo("qy151在线文档","这是一个文档","A1.0","http://www.aaa.com",
                DEFAULT_CONTAT,"AAA","http://www.aaa.com",new ArrayList<VendorExtension>());
        return  apiInfo;
    }
}

增加

  /**
     *  主键mp提供相应的生成策略:
     *     AUTO(0),递增策略，如果使用该策略必须要求数据表的列也是递增。
     *     NONE(1),
     *     INPUT(2),没有策略，必须人为的输入id值
     *     ASSIGN_ID(3), 随机生成一个Long类型的值。该值一定是唯一。而且每次生成都不会相同。算法：雪花算法。 适合分布式主键。
     *     ASSIGN_UUID(4); 随机产生一个String类型的值。该值也是唯一的。
     */
   @PostMapping("/findInsert")
        @ApiOperation(value = "添加")
        @ApiImplicitParams(
                {
                        @ApiImplicitParam(value = "姓名", name="name",required = true),
                        @ApiImplicitParam(value = "年龄", name="age",required = true),
                        @ApiImplicitParam(value = "邮箱", name="email",required = true),
                        @ApiImplicitParam(value = "部门id", name="deptid",required = true)
                }
        )
    public CommonResult findInsert(User user){
            int insert = userMapper.insert(user);
            if(insert==1){
                return new CommonResult(2000,"添加成功",insert);
            }else {
                return new CommonResult(5000,"添加失败",null);
            }
        }

2.2 mp-逻辑删除

自动填充

package com.xzj.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 {

    //当添加时自动填充的值
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        // 或者
        this.strictInsertFill(metaObject, "gmtCreated", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
        this.strictInsertFill(metaObject, "isdelete", ()->0, Integer.class); // 起始版本 3.3.3(推荐)

    }
    //当修改时自动填充的值
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        // 或者
        this.strictUpdateFill(metaObject, "gmtUpdated", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
    }
}

删除

    /**
     *  实际开发中： 我们的删除可能是逻辑删除。所谓的逻辑删除就是修改功能。把某个列修改以删除的状态值。
     *  只对自动注入的 sql 起效:
             * 插入: 不作限制---
             * 查找: 追加 where 条件过滤掉已删除数据,且使用 wrapper.entity 生成的 where 条件会忽略该字段
             * 更新: 追加 where 条件防止更新到已删除数据,且使用 wrapper.entity 生成的 where 条件会忽略该字段
             * 删除: 转变为 更新
     * (1)增加一个逻辑字段: isdeleted  0表示未删除 1表示删除.
     * (2)实体类上的字段添加   @TableLogic.
     */


 @PostMapping("/findDelete")
        @ApiOperation(value = "删除")
        @ApiImplicitParams({
                @ApiImplicitParam(value = "id" ,name="id",required = true)
        })
    public CommonResult testDelete(Long id){
            int i = userMapper.deleteById(id);
            if(i==1){
                return new CommonResult(2000,"删除成功",i);
            }else {
                return new CommonResult(5000,"删除失败",null);
            }
        }