快捷導(dǎo)航

MybatisPlus代碼生成器的使用方法詳解

更新時(shí)間：2021年06月13日 11:46:22 作者：天元白手

在這里我將展示如何自動(dòng)生成實(shí)體類(lèi)、控制層、服務(wù)層、mapper等代碼,這些基礎(chǔ)的代碼全部不需要我們手動(dòng)創(chuàng)建,由MybatisPlus自動(dòng)幫我們完成,我們只需要告訴MybatisPlus怎么生成這些代碼就可以了,在此之前我們需要配置好測(cè)試的環(huán)境,數(shù)據(jù)庫(kù)和表數(shù)據(jù) ,需要的朋友可以參考下

搭建測(cè)試的數(shù)據(jù)庫(kù)和表數(shù)據(jù)的SQL

/*
 Navicat Premium Data Transfer

 Source Server         : MySQL8.0
 Source Server Type    : MySQL
 Source Server Version : 80022
 Source Host           : localhost:3306
 Source Schema         : mybatisplus

 Target Server Type    : MySQL
 Target Server Version : 80022
 File Encoding         : 65001

 Date: 11/06/2021 17:37:58
*/

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `id` bigint(0) NOT NULL COMMENT '主鍵ID',
  `name` varchar(30) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '姓名',
  `age` int(0) NULL DEFAULT NULL COMMENT '年齡',
  `email` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '郵箱',
  `create_time` datetime(0) NULL DEFAULT NULL COMMENT '創(chuàng)建時(shí)間',
  `update_time` datetime(0) NULL DEFAULT NULL COMMENT '修改時(shí)間',
  `version` int(0) NULL DEFAULT NULL COMMENT '版本號(hào)',
  `deleted` tinyint(1) NULL DEFAULT NULL COMMENT '用于邏輯刪除',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (1, 'Jone', 18, 'test1@baomidou.com', NULL, NULL, NULL, NULL);
INSERT INTO `user` VALUES (2, 'Jack', 20, 'test2@baomidou.com', NULL, NULL, NULL, NULL);
INSERT INTO `user` VALUES (3, 'Tom', 38, 'test3@baomidou.com', NULL, '2021-04-11 16:13:56', NULL, NULL);
INSERT INTO `user` VALUES (4, 'Sandy', 21, 'test4@baomidou.com', NULL, NULL, NULL, NULL);
INSERT INTO `user` VALUES (5, 'Billie', 24, 'test5@baomidou.com', NULL, NULL, NULL, NULL);
INSERT INTO `user` VALUES (1381145367839522818, '李白', 28, 'lucy@qq.com', NULL, NULL, NULL, NULL);
INSERT INTO `user` VALUES (1381156317133090817, 'lili', 28, 'lucyee@qq.com', NULL, NULL, NULL, NULL);
INSERT INTO `user` VALUES (1381157235618492418, 'lili', 28, 'lucyee@qq.com', NULL, NULL, NULL, NULL);
INSERT INTO `user` VALUES (1381158109963096065, 'lili', 28, 'lucyee@qq.com', '2021-04-11 16:12:09', NULL, NULL, NULL);
INSERT INTO `user` VALUES (1381166877736280066, '江小白', 200, 'lucyee@qq.com', '2021-04-11 16:46:59', '2021-04-11 16:51:57', 2, NULL);
INSERT INTO `user` VALUES (1381186511252258818, '東方不敗', 200, 'lucyee@qq.com', '2021-04-11 18:05:00', '2021-04-11 18:05:47', 2, 1);
INSERT INTO `user` VALUES (1381225266432524290, '東方不敗11', 28, 'lucyee@qq.com', '2021-04-11 20:39:00', '2021-04-11 20:39:00', 1, NULL);

SET FOREIGN_KEY_CHECKS = 1;

引入Maven的配置文件

