网站链接: element-ui dtcms
当前位置: 首页 > 技术博文  > 技术博文

Java学习笔记-Day89 Spring Mybatis-plus框架

2021/4/5 15:48:08 人评论

Java学习笔记-Day89 Spring Mybatis-plus框架一、Spring Mybatis-plus的简介二、Spring Mybatis-plus的使用1、实现步骤2、模糊分页查询(分页插件)3、注解3.1、TableName3.2、TableId3.3、TableField4、逻辑删除5、执行 SQL 分析打印6、乐观锁7、动态表名…

Java学习笔记-Day89 Spring Mybatis-plus框架

  • 一、Spring Mybatis-plus的简介
  • 二、Spring Mybatis-plus的使用
    • 1、实现步骤
    • 2、模糊分页查询(分页插件)
    • 3、注解
      • 3.1、@TableName
      • 3.2、@TableId
      • 3.3、@TableField
    • 4、逻辑删除
    • 5、执行 SQL 分析打印
    • 6、乐观锁
    • 7、动态表名
    • 8、代码生成器

一、Spring Mybatis-plus的简介


MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。支持任何能使用 mybatis 进行 crud,并且支持标准 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)分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库。
(11)内置性能分析插件:可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询。
(12)内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作。

二、Spring Mybatis-plus的使用

1、实现步骤


(1)MyBatis-Plus 3.0 版本基于 JDK8,项目的JDK版本要在JDK8及其以上。点击 New Project -> 选择Spring Initializr -> 点击Next -> 输入Group和Artifact,Java Version选择8 ->点击Next。

在这里插入图片描述
(2)选择Web的Spring Web、SQL的MySQL Driver。

在这里插入图片描述
(3)在pom.xml中引入mybatisplus依赖。

<!--引入mybatisplus依赖-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.1</version>
</dependency>

(4)在MySql数据中,使用如下sql语句创建数据库的users表。

DROP TABLE IF EXISTS `users`;
CREATE TABLE `users` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '用户编号',
  `name` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci DEFAULT NULL COMMENT '用户姓名',
  `age` int DEFAULT NULL COMMENT '用户年龄',
  `email` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci DEFAULT NULL COMMENT '用户邮箱',
  PRIMARY KEY (`id`)
)

users表的结构:

在这里插入图片描述
(5)在 application.properties 配置文件中添加 Mysql 数据库的相关配置。

server.port=8081
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/usersdb?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root

(6)在 Spring Boot 启动类中添加 @MapperScan 注解,扫描 Mapper 文件夹。

package com.etc.mybatisplusdemo;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.etc.mybatisplusdemo.mapper")
public class MybatisplusdemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisplusdemoApplication.class, args);
    }
}

(7)安装lombok插件(点击菜单栏的Files -> settings -> plugins),并在pom.xml文件中引入lombok依赖。

在这里插入图片描述

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

(8)编写实体类 Users,添加lombok的@Data、@AllArgsConstructor、@NoArgsConstructor等注解。

  • Users.java
