spring-boot中使用mybatis-plus代碼生成器讓你輕松的完成單表的CURD

摘要：

最近spring-boot/cloud 項目中使用了mybatis-plus持久層框架，但是在開發中發現還是比較讓你煩惱是一個個的去建對應的表實體類BaseEntity,BaseMapper,Service,Ctrooller,這些操作實在枯燥乏味而且尤其是實體特別容易由於粗心和手誤導致不小心寫錯變量名，在寫完代碼測試時發現錯誤，比較麻煩，影響開發效率。這里mybatis-plus官網是提供了一個代碼生成器插件，自從使用了它，效率提高不少！非常推薦使用，學習使用成本低。

mybatis-plus代碼生成器的使用

[mybatis-plus官方網站](https://mybatis.plus/)

本文建立在了解mbatis持久層框架基礎上。

使用軟件環境

jdk 8

<spring-boot.version>2.1.6.RELEASE</spring-boot.version>

<spring-cloud.version>Greenwich.SR2</spring-cloud.version>

<lombok.version>1.18.12</lombok.version>

mybatis-plus代碼生成器依賴

 <mybatis-plus.version>3.3.2</mybatis-plus.version>

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>${mybatis-plus.version}</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>${mybatis-plus.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>

 代碼生成器Demo

直接上代碼

/**
 * TODO mybait-plus代碼生成器
 *
 <dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-boot-starter</artifactId>
     <version>${mybatis-plus.version}</version>
 </dependency>
 <dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-generator</artifactId>
     <version>${mybatis-plus.version}</version>
 </dependency>
 <dependency>
     <groupId>org.apache.velocity</groupId>
     <artifactId>velocity-engine-core</artifactId>
     <version>2.2</version>
 </dependency>
 *
 * @author: [e-mail]
 * @since: 2020/7/27 22:05
 */
public class MyBatisPlusAutoGenerator {

    /**
     * <p>
     * 讀取控制台內容
     * </p>
     *
     * @param tip 提示信息
     * @return 控制台輸入信息
     */
    public static String scannerInput(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder sbTips = new StringBuilder();
        sbTips.append("正在使用Mybatis-Plus代碼生成器！\n");
        sbTips.append("請輸入需要自動生成的" + tip + "：");
        System.out.println(sbTips.toString());
        if (scanner.hasNext()) {
            String inputText = scanner.next();
            if (StrUtil.isNotEmpty(inputText)) {
                return inputText;
            }
        }
        throw new MybatisPlusException("請輸入正確的" + tip + "！");
    }

    private static final String BASE_SRC_ROOT = "/src/main/java/";
    public void codeGenerate() {
        // 代碼生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        String baseSrc = projectPath + BASE_SRC_ROOT;
        gc.setOutputDir(baseSrc);
        gc.setAuthor("autoGenerateByMyBatisPlus");
        gc.setOpen(true);//生成完代碼，打開資源管理器查看
        // gc.setSwagger2(true); 實體屬性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/db_geek?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT");
        // dsc.setSchemaName("public");
        // 8.X.X com.mysql.cj.jdbc.Driver  // com.mysql.jdbc.Driver
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");//數據庫驅動
        dsc.setUsername("root");//用戶名
        dsc.setPassword("root");//密碼
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("org.demo.springcloud"); //"com.baomidou.ant"
        //最終生成代碼目錄為 baseSrc/org/demo/springcloud/moduleName
        pc.setModuleName(scannerInput("模塊名"));
        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.setEntityLombokModel(true);   //使用lombok插件
        strategy.setRestControllerStyle(true);//使用@RestController
        // 公共父類
//        strategy.setSuperControllerClass("你自己的父類控制器,沒有就不用設置!");//BaseController
        // 寫於父類中的公共字段
//        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scannerInput("表名，多個英文逗號分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
//        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

    public static void main(String[] args) {
        new MyBatisPlusAutoGenerator().codeGenerate();
    }
}

直接右鍵運行該類的main方法執行后在控制台按提示輸入

模塊名、表名，即可生成相應的代碼。

 

 成功生成代碼后會自動打開生成的目錄文件夾

 

開始使用 

使用自動生成的代碼快速完成單表的CURD。CURD是一個數據庫技術中的縮寫詞，一般的項目開發的各種參數的基本功能都是CURD。作用是用於處理數據的基本原子操作。

它代表創建（Create）、更新（Update）、讀取（Retrieve）和刪除（Delete）操作。

CURD 定義了用於處理數據的基本原子操作。

自動生成代碼在Idea中項目結構

直接在controller完成增刪改查的操作

@RestController
@RequestMapping("/auto/bs-bank-info")
public class BsBankInfoController {

    @Resource
    BsBankInfoServiceImpl bankInfoService;

    /**
     * 查詢列表
     * @param bsBankInfo
     * @return
     */
    @PostMapping("list")
    public Object list(@RequestBody BsBankInfo bsBankInfo){
        Wrapper queryWrapper = new QueryWrapper<>(bsBankInfo);
        return bankInfoService.list(queryWrapper);
    }
    @PostMapping("listbyPage")
    public Object listbyPage(@RequestBody BsBankInfo bsBankInfo){
        Page<BsBankInfo> pager = new Page(1,1);//這里測試固定了
        Wrapper queryWrapper = new QueryWrapper<>(bsBankInfo);
        return bankInfoService.page(pager ,queryWrapper);
    }
    @PostMapping("add")
    public Object add(@RequestBody BsBankInfo bsBankInfo){
        return bankInfoService.save(bsBankInfo);
    }
    @PostMapping("update")
    public Object update(@RequestBody BsBankInfo bsBankInfo){
        return bankInfoService.updateById(bsBankInfo);
    }
    @PostMapping("delete")
    public Object delete(@RequestBody BsBankInfo bsBankInfo){
        return bankInfoService.remove(new QueryWrapper<>(bsBankInfo));
    }
}

上面的代碼示例是不是看起非常絲滑，簡潔！

到此基本上單表的CURD簡單完成了。這里只需要寫controller里面寫你的業務接口代碼，其他部分的都是mybatis-plus代碼生成器幫你自動生成的。

總結：

這里我用的是3.X版本，現在用的mybatis-plus還是主要以2.X比較多。2.X和3.X目前我直觀了解到是

增刪查改的方法名不太一樣了

如

2.X insert 、selectList

3.X save、 list

代碼生成器的區別

代碼生成的實體類

3.X去除注解@TableName,@TableField,@TableId等注解，感覺有點不習慣，好像少點了什么，不知道為什么要這樣

3.X 實體類 未繼承 Model<T> 了，2.X自動生成是繼承，可以直接完成簡單增刪改操作。