四.SpringBoot配置MyBatis-Plus

十分钟空间

发布于 2022-08-17 14:16:33

7590

发布于 2022-08-17 14:16:33

文章被收录于专栏：Springboot框架学习

引言：

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

特性：

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
参照：https://mp.baomidou.com/

支持数据库：

mysql，oracle，db2，h2，hsql，sqlite，postgresql，sqlserver，Phoenix，Gauss ，clickhouse，Sybase，OceanBase，Firebird，cubrid，goldilocks，csiidb

一.Springboot简单配置Mybatis-Plus

1.配置pom.xml引用

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

2.配置application.yml数据库连接

spring:
  # 数据库
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/tblog?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
    username: root
    password: root

3.在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹,例如我现在的dao里面存储的是Mapper的文件：

package com.tms.tblog;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.tms.tblog.dao")
public class TBlogApplication {

    public static void main(String[] args) {
        SpringApplication.run(TBlogApplication.class, args);
    }

}

二.编写测试代码

1.做一个测试的表插入的数据库中（采用mysql数据库）

DROP TABLE IF EXISTS `account`;
CREATE TABLE `account`  (
  `account_id` bigint(0) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键',
  `role_id` bigint(0) UNSIGNED NULL DEFAULT NULL COMMENT '角色id',
  `username` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户名',
  `password` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '密码',
  `salt` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '加密盐',
  `real_name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '真实姓名',
  `sex` char(1) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '性别',
  `email` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '邮箱',
  `create_time` datetime(0) NULL DEFAULT NULL COMMENT '创建时间',
  `modified_time` datetime(0) NULL DEFAULT NULL COMMENT '修改时间',
  `create_account_id` bigint(0) UNSIGNED NULL DEFAULT NULL COMMENT '创建人',
  `modified_account_id` bigint(0) UNSIGNED NULL DEFAULT NULL COMMENT '修改人',
  `deleted` tinyint(0) UNSIGNED NULL DEFAULT 0 COMMENT '逻辑删除标识(0、否 1、是)',
  PRIMARY KEY (`account_id`) USING BTREE
) COMMENT = '账号表';

2.给数据库插入几个测试数据

3.在entity文件夹下创建数据库对应的实体(采用lombok)

package com.tms.tblog.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;

import java.time.LocalDateTime;

/**
 * 账号表
 */
@Data
public class Account {

    private static final long serialVersionUID = 1L;

    /**
     * 创建时间
     */
    @TableField(fill = FieldFill.INSERT)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

    /**
     * 主键
     */
    @TableId(value = "account_id", type = IdType.AUTO)
    private Long accountId;

    /**
     * 角色id
     */
    private Long roleId;

    @TableField(exist = false)
    private String roleName;

    /**
     * 用户名
     */
    private String username;

    /**
     * 密码
     */
    private String password;

    /**
     * 加密盐
     */
    private String salt;

    /**
     * 真实姓名
     */
    private String realName;

    /**
     * 性别
     */
    private String sex;

    /**
     * 邮箱
     */
    private String email;

    /**
     * 修改时间
     */
    @TableField(fill = FieldFill.UPDATE)
    private LocalDateTime modifiedTime;

    /**
     * 创建人
     */
    @TableField(fill = FieldFill.INSERT)
    private Long createAccountId;

    /**
     * 修改人
     */
    @TableField(fill = FieldFill.UPDATE)
    private Long modifiedAccountId;

    /**
     * 逻辑删除标识(0、否 1、是)
     */
    @TableLogic
    private Integer deleted;
}

4.创建一个Mapper接口，用来作为调用持久层的调用接口继承mybatisplus的BaseMapper接口，BaseMapper封装了很多比较常用的操作数据库的方法

package com.tms.tblog.dao;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.tms.tblog.entity.Account;

/**
 * 账户接口
 */
public interface AccountMapper extends BaseMapper<Account> {
}

5.创建业务逻辑层的服务类和接口service

AccountService接口类定义,继承了基础接口Iservice

package com.tms.tblog.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.tms.tblog.entity.Account;

import java.util.List;

/**
 * 账号表 服务接口类
 */
public interface AccountService extends IService<Account> {
    List<Account> getAccount();
}

AccountServiceImpl实现类定义，继承了实现类ServiceImpl同时实现账户接口

package com.tms.tblog.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.tms.tblog.dao.AccountMapper;
import com.tms.tblog.entity.Account;
import com.tms.tblog.service.AccountService;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * 账号表 服务实现类
 */
@Service
public class AccountServiceImpl extends ServiceImpl<AccountMapper, Account> implements AccountService {
    @Override
    public List<Account> getAccount() {
        List AccountList = list();
        return AccountList;
    }
}

6.最后编写Controller实现接口调用

package com.tms.tblog.controller;

import com.tms.tblog.entity.Account;
import com.tms.tblog.service.AccountService;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.List;

/**
 * 账户控制
 */
@RequestMapping("/Account")
@RestController
public class AccountController {

    @Resource
    private AccountService accountService;

    /**
     * 获取所有账户信息
     *
     * @return
     */
    @RequestMapping("getAccount")
    public List<Account> getAccount() {
        List<Account> list = accountService.getAccount();
        return list;
    }
}