简介
这篇博客主要介绍了在SpringBoot框架内,与Mybatis-plus框架的整合使用,包括代码生成器,内置分页方法,自定义多表分页查询,方便后续的代码开发。
一.Mybatis-plus框架介绍:
MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。下面简单介绍一下MP框架的主要功能:
- 内置代码生成器;
- 内置通用mapper方法,通用Service方法,使用MD框架方法可以通过少量的配置实现对单表的curd;
- 内置条件构造器,可以通过条件构造器生成自己需要的sql语句;
- 内置分页插件,可以实现对单表的分页操作,支持xml自定义分页功能;
- 还有一些其他功能:自定义ID生成器,Sql注入,Sql打印,乐观锁,动态表名等功能,在这里不做过多介绍,如有需求可访问MP官方文档: https://baomidou.com/guide/.;
二.SpringBoot与Mybatis-Plus的代码整合
2.1:准备工作:创建一个SpringBoot基本项目;
附上刚创建好的项目结构:
2.2:pom.xml文件的配置
向pom.xml文件中添加一下项目依赖。
// An highlighted block
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.0</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.lx</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.7.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
三.数据库表的准备
现有一张 User 表,其表结构如下:
id | name | age | |
---|---|---|---|
1 | Jone | 18 | test1@baomidou.com |
2 | Jack | 20 | test2@baomidou.com |
3 | Tom | 28 | test3@baomidou.com |
4 | Sandy | 21 | test4@baomidou.com |
5 | Billie | 24 | test5@baomidou.com |
其对应的数据库 Schema 脚本如下:
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
其对应的数据库 Data 脚本如下:
DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');
四.使用代码生成器生成代码
4.1:添加代码生成器依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
4.2:添加模板引擎依赖(我这里用的是freemarker)
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
4.3创建代码生成器CodeGenerator
// 演示例子,执行 main 方法控制台输入表名回车自动生成对应项目目录中
public class CodeGenerator {
/**
* <p>
* 读取控制台内容
* </p>
*/
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.isNotBlank(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("zj");
gc.setOpen(false);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/demo?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
//pc.setModuleName(scanner("模块名"));
pc.setParent("com.lx.demo");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 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/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
/*
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// 判断自定义文件夹是否需要创建
checkDir("调用默认方法创建的目录,自定义目录用");
if (fileType == FileType.MAPPER) {
// 已经生成 mapper 文件判断存在,不想重新生成返回 false
return !new File(filePath).exists();
}
// 允许生成模板文件
return true;
}
});
*/
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
//strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
//strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
4.4创建调试完毕后运行main方法
在控制台打印输出:
执行完毕后的代码结构图:
4.5代码调试
application.yml文件配置:
server:
port: 8080
spring:
datasource:
url: jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver
mybatis-plus:
mapper-locations: classpath:mapper/*.xml
type-aliases-package: com.lx.demo.entity
在UserController添加测试案例:
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserMapper userMapper;
@RequestMapping("/getUser")
public User getUser(){
return userMapper.selectById(1);
}
}
在启动类上加上扫描mapper文件注解:
@SpringBootApplication
@MapperScan("com.lx.demo.mapper")
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
启动项目访问本地网址:127.0.0.1:8080/user/getUser
五.测试MP框架内置的方法
在MP框架中继承了很多的内置方法,我们可以通过这些内置方法完成对数据库单表的curd,这里演示一下使用内置方法进行单表的分页查询:
添加一个分页必须的配置文件MybatisPlusConfig:
@Configuration
public class MybatisPlusConfig {
/**
* 分页插件配置
* @return
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
return interceptor;
}
}
控制层代码:
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserMapper userMapper;
@RequestMapping("/getIPageUser")
public IPage<User> getIPageUser(){
IPage<User> page = new Page<>(1,3);
QueryWrapper<User> qw = new QueryWrapper<>();
qw.eq("age","20");
return userMapper.selectPage(page,qw);
}
}
启动项目访问本地网址:127.0.0.1:8080/user/getIPageUser
注意:我在controller控制层,selectPage方法的两个参数Page和Wrapper,Page是用来定义当前页和每页记录数,Wrapper的赋值是由MP框架内的条件构造器组成,可以加入自己业务上的条件,具体的条件构造器的使用方法可以参考官网文档:点击跳转MP官网条件构造器
六.自定义多表的分页查询案例
添加一张关联表: Job,其表结构如下:
id | user_id | job |
---|---|---|
1 | 1 | teacher |
2 | 1 | interpreter |
3 | 2 | watcher |
4 | 3 | star |
5 | 4 | cook |
6 | 5 | programmer |
其对应的数据库 Schema 脚本如下:
DROP TABLE IF EXISTS job;
CREATE TABLE job
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
user_id BIGINT(20) NULL DEFAULT NULL COMMENT '用户id',
job VARCHAR(30) NULL DEFAULT NULL COMMENT '职业',
PRIMARY KEY (id)
);
其对应的数据库 Data 脚本如下:
DELETE FROM job;
INSERT INTO job (id, user_id, job) VALUES
(1,1, 'teacher'),
(2,1, 'interpreter'),
(3,2, 'watcher'),
(4,3, 'star' ),
(5,4, 'cook'),
(6,5, 'programmer');
实体类Job:
@Data
public class Job implements Serializable {
/**
* 主键ID
*/
private Long id;
/**
* 用户id
*/
private Long userId;
/**
* 职业
*/
private String job;
}
实体类User内加上:
private List<Job> job;
UserMapper:
public interface UserMapper extends BaseMapper<User> {
/**
* 针对多表的分页查询
* @param page
* @param wrapper
* @return
*/
IPage<User> getUserAndJob(IPage<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
}
UserMapper.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.lx.demo.mapper.UserMapper">
<resultMap id="sss" type="com.lx.demo.entity.User" autoMapping="true">
<id property="id" column="id" />
<collection property="job" ofType="com.lx.demo.entity.Job" javaType="List" autoMapping="true">
<id property="id" column="jid" />
<id property="userId" column="userId" />
<id property="job" column="job" />
</collection>
</resultMap>
<select id="getUserAndJob" resultMap="sss">
select u.id, u.name, u.age, u.email, j.id jid, j.user_id userId, j.job
from user u LEFT JOIN job j on u.id = j.user_id ${ew.customSqlSegment}
</select>
</mapper>
IUserService :
public interface IUserService extends IService<User> {
/**
* 针对多表的分页查询
* @param page
* @param wrapper
* @return
*/
IPage<User> getUserAndJob(IPage<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
}
UserServiceImpl :
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
@Autowired
private UserMapper userMapper;
@Override
public IPage<User> getUserAndJob(IPage<User> page, Wrapper<User> wrapper) {
return userMapper.getUserAndJob(page,wrapper);
}
}
UserController :
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private IUserService userService;
@RequestMapping("/getUserAndJob")
public IPage<User> getUserAndJob(){
IPage<User> page = new Page<>(1,9);
QueryWrapper<User> qw = new QueryWrapper<>();
qw.eq("age","18");
return userService.getUserAndJob(page,qw);
}
}
启动项目访问本地网址:127.0.0.1:8080/user/getUserAndJob
这篇文档主要介绍了SpringBoot与MP框架的整合以及MP框架内的代码生成器,分页查询,自定义多表分页查询操作,如有疑问请在评论区留言。