package com.etc.mybatisplusdemo.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Users {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

(9)编写Mapper接口 UserMappe,继承 BaseMapper<T> 接口。

  • UserMappe.java
package com.etc.mybatisplusdemo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.etc.mybatisplusdemo.entity.Users;

public interface UsersMapper extends BaseMapper<Users> {
}

(10)添加测试类MybatisplusdemoApplicationTests ,进行增删改查的测试。

  • MybatisplusdemoApplicationTests.java
package com.etc.mybatisplusdemo;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.etc.mybatisplusdemo.entity.Users;
import com.etc.mybatisplusdemo.mapper.UsersMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@SpringBootTest
class MybatisplusdemoApplicationTests {
    @Autowired
    private UsersMapper usersMapper;
    /**
     * 获取所有users数据
     */
    @Test
    void testSelect01() {
        System.out.println(usersMapper.selectList(null));
    }
    /**
     * 获取编号为1378393517868449793的users数据
     */
    @Test
    void testSelect02() {
        System.out.println(usersMapper.selectById(1378393517868449793L));
    }
    /**
     * 插入编号为5的users数据
     */
    @Test
    void testInsert01() {
        //创建User对象
        Users user = new Users();
        user.setId(5L);
        user.setName("jerry");
        user.setEmail("jerry@google.com");
        user.setAge(24);
        //调用insert方法
        int i = usersMapper.insert(user);
        System.out.println(i);
    }
    /**
     * 插入users数据
     */
    @Test
    void testInsert02() {
        //创建Users对象
        Users user = new Users();
        user.setName("jack");
        user.setEmail("jack@google.com");
        user.setAge(25);
        //调用insert方法
        int i = usersMapper.insert(user);
        System.out.println(i);
    }
    /**
     * 修改编号为1378393517868449793的users数据
     */
    @Test
    void testUpdate01() {
        //创建Users对象
        Users user = new Users();
        user.setId(1378393517868449793L);
        user.setEmail("jack2@google.com");
        user.setName("jack2");
        //调用update方法
        int i = usersMapper.updateById(user);
        System.out.println(i);
    }
    /**
     * 修改编号为1378393517868449793的users数据(先查询,再修改)
     */
    @Test
    void testUpdate02() {
        //先查询,再修改
        // UPDATE user SET name=?, age=?, email=? WHERE id=?
        Users user = usersMapper.selectById(1378393517868449793L);
        user.setEmail("jack3@google.com");
        user.setName("jack3");
        //调用update方法
        int i = usersMapper.updateById(user);
        System.out.println(i);
    }
    /**
     * 删除编号为1378393517868449793的users数据
     */
    @Test
    void testDelete() {
        //物理删除
        int i = usersMapper.deleteById(1378393517868449793L);
        System.out.println(i);
    }
    /**
     * 多条件查询users数据(使用queryWrapper)
     */
    @Test
    void testQueryWrapper01() {
        //实例queryWrapper
        QueryWrapper queryWrapper = new QueryWrapper();
        //条件构造
        Map map = new HashMap();
        map.put("id","5");
        map.put("name","jerry");
        queryWrapper.allEq(map);
        List list = usersMapper.selectList(queryWrapper);
        list.forEach(System.out::println);
    }
    /**
     * 多条件查询users数据(使用queryWrapper)
     */
    @Test
    void testQueryWrapper02() {
        //实例queryWrapper
        QueryWrapper queryWrapper = new QueryWrapper();
        //条件构造
        //between
        queryWrapper.between("age","20","30");
        //like
        queryWrapper.like("name","j");
        //oroder by
        queryWrapper.orderByDesc("age");
        List list = usersMapper.selectList(queryWrapper);
        list.forEach(System.out::println);
    }
}

2、模糊分页查询(分页插件)


(1)使用Spring boot方式配置MyBatis-plus的插件,先创建config包,并在该包下创建MyBatisPlusConfig配置类,在该类中添加分页插件。

package com.etc.mybatisplusdemo.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

//Spring boot方式
@Configuration
public class MyBatisPlusConfig {
    //新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //分页插件(设置mysql数据库)
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

(2)创建测试类MybatisplusdemoApplicationTests2,测试模糊分页查询。

  • MybatisplusdemoApplicationTests2.java
package com.etc.mybatisplusdemo;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.etc.mybatisplusdemo.entity.Users;
import com.etc.mybatisplusdemo.mapper.UsersMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@SpringBootTest
class MybatisplusdemoApplicationTests2 {
    @Autowired
    private UsersMapper usersMapper;
    /**
     * 多条件查询users数据(模糊分页查询)
     */
    @Test
    void testqueryByPage() {
        //实例queryWrapper
        QueryWrapper queryWrapper = new QueryWrapper();
        //like
        queryWrapper.like("name","");
        //order by
        queryWrapper.orderByAsc("id");
        //构造一个Ipage接口的实现类对象Page
        //参数 一个页码 每页显示的记录数
        Page page = new Page(1, 3);
        //将page和queryWrapper作为方法参数
        Page selectPage = usersMapper.selectPage(page, queryWrapper);
        //输出查询结果集合
        selectPage.getRecords().forEach(System.out::println);
        //总数
        System.out.println(selectPage.getTotal());
        //当前分页总页数
        System.out.println(selectPage.getPages());
    }
}

3、注解

3.1、@TableName


@TableName:表名注解,如果数据库表名和实体类名不一致的话,可以使用该注解。

属性类型必须指定默认值描述
valueString“”表名
schemaString“”schema
keepGlobalPrefixbooleanfalse是否保持使用全局的 tablePrefix 的值(如果设置了全局 tablePrefix 且自行设置了 value 的值)
resultMapString“”xml 中 resultMap 的 id
autoResultMapbooleanfalse是否自动构建 resultMap 并使用(如果设置
excludePropertyString[]{}需要排除的属性名(@since 3.3.1)

3.2、@TableId


@TableId:主键注解(如果数据库主键设置了自增,可以指定type属性为AUTO或者ASSIGN_UUID等)。

属性类型必须指定默认值描述
valueString“”主键字段名
typeEnumIdType.NONE主键类型
描述
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方法)
  • Users.java
package com.etc.mybatisplusdemo.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.time.LocalDateTime;

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName(value="users")
public class Users implements Serializable {
    @TableId(value = "id",type = IdType.ASSIGN_UUID)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

3.3、@TableField


@TableField:字段注解(非主键)。

@TableField注解的 value 和 fill 属性说明:

属性类型必须指定默认值描述
valueString“”数据库字段名
fillEnumFieldFill.DEFAULT字段自动填充策略

字段填充策略 FieldFill:

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

自动填充功能的实现

(1)创建config包,并在该包下创建MyMetaObjectHandler类(配置类)。

  • MyMetaObjectHandler.java
package com.etc.mybatisplusdemo.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, "created", LocalDateTime.class, LocalDateTime.now());
        this.strictUpdateFill(metaObject, "modified", LocalDateTime.class, LocalDateTime.now());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.strictUpdateFill(metaObject, "modified", LocalDateTime.class, LocalDateTime.now());
    }
}

