SpringBoot2.0（mybatis-plus初始使用）

柔情只为你懂 2023-10-15 22:26 2阅读 0赞

#### 目录 ####

*  一，介绍
 *  二，SpringBoot2.x整合MybatisPlus + Lombok
 *   *  2.1，添加依赖 \`pom\`
     *  2.2，配置数据库信息 \`application.properties\`
     *  2.3，工程结构初始化
 *  三，创建接口返回统一对象
 *  四，创建bean
 *  五，创建mapper
 *  六，创建service
 *   *  6.1，创建impl
 *  七，创建controller
 *  八，api测试和配置打印SQL配置
 *  九，BaseMapper介绍
 *  十，QueryWrapper介绍

## 一，介绍 ##

> 官网 `https://baomidou.com/`  
> 是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生  
> 是怎么增强的呢？已经封装好了一些crud方法，我们不需要再写xml了，直接调用这些方法就行，类似JPA但优于JPA  
> 更多特性  
> `无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑`  
> `损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作`

## 二，SpringBoot2.x整合MybatisPlus + Lombok ##

### 2.1，添加依赖 `pom` ###

<parent>
            
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.5.7</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-thymeleaf</artifactId>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.5.1</version>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.6</version>
            </dependency>
    
            
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-boot-starter</artifactId>
                <version>3.0.0</version>
            </dependency>
    
    
        </dependencies>

### 2.2，配置数据库信息 `application.properties` ###

server.port= 8080
    spring.datasource.username=root
    spring.datasource.password=20031011
    spring.datasource.url=jdbc:mysql://localhost:3306/bianlidain?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT-8
    spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

### 2.3，工程结构初始化 ###

> 要在启动类上添加注释@MapperScan

![在这里插入图片描述][44469b4be46041f7b09238142976adca.png]

## 三，创建接口返回统一对象 ##

> `util`类 `JsonData`包

package com.demo.util;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    
    @Data
    @AllArgsConstructor //会生成一个包含所有变量
    @NoArgsConstructor //生成一个无参数的构造方法
    public class JsonData {
        
    
        /**
         * 状态码 0 表示成功，1表示处理中，-1表示失败
         */
        private Integer code;
        /**
         * 数据
         */
        private Object data;
        /**
         * 描述
         */
        private String msg;
    
        // 成功，传入数据
        public static JsonData buildSuccess() {
        
            return new JsonData(0, null, null);
        }
    
        // 成功，传入数据
        public static JsonData buildSuccess(Object data) {
        
            return new JsonData(0, data, null);
        }
    
        // 失败，传入描述信息
        public static JsonData buildError(String msg) {
        
            return new JsonData(-1, null, msg);
        }
    
        // 失败，传入描述信息,状态码
        public static JsonData buildError(String msg, Integer code) {
        
            return new JsonData(code, null, msg);
        }
    }

## 四，创建bean ##

> `bean`类 `Lapop`包

package com.demo.bean;
    
    import lombok.Data;
    
    @Data
    public class Lapop {
        
    
        /** 键盘id */
        private Integer id ;
        /** 键盘名称 */
        private String name ;
        /** 键盘尺寸 */
        private String size ;
        /** 键盘重量 */
        private String weight ;
        /** 电压 */
        private String voltage ;
        /** 电流 */
        private String current ;
        /** 键盘接口 */
        private String interfacepass ;
        /** 按键个数 */
        private String number ;
    }

## 五，创建mapper ##

> `mapper`包 `LapopMapper`接口

package com.demo.mapper;
    
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.demo.bean.Lapop;
    
    public interface LapopMapper extends BaseMapper<Lapop> {
        
    }

## 六，创建service ##

> `service`包 `LapopService`接口

package com.demo.service;
    
    import com.baomidou.mybatisplus.core.metadata.IPage;
    import com.demo.bean.Lapop;
    
    import java.util.List;
    import java.util.Map;
    
    public interface LapopService {
        
    
        List<Lapop> getLapop();
    
    }

### 6.1，创建impl ###

> `impl`包 `LapopServiceImpl`类

