Springboot+mybatisPlus搭建

以你之姓@ 2023-01-03 14:11 153阅读 0赞

## 1.0 最简单版本搭建 ##

先搭建一个springboot项目。  
请先确保springboot项目搭建无误。(不需要写entity,mapper,service,controller这些。配置写好就可)

\*\* 实体类和接口的创建方法\*\*

1.  先创建表。然后使用@Data注解创建实体类  
    ![在这里插入图片描述][20210108152327647.png]
2.  导入依赖

<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.1.2</version>
    </dependency>
    
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

1.  **import pom文件后**，创建mapper接口文件，**继承BaseMapper**，无需写mapper映射文件  
    ![在这里插入图片描述][20210108152836619.png]
2.  创建Service接口及其实现类。  
    注意：Service接口需要继承IService  
    ![在这里插入图片描述][20210108170649638.png]  
    而ServiceImpl则需要在实现的基础上**添加继承关系：extends ServiceImpl<UserMapper,User>**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70]

创建测试类，通过service层使用  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70 1]  
完毕。

## 2.0进阶版，代码生成器 ##

1.  导入新的依赖：

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

2.**reimport之后**，新建一个类，名为CodeGenerator

package com.example.demo;
    
    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.BeetlTemplateEngine;
    import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
    import org.apache.commons.lang3.StringUtils;
    
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Scanner;
    
    // 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
    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.isNotBlank(ipt)) {
        
                    return ipt;
                }
            }
            throw new MybatisPlusException("请输入正确的" + tip + "！");
        }
    
        public static void main(String[] args) {
        
            // 代码生成器
            AutoGenerator mpg = new AutoGenerator();
            // set freemarker engine
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
    
            // set beetl engine
    //        mpg.setTemplateEngine(new BeetlTemplateEngine());
    
            // set custom engine (reference class is your custom engine class)
    //        mpg.setTemplateEngine(new CustomTemplateEngine());
    
    
            // 全局配置
            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://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
            // dsc.setSchemaName("public");
            dsc.setDriverName("com.mysql.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("密码");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName(scanner("模块名"));
            pc.setParent("com.baomidou.ant");
            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);
            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();
        }
    
    }

踩坑记录：  
如果全局配置这里出现部分爆红，可能是导错了依赖，注意应该导入的是：import com.baomidou.mybatisplus.generator.config.GlobalConfig;  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70 2]  
要修改的地方：  
如果运行时提示JDBC驱动com.mysql.jdbc.Driver已经被弃用，需要替换成com.mysql.\*\*cj.\*\*jdbc.Driver  
同时需要在url中指定时区：&serverTimezone=UTC  
![在这里插入图片描述][20210108160613774.png]  
注意修改账号密码

第2处：  
![在这里插入图片描述][20210108160752846.png]  
setParent改成自己的package名

第三处：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70 3]  
策略配置里父类控制器和父类实体，如果没有就注释掉

第四处：  
如果自动创建的实体类上面有@EqualsAndHashCode注解，并且没有继承其他基类，需要把这个注解去掉

实际运行踩坑记录  
第五处：  
如果原始的启动类在其他包下，创建的ge包下没有启动类，需要手动建立；  
或者将启动类移动到根目录下，与最外层package同级  
![在这里插入图片描述][20210108174156997.png]

效果：  
![在这里插入图片描述][20210108161119121.png]

[20210108152327647.png]: /images/20221119/118aad80120e44e9a9460b48b5525234.png
[20210108152836619.png]: /images/20221119/4cd1cecbb3244998b5859dae6bb1b79c.png
[20210108170649638.png]: /images/20221119/293f286f2d074843b51214a4fd048f49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70]: /images/20221119/4fe8a84549d64c759a8a3bb205cee82f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70 1]: /images/20221119/6c2ffd6cadc1476fa6da8451018813f2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70 2]: /images/20221119/a8bb5dc16e224122a8a9b34a9431b92e.png
[20210108160613774.png]: /images/20221119/f6faa714a4d546159c75713432e89acb.png
[20210108160752846.png]: /images/20221119/fde04c1ae60d495f8dcf57f76a76591f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2t1bkFVR1VTVA_size_16_color_FFFFFF_t_70 3]: /images/20221119/02e9a1e8763e4ff4840eda5a3ed616a4.png
[20210108174156997.png]: /images/20221119/ee0dbe4e52a645b7bd9cbb97a749e169.png
[20210108161119121.png]: /images/20221119/707928a75bb14793b7438c04126bbbfc.png