MyBatisPlus集成 - 乐耶园

1-5 MyBatisPlus集成

接下来我们完成一个品牌的CRUD操作、我们会集成MyBatisPlus来实现。

1、MyBatis Plus介绍

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

MyBatis Plus特性：

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

支持的数据库：

mysql 、mariadb 、oracle 、db2 、h2 、hsql 、sqlite 、postgresql 、sqlserver 、presto 、Gauss 、Firebird
Phoenix 、clickhouse 、Sybase ASE 、 OceanBase 、达梦数据库、虚谷数据库、人大金仓数据库、南大通用数据库、

2、MyBatisPlus集成

1)引入依赖包

在 mall-service-dependency 中引入如下依赖( 这个依赖包之前已经引入了，这里无需再次引入 )：

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

在 mall-api 中引入如下依赖( 编写JavaBean会用到MyBatis Plus的相关注解，引入依赖防止程序编译不通过 )：

 
 <!--MyBatis Plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>.3.2</version>
    <scope>provided</scope>
</dependency>

2)创建 goods-api 工程

在 mall -api 中创建子工程 goods-api ，用于创建 shop_goods 数据库表对应的实体Bean和Feign接口。

pom .xml:

 
 <?xml version=".0" encoding="UTF-8"?>
<project xmlns="#;
         xmlns:xsi="#;
         xsi:schemaLocation=" #;>
    <parent>
        <artifactId>mall-api</artifactId>
        <groupId>com.bobo.vip.mall</groupId>
        <version>.0-SNAPSHOT</version>
    </parent>
    <modelVersion>.0.0</modelVersion>
 
    <artifactId>goods-api</artifactId>
 
    <description>
        shop_goods数据库表对应的JavaBean
    </description>
 
</project>

在 goods-api 中创建 com.bobo.vip.mall.goods. Brand ，代码如下：

 
 package com.bobo.vip.mall.goods.model;
 
import com.baomidou.mybatisplus. annotation .IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
@Data
@AllArgsConstructor
@NoArgsConstructor
// MyBatisPlus 表映射注解
@TableName(value = "brand")
public class Brand {
 
    //    品牌ID
    //    MyBatisPlus主键策略注解
    @TableId(type= IdType.AUTO)
    private Integer id;
    //    品牌名字
    private String name;
    //    品牌图片
    private String image;
    //    品牌首字母
    private String initial;
    //    品牌排序
    private Integer sort;
}

主键生成策略

AUTO数据库ID自增 NONE无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT) INPUTinsert前自行set主键值 ASSIGN_ID分配ID(主键类型为Number(Long和Integer)或String)(since 3.3.0),使用接口 IdentifierGenerator 的方法 nextId (默认实现类为 DefaultIdentifierGenerator 雪花算法) ASSIGN_UUID分配UUID,主键类型为String(since 3.3.0),使用接口 IdentifierGenerator 的方法 nextUUID (默认default方法) ID_WORKER分布式全局唯一ID 长整型类型(please use ASSIGN_ID ) ，已过时 UUID32位UUID字符串(please use ASSIGN_UUID ) ，已过时 ID_WORKER_STR分布式全局唯一ID 字符串类型(please use ASSIGN_ID ) ，已过时

项目工程结构如下:

3)商品微服务

在 mall-service 中创建 mall-goods-service 微服务，用于操作 shop_goods 数据库。

pom.xml代码如下：

 
 <?xml version=".0" encoding="UTF-8"?>
<project xmlns="#;
         xmlns:xsi="#;
         xsi:schemaLocation=" #;>
    <parent>
        <artifactId>mall-service</artifactId>
        <groupId>com.bobo.vip.mall</groupId>
        <version>.0-SNAPSHOT</version>
    </parent>
    <modelVersion>.0.0</modelVersion>
 
    <artifactId>mall-goods-service</artifactId>
    <description>
        shop_goods微服务
    </description>
 
    <dependencies>
        <!--goods-api依赖-->
        <dependency>
            <groupId>com.bobo.vip.mall</groupId>
            <artifactId>goods-api</artifactId>
            <version>.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
 
</project>

创建 bootstrap.yml ，配置如下：

 
 server:
  port:
spring:
  application:
    name: mall-goods
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://.168.100.140:3306/shop_goods?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
    username: root
    password:
  cloud:
    nacos:
      config:
        file-extension: yaml
        server-addr:.168.100.140:8848
      discovery:
        #Nacos的注册地址
        server-addr:.168.100.140:8848
