1、Mybatis-Plus 简介
1.1、什么是 Mybatis-Plus
Mybatis-Plus(简称 MP)是一个 Mybatis 的增强工具,在 Mybatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
1.2、Mybatis-Plus有什么用?
使用 Mybatis-Plus 工具,我们只需要将我们定义的抽象接口,继承一个公用的 BaseMapper 接口,就可以获得一组通用的 crud 方法来操作数据库!!!
使用 Mybatis-Plus 时,甚至不需要任何的 xml 映射文件或者接口方法注解,真正的 dao 层零实现。
1.3、Mybatis-Plus 小结
Mybatis-Plus 只是在 Mybatis 的基础上,实现了功能增强,让开发更加简洁高效。
Mybatis-Plus 并没有修改 Mybatis 的任何特性。
2 入门示例
2.1、需求
使用 Mybatis-Plus 实现对用户的 crud 操作
2.2、配置步骤说明
(1)搭建环境(创建项目、导入包)
(2)配置 Mybatis-Plus(基于 Spring 实现)
(3)编写测试代码
2.3、配置步骤
2.3.1、第一步:搭建环境
2.3.1.1 前提
创建数据库环境:
建表语句:
CREATE TABLE `tb_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`)
)
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');
2.3.1.2 创建项目
创建一个空的 maven 工程(工程将以mysql作为默认数据库进行演示)
2.3.1.4 添加依赖
引入 Spring Boot Starter 父工程:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.7.RELEASE</version>
<relativePath/>
</parent>
引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、lombok、mysql依赖:
<dependencies>
<!-- 导入SpringBoot依赖 -->
<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>
<!-- Lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- mybatis-plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.1.2</version>
</dependency>
<!-- Mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!-- 连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.10</version>
</dependency>
</dependencies>
<build>
<!-- 插件 -->
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
配置
在 resources文件下application.yml 配置文件中添加Mysql 数据库的相关配置:
# DataSource Config
spring:
datasource:
url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8
username: root
password: root
driverClassName: com.mysql.jdbc.Driver
在 Spring Boot 启动类中添加 @MapperScan 注解,扫描 Mapper 文件夹:
@SpringBootApplication
@MapperScan("cn.lbw.mapper")
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
2.3.2 第二步:创建 User 实体类
说明:使用 Mybatis-Plus 可以不使用 xml 文件,而是基于一组注解来解决实体类和数据库表的映射问题。
@TableName(value=“tb_user”) 指定对应的表,表名和类名一致时,可以省略 value 属性。
@TableId 指定表的主键。Value 属性指定表的主键字段,和属性名一致时,可以省略。Type指定主键的增长策略。
@TableField 指定类的属性映射的表字段,名称一致时可以省略该注解。
编写实体类User.java:(此处使用了 Lombok 简化代码)
@Data
@TableName(value = "tb_user")
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
编写Mapper类 UserMapper.java
public interface UserMapper extends BaseMapper<User> {
}
添加测试类,进行功能测试:
@RunWith(SpringRunner.class)
@SpringBootTest
public class SampleTest {
@Resource
private UserMapper userMapper;
@Test
public void testSelect() {
System.out.println(("----- selectAll method test ------"));
List<User> userList = userMapper.selectList(null);
Assert.assertEquals(5, userList.size());
userList.forEach(System.out::println);
}
}
UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper,所以不填写就是无任何条件
控制台输出:
通过以上几个简单的步骤,我们就实现了 User 表的 CRUD 功能,甚至连 XML 文件都不用编写!
从以上步骤中,我们可以看到集成MyBatis-Plus非常的简单,只需要引入 starter 工程,并配置 mapper 扫描路径即可。