MybatisPlus入门案例

约定不等于承诺〃 2022-12-30 08:29 207阅读 0赞

我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能，在此之前，假设你已经：

*  拥有 Java 开发环境以及相应 IDE
 *  熟悉 Spring Boot
 *  熟悉 Maven

--------------------

1、现有一张 User 表，其表结构如下：

id	name	age	email
    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、创建一个数据库：  
名字任意，这里假设为：mybatis\_plus

--------------------

3、创建一个表：  
其对应的数据库脚本如下：

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)
    );

--------------------

4、插入一些数据：  
其对应的数据库 Data 脚本如下：

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');

--------------------

5、初始化工程：  
创建一个空的 Spring Boot 工程（工程将以 MySQL作为默认数据库进行演示）  
可以使用 Spring Initializer（IDEA工具中可以看到）快速初始化一个 Spring Boot 工程。

--------------------

6、添加依赖  
引入 Spring Boot Starter 父工程：

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.0</version>
        <relativePath/>
    </parent>

--------------------

7、引入其他相关依赖：

<dependencies>
    	
    	<dependency>
    	    <groupId>mysql</groupId>
    	    <artifactId>mysql-connector-java</artifactId>
    	</dependency>
    	
    	<dependency>
    	    <groupId>org.projectlombok</groupId>
    	    <artifactId>lombok</artifactId>
    	</dependency>
    	
    	<dependency>
    	    <groupId>com.baomidou</groupId>
    	    <artifactId>mybatis-plus-boot-starter</artifactId>
    	    <version>3.2.0</version>
    	</dependency>
    	
    	<dependency>
    	    <groupId>org.springframework.boot</groupId>
    	    <artifactId>spring-boot-starter-test</artifactId>
    	    <scope>test</scope>
    	    <exclusions>
    	        <exclusion>
    	            <groupId>org.junit.vintage</groupId>
    	            <artifactId>junit-vintage-engine</artifactId>
    	        </exclusion>
    	    </exclusions>
    	</dependency>
    </dependencies>

--------------------

8、在 application.yml 配置文件中添加MySQL数据库的相关配置：

spring:
      datasource:
        username: root
        password: 666666
        url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
        driver-class-name: com.mysql.cj.jdbc.Driver

注意：url信息尽量填全，在新版本的mysql连接驱动中，不注明时区：serverTimezone=Asia/Shanghai，启动不起来。时区也可以用GMT+8。

--------------------

9、在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@MapperScan(value = { "com.pipi.mybatis_plus.mapper"})
    @SpringBootApplication
    public class MybatisPlus01Application { 
    
        public static void main(String[] args) { 
            SpringApplication.run(MybatisPlus01Application.class, args);
        }
    
    }

--------------------

10、编写实体类 User.java（此处使用了 Lombok 插件，可简化代码）

@Data
    @NoArgsConstructor
    @AllArgsConstructor
    @TableName("tbl_user")
    public class UserEntity { 
    
        @TableId("id")
        private Long id;
        @TableField("name")
        private String name;
        @TableField("age")
        private Integer age;
        @TableField("email")
        private String email;
    
    }

提示：  
@Data注解用来简化代码，表示该类有getter and setter、equals()、hashCode()、toString() 方法。  
@NoArgsConstructor，无参构造。  
@AllArgsConstructor，有参构造。  
@TableName(“tbl\_user”)，指定数据库中表的名字  
@TableId(“id”)，指定表中id的名字。  
@TableField(“name”)，指定表中非主键字段的名字。

--------------------

11、编写Mapper类 UserMapper.java

public interface UserMapper extends BaseMapper<User> { 
    	// 这里不用写其他代码
    }

--------------------

12、进行功能测试：

@SpringBootTest
    class MybatisPlus01ApplicationTests { 
    
        @Resource
        private UserMapper userMapper;
    
        @Test
        void testSelectAll() { 
            List<UserEntity> userList = userMapper.selectList(null);
            userList.forEach(System.out::println);
        }
    }

注意：UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件。

--------------------

13、控制台输出：

User(id=1, name=Jone, age=18, email=test1@baomidou.com)
    User(id=2, name=Jack, age=20, email=test2@baomidou.com)
    User(id=3, name=Tom, age=28, email=test3@baomidou.com)
    User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
    User(id=5, name=Billie, age=24, email=test5@baomidou.com)

--------------------

小结：  
通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！

从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。

但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能？那就继续学习吧！

--------------------