spring-boot中使用mybatis-plus程式碼生成器讓你輕鬆的完成單表的CURD
阿新 • • 發佈：2020-08-01
摘要：
最近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: [email protected] * @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自動生成是繼承，可以直接完成簡單增刪改操作。