idea搭建一个springBoot mybatisPlus框架的后台项目

这是我参与11月更文挑战的第4天，活动详情查看：[2021最后一次更文挑战]

前言

最近有几个朋友叫我帮他们弄一个ssm的框架模板，然后搭建一个标准的后台项目，以供他们后续自己玩拓展。 spring boot我这边就不介绍了哈，关于MybatisPlus的话其实就是做了一点点增强而已，具体的大家可以去看看人家的官方网站哦，还是挺有用的：mp.baomidou.com/

上面核心功能大家可以着重看看哦。

Let's do it!

第一步：搭建SSM项目

idea

->file->new project 关于上面的打包方式其实后续可以通过pom修改这里默认就好，war包是放在tomcat下进行允许的。

->next

选择自己会用到的东西 starter 这里我选择了一个mysqlDriver以及一个 lombok的

然后直接finish就行了，然后让idea 自己跑一会儿吧！

直接启动会可能会提示报这个错误：

产生理由：现在springboot项目对于一下项目会认为可能存在多个环境，所以需要我们指定一下启动的配置文件另外对于springBoot项目官方倡导我们使用 yml 配置文件的格式（其实与properties效果是一样的）

解决方式：

先自己申明一下自己的环境eg:dev

spring:
  config:
    activate:
      on-profile: dev

然后修改启动类：profiles;再次启动应该就不会报错了ps：这个项目我应该会使用，所以引入了mybatisPlus多数据源以及druid mysql池管理，对于喜欢单数据源的朋友可以自己将多数据源去掉就行了,然后druid这边不多介绍了，基本配置，后台的那种监控页面啥的我这边就不拓展了。多数据源中，可以引入其他的数据源，只需要修改基本的连接池，连接驱动等等就行

项目启动完成之后那么搭建就完成了

pom

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.6.0</version>
      <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <groupId>com.smile</groupId>
  <artifactId>ssm</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>ssm</name>
  <description>Demo project for Spring Boot</description>
  <properties>
      <java.version>1.8</java.version>
  </properties>
  <dependencies>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter</artifactId>
      </dependency>
      <!--mybatis-plus依赖-->
      <dependency>
          <groupId>com.baomidou</groupId>
          <artifactId>mybatis-plus-boot-starter</artifactId>
          <version>3.3.2</version>
      </dependency>

      <!-- https://mvnrepository.com/artifact/com.baomidou/dynamic-datasource-spring-boot-starter -->
      <dependency>
          <groupId>com.baomidou</groupId>
          <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
          <version>3.3.2</version>
      </dependency>
      <!--druid-->
      <dependency>
          <groupId>com.alibaba</groupId>
          <artifactId>druid</artifactId>
          <version>1.1.10</version>
      </dependency>
      <!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity -->
      <dependency>
          <groupId>org.apache.velocity</groupId>
          <artifactId>velocity</artifactId>
          <version>1.7</version>
      </dependency>
      <!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
      <dependency>
          <groupId>org.freemarker</groupId>
          <artifactId>freemarker</artifactId>
          <version>2.3.23</version>
      </dependency>



      <dependency>
          <groupId>org.apache.commons</groupId>
          <artifactId>commons-lang3</artifactId>
          <version>3.8.1</version>
      </dependency>

      <dependency>
          <groupId>com.baomidou</groupId>
          <artifactId>mybatis-plus-generator</artifactId>
          <version>3.4.1</version>
      </dependency>

      <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <scope>runtime</scope>
      </dependency>
      <dependency>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
          <optional>true</optional>
      </dependency>
      <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web -->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
          <version>2.3.4.RELEASE</version>
      </dependency>

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
      </dependency>
  </dependencies>

  <build>
      <plugins>
          <plugin>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-maven-plugin</artifactId>
              <configuration>
                  <excludes>
                      <exclude>
                          <groupId>org.projectlombok</groupId>
                          <artifactId>lombok</artifactId>
                      </exclude>
                  </excludes>
              </configuration>
          </plugin>
      </plugins>
  </build>

</project>

第二步：自动代码生成器

官方示例

// 演示例子，执行 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();

        // 全局配置
        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();
    }

}

官方给出的例子中，使用的是ftl模板引擎必须自己去引用freemarker的依赖，同理如果使用的是默认的也需要进行引用，不然的话会报错，我这边测试了如果使用的是默认的 vm 的话生成的内容中格式会比较乱不是很规整，还是推荐使用ftl 吧。

<!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.23</version>
</dependency>

这两个配置也要自己去修改一下，不然生成的会有问题.

MySelf

public static String scanner(String tip) {
    Scanner scanner = new Scanner(System.in);
    StringBuilder help = new StringBuilder();
    help.append("请输入").append(tip).append("：");
    System.out.println(help);
    if (scanner.hasNext()) {
        String ipt = scanner.next();
        if (StringUtils.isNotBlank(ipt)) {
            return ipt;
        }
    }
    throw new MybatisPlusException("请输入正确的" + tip + "！");
}


public static void main(String[] args) {
    CodeGenerator.selfSuccess();
}