# ====================MybatisPlus====================
mybatis-plus:
  mapper-locations: mapper/*.xml
  type-aliases-package: com.bobo.vip.mall.*.model
  configuration:
    map-underscore-to-camel-case: true
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
 
#日志配置
logging:
  pattern:
    console: "%msg%n"

配置说明：

 
 type-aliases-package:指定JavaBean的别名包，和MyBatis用法一样。
mapper-locations:复杂的操作可能需要自己写SQL，SQL可以写到xml文件中，这里指定和Dao对应的xml文件，此时我们需要在resources中创建一个mapper目录。
map-underscore-to-camel-case:开启驼峰功能，数据库表列名如果有_，可以自动按驼峰命名规则转换。
log-impl:日志开启，方便测试。

创建启动类 com.bobo.vip.mall.MallGoodsServiceApplication ：

 
 @SpringBootApplication
@MapperScan(basePackages = {"com.bobo.vip.mall.goods.mapper"})
public class MallGoodsServiceApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(MallGoodsServiceApplication.class,args);
    }
}

此时启动程序，查看Nacos控制台：账号和密码都是nacos，效果如下：

3、MyBatisPlus操作案例

我们创建一个品牌操作的功能，实现品牌增删改查，分别创建 model 、 mapper 、 service 、 controller 。

MyBatisPlus提供了很多通用方法：

 
 mapper(接口)->extends BaseMapper【增删改查】
service(接口)->extends IService【增删改查】
serviceImpl->extends ServiceImpl【增删改查】

3.1 Mapper创建

在 mall-goods-service 创建 com.bobo.vip.mall.goods.mapper.BrandMapper 接口，代码如下：

 
 public interface BrandMapper extends BaseMapper<Brand> {
}

代码说明：BaseMapper中已经存在了很多常见数据库操作方法，可以大幅提升开发速度。

3.2 Service创建

在 mall-goods-service 创建 com.bobo.vip.mall.goods.service.BrandService 接口，代码如下：

 
 public interface BrandService extends IService<Brand>{
}

在 mall-goods-service 创建 com.bobo.vip.mall.goods.service.impl.BrandServiceImpl 实现类，代码如下：

 
 @Service
public class BrandServiceImpl extends ServiceImpl<BrandMapper,Brand> implements BrandService {}

代码说明： IService 和 ServiceImpl 中已经创建好了很多常用的增删改查方法，我们写常用的增删改查，几乎不用写方法。

3.3 增删改功能

增删改功能在 IService 和 ServiceImpl 中已经全部存在，不需要额外添加方法，只需要在Controller调用即可。

在 mall-goods-service 创建 com.bobo.vip.mall.goods.controller.BrandController ，代码如下：

 
 @RestController
@RequestMapping("/brand")
public class BrandController {
 
    @Autowired
    private BrandService service;
 
    /**
     * 添加品牌
     * @param brand
     * @return
     */    @PostMapping
    public RespResult save(@RequestBody Brand brand){
        service.save(brand);
        return RespResult.ok();
    }
 
    /****
     * 修改
     */    @PutMapping
    public RespResult update(@RequestBody Brand brand){
        //修改品牌
        service.updateById(brand);
        return RespResult.ok();
    }
 
    /****
     * 删除品牌
     */    @DeleteMapping("/{id}")
    public RespResult delete(@PathVariable(value = "id") Integer id){
        //删除品牌
        service.removeById(id);
        return RespResult.ok();
    }
}

重启服务然后我们通过Postman来测试即可

表结构中原有数据

Postman中的数据

点击 Send 后查看数据库中数据

操作成功

修改删除操作是一样的，就不再截图演示了，大家可以自行尝试下哦！

4.4 条件查询/分页

条件查询需要封装条件信息，MyBatis Plus提供了条件封装对象 Wrapper （它的子类 QueryWrapper 可以直接使用），我们可以用它的子类 QueryWrapper 实现封装查询条件。

4.4.1 条件查询

在 BrandService 中创建如下方法：


 List<Brand> queryList(Brand brand);

在 BrandServiceImpl 中创建条件查询方法实现(不要忘了注入 brandMapper )：

 
 /**
 * 多条件查询
 * @param brand
 * @return
 */    @Override
