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方法,依次在控制台输入信息:
代码中的结果:
红框标识是自动生成的。
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调用看看: