MyBatis-Plus代碼生成

導入jar包

• <!-- mybatis-plus -->
  <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-boot-starter</artifactId>
      <version>3.2.0</version>
  </dependency>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-freemarker</artifactId>
  </dependency>
  <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <scope>runtime</scope>
  </dependency>
  <!-- mybatis-plus 代碼生成器 -->
  <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-generator</artifactId>
      <version>3.2.0</version>
  </dependency>

配置文件

• # DataSource Config
  spring:
    datasource:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/vueblog?useUnicode=true&useSSL=false&characterEncoding=UTF-8&serverTimezone=UTC
      username: root
      password: 123456
  # mybatis-plus\u8BBE\u7F6E\u626B\u63CF\u4F4D\u7F6E
  mybatis-plus:
    mapper-locations: classpath*:/mapper/**Mapper.xml
  server:
    port: 8081
  

開啓mapper掃描

• import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
  import org.mybatis.spring.annotation.MapperScan;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  import org.springframework.transaction.annotation.EnableTransactionManagement;
  
  /**
   * @description: 開啓mapper接口掃描,添加分頁插件
   * @author: Mr.Li
   * @date: Created in 2020/6/13 10:42
   * @version: 1.0
   * @modified By:
   *
   * @MapperScan: 開啓接口掃描
   */
  
  @Configuration
  @EnableTransactionManagement
  @MapperScan("com.futurell.mapper")
  public class MybatisPlusConfig {
      @Bean
      public PaginationInterceptor paginationInterceptor() {
          // 分頁攔截器
          PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
          return paginationInterceptor;
      }
  }

• 如果沒有其他插件，那麼可以開始使用 MyBatis-Plus

代碼生成

• 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 方法控制檯輸入模塊表名 (如: m_user,m_blog) 回車自動生成對應項目目錄中
   *
   * contorller、entity、mapper、service、service 中的 impl 以及 resources 中的 mapper
   *
   * @since 2020-06-13
   */
  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.setOutputDir("D:\\test");
          gc.setAuthor("FutureLL");
          gc.setOpen(false);
          // gc.setSwagger2(true); 實體屬性 Swagger2 註解
          gc.setServiceName("%sService");
          mpg.setGlobalConfig(gc);
  
          // 數據源配置
          DataSourceConfig dsc = new DataSourceConfig();
          dsc.setUrl("jdbc:mysql://localhost:3306/vueblog?useUnicode=true&useSSL=false&characterEncoding=UTF-8&serverTimezone=UTC");
          // 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(null);
          pc.setParent("com.futurell");
          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/"
                          + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
              }
          });
  
          cfg.setFileOutConfigList(focList);
          mpg.setCfg(cfg);
  
          // 配置模板
          TemplateConfig templateConfig = new TemplateConfig();
  
          templateConfig.setXml(null);
          mpg.setTemplate(templateConfig);
  
          // 策略配置
          StrategyConfig strategy = new StrategyConfig();
          strategy.setNaming(NamingStrategy.underline_to_camel);
          strategy.setColumnNaming(NamingStrategy.underline_to_camel);
          strategy.setEntityLombokModel(true);
          strategy.setRestControllerStyle(true);
          strategy.setInclude(scanner("表名, 多個英文逗號分割").split(","));
          strategy.setControllerMappingHyphenStyle(true);
          strategy.setTablePrefix("m_");
          mpg.setStrategy(strategy);
          mpg.setTemplateEngine(new FreemarkerTemplateEngine());
          mpg.execute();
      }
  }

• 代碼生成的前提是，要在數據庫中建好我們需要的表
• 運行 CodeGenerator 的 main 方法，在控制檯輸入表名，以 " , " 隔開，然後回車等待即可

測試

• 在 UserController 中寫個測試：

• @RestController
  @RequestMapping("/user")
  public class UserController {
      @Autowired
      UserService userService;
      @GetMapping("/{id}")
      public Object test(@PathVariable("id") Long id) {
          return userService.getById(id);
      }
  }