MybatisPlus——全網配置最全的代碼生成器

MybatisPlus代碼生成器

這裡講解的是新版 （mybatis-plus 3.5.1+版本），舊版不相容

官方文檔：https://baomidou.com/（建議多看看官方文檔，每種功能裡面都有講解）

配置

這裡的配置表格和官方文檔一致

數據源配置（DataSource）

全局配置（GlobalConfig）

包配置（PackageConfig）

策略配置（StrategyConfig）

模板引擎配置（TemplateEngine）

預設 Velocity ；可選模板引擎 Beetl 或 Freemarker。（二選一即可）

手動配置代碼生成器

1. 建表，插入數據

   DROP TABLE IF EXISTS user;
   
   CREATE TABLE user
   (
       id BIGINT(20) NOT NULL COMMENT '主鍵ID',
       name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
       age INT(11) NULL DEFAULT NULL COMMENT '年齡',
       email VARCHAR(50) NULL DEFAULT NULL COMMENT '郵箱',
       version INT(10) NOT NULL DEFAULT 1 COMMIT '樂觀鎖版本號',
       DELETED INT(10) NOT NULL DEFAULT 0 COMMIT '邏輯刪除',
       CREATE_TIME DATE COMMIT '創建時間',
       modify_time DATE COMMIT '更新時間',
       PRIMARY KEY (id)
   );
   
   DELETE FROM user;
   
   INSERT INTO user (id, name, age, email) VALUES
   (1, '工藤新一','[email protected]'),
   (2, '毛利蘭','[email protected]'),
   (3, '柯南', 28, '[email protected]'),
   (4, '灰原哀', 21, '[email protected]'),
   (5, '工藤有希子', 24, '[email protected]');
   
   

2. 導入依賴

   <dependencies>
       <!--spring-boot-->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
       <!--SpringBootTest-->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-test</artifactId>
           <scope>test</scope>
       </dependency>
       <!--swagger-->
       <dependency>
           <groupId>io.swagger</groupId>
           <artifactId>swagger-annotations</artifactId>
           <version>1.6.3</version>
       </dependency>
       <!--lombok-->
       <dependency>
           <groupId>org.projectlombok</groupId>
           <artifactId>lombok</artifactId>
       </dependency>
       <!--mysql 驅動-->
       <dependency>
           <groupId>mysql</groupId>
           <artifactId>mysql-connector-java</artifactId>
           <version>8.0.26</version>
       </dependency>
       <!--mybatis-plus-->
       <dependency>
           <groupId>com.baomidou</groupId>
           <artifactId>mybatis-plus-boot-starter</artifactId>
           <version>3.5.2</version>
       </dependency>
       <!--mybatis-plus-generator 生成器-->
       <dependency>
           <groupId>com.baomidou</groupId>
           <artifactId>mybatis-plus-generator</artifactId>
           <version>3.5.2</version>
       </dependency>
       <!--velocity-->
       <dependency>
           <groupId>org.apache.velocity</groupId>
           <artifactId>velocity-engine-core</artifactId>
           <version>2.3</version>
       </dependency>
       <!--以下兩個引擎模板保留一個即可，看個人愛好選擇-->
       <!--freemarker引擎模板-->
       <dependency>
           <groupId>org.freemarker</groupId>
           <artifactId>freemarker</artifactId>
           <version>2.3.31</version>
       </dependency>
       <!--beetl引擎模板-->
       <dependency>
           <groupId>com.ibeetl</groupId>
           <artifactId>beetl</artifactId>
           <version>3.8.1.RELEASE</version>
       </dependency>
   </dependencies>
   

3. yaml

   #設置開發環境
   spring:
     datasource:
       username: root
       password: 123456
       driver-class-name: com.p6spy.engine.spy.P6SpyDriver
       url: jdbc:p6spy:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
   
   
   
   
   mybatis-plus:
   	#配置日誌  log-impl:日誌實現
     configuration:
       log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
     global-config:
       db-config:
         logic-delete-field: isDelete # 全局邏輯刪除的實體欄位名(since 3.3.0,配置後可以忽略不配置步驟2)
         logic-delete-value: 1 # 邏輯已刪除值(預設為 1)
         logic-not-delete-value: 0 # 邏輯未刪除值(預設為 0)
   
   
   
   
   

