搭建mybatis-plus學習
阿新 • • 發佈：2022-03-11
1、搭建springboot+maven
2、新增依賴：
<dependencies>
<!--Mybatis-Plus依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.2</version>
</dependency>
<!--Mybatis-Plus程式碼生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.2</version>
</dependency>
<!--Velocity模板生成引擎-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
</dependencies>3、在SpringBoot配置檔案application.yml新增如下配置，配置好資料來源和MyBatis-Plus；
spring: datasource: url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai username: root password: root mybatis-plus: mapper-locations: classpath:/mapper/**/*.xml #指定mapper.xml路徑 global-config: db-config: id-type: auto #全域性預設主鍵型別設定為自增 configuration: auto-mapping-behavior: partial #只對非巢狀的 resultMap 進行自動對映 map-underscore-to-camel-case: true #開啟自動駝峰命名規則對映
4、新增MyBatis-Plus的Java配置，使用@MapperScan註解配置好需要掃碼的Mapper介面路徑，MyBatis-Plus自帶分頁功能，需要配置好分頁外掛PaginationInterceptor。
/** * MyBatis配置類 */ @Configuration @MapperScan("com.test.zyj.modules.*.mapper") public class MyBatisConfig { @Bean public PaginationInterceptor paginationInterceptor() { PaginationInterceptor paginationInterceptor= new PaginationInterceptor(); paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true)); return paginationInterceptor; } }
程式碼生成器
MyBatis-Plus 提供了程式碼生成器，可以一鍵生成controller、service、mapper、model、mapper.xml程式碼，非常方便！
首先我們建立程式碼生成器類MyBatisPlusGenerator，直接執行其main方法即可生成相關程式碼；
package com.test.zyj.generator; import cn.hutool.core.util.StrUtil; import cn.hutool.setting.dialect.Props; import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.generator.AutoGenerator; import com.baomidou.mybatisplus.generator.InjectionConfig; import com.baomidou.mybatisplus.generator.config.*; import com.baomidou.mybatisplus.generator.config.po.LikeTable; import com.baomidou.mybatisplus.generator.config.po.TableInfo; import com.baomidou.mybatisplus.generator.config.rules.DateType; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine; import java.util.ArrayList; import java.util.List; import java.util.Scanner; /** * MyBatisPlus程式碼生成器 */ public class MyBatisPlusGenerator { public static void main(String[] args) { String projectPath = System.getProperty("user.dir") + "/mybatis-plus"; String moduleName = scanner("模組名"); String[] tableNames = scanner("表名，多個英文逗號分割").split(","); // 程式碼生成器 AutoGenerator autoGenerator = new AutoGenerator(); autoGenerator.setGlobalConfig(initGlobalConfig(projectPath)); autoGenerator.setDataSource(initDataSourceConfig()); autoGenerator.setPackageInfo(initPackageConfig(moduleName)); autoGenerator.setCfg(initInjectionConfig(projectPath, moduleName)); autoGenerator.setTemplate(initTemplateConfig()); autoGenerator.setStrategy(initStrategyConfig(tableNames)); autoGenerator.setTemplateEngine(new VelocityTemplateEngine()); autoGenerator.execute(); } /** * 讀取控制檯內容資訊 */ private static String scanner(String tip) { Scanner scanner = new Scanner(System.in); System.out.println(("請輸入" + tip + "：")); if (scanner.hasNext()) { String next = scanner.next(); if (StrUtil.isNotEmpty(next)) { return next; } } throw new MybatisPlusException("請輸入正確的" + tip + "！"); } /** * 初始化全域性配置 */ private static GlobalConfig initGlobalConfig(String projectPath) { GlobalConfig globalConfig = new GlobalConfig(); globalConfig.setOutputDir(projectPath + "/src/main/java"); globalConfig.setAuthor("zyj"); globalConfig.setOpen(false); globalConfig.setSwagger2(true); globalConfig.setBaseResultMap(true); globalConfig.setFileOverride(true); globalConfig.setDateType(DateType.ONLY_DATE); globalConfig.setEntityName("%s"); globalConfig.setMapperName("%sMapper"); globalConfig.setXmlName("%sMapper"); globalConfig.setServiceName("%sService"); globalConfig.setServiceImplName("%sServiceImpl"); globalConfig.setControllerName("%sController"); return globalConfig; } /** * 初始化資料來源配置 */ private static DataSourceConfig initDataSourceConfig() { Props props = new Props("generator.properties"); DataSourceConfig dataSourceConfig = new DataSourceConfig(); dataSourceConfig.setUrl(props.getStr("dataSource.url")); dataSourceConfig.setDriverName(props.getStr("dataSource.driverName")); dataSourceConfig.setUsername(props.getStr("dataSource.username")); dataSourceConfig.setPassword(props.getStr("dataSource.password")); return dataSourceConfig; } /** * 初始化包配置 */ private static PackageConfig initPackageConfig(String moduleName) { Props props = new Props("generator.properties"); PackageConfig packageConfig = new PackageConfig(); packageConfig.setModuleName(moduleName); packageConfig.setParent(props.getStr("package.base")); packageConfig.setEntity("model"); return packageConfig; } /** * 初始化模板配置 */ private static TemplateConfig initTemplateConfig() { TemplateConfig templateConfig = new TemplateConfig(); //可以對controller、service、entity模板進行配置 //mapper.xml模板需單獨配置 templateConfig.setXml(null); return templateConfig; } /** * 初始化策略配置 */ private static StrategyConfig initStrategyConfig(String[] tableNames) { StrategyConfig strategyConfig = new StrategyConfig(); strategyConfig.setNaming(NamingStrategy.underline_to_camel); strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel); strategyConfig.setEntityLombokModel(true); strategyConfig.setRestControllerStyle(true); //當表名中帶*號時可以啟用萬用字元模式 if (tableNames.length == 1 && tableNames[0].contains("*")) { String[] likeStr = tableNames[0].split("_"); String likePrefix = likeStr[0] + "_"; strategyConfig.setLikeTable(new LikeTable(likePrefix)); } else { strategyConfig.setInclude(tableNames); } return strategyConfig; } /** * 初始化自定義配置 */ private static InjectionConfig initInjectionConfig(final String projectPath, final String moduleName) { // 自定義配置 InjectionConfig injectionConfig = new InjectionConfig() { @Override public void initMap() { // 可用於自定義屬性 } }; // 模板引擎是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/" + moduleName + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML; } }); injectionConfig.setFileOutConfigList(focList); return injectionConfig; } }
然後在resources目錄下新增配置檔案generator.properties，新增程式碼生成器的資料來源配置及存放業務程式碼的基礎包名稱；
dataSource.url=jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai dataSource.driverName=com.mysql.cj.jdbc.Driver dataSource.username=root dataSource.password=root package.base=com.test.zyj.modules
執行程式碼生成器MyBatisPlusGenerator中的main方法，依次在控制檯輸入資訊：
程式碼中的結果：
紅框標識是自動生成的。
CRUD操作：
controller:
package com.test.zyj.modules.pms.controller; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.test.zyj.common.CommonResult; import com.test.zyj.modules.pms.model.PmsBrand; import com.test.zyj.modules.pms.service.PmsBrandService; import io.swagger.annotations.ApiOperation; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestController; import java.util.List; /** * <p> * 品牌表 前端控制器 * </p> * * @author zyj * @since 2022-03-11 */ @RestController @RequestMapping("/pms/pmsBrand") public class PmsBrandController { @Autowired private PmsBrandService brandService; @ApiOperation("獲取所有品牌列表") @RequestMapping(value = "/listAll", method = RequestMethod.GET) @ResponseBody public CommonResult<List<PmsBrand>> getBrandList() { QueryWrapper<PmsBrand> wrapper = new QueryWrapper<>(); wrapper.eq("id",1); List<PmsBrand> list = brandService.list(wrapper); return CommonResult.success(list); } }
其他的自己填。。。
postman呼叫看看：