當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

mybatis 代码生成器_spring Boot手把手教学（4）: mybatis-plus 代码生成器，自动帮你生成代码

發布時間：2025/6/17 编程问答 34 豆豆

生活随笔收集整理的這篇文章主要介紹了 mybatis 代码生成器_spring Boot手把手教学（4）: mybatis-plus 代码生成器，自动帮你生成代码小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

1、前言
2、安裝依賴
3、配置
4、生成器代碼
5、代碼展示
6、代碼測試
- 6.1 添加工作
- 6.2 其余操作

1、前言

俗話說：工欲善其事，必先利其器。

我們在使用springBoot開發項目的，剛開始的時候，肯定會手動去創建Contoller、entity、

、Service、ServiceImpl、Mapper 甚至 xml文件，手動效率實在是慢。

這里介紹，如何去利用代碼生成器，幫我們去自動生成各個模塊代碼；

)

MyBatis-Plus 的代碼生成器，通過 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller等各個模塊的代碼，極大的提升了開發效率。

? 效果預覽:
?

? 代碼預覽
?package com.scaffold.test.base;import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.core.toolkit.StringUtils; 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.TableInfo; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;import java.util.ArrayList; import java.util.List; import java.util.Scanner;public class CodeGenerator {/*** * 讀取控制臺內容* */public static String scanner(String tip) {Scanner scanner = new Scanner(System.in);StringBuilder help = new StringBuilder();help.append("請輸入" + tip + "：");System.out.println(help.toString());if (scanner.hasNext()) {String ipt = scanner.next();if (StringUtils.isNotEmpty(ipt)) {return ipt;}}throw new MybatisPlusException("請輸入正確的" + tip + "！");}public static void main(String[] args) {// 代碼生成器AutoGenerator mpg = new AutoGenerator();// 全局配置GlobalConfig gc = new GlobalConfig();String projectPath = System.getProperty("user.dir");gc.setOutputDir(projectPath + "/src/main/java");gc.setAuthor("alex wong");gc.setOpen(false);// 設置名字gc.setControllerName("%sController");gc.setServiceName("%sService");gc.setServiceImplName("%sServiceImpl");gc.setMapperName("%sMapper");// 設置 resultMapgc.setBaseResultMap(true);gc.setBaseColumnList(true); // gc.setFileOverride(true);// gc.setSwagger2(true); 實體屬性 Swagger2 注解mpg.setGlobalConfig(gc);// 數據源配置DataSourceConfig dsc = new DataSourceConfig();dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8");dsc.setDriverName("com.mysql.cj.jdbc.Driver");dsc.setUsername("admin");dsc.setPassword("你的mysql密碼");mpg.setDataSource(dsc);// 自定義配置InjectionConfig cfg = new InjectionConfig() {@Overridepublic void initMap() {// to do nothing}};// 包配置PackageConfig pc = new PackageConfig();// pc.setModuleName(scanner("模塊名"));pc.setParent("com.scaffold.test");mpg.setPackageInfo(pc);// 如果模板引擎是 velocityString templatePath = "/templates/mapper.xml.vm";// 自定義輸出配置List<FileOutConfig> focList = new ArrayList<>();// 自定義配置會被優先輸出focList.add(new FileOutConfig(templatePath) {@Overridepublic String outputFile(TableInfo tableInfo) {// 自定義輸出文件名，如果你 Entity 設置了前后綴、此處注意 xml 的名稱會跟著發生變化！！return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;}});cfg.setFileOutConfigList(focList);mpg.setCfg(cfg);// 配置模板TemplateConfig templateConfig = new TemplateConfig();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);strategy.setRestControllerStyle(true);// 寫于父類中的公共字段 // strategy.setSuperEntityColumns("id");strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));strategy.setControllerMappingHyphenStyle(true);strategy.setTablePrefix(pc.getModuleName() + "_");mpg.setStrategy(strategy);mpg.setTemplateEngine(new VelocityTemplateEngine());mpg.execute();，} }

2、安裝依賴

初始一個spring boot項目我就不再多說了，可以參考以下：

引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、lombok、mysql-connector 依賴：

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope><exclusions><exclusion><groupId>org.junit.vintage</groupId><artifactId>junit-vintage-engine</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.3.2</version></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId></dependency><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-generator</artifactId><version>3.3.2</version></dependency><dependency><groupId>org.apache.velocity</groupId><artifactId>velocity-engine-core</artifactId><version>2.0</version></dependency></dependencies>

3、配置

在 application.yml 配置文件中添加mysql數據庫的相關配置

server:port: 9002spring:datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://127.0.0.1:3306/testusername: adminpassword: ************logging:level:root: warncom.scaffold.test.mapper: trace

4、生成器代碼

新建 com.scaffold.test.base.CodeGenerator 類

package com.scaffold.test.base;import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.core.toolkit.StringUtils; 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.TableInfo; 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;public class CodeGenerator {/*** * 讀取控制臺內容* */public static String scanner(String tip) {Scanner scanner = new Scanner(System.in);StringBuilder help = new StringBuilder();help.append("請輸入" + tip + "：");System.out.println(help.toString());if (scanner.hasNext()) {String ipt = scanner.next();if (StringUtils.isNotEmpty(ipt)) {return ipt;}}throw new MybatisPlusException("請輸入正確的" + tip + "！");}public static void main(String[] args) {// 代碼生成器AutoGenerator mpg = new AutoGenerator();// 全局配置GlobalConfig gc = new GlobalConfig();String projectPath = System.getProperty("user.dir");gc.setOutputDir(projectPath + "/src/main/java");gc.setAuthor("alex wong");gc.setOpen(false);// 設置名字gc.setControllerName("%sController");gc.setServiceName("%sService");gc.setServiceImplName("%sServiceImpl");gc.setMapperName("%sMapper");// 設置 resultMapgc.setBaseResultMap(true);gc.setBaseColumnList(true); // gc.setFileOverride(true);// gc.setSwagger2(true); 實體屬性 Swagger2 注解mpg.setGlobalConfig(gc);// 數據源配置DataSourceConfig dsc = new DataSourceConfig();dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8");dsc.setDriverName("com.mysql.cj.jdbc.Driver");dsc.setUsername("admin");dsc.setPassword("**********");mpg.setDataSource(dsc);// 自定義配置InjectionConfig cfg = new InjectionConfig() {@Overridepublic void initMap() {// to do nothing}};// 包配置PackageConfig pc = new PackageConfig();// pc.setModuleName(scanner("模塊名"));pc.setParent("com.scaffold.test");mpg.setPackageInfo(pc);// 如果模板引擎是 velocityString templatePath = "/templates/mapper.xml.vm";// 自定義輸出配置List<FileOutConfig> focList = new ArrayList<>();// 自定義配置會被優先輸出focList.add(new FileOutConfig(templatePath) {@Overridepublic String outputFile(TableInfo tableInfo) {// 自定義輸出文件名，如果你 Entity 設置了前后綴、此處注意 xml 的名稱會跟著發生變化！！return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;}});cfg.setFileOutConfigList(focList);mpg.setCfg(cfg);// 配置模板TemplateConfig templateConfig = new TemplateConfig();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);strategy.setRestControllerStyle(true);// 寫于父類中的公共字段 // strategy.setSuperEntityColumns("id");strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));strategy.setControllerMappingHyphenStyle(true);strategy.setTablePrefix(pc.getModuleName() + "_");mpg.setStrategy(strategy);mpg.setTemplateEngine(new VelocityTemplateEngine());mpg.execute();} }? 第一步：修改為你的數據源
?

? 第二步：修改包
?

? 第三步：執行 main 方法
?

這里輸入的表名，必須是你數據庫真實存在的表，否則不生效；

5、代碼展示

以job表為例：

? jobController
?package com.scaffold.test.controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;/*** * 前端控制器* ** @author alex wong* @since 2020-06-14*/ @RestController @RequestMapping("/job") public class JobController {}? job entity 實體類
?package com.scaffold.test.entity;import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableId; import java.io.Serializable; import lombok.Data; import lombok.EqualsAndHashCode;/*** * * ** @author alex wong* @since 2020-06-14*/ @Data @EqualsAndHashCode(callSuper = false) public class Job implements Serializable {private static final long serialVersionUID=1L;@TableId(value = "id", type = IdType.AUTO)private Integer id;private String name;private Integer age;private String position;}? Job mapper
?package com.scaffold.test.mapper;import com.scaffold.test.entity.Job; import com.baomidou.mybatisplus.core.mapper.BaseMapper;/*** * Mapper 接口* ** @author alex wong* @since 2020-06-14*/ public interface JobMapper extends BaseMapper<Job> {}? Job Service 服務類接口
?package com.scaffold.test.service;import com.scaffold.test.entity.Job; import com.baomidou.mybatisplus.extension.service.IService;/*** * 服務類* ** @author alex wong* @since 2020-06-14*/ public interface JobService extends IService<Job> {}? Job ServiceImpl 服務類的實現方法
?package com.scaffold.test.service.impl;import com.scaffold.test.entity.Job; import com.scaffold.test.mapper.JobMapper; import com.scaffold.test.service.JobService; import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl; import org.springframework.stereotype.Service;/*** * 服務實現類* ** @author alex wong* @since 2020-06-14*/ @Service public class JobServiceImpl extends ServiceImpl<JobMapper, Job> implements JobService {}? Mapper XML
?<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.scaffold.test.mapper.JobMapper"><resultMap id="BaseResultMap" type="com.scaffold.test.entity.Job"><id column="id" property="id" /><result column="name" property="name" /><result column="age" property="age" /><result column="position" property="position" /></resultMap><sql id="Base_Column_List">id, name, age, position</sql></mapper>

6、代碼測試

我們依然以 job 表為例，雖然單表操作執行，一般不用Mapper XML，可以使用Mybatis-plus的CRUD , 不過我們接下來依然是用XML來做數據庫操作。

6.1 添加工作

? 1、Mapper XML 增加sql語句 mapper/JobMapper.xml
?<insert id="insertJob">insert into job(name, age, position)values(#{name}, #{age}, #{position})</insert> ? 2、com.scaffold.test.mapper.JobMapper
?package com.scaffold.test.mapper;import com.scaffold.test.entity.Job; import com.baomidou.mybatisplus.core.mapper.BaseMapper; import org.springframework.beans.factory.annotation.Autowired;/*** * Mapper 接口* ** @author alex wong* @since 2020-06-14*/ public interface JobMapper extends BaseMapper<Job> {public void insertJob(Job job);}? 3、增加Service接口和實現方法
?
? Service接口: com.scaffold.test.service.JobService
?package com.scaffold.test.service;import com.scaffold.test.entity.Job; import com.baomidou.mybatisplus.extension.service.IService;/*** * 服務類* ** @author alex wong* @since 2020-06-14*/ public interface JobService extends IService<Job> {public String addJob(Job job);}? JobServiceImpl接口實現方法：com.scaffold.test.service.impl.JobServiceImpl
?package com.scaffold.test.service.impl;import com.scaffold.test.entity.Job; import com.scaffold.test.mapper.JobMapper; import com.scaffold.test.service.JobService; import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service;/*** * 服務實現類* ** @author alex wong* @since 2020-06-14*/ @Service public class JobServiceImpl extends ServiceImpl<JobMapper, Job> implements JobService {@Autowiredprivate JobMapper jobMapper;@Overridepublic String addJob(Job job) {jobMapper.insertJob(job);return "添加成功";} }? JobController控制層：com.scaffold.test.controller.JobController
?package com.scaffold.test.controller;import com.scaffold.test.entity.Job; import com.scaffold.test.service.JobService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;/*** * 前端控制器* ** @author alex wong* @since 2020-06-14*/ @RestController @RequestMapping("/job") public class JobController {@Autowiredprivate JobService jobService;@PostMapping("/add")public String add(){Job job = new Job();job.setAge(20);job.setPosition("總經理");job.setName("汪汪");return jobService.addJob(job);} }

添加結果如下：

測試成功；

6.2 其余操作

其余增刪改查操作不再贅述：

代碼如下：

? src/main/resources/mapper/JobMapper.xml
?<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.scaffold.test.mapper.JobMapper"><resultMap id="BaseResultMap" type="com.scaffold.test.entity.Job"><id column="id" property="id"/><result column="name" property="name"/><result column="age" property="age"/><result column="position" property="position"/></resultMap><sql id="Base_Column_List">id, name, age, position</sql><insert id="insertJob">insert into job(name, age, position)values(#{name}, #{age}, #{position})</insert><select id="selectAll" resultMap="BaseResultMap">select * from job</select><update id="updateJob">update job setname = #{name},age = #{age},position = #{position}</update><delete id="deleteJobById">delete from jobwhere id = #{id}</delete></mapper>? com.scaffold.test.mapper.JobMapper
?package com.scaffold.test.mapper;import com.scaffold.test.entity.Job; import com.baomidou.mybatisplus.core.mapper.BaseMapper;import java.util.List;/*** * Mapper 接口* ** @author alex wong* @since 2020-06-14*/ public interface JobMapper extends BaseMapper<Job> {public void insertJob(Job job);public List<Job> selectAll();public void updateJob(Job job);public void deleteJobById(int id);}? com.scaffold.test.service.JobService
?package com.scaffold.test.service;import com.scaffold.test.entity.Job; import com.baomidou.mybatisplus.extension.service.IService;import java.util.List;/*** * 服務類* ** @author alex wong* @since 2020-06-14*/ public interface JobService extends IService<Job> {public String addJob(Job job);public List<Job> findAll();public String updateJob(Job job);public String deleteJobById(int id);}? com.scaffold.test.service.impl.JobServiceImpl
?package com.scaffold.test.service.impl;import com.scaffold.test.entity.Job; import com.scaffold.test.mapper.JobMapper; import com.scaffold.test.service.JobService; import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service;import java.util.List;/*** * 服務實現類* ** @author alex wong* @since 2020-06-14*/ @Service public class JobServiceImpl extends ServiceImpl<JobMapper, Job> implements JobService {@Autowiredprivate JobMapper jobMapper;@Overridepublic String addJob(Job job) {jobMapper.insertJob(job);return "添加成功";}@Overridepublic List<Job> findAll() {return jobMapper.selectAll();}@Overridepublic String updateJob(Job job) {jobMapper.updateJob(job);return "更新成功";}@Overridepublic String deleteJobById(int id) {jobMapper.deleteJobById(id);return "刪除成功";} }? com.scaffold.test.controller.JobController
?package com.scaffold.test.controller;import com.scaffold.test.entity.Job; import com.scaffold.test.service.JobService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.*;import java.util.List;/*** * 前端控制器* ** @author alex wong* @since 2020-06-14*/ @RestController @RequestMapping("/job") public class JobController {@Autowiredprivate JobService jobService;// 添加@PostMapping("/add")public String add() {Job job = new Job();job.setAge(20);job.setPosition("總經理");job.setName("汪汪");return jobService.addJob(job);}// 查詢所有@GetMapping("/list")public List<Job> getList() {return jobService.findAll();}// 更新@PostMapping("/update")public String update() {Job job = new Job();job.setAge(20);// 汪汪被降職job.setPosition("總經理助理");job.setName("汪汪");return jobService.updateJob(job);}// 刪除@PostMapping("/delete")public String delete(@RequestParam int id) {// 汪汪被刪除return jobService.deleteJobById(id);}}

總結

以上是生活随笔為你收集整理的mybatis 代码生成器_spring Boot手把手教学（4）: mybatis-plus 代码生成器，自动帮你生成代码的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇： python django 动态网页_使
下一篇：全局程序集缓存gac中安装程序集_我就不