MyBatis-Plus
(简称 MP)在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
官网地址:
https://baomidou.com/pages/24112f/
使用 mybatisplus 需要先确定表结构,下面就是测试用的表结构。
create table t_user (
id int (10) primary key auto_increment comment '用户主键',
username varchar (100) not null comment '用户名称',
pwd varchar(50) not null comment '密码',
create_time datetime not null comment '创建时间',
update_time datetime comment '修改时间'
) engine = innodb default charset = utf8 collate = utf8_bin comment '用户表';
<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">
<parent>
<groupId>org.examplegroupId>
<artifactId>springboot-learning-parentsartifactId>
<version>1.0-SNAPSHOTversion>
parent>
<modelVersion>4.0.0modelVersion>
<groupId>springboot-demogroupId>
<artifactId>springboot-mybatisplusartifactId>
<version>1.0-SNAPSHOTversion>
<name>springboot-mybatisplusname>
<description>springboot 集成 mybatisplusdescription>
<packaging>jarpackaging>
<url>https://gitee.com/leo825/springboot-learning-parents.giturl>
<properties>
<start-class>com.demo.SpringbootMybatisplusApplicationstart-class>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8project.reporting.outputEncoding>
<java.version>1.8java.version>
<mybatisplus.version>3.5.1mybatisplus.version>
<freemaker.version>2.3.31freemaker.version>
<mysql.version>8.0.28mysql.version>
properties>
<dependencies>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starterartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>${mybatisplus.version}version>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-generatorartifactId>
<version>${mybatisplus.version}version>
dependency>
<dependency>
<groupId>org.freemarkergroupId>
<artifactId>freemarkerartifactId>
<version>2.3.31version>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>${mysql.version}version>
dependency>
dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-maven-pluginartifactId>
plugin>
plugins>
build>
project>
# springboot多环境配置
#端口,项目上下文
server:
port: 8080
servlet:
context-path: /springboot-mybatisplus
spring:
# mysql 数据库连接信息,本地使用 mysql 服务版本为:8.0.28
datasource:
username: root
password: 6tojyh*A3eQ6
url: jdbc:mysql://localhost:3306/local_test?useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true&allowPublicKeyRetrieval=true
driver-class-name: com.mysql.cj.jdbc.Driver
# mybatis-plus 配置
mybatis-plus:
mapper-locations: classpath*:/mapper/**/*.xml
#实体扫描,多个package用逗号或者分号分隔
typeAliasesPackage: com.dmo.entity
global-config:
#数据库相关配置
db-config:
#主键类型 AUTO:"数据库ID自增", INPUT:"用户输入ID", ID_WORKER:"全局唯一ID (数字类型唯一ID)", UUID:"全局唯一ID UUID";
id-type: AUTO
#字段策略 IGNORED:"忽略判断",NOT_NULL:"非 NULL 判断"),NOT_EMPTY:"非空判断"
field-strategy: NOT_NULL
#驼峰下划线转换
column-underline: true
logic-delete-value: -1
logic-not-delete-value: 0
banner: false
#原生配置
configuration:
# 打印sql
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
map-underscore-to-camel-case: true
cache-enabled: false
call-setters-on-nulls: true
jdbc-type-for-null: 'null'
# 日志输出配置
logging:
level:
root: INFO
org:
springframework:
security: WARN
web: ERROR
# 设置自己的 mapper 目录 输出sql日志
com.demo.mapper: debug
file:
path: ./logs
name: './logs/springboot-mybatisplus.log'
pattern:
file: '%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n'
console: '%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n'
使用代码生成器,把以前用于 CURD 的代码一键生成,大大节省了时间提高了效率,把原本1天的工作量,1个小时就能完成。
MybatisPlusGenerator.java
package com.demo.util;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import java.util.Collections;
/**
* MybatisPlusGenerator 代码生成神器
*/
public class MybatisPlusGenerator {
public static void main(String[] args) {
// mysql 连接
FastAutoGenerator.create("jdbc:mysql://localhost:3306/local_test?useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true&allowPublicKeyRetrieval=true", "root", "6tojyh*A3eQ6")
.globalConfig(builder -> {
builder.author("springBoot-Learning") // 设置作者
//.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir(System.getProperty("user.dir")+"/springboot-mybatisplus/src/main/java"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com") // 设置父包名
.moduleName("demo") // 设置父包模块名
// .service() // 设置自定义service路径,不设置就是默认路径
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, System.getProperty("user.dir") +"/src/main/resources/mapper/")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("t_user") // 设置需要生成的表名
.addTablePrefix("t_", "c_")
// 设置自动填充的时间字段
.entityBuilder().addTableFills(
new Column("create_time", FieldFill.INSERT),new Column("update_time", FieldFill.INSERT_UPDATE))
; // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
}
package com.demo.config;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* mybatisplus 配置
*/
@Configuration
public class MybatisPlusConfig {
/**
* 老版本,目前已失效
* @return
*/
/**@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
return paginationInterceptor;
}*/
/**
* 新的分页插件,一缓和二缓遵循mybatis的规则,
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
package com.demo.config;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
/**
* 填充公共字段
*
*/
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill...");
this.setFieldValByName("createTime", LocalDateTime.now(), metaObject);
this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill...");
this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
}
}
package com.demo.controller;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.demo.base.Result;
import com.demo.entity.User;
import com.demo.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* controller 测试
*
*/
@RestController
@RequestMapping("/user")
public class UserController {
/**
* 构造方法注入
*/
@Autowired
IUserService userService;
/**
* 保存数据
*
* @return
*/
@GetMapping("/save")
public Result save() {
User user = new User();
user.setUsername("miaolinlin");
user.setPwd("121212");
userService.save(user);
return new Result().ok(user);
}
/**
* 修改数据
*
* @param id
* @return
*/
@GetMapping("/update")
public Result update(Integer id) {
User user = new User();
user.setId(id);
user.setPwd("1111111111");
userService.updateById(user);
return new Result().ok("{}");
}
@GetMapping("/list")
public Result list() {
// 返回所有
List<User> list = userService.list();
return new Result().ok(list);
}
@GetMapping("/listByContion")
public Result listByContion() {
/**
* 条件查询, 通过QueryWrapper来实现查询的条件:
* eq: 代表相等
* like: 模糊匹配
* orderBy: 排序
* in, notin
* 大于,小于,between等
*/
List<User> list = userService.list(new LambdaQueryWrapper<User>()
// 查询年龄=11的
.eq(User::getUsername, "miao")
// 模糊匹配
.like(User::getPwd, "%111%")
// 排序,按照创建时间
.orderByDesc(User::getCreateTime)
);
return new Result().ok(list);
}
/**
* 根据id获取数据
*
* @param id
* @return
*/
@GetMapping("/getById")
public Result getById(Integer id) {
User user = userService.getById(id);
return new Result().ok(user);
}
/**
* 删除数据
*
* @param id
* @return
*/
@GetMapping("/delete")
public Result delete(Integer id) {
userService.removeById(id);
return new Result().ok("success");
}
/**
* 分页查询
*
* @param pageNum
* @param pageSize
* @param name
* @return
*/
@GetMapping("/page")
public Result page(int pageNum, int pageSize, String name) {
IPage<User> page = new Page<>(pageNum, pageSize);
IPage<User> page1 = userService.page(page, new LambdaQueryWrapper<User>()
// 主要演示这里可以加条件。在name不为空的时候执行
.like(StringUtils.isNotEmpty(name), User::getUsername, "%" + name + "%"));
return new Result().ok(page1);
}
}