Mybatis Plus学习笔记

Mybatis Plus官网有基本操作与配置指南，不理解可以看其中相应功能部分示例代码。

若要使用Mybatis的代码生成器，推荐Mybatis代码生成器配置参考博客

目录

一、Mybatis plus代码生成器基本配置流程：

二、Mybatis plus 使用的基本结构：

三、Mybatis plus实践中遇到的问题以及易忽略要点：

四、Mybatis plus 代码生成器代码示例：

五、Mybatis 事务：

---

一、Mybatis plus代码生成器基本配置流程：

AutoGenerator代码生成器类型，执行生成方法execute前需要配置如下配置信息：

DataSourceConfig类数据源配置--》GlobalConfig全局类策略配置--》PackageConfig类包名信息配置--》TemplateConfig类自定义代码生成模板配置--》InjectionConfig类自定义配置（可自定义配置生成xml文件）--》StrategyConfig类数据库表配置（可指定生成哪些表、排除哪些表）。

二、Mybatis plus 使用的基本结构：

依赖包：

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>Latest Version</version>
    </dependency>

yml配置结构：

mybatis-plus:
  ......
  configuration:
    ......
  global-config:
    ......
    db-config:
      ...... 

数据库与自动加载sql文件配置-yum中配置：

spring:
  datasource:
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/data
  sql:
    init:
      schema-locations: db/schema.sql
      data-locations: db/data.sql
      mode: always

配置表实体：

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

配置Mapper：

public interface UserMapper extends BaseMapper<User> {

}

容器注入Mapper设置：

@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")

三、Mybatis plus实践中遇到的问题以及易忽略要点：

1. Mybatis plus代码生成器需要依赖于模板引擎生成，故不要忽略了对模板引擎的设置与装配入代码生成器；
2. Mybatis plus基本使用不需要用到xml，如果需要对mapper进行拓展可按Mybatis方式使用xml进行拓展。

四、Mybatis plus 代码生成器代码示例：

package org.example.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;

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class MysqlGenerator {

    /**
     * <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("huang");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/data?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // 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("org.example");
        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/resource/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.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 写于父类中的公共字段
//        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

五、Mybatis 事务：

使用原生的JDBC默认是关闭事务操作的，每个操作都直接对磁盘持久层进行操作。而Mybatis不配置transactionManager则如同原生JDBC一样，每个操作都直接对磁盘持久层进行操作。当Mybatis在配置文件中配置了transactionManager，则会默认对数据库操作开启事务，默认关闭自动提交，需手动提交。

SpringBoot下使用Mybatis事务需要在启动类上标注@EnableTransactionManagement（单数据源可用，多数据源时失效），对需要开启事务的方法或者类标注@Transaction注释，未标注则未开启事务。@Transaction底层原理是通过生成代理类以切面的方式代理标注了@Transaction的方法。

如：

///未使用@Transaction注解方法调用其他@Transaction注解方法，其中的@Transaction注解失效
public class Demo{
	public void editNoTran(){
		editTran();
	}
	@Transactional
	public void editTran(){
		editOther();
	}
}

SpringBoot生成的代理类为：（伪代码如下）

//动态代理类
public class demoProxy{
	Demo demo=new Demo();
	
	//有editNoTran没有注解，动态代理类内方法主要为委托对象调用
		public void editNoTran(){
			demo.editTran();
	}
	
	///由于addTran方法有注解会在方法调用前后完成事务操作
	public void editTran(){
		///新建事务
		$trans.newInstance
		
		///****切面*****
		demo.editTran();
		
		///提交事务
		$trans.commit
	}
	
}

当一个服务下有多数据源时，原来的事务处理无法使用，需进行相关策略选择，有两种策略：

1、参考博文：springboot+mybatis-plus 多容器时,解决Spring默认事务无法传递问题

2、使用Seata分布式事务管理框架