Mybatis-Plus学习笔记


阅读数: 次   

Mybatis-Plus学习笔记

一、Mybatis-Plus

1、mybatis-plus

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

国内的公司，苞米豆。在mybatis的基础上开发的。

2、支持数据库

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

达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库

3、框架结构

img

二、快速搭建

1、创建springboot项目

2、搭建mybatis-plus

（1）依赖

1
2
3
4
5
6
<!--mybatis plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3</version>
</dependency>

（2）配置数据源

1
2
3
4
5
#数据源
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql:///mp?serverTimezone=Asia/Shanghai

（3）启动测试

1
2
3
4
5
6
7
@SpringBootApplication
public class MybatisPlusDemoApplication {

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

3、开发体验

（1）实体类

建立映射

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.example.mybatisplusdemo.domain;

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.sun.javafx.beans.IDProperty;
import lombok.Data;

import java.util.Date;

@Data
public class User {
    @TableId
    private  int  uid;
    private  String  username;
    private  String  passwd;
    @TableField(value = "regTime")
    private Date regTime;
}

（2）mapper

1
2
3
4
5
6
7
8
9
10
package com.example.mybatisplusdemo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.mybatisplusdemo.domain.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {

}

（3）测试类

1
2
3
4
5
6
7
8
9
10
11
12
@SpringBootTest
class MybatisPlusDemoApplicationTests {
    @Autowired
    private UserMapper  userMapper;

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

}

三、常用注解

1、@TableName

  • 描述：表名注解
属性 类型 必须指定 默认值 描述
value String 否 “” 表名
schema String 否 “” schema
keepGlobalPrefix boolean 否 false 是否保持使用全局的 tablePrefix 的值(如果设置了全局 tablePrefix 且自行设置了 value 的值)
resultMap String 否 “” xml 中 resultMap 的 id
autoResultMap boolean 否 false 是否自动构建 resultMap 并使用(如果设置 resultMap 则不会进行 resultMap 的自动构建并注入)
excludeProperty String[] 否 {} 需要排除的属性名(@since 3.3.1)

2、@TableId

  • 描述：主键注解
属性 类型 必须指定 默认值 描述
value String 否 “” 主键字段名
type Enum 否 IdType.NONE 主键类型

IdType

值 描述
AUTO 数据库ID自增
NONE 无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
INPUT insert前自行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)
UUID 32位UUID字符串(please use ASSIGN_UUID)
ID_WORKER_STR 分布式全局唯一ID 字符串类型(please use ASSIGN_ID)

3、@TableField

  • 描述：字段注解(非主键)
属性 类型 必须指定 默认值 描述
value String 否 “” 数据库字段名
el String 否 “” 映射为原生 #{ ... } 逻辑,相当于写在 xml 里的 #{ ... } 部分
exist boolean 否 true 是否为数据库表字段
condition String 否 “” 字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s},参考(opens new window)
update String 否 “” 字段 update set 部分注入, 例如：update=”%s+1”：表示更新时会set version=version+1(该属性优先级高于 el 属性)
insertStrategy Enum N DEFAULT 举例：NOT_NULL: insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)
updateStrategy Enum N DEFAULT 举例：IGNORED: update table_a set column=#{columnProperty}
whereStrategy Enum N DEFAULT 举例：NOT_EMPTY: where <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>
fill Enum 否 FieldFill.DEFAULT 字段自动填充策略
select boolean 否 true 是否进行 select 查询
keepGlobalFormat boolean 否 false 是否保持使用全局的 format 进行处理
jdbcType JdbcType 否 JdbcType.UNDEFINED JDBC类型 (该默认值不代表会按照该值生效)
typeHandler Class<? extends TypeHandler> 否 UnknownTypeHandler.class 类型处理器 (该默认值不代表会按照该值生效)
numericScale String 否 “” 指定小数点后保留的位数

FieldStrategy

值 描述
IGNORED 忽略判断
NOT_NULL 非NULL判断
NOT_EMPTY 非空判断(只对字符串类型字段,其他类型字段依然为非NULL判断)
DEFAULT 追随全局配置

FieldFill

值 描述
DEFAULT 默认不处理
INSERT 插入时填充字段
UPDATE 更新时填充字段
INSERT_UPDATE 插入和更新时填充字段