public static void selfSuccess() {
    String projectPath = System.getProperty("user.dir");
    // 实例化代码生成器类
    AutoGenerator mpg = new AutoGenerator();

    //全局地址配置 以及部分规则配置
    mpg.setGlobalConfig(CodeGenerator.globalConfig(projectPath));

    //数据源配置
    mpg.setDataSource(CodeGenerator.dataSourceConfig());

    PackageConfig pc = CodeGenerator.packageConfig();
    // 包配置
    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 + "/src/main/resources/mapper/" + pc.getModuleName()
                    + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
        }
    });
    cfg.setFileOutConfigList(focList);
    mpg.setCfg(cfg);

    // 配置模板
    TemplateConfig templateConfig = new TemplateConfig();
    templateConfig.setXml(null);
    mpg.setTemplate(templateConfig);

    //策略
    StrategyConfig strategy = CodeGenerator.strategyConfig();
    mpg.setStrategy(strategy);

    //ftl的需要这个步骤
    mpg.setTemplateEngine(new FreemarkerTemplateEngine());
    //执行
    mpg.execute();
}

/**
 * 自动代码生成 全局 GlobalConfig 配置
 *
 * @return GlobalConfig
 */
public static GlobalConfig globalConfig(String projectPath) {
    GlobalConfig gc = new GlobalConfig();
    //项目根路径

    //生成文件的输出目录
    //默认值：D 盘根目录
    gc.setOutputDir(projectPath + "/src/main/java");

    //作者
    gc.setAuthor("Smile");

    //是否覆盖已有文件
    //默认值：false
    gc.setFileOverride(false);

    //是否打开输出目录
    //默认值：true
    gc.setOpen(false);

    //实体命名方式
    //默认值：null 例如：%sEntity 生成 UserEntity
    gc.setEntityName("%sPO");

    //mapper 命名方式
    //默认值：null 例如：%sDao 生成 UserDao
    gc.setMapperName("%sDao");

    //Mapper xml 命名方式
    //默认值：null 例如：%sDao 生成 UserDao.xml
    gc.setXmlName("%sDao");

    //service 命名方式
    //默认值：null 例如：%sBusiness 生成 UserBusiness
    gc.setServiceName("%sService");

    //service impl 命名方式
    //默认值：null 例如：%sBusinessImpl 生成 UserBusinessImpl
    gc.setServiceImplName("%sServiceImpl");

    //controller 命名方式
    //默认值：null 例如：%sAction 生成 UserAction
    gc.setControllerName("%sApi");
    return gc;
}

/**
 * 自动生成数据源配置
 *
 * @return DataSourceConfig
 */
public static DataSourceConfig dataSourceConfig() {
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8");
    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("root");
    return dsc;
}

/**
 * 报包属性配置 包名啥的
 *
 * @return xx
 */
public static PackageConfig packageConfig() {
    PackageConfig pc = new PackageConfig();

    //父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
    pc.setParent("com.smile.ssm");

    //父包模块名 父包下面的模块名
    pc.setModuleName(scanner("模块名"));

    //Entity包名
    pc.setEntity("entity");

    //Mapper包名
    pc.setMapper("dao");

    //xml包名
    pc.setXml("mapper");

    //Controller包名
    pc.setController("api");

    return pc;
}

/**
 * 策略配置
 *
 * @return 返回配置的策略
 */
public static StrategyConfig strategyConfig() {
    StrategyConfig strategyConfig = new StrategyConfig();
    strategyConfig.setNaming(NamingStrategy.underline_to_camel);
    strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
    strategyConfig.setEntityLombokModel(true);
    strategyConfig.setEntityBooleanColumnRemoveIsPrefix(true);
    strategyConfig.setEntityTableFieldAnnotationEnable(true);
    strategyConfig.setRestControllerStyle(true);
    strategyConfig.setControllerMappingHyphenStyle(true);
    // 表名前辍
    strategyConfig.setTablePrefix("s_");
    // 自定义继承的Entity类全称，带包名
    strategyConfig.setSuperEntityClass(CommonPO.class);
    strategyConfig.setEntityTableFieldAnnotationEnable(true);

    return strategyConfig;
}

只要运行上面的方法就能根据数据库表生成部分非业务代码，对于我们快速开发来说这个很重要的。

我们可以花费更多的时间在前期的数据库表设计上面，并且设计合理的话每一个字段的注释都不需要我们添加直接生成就行（策略中设置了不需要全部覆盖生成，所以不用担心新加的）

Enhance

对于生成的内容如果自己觉得不满意怎么办呢？

自己修改模板设计自己想要的效果吧并且还能在每一个实体中添加一些公共的方法哦。

我们去哪找原始模板呢，进行修改呢？

我们可以去原始的jar包中找到原始模板进行修改。

like this我改了原始模板的 p 标签

添加自定义的路径

then has changed

第三步：测试一下吧

在实际使用过程中发现很恶心的事:

No qualifying bean of type 'com.smile.ssm.service.SysUserService' available: expected single matching bean but found 2: sysUserServiceImpl,sysUserService

一直会报这个说存在两个bean示例导致项目启动报错

解决方法

@MapperScan  这个扫描包的时候只需要扫描到 时间mapper 层就行

ps:我不喜欢使用mapper 是因为后续我会引入 mapstruct 进行类实体转换操作。

正常使用，over...

End

源码地址：gitee.com/smile_lx/ss…

后续这个项目我会补充一些测试用例以及标准化代码，前台的话会layui 以及 vue 都会尝试去写一点东西，我当作复习啦！

Idea搭建SpringBoot+MybatisPlus+Druid+多数据源+自动化代码生成器 附源码！！！