package com.demo.service.impl;
    
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
    import com.baomidou.mybatisplus.core.metadata.IPage;
    import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
    import com.demo.bean.Lapop;
    import com.demo.mapper.LapopMapper;
    import com.demo.service.LapopService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import java.util.List;
    import java.util.Map;
    
    @Service
    public class LapopServiceImpl implements LapopService {
        
    
        @Autowired
        private LapopMapper lapopMapper;
    
        @Override
        public List<Lapop> getLapop() {
        
            // 查询全部
            List<Lapop> getLapopList = lapopMapper.selectList(new QueryWrapper<Lapop>());
            return getLapopList;
        }

## 七，创建controller ##

> `controller`包 `LapopController`类

package com.demo.controller;
    
    
    import com.demo.bean.Lapop;
    import com.demo.service.LapopService;
    import com.demo.util.JsonData;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/lapopController")
    public class LapopController {
        
    
        @Autowired
        private LapopService lapopService;
    
        @RequestMapping("/LapopList")
        @ResponseBody
        public JsonData LapopList(){
        
            return JsonData.buildSuccess(lapopService.getLapop());
        }
    }

## 八，api测试和配置打印SQL配置 ##

> 配置打印SQL配置 `application.properties`

#配置mybatis plus打印sql日志
    mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

> 使用软件`Apifox`来测试

![在这里插入图片描述][d620c3b712a14732b680696e36b4b04a.png]

> 打印出来的SQL 和输出结果

![在这里插入图片描述][5b0b5e7c1b2e4d908c30ebe4c641788d.png]

## 九，BaseMapper介绍 ##

> Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能  
> 方法很多：记住常用的几个就行。可以查看源码的说明，如下：

/**
     * Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能
     * <p>这个 Mapper 支持 id 泛型</p>
     *
     * @author hubin
     * @since 2016-01-23
     */
    public interface BaseMapper<T> extends Mapper<T> {
        
    
        /**
         * 插入一条记录
         *
         * @param entity 实体对象
         */
        int insert(T entity);
    
        /**
         * 根据 ID 删除
         *
         * @param id 主键ID
         */
        int deleteById(Serializable id);
    
        /**
         * 根据 columnMap 条件，删除记录
         *
         * @param columnMap 表字段 map 对象
         */
        int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
    
        /**
         * 根据 entity 条件，删除记录
         *
         * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
         */
        int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
        /**
         * 删除（根据ID 批量删除）
         *
         * @param idList 主键ID列表(不能为 null 以及 empty)
         */
        int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
    
        /**
         * 根据 ID 修改
         *
         * @param entity 实体对象
         */
        int updateById(@Param(Constants.ENTITY) T entity);
    
        /**
         * 根据 whereEntity 条件，更新记录
         *
         * @param entity        实体对象 (set 条件值,可以为 null)
         * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
         */
        int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
    
        /**
         * 根据 ID 查询
         *
         * @param id 主键ID
         */
        T selectById(Serializable id);
    
        /**
         * 查询（根据ID 批量查询）
         *
         * @param idList 主键ID列表(不能为 null 以及 empty)
         */
        List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
    
        /**
         * 查询（根据 columnMap 条件）
         *
         * @param columnMap 表字段 map 对象
         */
        List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
    
        /**
         * 根据 entity 条件，查询一条记录
         *
         * @param queryWrapper 实体对象封装操作类（可以为 null）
         */
        T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
        /**
         * 根据 Wrapper 条件，查询总记录数
         *
         * @param queryWrapper 实体对象封装操作类（可以为 null）
         */
        Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
        /**
         * 根据 entity 条件，查询全部记录
         *
         * @param queryWrapper 实体对象封装操作类（可以为 null）
         */
        List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
        /**
         * 根据 Wrapper 条件，查询全部记录
         *
         * @param queryWrapper 实体对象封装操作类（可以为 null）
         */
        List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
        /**
         * 根据 Wrapper 条件，查询全部记录
         * <p>注意： 只返回第一个字段的值</p>
         *
         * @param queryWrapper 实体对象封装操作类（可以为 null）
         */
        List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
        /**
         * 根据 entity 条件，查询全部记录（并翻页）
         *
         * @param page         分页查询条件（可以为 RowBounds.DEFAULT）
         * @param queryWrapper 实体对象封装操作类（可以为 null）
         */
        <E extends IPage<T>> E selectPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
        /**
         * 根据 Wrapper 条件，查询全部记录（并翻页）
         *
         * @param page         分页查询条件
         * @param queryWrapper 实体对象封装操作类
         */
        <E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    }

## 十，QueryWrapper介绍 ##

> 查询包装类，可以封装多数查询条件，泛型指定返回的实体类

List<BannerDO> list = bannerMapper.selectList(new QueryWrapper<BannerDO>());

[44469b4be46041f7b09238142976adca.png]: https://img-blog.csdnimg.cn/44469b4be46041f7b09238142976adca.png
[d620c3b712a14732b680696e36b4b04a.png]: https://img-blog.csdnimg.cn/d620c3b712a14732b680696e36b4b04a.png
[5b0b5e7c1b2e4d908c30ebe4c641788d.png]: https://img-blog.csdnimg.cn/5b0b5e7c1b2e4d908c30ebe4c641788d.png