4、@OrderBy

  • 描述：内置 SQL 默认指定排序，优先级低于 wrapper 条件查询
属性 类型 必须指定 默认值 描述
isDesc boolean 否 是 是否倒序查询
sort short 否 Short.MAX_VALUE 数字越小越靠前

四、对Mapper的封装

1
2
3
4
5
6
说明:

通用 CRUD 封装BaseMapper (opens new window)接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器
泛型 T 为任意实体对象
参数 Serializable 为任意类型主键 Mybatis-Plus 不推荐使用复合主键约定每一张表都有自己的唯一 id 主键
对象 Wrapper 为 条件构造器

编写Mapper：

1
2
3
4
@Mapper
public interface UserMapper extends BaseMapper<User> {

}

1、 Insert方法

image-20211210153753195

1
2
3
4
5
6
7
8
9
10
11
12
/**
 * 添加用户
 */
@Test
void   test11(){
    User  user=new User();
    user.setUsername("maliu");
    user.setPasswd("123");
    user.setRegTime(new Date());
    int i = userMapper.insert(user);
    System.out.println(i);
}

2、Delete方法

image-20211210153819281

1
2
3
4
5
6
7
8
/**
 * 删除用户：根据主键删除
 */
@Test
void   test12(){
    int i = userMapper.deleteById(1);
    System.out.println(i);
}
1
2
3
4
5
6
7
8
9
10
11
12
/**
 * 删除用户：根据主键批量删除
 */
@Test
void   test13(){
    List<Integer>   idList=new ArrayList<>();
    idList.add(1);
    idList.add(2);
    idList.add(3);
    int i = userMapper.deleteBatchIds(idList);
    System.out.println(i);
}
1
2
3
4
5
6
7
8
9
10
/**
 * 删除用户：根据条件删除
 */
