MyBatis-Plus
1. 简介
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
官网文档地址https://mp.baomidou.com/guide/#特性
mybatis和mybatis-plus就像是魂斗罗的红蓝兄弟,搭配更强。
mybatis在持久层框架中还是比较火的,一般项目都是基于ssm。虽然mybatis可以直接在xml中通过SQL语句操作数据库,很是灵活。但正其操作都要通过SQL语句进行,就必须写大量的xml文件,很是麻烦。mybatis-plus就很好的解决了这个问题。
1.1 特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD
操作,更有强大的条件构造器,满足各类使用需求 - 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
- 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
- 支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD
操作 - 支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
- 内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller
层代码,支持模板引擎,更有超多自定义配置等您来使用 - 内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询
- 分页插件支持多种数据库:支持
MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库 - 内置性能分析插件:可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
- 内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作
支持数据库
任何能使用 mybatis 进行 crud, 并且支持标准 sql 的数据库
框架结构
2.使用 SpringBoot 快速使用 MyBatis-Plus
正如官方所说,mybatis-plus在mybatis的基础上只做增强不做改变,因此其与spring的整合亦非常简单。只需把mybatis的依赖换成mybatis-plus的依赖,再把sqlSessionFactory换成mybatis-plus的即可。接下来看具体操作:
2.1 准备环境
- 需要 Java 开发环境(JDK)以及相应的开发工具(IDE)。
- 需要 maven(用来下载相关依赖的 jar 包)。
- 需要 SpringBoot。
- 可以使用 IDEA 安装一个 mybatis-plus 插件。
2.2 创建一个SpringBoot 项目。
- 方式一:去官网 https://start.spring.io/ 初始化一个,然后导入 IDE 工具即可。
- 方式二:直接使用 IDE 工具创建一个。 Spring Initializer。
2.3 pom.xml文件配置依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
2.4 application.yml:
spring:
datasource:
url: jdbc:mysql://localhost:3306/step?useUnicode=true&characterEncoding=utf-8&serverTimezone=CTT
username: "root"
password: "sses"
driver-class-name: com.mysql.cj.jdbc.Driver
# mybatis-plus配置
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
typeAliasesPackage: com.mystep.step.entity
mapperLocations: classpath:mapper/*.xml
2.5 启动类
@SpringBootApplication
public class SepApplication {
public static void main(String[] args) {
SpringApplication.run(StepApplication.class, args);
2.6 实体类
@TableName(“sys_user”)因为我的实体类用的User,所以为了保持和数据库表名一致,我这里使用**@TableName**注解,内部写数据库表名。注意这是重点。
/**
* @author setp
* @date 2021年07月19日 9:45
*/
@TableName("sys_user")
@Data
@Accessors(chain = true)
public class User {
Long id;
String account;//用户账号
String nickName;//用户名称
int sex;//用户性别
Long age;//用户年龄
String password;//登录密码
LocalDateTime createTime;//创建时间
LocalDateTime updateTime;//更新时间
}
2.7 Mapper(dao层与数据库交互相关代码)操作实体类的
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.qcby.teach.help.entity.User;
/**
* @author step
* @date 2021年07月19日 17:41
*/
public interface UserMapper extends BaseMapper<User> {
}
Usermapper层继承了 BaseMapper ,这是 mybatis-plus 封装好的类。
2.8 service
import com.baomidou.mybatisplus.extension.service.IService;
import com.qcby.teach.help.entity.User;
/**
* @author step
* @date 2021年07月19日 17:42
*/
public interface UserService extends IService<User> {
}
UserService 继承了 IService
2.9 serviceImpl
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.qcby.teach.help.entity.CustomUserDetails;
import com.qcby.teach.help.entity.User;
import com.qcby.teach.help.mapper.UserMapper;
import com.qcby.teach.help.service.UserService;
import org.springframework.stereotype.Service;
/**
* @author step
* @date 2021年07月19日 17:44
*/
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}
2.10 Controller
2.10.1 添加(save)
关键代码
userService.save(userVo);
应用
/**
* 用户添加信息
* @author step
* @date 2021/7/19 10:57
* @param user
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/user/add
*/
@RequestMapping("add")
public ResultJson add(User user){
log.info("入参{}",userVo);
userService.save(userVo);
ResultJson resultJson=ResultJson.ok("添加成功");
log.info("出参{}",resultJson);
return resultJson;
}
2.10.2 删除(removeByIds)单删/多删
关键代码
userService.removeByIds(ids);
应用
/**
* 删除
* @author step
* @date 2021/7/19 14:08
* @param ids
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/topic/delete?ids=1,2,3
*/
@RequestMapping("delete")
public ResultJson deleteResponse(@RequestParam List<Long> ids){
log.info("入参信息:ids:{}",ids);
userService.removeByIds(ids);
ResultJson resultJson=ResultJson.ok("删除成功");
log.info("出参信息:{}",resultJson);
return resultJson;
}
2.10.3 更改(updateById)根据id更改
关键代码
userService.updateById(user);
应用
/**
* 用户更改信息
* @author step
* @date 2021/7/19 10:39
* @param user
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/user/update
*/
@RequestMapping("update")
public ResultJson update(User user){
log.info("入参{}",user);
userService.updateById(user);
ResultJson resultJson=ResultJson.ok("更改成功");
log.info("出参{}",resultJson);
return resultJson;
}
2.10.4 查询(list)
关键代码
userService.list()
应用
/**
* 用户查询--》按account查询
* @author step
* @date 2021/7/19 10:20
* @param account
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/user/list?account=liming
*/
@RequestMapping("list")
public ResultJson list(@RequestParam(value = "account") String account){
log.info("入参{}",account);
UserVo users =userService.list(account);
ResultJson resultJson=ResultJson.ok("查询成功",users);
return resultJson;
}
2.10.6 分页查询(Page)
/**
* 展示分页展示
* @author step
* @date 2021/7/19 17:29
* @param pageNo
* @param pageSize
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/user/listPage
*/
@RequestMapping("list")
public IPage<User>listPage(@RequestParam(defaultValue = GlobalConstant.DEFAULT_PAGE_NO+"")int pageNo,
@RequestParam(defaultValue = GlobalConstant.DEFAULT_PAGE_SIZE+"")int pageSize){
log.info("pageNo{}--pageSize{}",pageNo,pageSize);
IPage<User>userIPage=new Page<>(pageNo,pageSize);
return testService.page(page);
}
2.10.7 Controller 全部代码
添加@Autowired 标记的变量出现 红色下划线,但是不影响 正常运行。
/**
* @author step
* @date 2021年07月19日 9:39
*/
@RequestMapping(GlobalConstant.REST_URL_PREFIX+"/user")
@RestController
@Slf4j
public class RestUserController {
@Autowired
private UserService userService;
/**
* 用户查询--》按account查询
* @author step
* @date 2021/7/19 10:20
* @param account
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/user/list?account=liming
*/
@RequestMapping("list")
public ResultJson list(@RequestParam(value = "account") String account){
log.info("入参{}",account);
UserVo users =userService.list(account);
ResultJson resultJson=ResultJson.ok("查询成功",users);
return resultJson;
}
/**
* 用户更改信息
* @author step
* @date 2021/7/19 10:39
* @param user
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/user/update
*/
@RequestMapping("update")
public ResultJson update(User user){
log.info("入参{}",user);
userService.updateById(user);
ResultJson resultJson=ResultJson.ok("更改成功");
log.info("出参{}",resultJson);
return resultJson;
}
/**
* 用户添加信息
* @author step
* @date 2021/7/19 10:57
* @param user
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/user/add
*/
@RequestMapping("add")
public ResultJson add(User user){
log.info("入参{}",userVo);
userService.save(userVo);
ResultJson resultJson=ResultJson.ok("添加成功");
log.info("出参{}",resultJson);
return resultJson;
}
/**
* 删除
* @author step
* @date 2021/7/19 14:08
* @param ids
* @return com.mystep.step.web.ResultJson
* http://localhost:8080/rest/topic/delete?ids=1,2,3
*/
@RequestMapping("delete")
public ResultJson deleteResponse(@RequestParam List<Long> ids){
log.info("入参信息:ids:{}",ids);
userService.removeByIds(ids);
ResultJson resultJson=ResultJson.ok("删除成功");
log.info("出参信息:{}",resultJson);
return resultJson;
}
}
2.11 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.qcby.teach.help.mapper.UserMapper">
</mapper>
好了,大家基本上可以运行了,对User表的基本操作CRUD就这样完成了!!应用即可不要过分依赖!
3. 总结
以上便是mybatis-plus的入门教程,介绍了其如何与spring整合、通用crud的使用、全局策略的配置以及条件构造器的使用,但是这并不是MP的所有内容,其强大不限于此。通常调整mapper和service(别的里面都是空的在controller里面再写别的)这便是基本的CRUD,我们再一起继续学习呀!!