public List<Brand> queryList(Brand brand) {
    // 多条件构造器
    QueryWrapper<Brand> queryWrapper = new QueryWrapper<>();
     if(brand != null){
        if(!StringUtils.isEmpty(brand.getName())){
            queryWrapper.like("name",brand.getName());
        }
        if(!StringUtils.isEmpty(brand.getInitial())){
            queryWrapper.eq("initial",brand.getInitial());
        }
    }
     return mapper.selectList(queryWrapper);
}

代码说明：

 
 like:表示模糊查询
eq:表示等值查询

在 BrandController 中创建条件查询方法：

 
 /****
 * 条件查询
 */@PostMapping(value = "/list")
public RespResult<List<Brand>> list(@RequestBody(required = false) Brand brand){
    // 查询
    List<Brand> brands = brandService.queryList(brand);
    return RespResult.ok(brands);
}

不带参数查询所有的数据

带参数查询

4.4.2 分页查询

在 BrandService 中创建如下方法：


 Page<Brand> queryPageList(Long currentPage,Long size,Brand brand);

在 BrandServiceImpl 中创建条件查询方法实现(不要忘了注入 brandMapper )：

 
 /***
 * 分页查询
 * @param brand
 * @return
 */@Override
public Page<Brand> queryPageList(Long currentPage, Long size, Brand brand) {
    // 封装查询条件
    Page<Brand> page = brandMapper.selectPage(
            new Page<Brand>(currentPage, size),
            new QueryWrapper<Brand>()
                    .like("name", brand.getName()));
    return page;
}

代码说明：


 like:表示模糊查询

在 BrandController 中创建条件查询方法：

 
 /****
 * 条件分页查询
 */@PostMapping(value = "/list/{page}/{size}")
public RespResult<Page<Brand>> list(
        @PathVariable(value = "page")Long currentPage,
        @PathVariable(value = "size")Long size,
        @RequestBody(required = false) Brand brand){
    // 分页查询
    Page<Brand> brandPage = brandService.queryPageList(currentPage,size,brand);
    return RespResult.ok(brandPage);
}

我们还在往Spring容器中注入一个分页的拦截器，不然分页效果不会有效

 
 package com.bobo.vip.mall;
 
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
 
@SpringBootApplication
@MapperScan(basePackages = {"com.bobo.vip.mall.goods.mapper"})
public class MallGoodsServiceApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(MallGoodsServiceApplication.class,args);
    }
 
 
    /**
     * 往容器中注入分页的拦截器
     * @return
     */    @Bean
    public PaginationInterceptor paginationInterceptor(){
        PaginationInterceptor interceptor = new PaginationInterceptor();
        // 设置数据库的类型
        interceptor.setDbType(DbType.MYSQL);
        return interceptor;
    }
}

分页查询的效果如下