@Test
void   test14(){
    Map<String,Object> map=new HashMap<>();
    map.put("username","zhangsan");
    int i = userMapper.deleteByMap(map);
    System.out.println(i);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
/**
 * 删除用户：根据Wrapper条件删除
 */
@Test
void   test15(){
    //Wrapper用于封装条件的
    //UpdateWrapper用于删除和修改的条件，QueryWrapper用于查询的条件
    UpdateWrapper<User>  wrapper=new UpdateWrapper<>();
    wrapper.eq("username","lisi");

    int i = userMapper.delete(wrapper);
    System.out.println(i);
}

3、Update方法

image-20211210153911418

1
2
3
4
5
6
7
8
9
10
11
12
/**
 * 修改用户：根据主键修改
 * 只修改设置的字段，没有设置字段不修改
 */
@Test
void   test16(){
    User user=new  User();
    user.setUid(4);
    user.setRegTime(new  Date());
    int i = userMapper.updateById(user);
    System.out.println(i);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
 * 修改用户：根据主键修改
 * 只修改设置的字段，没有设置字段不修改
 */
@Test
void   test17(){
    User user=new  User();
    user.setRegTime(new  Date());

    UpdateWrapper<User>  updateWrapper=new UpdateWrapper<>();
    updateWrapper.eq("passwd","123");

    int i = userMapper.update(user,updateWrapper);
    System.out.println(i);
}

4、Select方法

image-20211210153952690

image-20211210154017555

1
2
3
4
5
6
7
8
/**
 * 查询用户：根据 ID 查询
 */
@Test
void   test18(){
    User user = userMapper.selectById(4);
    System.out.println(user);
}
1
2
3
4
5
6
7
8
9
10
11
12
/**
     * 查询用户：根据 QueryWrapper 查询
     */
    @Test
    void   test19(){
        QueryWrapper<User> queryWrapper=new QueryWrapper<>();
        queryWrapper.eq("username","zhangsan");
//        queryWrapper.eq("passwd","123");
//        只能最多返回一条
        User user = userMapper.selectOne(queryWrapper);
        System.out.println(user);
    }
1
2
3
4
5
6
7
8
9
10
/**
 * 查询用户：根据 QueryWrapper 查询多条
 */
@Test
void   test20(){
    QueryWrapper<User> queryWrapper=new QueryWrapper<>();
    queryWrapper.eq("passwd","123");
    List<User> userList = userMapper.selectList(queryWrapper);
    userList.forEach(e-> System.out.println(e));
}
1
2
3
4
5
6
7
8
9
10
/**
 * 查询数量统计
 */
@Test
void   test21(){
    QueryWrapper<User> queryWrapper=new QueryWrapper<>();
    queryWrapper.eq("passwd","123");
    Integer count = userMapper.selectCount(queryWrapper);
    System.out.println(count);
}

五、对Service的封装

1
2
3
4
5
6
说明:

通用 Service CRUD 封装IService 接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆，
泛型 T 为任意实体对象
建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类
对象 Wrapper 为 条件构造器
1
2
3
4
5
6
7
8
package com.example.springbootmybatisplusdemo.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.example.springbootmybatisplusdemo.domain.User;

public interface UserService extends IService<User> {

}
1
2
3
4
5
6
7
8
9
10
11
12
package com.example.springbootmybatisplusdemo.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.springbootmybatisplusdemo.domain.User;
import com.example.springbootmybatisplusdemo.mapper.UserMapper;
import com.example.springbootmybatisplusdemo.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {

}

1、Save方法

1
2
3
4
5
6
7
// 插入一条记录（选择字段，策略插入）
boolean save(T entity);
// 插入（批量）
boolean saveBatch(Collection<T> entityList);

// TableId 注解存在更新记录，否插入一条记录
boolean saveOrUpdate(T entity);

2、Remove方法

1
2
3
4
// 根据 entity 条件，删除记录
boolean remove(Wrapper<T> queryWrapper);
// 根据 ID 删除
boolean removeById(Serializable id);

3、Update方法

1
2
3
4
// 根据 whereWrapper 条件，更新记录
boolean update(T updateEntity, Wrapper<T> whereWrapper);
// 根据 ID 选择修改
boolean updateById(T entity);

4、Get方法

查询单条

1
2
// 根据 ID 查询
T getById(Serializable id);

5、List方法

查询多条

1
2
3
4
5
// 查询所有
List<T> list();
// 查询列表
List<T> list(Wrapper<T> queryWrapper);
// 查询（根据ID 批量查询）

6、Page方法

1
2
3
4
// 无条件分页查询
IPage<T> page(IPage<T> page);
// 条件分页查询
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);

7、Count方法

1
2
3
4
// 查询总记录数
int count();
// 根据 Wrapper 条件，查询总记录数
int count(Wrapper<T> queryWrapper);

8、Chain链式操作

1
2
3
4
5
6
7
8
// 链式查询 普通
QueryChainWrapper<T> query();
// 链式查询 lambda 式。注意：不支持 Kotlin
LambdaQueryChainWrapper<T> lambdaQuery();

// 示例：
query().eq("column", value).one();
lambdaQuery().eq(Entity::getId, value).list();
1
2
3
4
5
6
7
8
// 链式更改 普通
UpdateChainWrapper<T> update();
// 链式更改 lambda 式。注意：不支持 Kotlin
LambdaUpdateChainWrapper<T> lambdaUpdate();

// 示例：
update().eq("column", value).remove();
lambdaUpdate().eq(Entity::getId, value).update(entity);

六、条件查询器

1、AbstractWrapper

1
2
3
4
5
说明:

QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类
用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件
注意: entity 生成的 where 条件与 使用各个 api 生成的 where 条件没有任何关联行为

2、条件

七、主键生成

八、分页插件

1、设置分页插件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package com.example.mybatisplusdemo.config;

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisPlusConfig {

    /**
     * 新版分页插件设置
     * @return
     */
    @Bean
    public MybatisPlusInterceptor getPaginationInnerInterceptor(){
        MybatisPlusInterceptor  interceptor=new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return  interceptor;
    }
}

2、分页查询mapper

1
2
3
4
5
6
7
8
9
10
11
12
/**
 * 分页查询
 */
@Test
void   test22(){
    Page<User>   page=new Page<>(2,3);
    QueryWrapper<User> queryWrapper =new QueryWrapper<>();
    queryWrapper.eq("passwd","123");
    Page<User> userPage = userMapper.selectPage(page, queryWrapper);
    List<User> records = userPage.getRecords();
    records.forEach(System.out::println);
}
赏

老板大气

支付宝
微信

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

很惭愧<br><br>只做了一点微小的工作<br>谢谢大家