spring-boot 整合 mybatis-plus （BaseMapper/ IService / 通用枚举/ 逻辑删除）

MyBatis-Plus 简介

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

MyBatis-Plus 官网：https://mp.baomidou.com
本篇文章demo：https://gitee.com/wslxm/spring-boot-mybatis-plus

一、创建springboot + mybatis-plus 项目

添加测试表及数据

-- 建测试表
DROP TABLE IF EXISTS user;

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, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

1、maven 依赖 pom.xml

主要依赖

        
        
            com.baomidou
            mybatis-plus-boot-starter
            3.1.0
        

完整依赖

    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.1.7.RELEASE
         
    
    com.example
    spring-boot-mybatis-plus
    0.0.1-SNAPSHOT
    spring-boot-mybatis-plus
    Demo project for Spring Boot

    
        1.8
    


    

        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
        
        
            org.springframework.boot
            spring-boot-starter
        
        
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
        
        
            org.projectlombok
            lombok
            true
        
    
        
        
            mysql
            mysql-connector-java
            8.0.16
            runtime
        
        
        
        
            com.alibaba
            druid-spring-boot-starter
            1.1.10
        
        
        
        
            com.baomidou
            mybatis-plus-boot-starter
            3.1.0
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

2、yml 配置（全）

数据连接配置

server:
  port: 8088
spring:
  # DataSource Config
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url:  jdbc:mysql://127.0.0.1:3306/mybatis-plus?useUnicode=true&characterEncoding=utf-8&useTimezone=true&serverTimezone=GMT%2B8
    username: root
    password: 123456

mybatis-plus: 相关配置（暂时可不配置，有默认，需要时按需配置）

• 1、mapper-locations：mapper对应的 xml 配置
• 2、type-enums-package：枚举配置
• 3、global-config: 主键, sql 打印，Id策略，驼峰命名规则映射等配置
• 4、逻辑删除配置请看步骤六

# mybatis-plus相关配置,
mybatis-plus:
  ### xml扫描，多个目录用逗号或者分号分隔（告诉 Mapper 所对应的 XML 文件位置）
  mapper-locations: classpath:mapper/*.xml
  ### 枚举配置，支持*匹配, 多个目录用逗号分隔
  type-enums-package: com.trade.api.enums 
  # 以下配置均有默认值,可以不设置
  global-config:
    db-config:
      #主键类型  auto:"数据库ID自增" 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
      id-type: auto
      #字段策略 IGNORED:"忽略判断"  NOT_NULL:"非 NULL 判断")  NOT_EMPTY:"非空判断"
      field-strategy: NOT_EMPTY
      #数据库类型
      db-type: MYSQL
  configuration:
    # 是否开启自动驼峰命名规则映射:从数据库列名到Java属性驼峰命名的类似映射
    map-underscore-to-camel-case: true
    # 如果查询结果中包含空值的列，则 MyBatis 在映射的时候，不会映射这个字段
    call-setters-on-nulls: true
    # 这个配置会将执行的sql打印出来，在开发或测试的时候可以用
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl



#### 逻辑删除相关配置
mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: deleted  #全局逻辑删除字段值 3.3.0开始支持，详情看下面。
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

2、User

@Data
@TableName(value = "user")
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

3、UserMapper 数据操作CRUD 层

/**
 * TODO    用户
 *
 * @date 2020/2/4 0004 14:28
 * @return
 */
@Repository
public interface UserMapper extends BaseMapper {

}

4、UserController 查询参数测试

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;


    @GetMapping("/findAll")
    public List findAll() {
        List users = userMapper.selectList(null);
        return users;
    }
}

可以测试使用了

二、代码生成

1、添加依赖

        
        
            com.baomidou
            mybatis-plus-generator
            3.3.1.tmp
        
        
        
            org.apache.velocity
            velocity-engine-core
            2.2
        
        
        
            org.freemarker
            freemarker
            2.3.29
        

2、CodeGenerator 代码生成类

来自官网：
修改包路径，数据库连接信息，运行即可
默认生成：
service
serviceImpl
entity
controller
mapper
mapper.xml（这个默认没内容）

package com.example.springbootmybatisplus.utils;

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 CodeGenerator {

    /**
     * 

     * 读取控制台内容
     * 
     */
    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.isNotEmpty(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("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mybatis-plus?useUnicode=true&characterEncoding=utf-8&useTimezone=true&serverTimezone=GMT%2B8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);
        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.example.springbootmybatisplus");
        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 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("调用默认方法创建的目录");
                return false;
            }
        });
        */
        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");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

