收藏等于学会,赶紧关注吧!前言 代码自动生成是根据我们的数据表,逆向生成Controller、Service、Mapper接口以及Mapper的xml文件的代码,不用再手动创建文件写通用的注解等,以此来提高开发效率,当然你也可以通过MybatisPlus的代码生成器封装进自己的系统中来二次实现,加入前端实现可视化的代码生成,我们这里实现一个在控制台操作的代码生成器一、什么是代码生成器 AutoGenerator是MyBatisPlus的代码生成器,通过AutoGenerator可以快速生成Entity、Mapper、MapperXML、Service、Controller等各个模块的代码,而且对单表都有默认实现,极大提升开发效率。二、怎么用2。1、使用步骤引入mybatisplus、generator、velocity、mysql、springbootstarterweb、swagger【非必要】、lombok【非必要】依赖创建代码生成器类,并完成代码生成的相关配置配置多张表,批量生成模块代码2。2、项目引入依赖 特别说明:MyBatisPlus从3。0。3之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖: 我这里使用maven搭建的springboot项目,项目名为buyetest相关依赖如下:lt;?xmlversion1。0encodingUTF8?projectxmlnshttp:maven。apache。orgPOM4。0。0xmlns:xsihttp:www。w3。org2001XMLSchemainstancexsi:schemaLocationhttp:maven。apache。orgPOM4。0。0http:maven。apache。orgxsdmaven4。0。0。xsd!依赖自己的父工程parentbuyeartifactIdgroupIdcom。buyegroupIdversion1。0。0versionparentmodelVersion4。0。0modelVersionbuyetestartifactIddependencies!springbootweb依赖dependencygroupIdorg。springframework。bootgroupIdspringbootstarterwebartifactIddependency!mybatisplus依赖dependencygroupIdcom。baomidougroupIdmybatisplusbootstarterartifactIddependency!mybatisplus代码生成依赖MyBatisPlus从3。0。3之后移除了代码生成器与模板引擎的默认依赖dependencygroupIdcom。baomidougroupIdmybatisplusgeneratorartifactIddependency!模板引擎依赖,当然您也可以使用Freemarker或者BeetldependencygroupIdorg。apache。velocitygroupIdvelocityenginecoreartifactIddependency!mysql依赖dependencygroupIdmysqlgroupIdmysqlconnectorjavaartifactIddependency!lombok插件dependencygroupIdorg。projectlombokgroupIdlombokartifactIddependency!swagger3依赖dependencygroupIdio。springfoxgroupIdspringfoxbootstarterartifactIddependencydependenciesproject 父工程中主要定义依赖了版本,下边贴出父工程的依赖: lt;?xmlversion1。0encodingUTF8?projectxmlnshttp:maven。apache。orgPOM4。0。0xmlns:xsihttp:www。w3。org2001XMLSchemainstancexsi:schemaLocationhttp:maven。apache。orgPOM4。0。0http:maven。apache。orgxsdmaven4。0。0。xsdmodelVersion4。0。0modelVersiongroupIdcom。buyegroupIdbuyeartifactIdpackagingpompackagingversion1。0。0versionmodulesmodulebuyetestmodulemodulespropertiesbuye。version1。0。0buye。versionproject。build。sourceEncodingUTF8project。build。sourceEncodingproject。reporting。outputEncodingUTF8project。reporting。outputEncodingjava。version1。8java。versionswagger。version3。0。0swagger。versionmybatisplus。version3。4。3。4mybatisplus。versionmpgenerator。version3。4。1mpgenerator。versionvelocity。version2。3velocity。versionlombok。version1。18。22lombok。versionproperties!依赖声明dependencyManagementdependencies!SpringBoot的依赖配置dependencygroupIdorg。springframework。bootgroupIdspringbootdependenciesartifactIdversion2。5。6versiontypepomtypescopeimportscopedependency!mybatisplusdependencygroupIdcom。baomidougroupIdmybatisplusbootstarterartifactIdversion{mybatisplus。version}versiondependency!MP的代码生成器dependencygroupIdcom。baomidougroupIdmybatisplusgeneratorartifactIdversion{mpgenerator。version}versiondependency!模板引擎dependencygroupIdorg。apache。velocitygroupIdvelocityenginecoreartifactIdversion{velocity。version}versiondependency!lombok插件dependencygroupIdorg。projectlombokgroupIdlombokartifactIdversion{lombok。version}versiondependency!Swagger3依赖dependencygroupIdio。springfoxgroupIdspringfoxbootstarterartifactIdversion{swagger。version}versionexclusionsexclusiongroupIdio。swaggergroupIdswaggermodelsartifactIdexclusionexclusionsdependencydependenciesdependencyManagementproject 这里您可以根据自己的需求来创建项目,只需要将这些依赖引入即可,具体依赖见buyetest工程,没有引入任何多余依赖2。2。1、模板引擎依赖 这里我引入的模板引擎是Velocity(默认也就是无需做配置),MyBatisPlus还支持Freemarker、Beetl,您可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎,如果您也是用Velocity引擎则无需引入以下依赖,如果您使用其他模板引擎,请将上文的maven依赖中的Velocity依赖替换掉。 Freemarker依赖:dependencygroupIdorg。freemarkergroupIdfreemarkerartifactIdversion版本可以通过mavne中央仓库查询,选择您想用的版本versiondependency Beetl依赖:dependencygroupIdcom。ibeetlgroupIdbeetlartifactIdversion版本可以通过mavne中央仓库查询,选择您想用的版本versiondependency2。3、创建代码生成器类 您在项目创建一个类即可,代码中的注释值得详细看一下,所有的代码解释都在其中,如果还有哪里不明白的评论区见,如果您觉得非常清晰,请给个赞吧。代码如下:packagecom。buye。gen;importcom。baomidou。mybatisplus。annotation。DbType;importcom。baomidou。mybatisplus。annotation。IdType;importcom。baomidou。mybatisplus。generator。AutoGenerator;importcom。baomidou。mybatisplus。generator。config。DataSourceConfig;importcom。baomidou。mybatisplus。generator。config。GlobalConfig;importcom。baomidou。mybatisplus。generator。config。PackageConfig;importcom。baomidou。mybatisplus。generator。config。StrategyConfig;importcom。baomidou。mybatisplus。generator。config。rules。DateType;importcom。baomidou。mybatisplus。generator。config。rules。NamingStrategy;整个流程分为6部分1、创建AutoGenerator代码生成器对象2、做全局配置3、数据源配置4、包配置5、策略配置6、执行代码生成Date2021112711:18Created添甄publicclassBuyeCodeGenerator{publicstaticvoidmain(String〔〕args){1、创建代码生成器AutoGeneratormpgnewAutoGenerator();2、创建全局配置对象1)、可以通过该对象配置生成文件的输出位置,类上的Author注解等2)、在下边我们会使用一些常用的配置GlobalConfiggcnewGlobalConfig();获取本项目的项目路径,不过该路径在有些情况下会出现问题,所以一般在设置文件输出路径时我会写绝对路径StringprojectPathSystem。getProperty(user。dir);System。out。println(projectPath);设置生成文件的输出路径,这里前部分使用的一个绝对路径,后部分是一个mavne项目的目录结构当然您也可以D:codebuyebuyetestsrcmainjava这样的一个完整绝对路径gc。setOutputDir(D:codebuyebuyetestsrcmainjava);设置生成文件(也就是类)上方的Author注解gc。setAuthor(添甄);生成后是否打开资源管理器gc。setOpen(false);重新生成时文件是否覆盖gc。setFileOverride(false);mp生成service层代码,默认接口名称第一个字母有I,去掉Service接口的首字母Igc。setServiceName(sService);主键策略,这里的策略和您的实际项目需要设置在https:blog。csdn。netqq36386908articledetails121465444文章中讲过主键策略了gc。setIdType(IdType。ASSIGNID);定义生成的实体类中日期类型gc。setDateType(DateType。ONLYDATE);开启Swagger2模式gc。setSwagger2(true);将配置加入到代码生成器中mpg。setGlobalConfig(gc);3、数据源配置DataSourceConfigdscnewDataSourceConfig();dsc。setUrl(jdbc:mysql:localhost:3306buye?serverTimezoneGMT2B8);dsc。setDriverName(com。mysql。cj。jdbc。Driver);dsc。setUsername(root);dsc。setPassword(root);dsc。setDbType(DbType。MYSQL);将数据源设置仅代码生成器中mpg。setDataSource(dsc);4、包配置PackageConfigpcnewPackageConfig();模块名pc。setModuleName(mp);pc。setParent(com。buye);pc。setController(controller);pc。setEntity(entity);pc。setService(service);pc。setMapper(mapper);将包配置设置进代码生成器中mpg。setPackageInfo(pc);5、策略配置StrategyConfigstrategynewStrategyConfig();设置表名,根据数据库表生成实体类和其他文件strategy。setInclude(sysuser);数据库表映射到实体的命名策略strategy。setNaming(NamingStrategy。underlinetocamel);生成实体时去掉表前缀strategy。setTablePrefix(pc。getModuleName());数据库表字段映射到实体的命名策略strategy。setColumnNaming(NamingStrategy。underlinetocamel);lombok模型Accessors(chaintrue)setter链式操作strategy。setEntityLombokModel(true);restfulapi风格控制器strategy。setRestControllerStyle(true);url中驼峰转连字符strategy。setControllerMappingHyphenStyle(true);将策略设置仅代码生成器mpg。setStrategy(strategy);6、执行mpg。execute();}}2。3。1、执行测试 其中有数据表如下: 运行代码: 上边我们仅仅是实现了单表,我们一般的项目也在几十张,甚至百张以上的表,一个一个生成起步很慢,我们只需要将代码生成类中的策略配置中的strategy。setInclude(sysuser,sysdept);配置需要生成代码的表。 setInclude(String。。。include)这个函数的参数是一个可变参数,并且将数据存储到一个Set集合中筛选掉用户不小心传入的重复数据。 注意:这里并不是是说一次性生成所有的表,我们还配置了模块记得吗?根据模块去生成就可以啦 以上就是我们的代码生成的具体操作,在项目中如果能用就用,毕竟可以省略掉很多重复的工作。无论是单表还是多表都给您介绍到。我们没有结束,接下来再翻一翻生成的代码深入理解一下。三、深挖生成的代码 注意:这里代码生成与代码生成类中的配置息息相关。3。1、公共部分 每个类上都有的公共部分 2。4、使用其他模板引擎 如果您要使用其他模板引擎:请替换模板引擎依赖在代码生成类中配置模板引擎 默认的就够用啦,别瞎折腾了setfreemarkerenginegenerator。setTemplateEngine(newFreemarkerTemplateEngine());setbeetlenginegenerator。setTemplateEngine(newBeetlTemplateEngine());3。2、实体类 知道为什么引入lombok和swagger了吧3。3、Mapper接口 3。4、mapper的xml文件 这个文件空空如也,仅仅有一个namespace配置 3。5、Service接口 这里仅仅继承了IService接口,该接口是MyBatisPlus的,稍后会和BaseMapper、以及Service实现类中继承的ServiceImpl一起介绍 3。6、Service实现类 之前我们的实现类也就是实现接口,但是这里他还帮我们继承了一个ServiceImpl类 3。7、Controller 四、MyBatisPlus基础接口 mybatisplus中的源码都是中文注释,阅读门槛较低,推荐您阅读一遍,因篇幅问题,以下仅贴出部分代码4。1、BaseMapper 这个是每个Mapper接口都继承的接口,里边拥有单表的所有CRUD实现、批量操作以及分页查询,部分代码截图如下: 4。2、IService接口 该接口为Service的顶级接口,进一步封装CRUD采用get【查询单行】remove【删除】list【查询集合】page【分页】的前缀命名方式区分Mapper层避免混淆 4。3、ServiceImpl实现类 该实现类接受两个泛型对应模块的Mapper接口对应模块的实现类 可以将Mapper直接进行注入,并且提供getBaseMapper方法提供mapper的获取,方便别的service层调用,并且对sqlSession、单表的CRUD操作做了默认实现,酸爽无比。五、测试代码 接下来在Controller中写一个添加供您参考,其余的操作都一样packagecom。buye。mp。controller;importcom。buye。mp。entity。SysUser;importcom。buye。mp。service。SysUserService;importcom。sun。org。apache。xpath。internal。operations。Bool;importorg。springframework。beans。factory。annotation。Autowired;importorg。springframework。web。bind。annotation。PostMapping;importorg。springframework。web。bind。annotation。RequestBody;importorg。springframework。web。bind。annotation。RequestMapping;importorg。springframework。web。bind。annotation。RestController;importjava。util。HashMap;importjava。util。Map;p用户信息表前端控制器author添甄RestControllerRequestMapping(mpsysuser)publicclassSysUserController{AutowiredprivateSysUserServiceuserService;添加用户paramsysUserreturnPostMappingpublicMapString,ObjectaddUser(RequestBodySysUsersysUser){添加,直接调用service,因为有默认实现,所以其他地方就不用写代码了booleansaveCountuserService。save(sysUser);MapString,ObjectmapnewHashMap();if(saveCount){map。put(code,200);map。put(message,添加用户成功);}else{map。put(code,500);map。put(message,添加用户失败);}returnmap;}} 注意:别忘记添加Mapper扫描 因为从Service到Mapper都已经有了默认实现,我们在单表操作时仅编写Controller即可,如果需要条件查询做判断,可以使用Wrapper是吧!总结 不知不觉写了一万三千多字,本篇主要介绍了:MyBatisPlus代码生成器的配置和开发,并且实现单量和批量的代码生成讲解了生成代码的结构,和引入依赖的说明通过翻阅生成的代码,为您讲解MyBatisPlus的常见接口以及它的实现原理通过一个添加案例实现MyBatisPlus生成代码的具体应用。 如果觉得不错记得关注,点赞哦!!持续更新编程文章