4. 在測試類里寫入主方法並修改參數，運行即可【配置已經封裝好了】

   public static void main(String[] args) {
       
       //這裡按著給的註解修改參數即可
       
           //手動配置數據源
           String url="jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8";   //註意修改資料庫名
           String name="root";
           String password="123456";
   
           //資料庫表的設置
           List<String> listTable = Arrays.asList("user");  //設置需要自動代碼生成的表名
           List<String> listTableSuffix = Arrays.asList("_b");    //設置 過濾 表的尾碼
           List<String> listTablePrefix = Arrays.asList("t_","c_"); //設置 過
   
           //基本信息
           String author = "柯南";    //作者
           String parent = "com";   //父包名
           String module = "example";   //模塊包名
       
       	
       	
       //已封裝好，無需更改。可按照需求進行註釋
       
           //1、配置數據源
           FastAutoGenerator.create(url, name, password)
                   //2、全局配置
                   .globalConfig(builder -> {
                       builder.author(author) // 設置作者名
                               .outputDir(System.getProperty("user.dir") + "/src/main/java")   //設置輸出路徑：項目的 java 目錄下【System.getProperty("user.dir")意思是獲取到項目所在的絕對路徑】
                               .commentDate("yyyy-MM-dd hh:mm:ss")   //註釋日期
                               .dateType(DateType.ONLY_DATE)   //定義生成的實體類中日期的類型 TIME_PACK=LocalDateTime;ONLY_DATE=Date;
                               .fileOverride()   //覆蓋之前的文件
                               .enableSwagger()   //開啟 swagger 模式
                               .disableOpenDir();   //禁止打開輸出目錄，預設打開
                   })
                   //3、包配置
                   .packageConfig(builder -> {
                       builder.parent(parent) // 設置父包名
                               .moduleName(module)   //設置模塊包名
                               .entity("entity")   //pojo 實體類包名
                               .service("service") //Service 包名
                               .serviceImpl("service.impl") // ***ServiceImpl 包名
                               .mapper("mapper")   //Mapper 包名
                               .xml("mapper.xml")  //Mapper XML 包名
                               .controller("controller") //Controller 包名
                               .other("config")    //自定義包名(一般不在這裡生成，而是後面編寫的時候自己建包）
                               .pathInfo(Collections.singletonMap(OutputFile.mapper.xml, System.getProperty("user.dir")+"/src/main/resources/mapper"));    //配置 mapper.xml 路徑信息：項目的 resources 目錄下
                   })
                   //4、策略配置
                   .strategyConfig(builder -> {
                       builder
                               .enableCapitalMode()    //開啟大寫命名
                               .enableSkipView()   //創建實體類的時候跳過視圖
                               .addInclude(listTable) // 設置需要生成的數據表名
                               .addTableSuffix(listTableSuffix) //設置 過濾 表的尾碼
                               .addTablePrefix(listTablePrefix) // 設置 過濾 表的首碼
   
                               //4.1、實體類策略配置
                               .entityBuilder()
                               .enableChainModel() //開啟鏈式模型
                               //.disableSerialVersionUID()  //預設是開啟實體類序列化，可以手動disable使它不序列化。由於項目中需要使用序列化就按照預設開啟了
                               .enableTableFieldAnnotation()       // 開啟生成實體時生成欄位註解
                               .enableLombok() //開啟 Lombok
                               .versionColumnName("version")   //樂觀鎖欄位名(資料庫)
                               .versionPropertyName("version") //樂觀鎖屬性名(實體)
                               .logicDeleteColumnName("deleted")   //邏輯刪除欄位名(資料庫)
                               .logicDeletePropertyName("deleteFlag")  //邏輯刪除屬性名(實體)
                               .naming(NamingStrategy.underline_to_camel)  //資料庫表映射到實體的命名策略：預設是下劃線轉駝峰命。這裡可以不設置
                               .columnNaming(NamingStrategy.underline_to_camel)    //資料庫表欄位映射到實體的命名策略：下劃線轉駝峰命。（預設是和naming一致，所以也可以不設置）
                               .addTableFills(
                                       new Column("create_time", FieldFill.INSERT),
                                       new Column("modify_time", FieldFill.INSERT_UPDATE)
                               )   //添加表欄位填充，"create_time"欄位自動填充為插入時間，"modify_time"欄位自動填充為插入修改時間
                               .idType(IdType.AUTO)    //設置主鍵自增
   
                               //4.2、Controller策略配置
                               .controllerBuilder()
                               .enableHyphenStyle()    //開啟駝峰連轉字元
                               .formatFileName("%sController") //格式化 Controller 類文件名稱，%s進行匹配表名，如 UserController
                               .enableRestStyle()  //開啟生成 @RestController 控制器
   
                               //4.3、service 策略配置
               	            .serviceBuilder()
                               .formatServiceFileName("%sService") //格式化 service 介面文件名稱，%s進行匹配表名，如 UserService
                               .formatServiceImplFileName("%sServiceImpl") //格式化 service 實現類文件名稱，%s進行匹配表名，如 UserServiceImpl
   
                               //4.4、Mapper策略配置
                               .mapperBuilder()
                               .superClass(BaseMapper.class)   //設置父類
                               .enableBaseResultMap()  //啟用 BaseResultMap 生成
                               .enableBaseColumnList() //啟用 BaseColumnList
                               .formatMapperFileName("%sMapper")   //格式化 mapper 文件名稱
                               .enableMapperAnnotation()       //開啟 @Mapper 註解
                               .formatXmlFileName("%sXml") //格式化Xml文件名稱
                               .formatMapperFileName("%sMapper");   //格式化Mapper文件名稱
   
                   })
                   //5、模板
                   .templateEngine(new VelocityTemplateEngine())
                   /*
                       模板引擎配置，預設 Velocity 可選模板引擎 Beetl 或 Freemarker(以下兩個引擎用哪個就保留哪個)
                      .templateEngine(new BeetlTemplateEngine())
                      .templateEngine(new FreemarkerTemplateEngine())
                    */
               	.templateEngine(new FreemarkerTemplateEngine())	//本人選擇了Freemarker
                   //6、執行
                   .execute();
       }
   

5. 運行結果：

   

   生成的包：

   

註意：代碼生成器生成的實體類是用@Setter和@Getter ，沒有toString方法和有參、無參構造，所以代碼生成後需要手動在實體類上刪除@Setter和@Getter ，添加@Data @NoArgsConstructor @AllArgsConstructor