Day201.项目起步MyBatisPlus 谷粒学院

Posted 2023-01-11 阿昌喜欢吃黄桃

谷粒学院

一、起步

0、前置知识

1、项目背景

在线教育顾名思义，是以网络为介质的教学方式，通过网络，学员与教师即使相隔万里也可以开展教学活动；此外，借助网络课件，学员还可以随时随地进行学习，真正打破了时间和空间的限制，对于工作繁忙，学习时间不固定的职场人而言网络远程教育是最方便不过的学习方式。

2、项目采用的商业模式

B2C模式（Business To Customer 会员模式）：此项目采用B2C

B2B2C模式：（商家到商家到用户）

---

3、项目功能模块

4、项目中使用的技术

---

二、在线教育项目简介

1、功能简介

谷粒学院，是一个B2C模式的职业技能在线教育系统，分为前台用户系统和后台运营平台。

2、系统模块

三、系统架构

---

三、MyBatisPlus简介

1、简介

官网：http://mp.baomidou.com/

参考教程：http://mp.baomidou.com/guide/

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化
开发、提高效率而生。

2、特性

快速开始参考：http://mp.baomidou.com/guide/quick-start.html

测试项目： mybatis_plus

数据库：mybatis_plus

---

四、MyBatisPlus入门

一、创建并初始化数据库

1、创建数据库：

mybatis_plus

2、创建 User 表

其表结构如下：

其对应的数据库 Schema 脚本如下：

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

其对应的数据库 Data 脚本如下：

DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[e-mail]'),
(2, 'Jack', 20, '[e-mail]'),
(3, 'Tom', 28, '[e-mail]'),
(4, 'Sandy', 21, '[e-mail]'),
(5, 'Billie', 24, '[e-mail]');

二、初始化工程

使用 Spring Initializr 快速初始化一个 Spring Boot 工程

Group：com.achang

Artifact：mybatis-plus

版本：2.2.1.RELEASE

---

三、添加依赖

1、引入依赖

spring-boot-starter、spring-boot-starter-test

添加：mybatis-plus-boot-starter、mysql、lombok、

在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写

<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>
    <exclusions>
        <exclusion>
            <groupId>org.junit.vintage</groupId>
            <artifactId>junit-vintage-engine</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<!--mybatis-plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

<!--mysql-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

<!--lombok用来简化实体类-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring ，以避免因版本差异导致的问
题。

---

2、idea中安装lombok插件

---

四、配置

在 application.properties 配置文件中添加 MySQL 数据库的相关配置：
mysql5

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus
spring.datasource.username=root
spring.datasource.password=00000

mysql8以上（spring boot 2.1）
注意：driver和url的变化

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

注意：
1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，

这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is unrecognized or representsmore

2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

---

五、编写代码

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

注意：扫描的包名根据实际情况修改

@SpringBootApplication
@MapperScan("com.achang.mybatisplus.mapper")
public class MybatisPlusApplication 
......

2、实体

创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）

@Data
public class User 
    private Long id;
    private String name;
    private Integer age;
    private String email;

查看编译结果：

Lombok 使用参考：

https://blog.csdn.net/motui/article/details/79012846

---

3、mapper

创建包 mapper 编写Mapper 接口： UserMapper.java

@Repository
public interface UserMapper extends BaseMapper<User> 

---

六、开始使用

添加测试类，进行功能测试：

@SpringBootTest
class MybatisPlusApplicationTests 

    @Autowired
    private UserMapper userMapper;

   @Test
    void testSelectList()
       System.out.println(("----- selectAll method test ------"));
       //UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper
        //所以不填写就是无任何条件
       List<User> list = userMapper.selectList(null);
       list.forEach(System.out::println);
   

注意：
IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。

为了避免报错，可以在 dao 层 的接口上添加 @Repository 注

---

控制台输出：

----- selectAll method test ------
User(id=1, name=Jone, age=18, email=[e-mail])
User(id=2, name=Jack, age=20, email=[e-mail])
User(id=3, name=Tom, age=28, email=[e-mail])
User(id=4, name=Sandy, age=21, email=[e-mail])
User(id=5, name=Billie, age=24, email=[e-mail])

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

---

七、配置日志

查看 sql 输出日志

#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

---

五、MyBatisPlus的CRUD 接口

1、insert

1、插入操作

@SpringBootTest
class MybatisPlusApplicationTests 

  @Autowired
  private UserMapper userMapper;

   @Test
    void testInsert()
       User user = new User();
       user.setAge(18);
       user.setName("阿昌");
       user.setEmail("[e-mail]");
       int result = userMapper.insert(user);

       System.out.println(result); //影响的行数
       System.out.println(user); //id自动回填
   

注意：数据库插入id值默认为：全局唯一id

---

2、主键策略：

（1）ID_WORKER

MyBatis-Plus默认的主键策略是： ID_WORKER 全局唯一 ID

参考资料：分布式系统唯一ID生成方案汇总：

https://www.cnblogs.com/haoxinyue/p/5208136.html

（2）自增策略

• 要想主键自增需要配置如下主键策略

  • 需要在创建数据表的时候设置主键自增

    

  • 实体字段中配置 @TableId(type = IdType.AUTO)

@Data
public class User 
    @TableId(type = IdType.AUTO) //id自增
    private Long id;
    private String name;
    private Integer age;
    private String email;

要想影响所有实体的配置，可以设置全局主键配置

