SpringBoot系列(整合mybaits-plus)

606 阅读3分钟

问题:

    快速整合mybaits
    mybatis-plus简单使用
    自动生成entity,xml,service,serviceImpl等等代码

原理:

    依赖mybatis-plus
    根据模板创建对应的文件
    连接数据库查询数据

文档:

    官方文档: https://mybatis.plus/guide/

步骤:

    1.引入mybatis-plus依赖和mysql依赖
    2.如果需要快速生成代码,引入mybatis-plus-generator和freemarker
    3.生成代码
    4.配置文件编写数据库连接地址,启动类编写扫描路径
    5.测试

1.引入mybatis-plus依赖和mysql依赖

        <!--快速使用mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.1</version>
        </dependency>

        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.45</version>
        </dependency>

2.如果需要快速生成代码,引入mybatis-plus-generator和freemarker

        <!--代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.1.1</version>
        </dependency>

        <!--自定义生成模板 -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.28</version>
        </dependency>

3.生成代码

把此文件放到与启动类同一目录

修改3个属性,projectName,moduleName,数据源配置。

运行此文件,在控制栏输入表名后按回车(多个表按逗号分隔),自动生成相关数据


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 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 + "!");
    }

    /**
     * TODO 重要提示
     * projectName,moduleName,数据源配置 需要改
     * 把此类放到启动类目录下。
     * 运行此方法, 在控制栏输入表名后按回车生成对应的文件
     *
     * @param args
     */
    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置  配置很多。 具体请看官网 https://mp.baomidou.com/config/generator-config.html#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE
        GlobalConfig gc = new GlobalConfig();

        // 项目名 与 模块名
        String projectName = "/mybaits-plus";
        String moduleName = "moduleName";

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://xxx:3306/xxx?useUnicode=true&characterEncoding=UTF-8");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("xxxx");
        dsc.setPassword("xxxx");
        mpg.setDataSource(dsc);

        String projectPath = System.getProperty("user.dir");
        String name = CodeGenerator.class.getPackage().getName();
        String src = "/src/main/java";
        String resources = "/src/main/resources/mapper/";
        //文件输出目录
        gc.setOutputDir(projectPath + projectName + src);
        //是否覆盖已有文件
        gc.setFileOverride(false);
        //开发人员
        gc.setAuthor("dripy");
        //是否打开输出目录
        gc.setOpen(false);
        //是否开启swagger
        gc.setSwagger2(false);
        // 默认生成表和实体的对应map
        gc.setBaseResultMap(true);

        mpg.setGlobalConfig(gc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        // 可以额外配置文件所在地址
        pc.setParent(name);
        pc.setModuleName(moduleName);
        mpg.setPackageInfo(pc);

        // 自定义生成文件配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        // 如果模板引擎是 freemarker  模板引擎的地址
        String templatePath = "/templates/mapper.xml.ftl";
        // 所需要生成的所有文件
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
                return projectPath + projectName + resources + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

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

        // 配置自定义输出模板
        //指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        //设置为null 不生成对应的文件。
//        templateConfig.setController(null);
//        templateConfig.setService(null);
//        templateConfig.setServiceImpl(null);
//        templateConfig.setMapper(null);
//        templateConfig.setEntity(null);
        templateConfig.setEntityKt(null);
        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(false); // false. 不生成get set
        strategy.setRestControllerStyle(false);//  true: restController 和 flase:controller的区别。
        //strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");  controller自定义继承父类
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(",")); // 需要生成的表名
        //strategy.setSuperEntityColumns("id"); // 自定义实体 公共字段
        strategy.setControllerMappingHyphenStyle(true); // 驼峰命名法
        strategy.setEntityTableFieldAnnotationEnable(true);//是否生成实体时,生成字段注解
        //strategy.setTablePrefix(pc.getModuleName() + "_");//  表前缀
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

指定生成某些文件,设置为null的时候就不生成对应的文件。

4.配置文件编写数据库连接地址,启动类编写扫描路径

    # TODO 这里请修改为对应的数据库连接信息
    spring.datasource.url=jdbc:mysql://xxx:3306/xxxx?useUnicode=true&characterEncoding=UTF-8
    spring.datasource.username=xxx
    spring.datasource.password=xxxx
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver

5.测试

controller下编写测试

启动项目并访问

成功获取到数据