MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
首先在pom.xml文件引入相关的依赖包。
<!-- 代码生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<!-- 生成器freemarker模板 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<!-- Mybatis-Plus 启动器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
代码生成器
如果大家对orm框架有了解，如果我们新建了一张数据表，那么我们需要写对应的xml、mapper、entity、service等，真的是又繁琐又枯燥。
代码生成器就是帮助我们自动去生成数据表的这一套代码，让我们更加地关注业务逻辑。
这里要注意我们使用的是3.5.1的版本，官方从3.5.1+后，代码生成器的api完全改变了，详情可以查阅官方的具体说明 传送门
养成习惯，先创建generator包路径，然后创建CodeGenerator.java
package org.liurb.springboot.demo.generator;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.keywords.MySqlKeyWordsHandler;
import java.io.File;
import java.util.Collections;
import java.util.Map;
/**
* mybatis-plus代码生成器
*/
public class CodeGenerator {
// 数据库连接配置
private static final String JDBC_DRIVER = "com.mysql.cj.jdbc.Driver";
private static final String JDBC_URL = "jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=Asia/Shanghai";
private static final String JDBC_USER_NAME = "demo";
private static final String JDBC_PASSOWRD = "123456";
// 包名和模块名
private static final String PACKAGE_NAME = "org.liurb.springboot";
private static final String MODULE_NAME = "demo";
//输出目录
private static String projectPath = System.getProperty("user.dir");
private static String daoOutputDir = projectPath + "/src/main/java";
private static String mapperOutputDir = projectPath + "/src/main/resources/mapper";
// 表名，多个表使用英文逗号分割
private static final String TBL_NAMES = "demo_student";
// 表名的前缀，从表生成代码时会去掉前缀
private static final String TABLE_PREFIX = "demo_";
// 生成代码入口main方法
public static void main(String[] args) {
// 数据库配置
DataSourceConfig.Builder dataSourceConfigBuilder = new DataSourceConfig.Builder(JDBC_URL, JDBC_USER_NAME, JDBC_PASSOWRD)
.keyWordsHandler(new MySqlKeyWordsHandler());// 数据库关键字处理器
FastAutoGenerator.create(dataSourceConfigBuilder)
.globalConfig(builder -> {
builder.author("liurb") // 设置作者
.fileOverride() // 覆盖已生成文件
.disableOpenDir() //禁止打开输出目录
.outputDir(daoOutputDir); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent(PACKAGE_NAME) // 设置父包名
.moduleName(MODULE_NAME) // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, mapperOutputDir)); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude(TBL_NAMES) // 设置需要生成的表名
.addTablePrefix(TABLE_PREFIX) // 设置过滤表前缀
.entityBuilder() // 设置实体类
.enableTableFieldAnnotation() //属性加上说明注释
.enableLombok() // 使用lombok
.serviceBuilder() // 设置服务类
.formatServiceFileName("%sService") //格式化service类
;
})
.templateConfig(builder -> {
builder.controller(null); // 不生成controller类
builder.mapperXml(null); // 不生成xml
})
.templateEngine(new FreemarkerTemplateEngine(){// 使用Freemarker引擎模板，默认的是Velocity引擎模板
@Override
protected void outputFile(File file, Map<String, Object> objectMap, String templatePath) {
//判断文件是否存在
boolean exist = file.exists();
if (exist) {//文件存在
if (templatePath.indexOf("entity") >= 0) {//entity
//覆盖entity
super.outputFile(file, objectMap, templatePath);
} else {//非entity，不做覆盖处理
return;
}
} else {//文件不存在
super.outputFile(file, objectMap, templatePath);
}
}
})
.execute();
}
}
详细的就不在这里讨论了，大家可以到官网上面按照自己的需要修改上面的配置，笔者这边只是给到一个样例。
这里具体说一下官方没说到的配置，就是平时如果我们要调整某个表的字段，但是这个数据表的代码已经生成好了，如果这时候去运行这个代码，生成器就会覆盖掉项目原本的代码。所以一般我们只想去覆盖实体entity，上面templateEngine()这个方法就是去处理这个问题，如果还有其他的情况可以按照实际情况做调整。
首先我们先创建一张demo_student表，字段就用文章5.2里面说的学生信息。
CREATE TABLE `demo_student` (
`id` int NOT NULL AUTO_INCREMENT,
`name` varchar(50) COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '学生名称',
`age` int DEFAULT NULL COMMENT '学生年龄',
`sex` varchar(10) COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '学生性别',
`created_at` datetime DEFAULT NULL COMMENT '创建时间',
PRIMARY KEY (`id`)
)我们来运行一下代码生成器看看。
控制台的输出打印。
项目可以看到多了几个包路径，entity(实体对象)、mapper(映射器)、service(服务)，代码生成器已经帮我们将demo_student表的代码全部都生成好了。
但是用上面的代码生成器是不会生成xml的，如果不涉及到多表查询或者连表的情况(即单表查询)，那么是不需要生成xml，其实mybatis-plus已经帮我们处理好了。
如果这时候运行项目是有问题，如下图。
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'demoController': Injection of resource dependencies failed; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'studentServiceImpl': Unsatisfied dependency expressed through field 'baseMapper'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.liurb.springboot.demo.mapper.StudentMapper' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}意思是说，我们没有实例化mapper对象，所以控制器内的service不能注入进来。
其实我们只需要在启动类中加入@MapperScan注解即可。
package org.liurb.springboot.demo;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("org.liurb.springboot.demo.mapper")
@SpringBootApplication
public class SpringbootDemoApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootDemoApplication.class, args);
}
}
其中“org.liurb.springboot.demo.mapper”为mapper包路径，在项目启动的时候，就自动会去扫这层下面的mapper，并加入到容器中，这样service层就可以将其mapper注入进来。
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。
文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/93617.html