(2)在数据库的表中新增created(类型为datetime)字段和modified(类型为datetime)字段,在实体类中新增created(类型为LocalDateTime)属性和modified(类型为LocalDateTime)属性,并在字段前添加@TableField注解,指定对应的字段填充策略。

  • Users.java
package com.etc.mybatisplusdemo.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.time.LocalDateTime;

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName(value="users")
public class Users implements Serializable {
    @TableId(value = "id",type = IdType.ASSIGN_UUID)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    // created代表创建时间,数据库中插入新的记录,会自动填充该字段
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime created;
    // modified代表更新时间,数据库中插入和更新记录,会自动填充该字段
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime modified;
}

4、逻辑删除


逻辑删除只对自动注入的sql起效。对于插入的sql语句不作限制。对于查询的sql语句,会追加where条件过滤掉已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段。对于更新的sql语句,会追加where条件防止更新到已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段。对于删除的sql语句,会转变为更新的sql语句。

逻辑删除功能的实现步骤

(1)在数据库的表中新增一个类型为int的deleted字段。

(2)在实体类中新增一个int类型的deleted属性,在该属性前加上@TableLogic注解。

package com.etc.mybatisplusdemo.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

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

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName(value="users")
public class Users implements Serializable {
    @TableId(value = "id",type = IdType.ASSIGN_UUID)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime created;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime modified;
    @TableLogic
    private Integer deleted;
}

注意:在执行该表的查询、修改、删除的sql语句时,都会在该sql语句后面增加一个deleted=0的条件。

查询的sql语句:
在这里插入图片描述
修改的sql语句:
在这里插入图片描述
删除的sql语句:
在这里插入图片描述

5、执行 SQL 分析打印


执行 SQL 分析打印功能依赖 p6spy 组件,能完美的输出打印 SQL 及执行时长,但该功能有性能损耗,不建议生产环境使用。

执行 SQL 分析打印功能的实现步骤:

(1)在pom.xml中加入 p6spy 组件的依赖。

<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.9.1</version>
</dependency>

(2)修改application.properties文件。

server.port=8081

spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
spring.datasource.url=jdbc:p6spy:mysql://localhost:3306/usersdb?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root

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

(3)在resouce目录下添加spy.properties配置文件。

#3.2.1以上使用
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
#3.2.1以下使用或者不配置
#modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2

(4)运行增加、修改、删除、查询的方法时,会输出执行的SQL语句和该SQL语句执行的时间。

在这里插入图片描述

6、乐观锁


当要更新一条记录的时候,希望这条记录没有被别人更新,可以使用乐观锁(OptimisticLockerInnerInterceptor)插件来实现。

乐观锁实现方式:
(1)取出记录时,获取当前version。
(2)更新时,带上这个version。
(3)执行更新时, set version = newVersion where version = oldVersion。例如:UPDATE users SET name=Tom,version=1 WHERE id=1 AND version=0
(4)如果version对不上,就更新失败。

