mybatis plus 简单使用及Generator使用记录笔记

「爱情、让人受尽委屈。」 2023-01-09 15:58 148阅读 0赞

## pom.xml配置文件 ##

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.4.1</version>
            </dependency>
    
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.30</version>
            </dependency>

## 在代码里面某个地方创建一个代码运行类 ##

package com.lsx.mp.generator;
    
    
    
    import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
    import com.baomidou.mybatisplus.core.toolkit.StringPool;
    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 org.springframework.util.StringUtils;
    
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Scanner;
    
    /**
     * @description:
     * @author:lsx
     * @time: 2021/1/22 11:09
     */
    public class CodeGenerator {
    	/**
    	 * <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.hasText(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("lsx");
    		gc.setOpen(false);
    		//TODO 是否覆盖已有的文件
    		gc.setFileOverride(true);
    
    		// gc.setSwagger2(true); 实体属性 Swagger2 注解
    		mpg.setGlobalConfig(gc);
    
    		// 数据源配置
    		DataSourceConfig dsc = new DataSourceConfig();
    		//TODO
    		dsc.setUrl("jdbc:mysql://127.0.0.1:3306/testsql?useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false");
    		// dsc.setSchemaName("public");
    		dsc.setDriverName("com.mysql.jdbc.Driver");
    		dsc.setUsername("root");
    		dsc.setPassword("root");
    		mpg.setDataSource(dsc);
    
    		// 包配置
    		PackageConfig pc = new PackageConfig();
    		//TODO
    		String defaultPackage = "com.lsx.mp.mybatisplus";
    		System.out.println("代码默认的包名位置为："+defaultPackage);
    		pc.setModuleName(scanner("代码生成之后所在模块名"));
    		pc.setParent(defaultPackage);
    		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);
    		// 配置 rest 风格的控制器（@RestController）
    		strategy.setRestControllerStyle(true);
    		// 公共父类
    		//strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
    		// 写于父类中的公共字段
    		//strategy.setSuperEntityColumns("id");
    		//输入表明
    		strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
    		// 配置驼峰转连字符
    		strategy.setControllerMappingHyphenStyle(true);
    		//TODO 是否生成表字段映射的常量
    		strategy.setEntityColumnConstant(true);
    		//TODO
    		//去表表前缀，比如数据库的表明为：t_user_test,那么在entity里面只要UserTest
    		strategy.setTablePrefix("t_");
    		mpg.setStrategy(strategy);
    		mpg.setTemplateEngine(new FreemarkerTemplateEngine());
    		mpg.execute();
    	}
    }

阅读一次代码，按照自己的项目把需要修改的配置文件修改一下，着重关注TODO 标签代码。修改完成之后运气上面的main方法，按照提示输入。最后效果如下：

### 表结构 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70][]

### 控制台输入代码 ###

![20210122121107181.png][]

### 代码生成结果 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70 1][]

### 注： ###

一套能用来测试mybatisplus的pom配置

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.4.2</version>
            <relativePath/> 
        </parent>
    
        <groupId>com.lsx.mp</groupId>
        <artifactId>mybatisplus</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>mybatisplus</name>
        <description>Demo project for Spring Boot</description>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.1.4</version>
            </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>
    
    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.44</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid-spring-boot-starter</artifactId>
                <version>1.1.20</version>
            </dependency>
    
    
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.1.0</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.4.1</version>
            </dependency>
    
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.30</version>
            </dependency>
    
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <excludes>
                            <exclude>
                                <groupId>org.projectlombok</groupId>
                                <artifactId>lombok</artifactId>
                            </exclude>
                        </excludes>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    </project>

yml配置

mybatis-plus:
      mapper-locations: classpath:/mybatis/mapper/*Mapper.xml
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    
    spring:
      datasource:
        #类型
        type: com.alibaba.druid.pool.DruidDataSource
        #驱动
        driverClassName: com.mysql.jdbc.Driver
        driver-class-name: com.mysql.jdbc.Driver
        platform: mysql
        #数据库连接
        url: jdbc:mysql://127.0.0.1:3306/testsql?useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false
        #数据库用户名密码
        username: 123456789
        password: 123456789
        #连接池配置
        druid:
          #初始化连接池大小
          initialSize: 10
          #最大空闲值.当经过一个高峰时间后，连接池可以慢慢将已经用不到的连接慢慢释放一部分，一直减少到maxIdle为止
          minIdle: 1
          #最大活跃数
          maxActive: 50
          #最大建立连接等待时间。如果超过此时间将接到异常。设为－1表示无限制
          maxWait: 60000
          #失效检查线程运行时间间隔，要小于MySQL默认
          timeBetweenEvictionRunsMillis: 60000
          #连接的超时时间，默认为半小时
          minEvictableIdleTimeMillis: 300000
          #检查连接有效性的SQL语句
          validationQuery: SELECT 1 FROM dual
          #检查连接是否有效
          testWhileIdle: true
          testOnBorrow: true
          testOnReturn: false
          #开启池的prepared statement 池功能
          poolPreparedStatements: false
          #statement池能够同时分配的打开的statements的最大数量
          maxOpenPreparedStatements: 50
          #开启StatFilter
          filter:
            stat:
              enabled: true
              log-slow-sql: true
              slow-sql-millis: 1000
              #开启Slf4jFilter,使用logback时注释
              #slf4j:
              #enabled: true
              #data-source-log-enabled: false
              #connection-log-enabled: false
              #statement-log-enabled: false
              #result-set-log-enabled: false
            #开启WallFilter
            wall:
              enabled: true
              log-violation: true
              throw-exception: false
              config:
                delete-where-none-check: true
          #开启Web监控
          web-stat-filter:
            enabled: true
            exclusions: /druid/*,*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico
            url-pattern: /*
          #开启监控页面
          stat-view-servlet:
            enabled: true
            login-username: admin
            login-password: admin123
    server:
      port: 8080

applicatoin配置

package com.lsx.mp.mybatisplus;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @MapperScan("com.lsx.mp.mybatisplus*")
    public class MybatisplusApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(MybatisplusApplication.class, args);
    	}
    
    }

注入物理逻辑分页插件

/**
    
    可以直接使用selectPage这样的分页，但返回的数据确实是分页后的数据，但在控制台打印的SQL语句其实并没有真正的物理分页，而是通过缓存来获得全部数据中再进行的分页，这样对于大数据量操作时是不可取的，那么接下来就叙述一下，真正实现物理分页的方法。
    官方在分页插件上如是描述：自定义查询语句分页（自己写sql/mapper），也就是针对自己在Mapper中写的方法，但经过测试，如果不配置分页插件，其默认采用的分页为RowBounds的分页即逻辑分页，也就是先把数据记录全部查询出来,然在再根据offset和limit截断记录返回（数据量大的时候会造成内存溢出），故而不可取，而通过分页插件的配置即可达到物理分页效果。
    */
    @Configuration
    public class MybatisPlusConfig {
    
    	@Bean
    	public PaginationInterceptor paginationInterceptor() {
    		PaginationInterceptor page = new PaginationInterceptor();
    		page.setDialectType("mysql");
    		return page;
    	}
    
    }

自定义sql跨表查询代码示例

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70 2][]

![20210122161743262.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70 3][]

![20210122161845633.png][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70]: /images/20221119/8b1c5f9f675a40d3897da875f38b15fa.png
[20210122121107181.png]: /images/20221119/8a91bc1c844141bc88407c4f8565db96.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70 1]: /images/20221119/ed377327b8db438aa0f39653e938fea2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20210122161727875.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw,size_16,color_FFFFFF,t_70
[20210122161743262.png]: https://img-blog.csdnimg.cn/20210122161743262.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20210122161821386.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTQ5MDUw,size_16,color_FFFFFF,t_70
[20210122161845633.png]: https://img-blog.csdnimg.cn/20210122161845633.png