#全局设置主键生成策略
mybatis-plus.global-config.db-config.id-type=auto

其它主键策略：分析 IdType 源码可知

@Getter
public enum IdType 
    /**
     * 数据库ID自增
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型
     */
    NONE(1),
    /**
     * 用户输入ID
     * 该类型可以通过自己注册自动填充插件进行填充
     */
    INPUT(2),

    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    /**
     * 全局唯一ID (idWorker)
     */
    ID_WORKER(3),
    /**
     * 全局唯一ID (UUID)
     */
    UUID(4),
    /**
     * 字符串全局唯一ID (idWorker 的字符串表示)
     */
    ID_WORKER_STR(5);

    private int key;

    IdType(int key) 
        this.key = key;
    

---

2、update

1、根据Id更新操作

注意：update时生成的sql自动是动态sql：UPDATE user SET age=? WHERE id=?

   @Test
    void testUpdate()
       User user = new User();
       user.setId(1L);
       user.setAge(28);
       int result = userMapper.updateById(user);

       System.out.println(result);
   

---

2、自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用 MyBatis Plus 的自动填充功能，完成这些字段的赋值工作：

（1）数据库表中添加自动填充字段

在User表中添加datetime类型的新的字段 create_time、update_time

（2）实体上添加注解

@Data
public class User 
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

//    @TableField(fill = FieldFill.UPDATE)
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

（3）实现元对象处理器接口

注意：不要忘记添加 @Component 注解，驼峰命名

@Component
public class MyMetaObjectHandler implements MetaObjectHandler 

    private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);
    
    //使用mp实现添加操作，这个方法执行
    @Override
    public void insertFill(MetaObject metaObject) 
        LOGGER.info("start insert fill。。。");
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);

    

    //使用mp实现修改操作，这个方法执行
    @Override
    public void updateFill(MetaObject metaObject) 
        LOGGER.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    

（4）测试

---

3、乐观锁

主要适用场景：当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新

乐观锁实现方式：

• 取出记录时，获取当前version

• 更新时，带上这个version

• 执行更新时， set version = newVersion where version = oldVersion

• 如果version不对，就更新失败

在提交数据时，比较当前版本号和数据库版本号是否一致，一致可提交，并将版本号+1；不一致就提交失败

---

（1）数据库中添加version字段

ALTER TABLE `user` ADD COLUMN `version` INT

（2）实体类添加version字段

并添加 @Version 注解

@Version
@TableField(fill = FieldFill.INSERT)
private Integer Version;

（3）元对象处理器接口添加version的insert默认值

@Component
public class MyMetaObjectHandler implements MetaObjectHandler 
    
    //使用mp实现添加操作，这个方法执行
    @Override
    public void insertFill(MetaObject metaObject) 
		...
        this.setFieldValByName("version",1,metaObject);

    
    

特别说明:

• 支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime

• 整数类型下 newVersion = oldVersion + 1

• newVersion 会回写到 entity 中

• 仅支持 updateById(id) 与 update(entity, wrapper) 方法

• 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

---

（4）在 MybatisPlusConfig 中注册 Bean，使用乐观锁插件

@EnableTransactionManagement
@Configuration
@MapperScan("com.achang.mybatisplus.mapper")
public class MybatisPlusConfig 
    //乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() 
        return new OptimisticLockerInterceptor();
    

（5）测试乐观锁可以修改成功

测试后分析打印的sql语句，将version的数值进行了加1操作

   @Test
    void testOptimisticLocker()
       //查询
       User user = userMapper.selectById(1364080977348956166L);
        //修改数据
       user.setName("Helen Yao");
       user.setEmail("[e-mail]");
        //执行更新
       userMapper.updateById(user);
   

（5）测试乐观锁修改失败

	//测试乐观锁修改失败
    @Test
    public void testOptimisticLockerFail() 
        //查询
        User user = userMapper.selectById(1L);
        //修改数据
        user.setName("Helen Yao1");
        user.setEmail("[e-mail]1");
        //模拟取出数据后，数据库中version实际数据比取出的值大，即已被其它线程修改并更新了version
        user.setVersion(user.getVersion() - 1);
        //执行更新
        userMapper.updateById(user);
    

---

4、select

1、根据id查询记录

@Test
void testSelectById()
    User user = userMapper.selectById(1);
    System.out.println(user);

2、通过多个id批量查询

完成了动态sql的foreach的功能

//多个id批量查询
@Test
void testSelectBatchIds()
    //通过集合，批量查询数据
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);

3、简单的条件查询

通过map封装查询条件

@Test
void testSelectByMap()
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","阿昌");
    map.put("age",18);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);

注意：

map中的key对应的是数据库中的列名。例如数据库user_id，实体类是userId，这时map的key需要填写user_id

---

5、分页

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

（1）创建配置类

此时可以删除主类中的 @MapperScan 扫描注解

//分页插件
@Bean
public PaginationInterceptor paginationInterceptor() 
    return new PaginationInterceptor();

（2）测试selectPage分页

测试：最终通过page对象获取相关数据

基于Springboot和MybatisPlus的外卖项目 瑞吉外卖Day4

 黑马程序员SSM框架教程_Spring+SpringMVC+MyBatisPlus笔记（自学用，持续更新）
 （转）网上总结的 NIPS 201 参会感受
 Day.js - JavaScript时间处理库
 红色小恐龙团队--冲刺DAY1
 暑假集训day11