Spring Boot 2.x（五）：整合Mybatis-Plus

本文轉載自查看原文 2018-12-24 20:28 5210 Spring Boot/ Spring Boot 2.x

簡介

Mybatis-Plus是在Mybatis的基礎上，國人開發的一款持久層框架。

並且榮獲了2018年度開源中國最受歡迎的中國軟件TOP5

同樣以簡化開發為宗旨的Spring Boot與Mybatis-Plus放在一起會產生什么樣的化學反應呢？下面我們來領略一下兩者配合帶來的效率上的提升。

Mybatis-Plus的作用

可以看到，它給我們提供了一些核心的功能：代碼生成器和現成的CRUD接口以及可以結合Lambda的條件構造器使我們的代碼變得足夠優雅，分頁的使用也是相當的方便，以及提供了不同的主鍵生成策略。
如果這些功能不能滿足我們的需求，Mybatis-Plus還提供了豐富的插件供我們去使用，我們接下來只講核心功能，插件的使用會在后面的文章中進行部分的講解，感興趣的同學可以先去看一下官方的文檔。

使用第一步：引入POM

首先我們需要引入POM，我在這里引用的是最新版本的：

接着，如果我們需要使用代碼生成器，需要引入模板引擎的依賴：

到此，pom的引入就告一段落，下面我們來看一下配置文件的編寫：

使用第二步：編寫配置文件

這里我們使用的是application.yml作為配置文件，而非新建Spring Boot 項目默認的application.properties，這里如果不會新建一個Spring Boot項目，可以去參考本系列教程的第一篇文章

在這里可以進行打印SQL的配置，便於我們進行排查問題。

使用第三步：建表

使用第四步：使用代碼生成器

直接貼出我的代碼生成器代碼：

public class MpGenerator {
    public static void main(String[] args) {
        GlobalConfig config = new GlobalConfig();
        String dbUrl = "jdbc:mysql://localhost:3306/viboot?useSSL=false";
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDbType(DbType.MYSQL)
                .setUrl(dbUrl)
                .setUsername("root")
                .setPassword("Passw0rd")
                .setDriverName("com.mysql.cj.jdbc.Driver");
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig
                .setCapitalMode(true)
                //這里結合了Lombok，所以設置為true，如果沒有集成Lombok，可以設置為false
                .setEntityLombokModel(true)
                .setNaming(NamingStrategy.underline_to_camel);
        //這里因為我是多模塊項目，所以需要加上子模塊的名稱，以便直接生成到該目錄下，如果是單模塊項目，可以將后面的去掉
        String projectPath = System.getProperty("user.dir") + "/viboot-mybatis-plus";
        // 自定義配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
            }
        };
        // 如果模板引擎是 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) {
                // 自定義輸出文件名
                return projectPath + "/src/main/resources/mapper/" + "user"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });

        cfg.setFileOutConfigList(focList);

        //設置作者，輸出路徑，是否重寫等屬性
        config.setActiveRecord(false)
                .setEnableCache(false)
                .setAuthor("viyoung")
                .setOutputDir(projectPath + "/src/main/java")
                .setFileOverride(true)
                .setServiceName("%sService");
        new AutoGenerator()
                .setGlobalConfig(config)
                .setDataSource(dataSourceConfig)
                .setStrategy(strategyConfig)
                .setTemplateEngine(new FreemarkerTemplateEngine())
                .setCfg(cfg)
                //這里進行包名的設置
                .setPackageInfo(
                        new PackageConfig()
                                .setParent("indi.viyoung.viboot.mybatis")
                                .setController("controller")
                                .setEntity("entity")
                                .setMapper("mapper")
                                .setServiceImpl("service.impl")
                                .setService("service")
                ).execute();
    }
}

下面我們來運行main方法，就可以看到生成的包：

將mapper包下面xml包刪掉，因為我們已經在resources中生成了*mapper.xml文件。
這里需要注意，需要在SpringBoot的啟動類上配置MapperScan來幫助我們去找到持久層接口的位置。

使用第四步：編寫查詢列表進行測試

沒錯，我們只需要寫一行代碼就可以獲取到我們想要的列表，下面我們來訪問一下

IService與BaseMapper

有些人可能會好奇，為什么我們只需要在controller層中直接去調用就可以獲得到列表，這是因為Mybatis-Plus給我們封裝了一系列的CRUD的基礎接口，在通過代碼生成器生成的UserService接口實際上是繼承了IService接口的，而UserServiceImpl則是繼承ServiceImpl，所以就可以獲取到一些基礎的實現。