MyBatis-Plus快速入门指南：零基础学习也能轻松上手

在Java开发的世界里，持久层框架的选择对于项目的成功至关重要。今天，我们要聊的主角是MyBatis-Plus——一个增强版的MyBatis，它以其强大的功能、简洁的代码和高效的性能，正在成为越来越多开发者的新宠。 那么，MyBatis-Plus到底是什么？又该如何快速入门呢？让我们一起探索这个强大的工具。 ## 一、MyBatis-Plus简介 ### 1、简介 MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。  ### 2、特性 **无侵入：** 只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。 **损耗小：** 启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作，BaseMapper。 **强大的 CRUD 操作：** 内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，简单的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 操作智能分析阻断，也可自定义拦截规则，预防误操作。 ### 3、框架结构  ## 二、快速入门 ### 1.开发环境 ### 2.创建数据库和表 1）创建表单 ``` CREATE DATABASE `mp_study` /*!40100 DEFAULT CHARACTER SET utf8mb4 */; use `mp_study`; CREATE TABLE `user` ( `id` bigint(20) NOT NULL COMMENT '主键ID', `name` varchar(30) DEFAULT NULL COMMENT '姓名', `age` int(11) DEFAULT NULL COMMENT '年龄', `email` varchar(50) DEFAULT NULL COMMENT '邮箱', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; ``` 2）添加数据 ``` 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'); ``` ### 3. 创建SpringBoot工程 1）初始化工程 2）导入依赖 ``` <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.1</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> </dependencies> ``` ### 4. 编写代码 1）配置application.yml ``` # DataSource Config spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8 username: root password: 1234 ``` 2）启动类 在Spring Boot启动类中添加@MapperScan注解，扫描mapper包 ``` @MapperScan("cn.frozenpenguin.mapper") @SpringBootApplication public class MybatisPlusStudyApplication { public static void main(String[] args) { SpringApplication.run(MybatisPlusStudyApplication.class, args); } } ``` 3）添加实体类 ``` @Data//lombok注解 public class User { private Long id; private String name; private Integer age; private String email; } ``` 4）添加mapper BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型。 ``` public interface UserMapper extends BaseMapper<User> { } ``` 5）测试 ``` @Autowired private UserMapper userMapper; @Test void test01(){ List<User> users = userMapper.selectList(null); for (User user : users) { System.out.println(user); } } ``` 结果  注意： IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确执行。为了避免报错，可以在mapper接口上添加 @Repository注解。 6）添加日志 我们所有的sql现在是不可见的，我们希望知道它是怎么执行的，所以我们必须要看日志！ 在application.yml中配置日志输出 ``` # 配置日志 mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl mapper-locations: ``` ## 三、基本CRUD ### 1.插入 ``` @Test void insert() User user = new User(null, "lisi", 2, "aaa@qq.com"); int insert = userMapper.insert(user); System.out.println("受影响行数"+insert); //1511332162436071425 System.out.println(user.getId()); } ``` id设置为null，却插入了1511332162436071425，这是因为MyBatis-Plus在实现插入数据时，会默认基于雪花算法的策略生成id。 ### 2.删除 1）通过id删除记录 ``` @Test void testDeleteById(){ //DELETE FROM user WHERE id=? int result = userMapper.deleteById(1); System.out.println("受影响行数："+result); } ``` 通过id批量删除记录 ``` @Test void testDeleteBatchIds(){ //DELETE FROM user WHERE id IN ( ? , ? , ? ) int result = userMapper.deleteBatchIds(ids); System.out.println("受影响行数："+result); } ``` 通过map条件删除记录 ``` @Test void testDeleteByMap(){ //DELETE FROM user WHERE name = ? AND age = ? Map<String,Object> map=new HashMap<>(); map.put("age",12); map.put("name","lisi"); int result = userMapper.deleteByMap(map); System.out.println("受影响行数："+result); } ``` ### 3. 修改 ``` @Test void testUpdateById(){ //SELECT id,name,age,email FROM user WHERE id=? User user = new User(10L, "hello", 12, null); int result = userMapper.updateById(user); //注意：updateById参数是一个对象 System.out.println("受影响行数："+result); } ``` ### 4.自动填充 - 创建时间、修改时间！这些个操作都是自动化完成的，我们不希望手动更新！ - 阿里巴巴开发手册：所有的数据库表：gmt_create、gmr_modified、几乎所有的表都要配置上！而且需要自动化！ **方式一：数据库级别** （工作中不允许修改数据库） 1）在表中新增字段 create_time, update_time；  2）再次测试插入方法，我们需要先把实体类同步！ 3）再次更新查看结果即可。  **方式二：代码级别** - 删除数据库的默认值，更新操作 - 实体类的字段属性上需要加注解 ``` @TableField(fill = FieldFill.INSERT) private Date createTime; @TableField(fill = FieldFill.INSERT_UPDATE) private Date updateTime; ``` - 编写处理器处理注解 ``` @Component public class MyMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { // 起始版本 3.3.0(推荐使用) this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); } @Override public void updateFill(MetaObject metaObject) { // 起始版本 3.3.0(推荐) this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); } } ``` - 测试插入 - 测试更新、观察时间即可 你还在苦恼找不到真正免费的编程学习平台吗?可以试试【云端源想】！课程视频、知识库、微实战、云实验室、一对一咨询……你想要的全部学习资源这里都有，重点是现在还是免费的！[点这里即可查看！](https://www.ydcode.cn/?sourceId=743) ### 5.查询 - 与查询基本一致； - 根据id查询用户信息； - 根据多个id查询多个用户信息； - 通过map条件查询用户信息； - 查询所有数据； ``` @Test void test01(){ List<User> users = userMapper.selectList(null); for (User user : users) { System.out.println(user); } } ``` 通过观察BaseMapper中的方法，大多方法中都有Wrapper类型的形参，此为条件构造器，可针 对于SQL语句设置不同的条件，若没有条件，则可以为该形参赋值null，即查询（删除/修改）所有数据。 ### 6.通用Service 说明： - 通用 Service CRUD 封装IService接口，进一步封装 CRUD； - 采用 get 查询单行； - remove 删除； - list 查询集合； - page 分页； - 前缀命名方式区分 Mapper 层避免混淆； - 泛型 T 为任意实体对象； - 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类； - 官网地址：https://baomidou.com/pages/49cc81/#service-crud-%E6%8E%A5%E5%8F%A3。 1）IService MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑 详情查看源码IService和ServiceImpl。 2）创建Service接口和实现 ``` /** * UserService继承IService模板提供的基础功能 */ public interface UserService extends IService<User> { } ``` ``` /** * ServiceImpl实现了IService，提供了IService中基础功能的实现 * 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现 */ @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { } ``` 3）测试查询记录数 ``` @Test void testGetCount(){ long count = userService.count(); System.out.println("总记录数：" + count); } ``` 4）测试批量插入 ``` @Test void testSaveBatch(){ // SQL长度有限制，海量数据插入单条SQL无法实行， // 因此MP将批量插入放在了通用Service中实现，而不是通用Mapper ArrayList<User> users = new ArrayList<>(); for (int i = 0; i < 5; i++) { User user = new User(); user.setName("lyl"+i); user.setAge(20+i); users.add(user); } //SQL:INSERT INTO t_user ( username, age ) VALUES ( ?, ? ) userService.saveBatch(users); } ``` 原理：先把user对象存到list（存在内存中），然后直接save集合list中的所有user。 MyBatis-Plus作为MyBatis的增强版，不仅继承了MyBatis的所有优点，还在此基础上做了大量的改进和扩展。它的出现，无疑为Java开发者提供了一个更为强大、便捷的数据操作工具。 技术的世界总是在不断进步，而我们作为开发者，也需要不断学习新的工具和技术。MyBatis-Plus正是这样一把钥匙，它能打开高效数据操作的大门。希望本文能帮助您快速入门MyBatis-Plus！