输入代码生成路径
及要生成代码对应的数据库表

如下：

生成更多可自定义模板并配置，详情看官网

三、BaseMapper-CRUD

BaseMapper-CRUD 和 Iservice -CRUD 的区别是后者有批量操作，api 命名有些不同

BaseMapper 官网Api文档：https://mybatis.plus/guide/crud-interface.html#mapper-crud

1、添加

@SpringBootTest
@RunWith(SpringRunner.class)
public class InsertTest {


    @Autowired
    private UserMapper userMapper;


    //添加 -- BaseMapper api不支持批量添加
    @Test
    public void insert() {
        //当前数据库id设置为自增,id策略需设置id-type配置，参考yml配置说明
        User user = new User();
        user.setName("wangsong");
        user.setAge(23);
        user.setEmail("[email protected]");
        userMapper.insert(user);
        System.out.println(user.getId());
    }
}

2、删除

@SpringBootTest
@RunWith(SpringRunner.class)

public class DeleteTest {


//    官网api
//    // 根据 entity 条件，删除记录
//    int delete(@Param(Constants.WRAPPER) Wrapper wrapper);
//    // 删除（根据ID 批量删除）
//    int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);
//    // 根据 ID 删除
//    int deleteById(Serializable id);
//    // 根据 columnMap 条件，删除记录
//    int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);



    @Autowired
    private UserMapper userMapper;


    // id删除
    @Test
    public void deleteById() {
        userMapper.deleteById(8L);
    }


    // ids 批量删除
    @Test
    public void deleteBatchIds() {
        List ids = new ArrayList<>();
        ids.add(7L);
        ids.add(6L);
        userMapper.deleteBatchIds(ids);
    }


    // columnMap 条件删除
    @Test
    public void deleteByMap() {
        //kay是字段名 value是字段值
        Map map = new HashMap<>();
        map.put("id","6");
        userMapper.deleteByMap(map);
    }


    // wrapper 条件删除
    @Test
    public void delete() {
        // 拼接sql参考：DELETE FROM user WHERE (id = ? AND name = ?)
        QueryWrapper wrapper = new QueryWrapper<>();
        // kay是字段名 value是字段值
        wrapper.eq("id",6L)
        .eq("name","wangsong");
        userMapper.delete(wrapper);
    }
}

3、修改

@SpringBootTest
@RunWith(SpringRunner.class)
public class UpdateTest {

//    官网api
//    //根据 whereEntity 条件，更新记录
//    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);
//    //根据 ID 修改
//    int updateById(@Param(Constants.ENTITY) T entity);


    @Autowired
    private UserMapper userMapper;


    // 根据id 更新修改
    @Test
    public void updateById() {
        User user = new User();
        //需要修改的数据 Id
        user.setId(9L);
        //需要修改的数据
        user.setName("erping");
        user.setAge(23);
        user.setEmail("[email protected]");
        userMapper.updateById(user);
    }


    // 使用 updateWrapper 条件修改（2种方式任选其一）
    @Test
    public void update() {
        //方式一
        // 更新修改字段
        User user = new User();
        user.setEmail("[email protected]");
        // 更新添加,未设置条件 sql： UPDATE user SET email=?  ，设置后：UPDATE user SET email=? WHERE (id = ?)
        UpdateWrapper wrapper1 = new UpdateWrapper();
        wrapper1.eq("id",9);
        userMapper.update(user,wrapper1);

        //方式二
//      UpdateWrapper wrapper2 = new UpdateWrapper();
//      wrapper2.set("email","[email protected]")   // 更新的内容，可往后 .set连接
//              .eq("id",9);                    // 更新的条件，可往后 .eq 添加
//      userMapper.update(null,wrapper2);
    }
}

4、查询

分页查询需配置分页插件–官网配置教程（3.3.0 无需配置）：https://mp.baomidou.com/guide/page.html

@SpringBootTest
@RunWith(SpringRunner.class)
public class SelectTest {


//    官网api
//
//    // 根据 ID 查询
//    T selectById(Serializable id);
//    // 根据 entity 条件，查询一条记录
//    T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);
//
//    // 查询（根据ID 批量查询）
//    List selectBatchIds(@Param(Constants.COLLECTION) Collection idList);
//    // 根据 entity 条件，查询全部记录
//    List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);
//    // 查询（根据 columnMap 条件）
//    List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);
//    // 根据 Wrapper 条件，查询全部记录
//    List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);
//    // 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
//    List