乐观锁功能的实现步骤:
(1)在数据库的表中新增一个int类型的version字段。
(2)在实体类中新增一个int类型的version属性,在该属性前加上@Version注解。

package com.etc.mybatisplusdemo.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.time.LocalDateTime;

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName(value="users")
public class Users implements Serializable {
    @TableId(value = "id",type = IdType.ASSIGN_UUID)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime created;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime modified;
    @TableLogic
    private Integer deleted;
    @Version
    private Integer version;
}

(3)执行修改方法(先查询,后修改)时,执行的sql语句会加上vesion条件。

    @Test
    void testUpdate() {
        //先查询,再修改
        //调用select方法
        Users user = usersMapper.selectById(15L);
        user.setName("jack3");
        user.setEmail("jack3@google.com");
        //调用update方法
        int i = usersMapper.updateById(user);
        System.out.println(i);
    }

该方法执行的sql语句如下:

Execute SQL:SELECT id,name,age,email,created,modified,deleted,version FROM users WHERE id=15 AND deleted=0

Execute SQL:UPDATE users SET name=‘jack3’, age=24, email=‘jack3@google.com’, created=‘2021-04-05T11:31:21’, modified=‘2021-04-05T11:32:08’, version=1 WHERE id=15 AND version=0 AND deleted=0

7、动态表名


当数据量比较大的时候,为了提高数据库操作的效率,尤其是查询的效率,其中一种解决方案就是将数据表拆分。 拆分的数据表,结构完全一致,只不过是表的名字,按照某种规律,而成为一组。

动态表名功能的实现步骤:

(1)复制users表为users_2020和users_2021。
在这里插入图片描述
(2)在MyBatisPlusConfig配置文件中加入 动态表名的插件(DynamicTableNameInnerInterceptor )及其配置。配置中的users代表表名,而_2020或者_2021在执行sql语句时将会拼接到user后面。

package com.etc.mybatisplusdemo.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.handler.TableNameHandler;
import com.baomidou.mybatisplus.extension.plugins.inner.DynamicTableNameInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.HashMap;
import java.util.Random;

//Spring boot方式
@Configuration
public class MyBatisPlusConfig {
    //新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //分页插件(设置mysql数据库)
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        //乐观锁插件
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        //动态表名插件
        DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor = new DynamicTableNameInnerInterceptor();
        HashMap<String, TableNameHandler> map = new HashMap<String, TableNameHandler>(2) {{
            put("users", (sql, tableName) -> {
                String year = "_2020";
                int random = new Random().nextInt(10);
                if (random % 2 == 1) {
                    year = "_2021";
                }
                return tableName + year;
            });
        }};
        dynamicTableNameInnerInterceptor.setTableNameHandlerMap(map);
        interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor);
        return interceptor;
    }
}

(3)运行增加、修改、删除、查询的方法时,sql语句的表名会和_2020或者_2021进行拼接。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

8、代码生成器


AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

实现步骤:

(1)在pom.xml文件中加入 generator 和 freemarker 依赖。

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>
<!--模板引擎-->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

(2)创建generator包,并在该包下创建MybatisPlusGenerator类,并设置作者名称、数据源配置和包配置。

package com.etc.mybatisplusdemo.generator;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

public class MybatisPlusGenerator {
    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        //拼接  ,用,隔开
        help.append("请输入" + tip + ":");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            //控制台接收
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        //设置输出目录
        gc.setOutputDir(projectPath + "/src/main/java");
        //设置作者名
        gc.setAuthor("tom");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        gc.setServiceName("%sService");
        gc.setControllerName("%sController");
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/usersdb?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //pc.setModuleName(scanner("模块名"));
        pc.setParent("com.etc.mybatisplusdemo");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录,自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在,不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        // strategy.setSuperEntityColumns("id"); 如果表中有id,加了这句,实体类将不生成id属性
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        //模板配置
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

(3)运行MybatisPlusGenerator类,运行成功后,在控制台输入表名,如果是多张表的话,则使用 , 隔开。

单张表:
在这里插入图片描述
多张表:
在这里插入图片描述

相关资讯

    暂无相关的数据...

共有条评论 网友评论

验证码: 看不清楚?