搞定~

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

	<?xml version=".0" encoding="UTF-8"?>
	<project xmlns="#;
	xmlns:xsi="#;
	xsi:schemaLocation=" #;>
	<parent>
	<artifactId>mall-api</artifactId>
	<groupId>com.bobo.vip.mall</groupId>
	<version>.0-SNAPSHOT</version>
	</parent>
	<modelVersion>.0.0</modelVersion>

	<artifactId>goods-api</artifactId>

	<description>
	shop_goods数据库表对应的JavaBean
	</description>

	</project>

	package com.bobo.vip.mall.goods.model;

	import com.baomidou.mybatisplus. annotation .IdType;
	import com.baomidou.mybatisplus.annotation.TableId;
	import com.baomidou.mybatisplus.annotation.TableName;
	import lombok.AllArgsConstructor;
	import lombok.Data;
	import lombok.NoArgsConstructor;

	@Data
	@AllArgsConstructor
	@NoArgsConstructor
	// MyBatisPlus 表映射注解
	@TableName(value = "brand")
	public class Brand {

	// 品牌ID
	// MyBatisPlus主键策略注解
	@TableId(type= IdType.AUTO)
	private Integer id;
	// 品牌名字
	private String name;
	// 品牌图片
	private String image;
	// 品牌首字母
	private String initial;
	// 品牌排序
	private Integer sort;
	}

	server:
	port:
	spring:
	application:
	name: mall-goods
	datasource:
	driver-class-name: com.mysql.cj.jdbc.Driver
	url: jdbc:mysql://.168.100.140:3306/shop_goods?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
	username: root
	password:
	cloud:
	nacos:
	config:
	file-extension: yaml
	server-addr:.168.100.140:8848
	discovery:
	#Nacos的注册地址
	server-addr:.168.100.140:8848
	# ====================MybatisPlus====================
	mybatis-plus:
	mapper-locations: mapper/*.xml
	type-aliases-package: com.bobo.vip.mall.*.model
	configuration:
	map-underscore-to-camel-case: true
	log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

	#日志配置
	logging:
	pattern:
	console: "%msg%n"

	type-aliases-package:指定JavaBean的别名包，和MyBatis用法一样。
	mapper-locations:复杂的操作可能需要自己写SQL，SQL可以写到xml文件中，这里指定和Dao对应的xml文件，此时我们需要在resources中创建一个mapper目录。
	map-underscore-to-camel-case:开启驼峰功能，数据库表列名如果有_，可以自动按驼峰命名规则转换。
	log-impl:日志开启，方便测试。

	@SpringBootApplication
	@MapperScan(basePackages = {"com.bobo.vip.mall.goods.mapper"})
	public class MallGoodsServiceApplication {

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

	mapper(接口)->extends BaseMapper【增删改查】
	service(接口)->extends IService【增删改查】
	serviceImpl->extends ServiceImpl【增删改查】

	@Service
	public class BrandServiceImpl extends ServiceImpl<BrandMapper,Brand> implements BrandService {}

	@RestController
	@RequestMapping("/brand")
	public class BrandController {

	@Autowired
	private BrandService service;

	/**
	* 添加品牌
	* @param brand
	* @return
	*/ @PostMapping
	public RespResult save(@RequestBody Brand brand){
	service.save(brand);
	return RespResult.ok();
	}

	/****
	* 修改
	*/ @PutMapping
	public RespResult update(@RequestBody Brand brand){
	//修改品牌
	service.updateById(brand);
	return RespResult.ok();
	}

	/****
	* 删除品牌
	*/ @DeleteMapping("/{id}")
	public RespResult delete(@PathVariable(value = "id") Integer id){
	//删除品牌
	service.removeById(id);
	return RespResult.ok();
	}
	}

	/**
	* 多条件查询
	* @param brand
	* @return
	*/ @Override
	public List<Brand> queryList(Brand brand) {
	// 多条件构造器
	QueryWrapper<Brand> queryWrapper = new QueryWrapper<>();
	if(brand != null){
	if(!StringUtils.isEmpty(brand.getName())){
	queryWrapper.like("name",brand.getName());
	}
	if(!StringUtils.isEmpty(brand.getInitial())){
	queryWrapper.eq("initial",brand.getInitial());
	}
	}
	return mapper.selectList(queryWrapper);
	}

	/****
	* 条件查询
	*/@PostMapping(value = "/list")
	public RespResult<List<Brand>> list(@RequestBody(required = false) Brand brand){
	// 查询
	List<Brand> brands = brandService.queryList(brand);
	return RespResult.ok(brands);
	}

	/***
	* 分页查询
	* @param brand
	* @return
	*/@Override
	public Page<Brand> queryPageList(Long currentPage, Long size, Brand brand) {
	// 封装查询条件
	Page<Brand> page = brandMapper.selectPage(
	new Page<Brand>(currentPage, size),
	new QueryWrapper<Brand>()
	.like("name", brand.getName()));
	return page;
	}

	/****
	* 条件分页查询
	*/@PostMapping(value = "/list/{page}/{size}")
	public RespResult<Page<Brand>> list(
	@PathVariable(value = "page")Long currentPage,
	@PathVariable(value = "size")Long size,
	@RequestBody(required = false) Brand brand){
	// 分页查询
	Page<Brand> brandPage = brandService.queryPageList(currentPage,size,brand);
	return RespResult.ok(brandPage);
	}

	package com.bobo.vip.mall;

	import com.baomidou.mybatisplus.annotation.DbType;
	import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
	import org.mybatis.spring.annotation.MapperScan;
	import org.springframework.boot.SpringApplication;
	import org.springframework.boot.autoconfigure.SpringBootApplication;
	import org.springframework.context.annotation.Bean;

	@SpringBootApplication
	@MapperScan(basePackages = {"com.bobo.vip.mall.goods.mapper"})
	public class MallGoodsServiceApplication {

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


	/**
	* 往容器中注入分页的拦截器
	* @return
	*/ @Bean
	public PaginationInterceptor paginationInterceptor(){
	PaginationInterceptor interceptor = new PaginationInterceptor();
	// 设置数据库的类型
	interceptor.setDbType(DbType.MYSQL);
	return interceptor;
	}
	}