翻越 Mybatis-Plus 的山坡

翻越 Mybatis-Plus 的山坡

写在前面：此文章为本人学习过程，路过大神不喜勿喷
一、Mybatis和Mybatis-Plus本是两兄弟，官方和我的愿景（此处笑而不语…）
我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

二、特性

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 操作智能分析阻断，也可自定义拦截规则，预防误操作
    三、来创建一个Mybaits-Plus的逆向工程
13. 创建一个Maven项目，引入以下依赖：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.5.RELEASE</version>
    <relativePath/>
</parent>
 
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </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>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.3.1.tmp</version>
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.3.1.tmp</version>
    </dependency>
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.2</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>
        </plugin>
    </plugins>
    <!--将生产的mapper.xml移动到resources目录下的工具-->
    <resources>
        <resource>
            <directory>src/main/java</directory>
            <!--包含了src/main/java目录下的所有xml资源配置文件-->
            <includes>
                <include>**/*.xml</include>
            </includes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <!--包含了src/main/resources目录下的所有资源配置文件,有别的格式的配置文件时，不要写成**/*.xml-->
                <include>**/*</include>
            </includes>
            <filtering>false</filtering>
        </resource>
    </resources>
</build>

2. 逆向工程方法

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  
import java.util.Scanner;
  
public class TestMP {
    /**
     * 读取控制台内容
     */
    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("作者");
        //是否生成后打开输出目录
        gc.setOpen(false);
        //是否覆盖已有文件 默认false
        gc.setFileOverride(true);
        mpg.setGlobalConfig(gc);
  
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("你数据库的Url");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("你数据库名");
        dsc.setPassword("你数据库密码");
        mpg.setDataSource(dsc);
  
        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com")
                .setMapper("mapper")
                .setService("service")
                .setController("controller")
                .setEntity("pojo")
                .setXml("mapper");
        mpg.setPackageInfo(pc);
  
  
        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
//         配置自定义输出模板
//         指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
//         templateConfig.setEntity("templates/Result.java");
//         templateConfig.setService("templates/ResultService.java");
//         templateConfig.setController("templates/ResultController.java");
//         templateConfig.setServiceImpl("templates/ResultServiceImpl.java")
//         templateConfig.setXml("/templates/mapper.xml");
        mpg.setTemplate(templateConfig);
  
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        //开启字段名称里下划线后字母转大写
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //继承 com.baomidou.mybatisplus.extension.activerecord.Model 可以开启AI模式
        strategy.setSuperEntityClass(Model.class);
        //是否添加@RestController 控制器
        strategy.setRestControllerStyle(false);
        // 公共父类
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

3． 话不多说，执行方法生成对应的项目结构

1. 添加一个SpringBoot启动类

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

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

3. 在test目录下测试，创建测试类MyTest

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.test.mapper.UserMapper;
import com.test.pojo.User;
import org.junit.jupiter.api.Test;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.test.context.SpringBootTest;

import javax.annotation.Resource;
import java.util.List;

@SpringBootTest
@MapperScan("com.test.mapper")
public class MpTest {
    @Resource
    private UserMapper userMapper;
    @Test
    public void testSelect(){
        //第一种写法
        List<User> users = userMapper.selectList(new QueryWrapper<User>());
        System.out.println(users);
        //第二种写法 由于实体类继承了Model类，调用Model中的方法
        User user = new User();
        List list = user.selectAll();
        System.out.println(list);
    }
}

注意：两种写法的最后数据结果一样。在进行简单的操作时，可以直接用实体类对象调用Model方法操作，简化了书写，很有意思，其他方法老铁们自己发掘吧。
写在后面
在整个的项目创建过程中有以下需要注意的地方：

1. 在生成代码时，开启了 setEntityLombokModel(true) 会发现实体类中没有Get/Set，有时候使用实体类存储数据时会不方便，所有建议关闭不使用。
2. 如果使用自定义模板需要手动编写，并制定路径，官方还有其他模板，需引入不同的依赖，这里我用的是freemarker的模板。
3. 可以直接创建SpringBoot项目，我这里是创建的Maven项目，再引入了SpringBoot的相关依赖。

最后的最后：希望文章可以帮到大家，路过大神不喜勿喷，我们共同学习，加油吧！！！！