在這里我多引入了swagger測(cè)試接口的依賴(lài)，因?yàn)樵贛ybatisPlus的配置文件里，可以配置自動(dòng)添加swagger的注解。用于測(cè)試接口時(shí)的標(biāo)識(shí)。

<!--mybatis-plus 持久層-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                 <version>3.0.5</version>
            </dependency>

            <!-- velocity 模板引擎, Mybatis Plus 代碼生成器需要 -->
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.0</version>
            </dependency>

 <!--swagger-->
       <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.7.0</version>
      <scope>provided </scope>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.7.0</version>
      <scope>provided </scope>
    </dependency>

編輯MybatisPlus的配置文件

在配置文件里有很多的注釋?zhuān)憧梢愿鶕?jù)注釋來(lái)理解配置文件，并且改成和自己數(shù)據(jù)庫(kù)對(duì)應(yīng)的配置

package com.atguigu.demo;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.junit.Test;

/**
 * @author huiXing
 * @since 2018/12/13
 */
public class CodeGenerator {

    @Test
    public void run() {

        // 1、創(chuàng)建代碼生成器
    AutoGenerator mpg = new AutoGenerator();

    // 2、全局配置
    GlobalConfig gc = new GlobalConfig();
    String projectPath = System.getProperty("user.dir");
    gc.setOutputDir(projectPath + "/src/main/java");
    gc.setAuthor("huiXing");
    gc.setOpen(false); //生成后是否打開(kāi)資源管理器
    gc.setFileOverride(false); //重新生成時(shí)文件是否覆蓋
    gc.setServiceName("%sService");	//去掉Service接口的首字母I
    gc.setIdType(IdType.ID_WORKER_STR); //主鍵策略
    gc.setDateType(DateType.ONLY_DATE);//定義生成的實(shí)體類(lèi)中日期類(lèi)型
    gc.setSwagger2(true);//開(kāi)啟Swagger2模式

    mpg.setGlobalConfig(gc);

    // 3、數(shù)據(jù)源配置
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://localhost:3306/fyDatabase?serverTimezone=GMT%2B8");
    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("123456");
    dsc.setDbType(DbType.MYSQL);
    mpg.setDataSource(dsc);

    // 4、包配置
    PackageConfig pc = new PackageConfig();
    pc.setModuleName("production"); //模塊名
    pc.setParent("com.fuyuan.springboot");
    pc.setController("controller");
    pc.setEntity("entity");
    pc.setService("service");
    pc.setMapper("mapper");
    mpg.setPackageInfo(pc);

    // 5、策略配置
    StrategyConfig strategy = new StrategyConfig();

    strategy.setInclude("tb_production");

    strategy.setNaming(NamingStrategy.underline_to_camel);//數(shù)據(jù)庫(kù)表映射到實(shí)體的命名策略
    // strategy.setTablePrefix(pc.getModuleName() + "_"); //生成實(shí)體時(shí)去掉表前綴
    strategy.setTablePrefix("tb" + "_"); //生成實(shí)體類(lèi)時(shí) 去掉前綴t_

    strategy.setColumnNaming(NamingStrategy.underline_to_camel);//數(shù)據(jù)庫(kù)表字段映射到實(shí)體的命名策略
    strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter鏈?zhǔn)讲僮?

    strategy.setRestControllerStyle(true); //restful api風(fēng)格控制器
    strategy.setControllerMappingHyphenStyle(true); //url中駝峰轉(zhuǎn)連字符
    mpg.setStrategy(strategy);
    // 6、執(zhí)行
    mpg.execute();
    }
}

配置application.properties文件

# 服務(wù)端口
server.port=8009

# mysql數(shù)據(jù)庫(kù)連接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

#返回json的全局時(shí)間格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

#mybatis-plus日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

編輯完畢了之后直接運(yùn)行測(cè)試類(lèi)就可以自動(dòng)生成開(kāi)發(fā)所需要的代碼了
當(dāng)你看到有代碼自動(dòng)生成出來(lái)了說(shuō)明你成功了：

在這里插入圖片描述