SpringBoot整合MyBatis-Plus框架（程式碼生成器）

風青宇發表於2021-02-26
Spring BootMyBatis框架

MyBatis-Plus的簡介

Mybatis-Plus（簡稱MP）是一個 Mybatis 的增強工具，在 Mybatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。

  • 程式碼生成器
  • 通用的CURD
  • 條件構造器
  • 自定義SQL語句
  • 分頁外掛、效能分析外掛
  • 公共欄位自動填充

特性

  • 無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
  • 損耗小：啟動即會自動注入基本 CURD，效能基本無損耗，直接物件導向操作
  • 強大的 CRUD 操作：內建通用 Mapper、通用 Service，僅僅通過少量配置即可實現單表大部分 CRUD 操作，更有強大的條件構造器，滿足各類使用需求
  • 支援 Lambda 形式呼叫：通過 Lambda 表示式，方便的編寫各類查詢條件，無需再擔心欄位寫錯
  • 支援主鍵自動生成：支援多達 4 種主鍵策略（內含分散式唯一 ID 生成器 - Sequence），可自由配置，完美解決主鍵問題
  • 支援 ActiveRecord 模式：支援 ActiveRecord 形式呼叫，實體類只需繼承 Model 類即可進行強大的 CRUD 操作
  • 支援自定義全域性通用操作：支援全域性通用方法注入（ Write once, use anywhere ）
  • 內建程式碼生成器：採用程式碼或者 Maven 外掛可快速生成 Mapper 、 Model 、 Service 、 Controller 層程式碼，支援模板引擎，更有超多自定義配置等您來使用
  • 內建分頁外掛：基於 MyBatis 物理分頁，開發者無需關心具體操作，配置好外掛之後，寫分頁等同於普通 List 查詢
  • 分頁外掛支援多種資料庫：支援 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多種資料庫
  • 內建效能分析外掛：可輸出 Sql 語句以及其執行時間，建議開發測試時啟用該功能，能快速揪出慢查詢
  • 內建全域性攔截外掛：提供全表 delete 、 update 操作智慧分析阻斷，也可自定義攔截規則，預防誤操作

MyBatis-Plus官網：https://mp.baomidou.com/

匯入依賴（pom.xml）

<!-- mysql驅動  -->
<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <scope>runtime</scope>
</dependency>

<!-- lombok -->
<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <optional>true</optional>
</dependency>

<!-- mybatis-plus 程式碼自動生成-->
<dependency>
　　<groupId>com.baomidou</groupId>
　　<artifactId>mybatis-plus-boot-starter</artifactId>
　　<version>3.2.0</version>
</dependency>
<dependency>
　　<groupId>com.baomidou</groupId>
　　<artifactId>mybatis-plus-generator</artifactId>
　　<version>3.2.0</version>
</dependency>
<dependency>
　　<groupId>org.apache.velocity</groupId>
　　<artifactId>velocity-engine-core</artifactId>
　　<version>2.1</version>
</dependency>

全域性配置（application.properties）

# 連線資料庫
spring.datasource.username=***
spring.datasource.password=***
spring.datasource.url=jdbc:mysql://localhost:3306/***?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8&allowPublicKeyRetrieval=true
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# 配置日誌
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

建立 MybatisPlusConfig 配置類

@Configuration // 配置類
@EnableTransactionManagement
@MapperScan("com.***.mapper")
public class MybatisPlusConfig {

    // 註冊分頁
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

}

建立 CodeGenerator 啟動類

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.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("請輸入正確的" + tip + "！");
    }

    public static void main(String[] args) {
        // 需要構建一個 程式碼自動生成器 物件
        AutoGenerator mpg = new AutoGenerator();
        // 配置策略
        // 1、全域性配置
        GlobalConfig gc = new GlobalConfig();

        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("DMFlySky");
        gc.setOpen(false);
        gc.setFileOverride(false); // 是否覆蓋
        gc.setServiceName("%sService");// 去Service的I字首
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        //2、設定資料來源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/***?useUnicode=true&useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("***");
        dsc.setPassword("***");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.***");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("***", "***", "***");// 設定要對映的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true); // 自動lombok；
        strategy.setLogicDeleteFieldName("deleted");

        // 自動填充配置
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        strategy.setTableFillList(tableFills);
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);
        mpg.setStrategy(strategy);

        mpg.execute(); //執行
    }
}

 

 

本文網址：https://www.cnblogs.com/dmflysky/p/14453274.html

相關文章