com.mybatisflex.core

接口 BaseMapper<T>

public interface BaseMapper<T>

方法概要

限定符和类型	方法和说明
int	deleteBatchByIds(Collection<? extends Serializable> ids) 根据多个 id 批量删除数据
default int	deleteBatchByIds(List<? extends Serializable> ids, int size) 根据多个 id 批量删除数据
default int	deleteByCondition(QueryCondition condition) 根据条件来删除数据
int	deleteById(Serializable id) 根据 id 删除数据 如果是多个主键的情况下，需要传入数组 new Object[]{100,101}
default int	deleteByMap(Map<String,Object> whereConditions) 根据 map 构建的条件来删除数据
int	deleteByQuery(QueryWrapper queryWrapper) 根据 query 构建的条件来数据吗
default int	insert(T entity) 插入 entity 数据
int	insert(T entity, boolean ignoreNulls) 插入 entity 数据
int	insertBatch(List<T> entities) 批量插入 entity 数据，只会根据第一条数据来构建插入的字段内容
default int	insertBatch(List<T> entities, int size) 批量插入 entity 数据，按 size 切分
default int	insertOrUpdate(T entity) 新增 或者 更新，若主键有值，则更新，若没有主键值，则插入
default int	insertSelective(T entity) 插入 entity 数据，但是忽略 null 的数据，只对有值的内容进行插入 这样的好处是数据库已经配置了一些默认值，这些默认值才会生效
default Page<T>	paginate(int pageNumber, int pageSize, int totalRow, QueryCondition condition) 根据条件分页查询
default Page<T>	paginate(int pageNumber, int pageSize, int totalRow, QueryWrapper queryWrapper) 分页查询
default Page<T>	paginate(int pageNumber, int pageSize, QueryCondition condition) 根据条件分页查询
default Page<T>	paginate(int pageNumber, int pageSize, QueryWrapper queryWrapper) 分页查询
default Page<T>	paginate(Page<T> page, QueryWrapper queryWrapper, Consumer<FieldQueryBuilder<T>>... consumers) 分页查询
default <R> Page<R>	paginateAs(Page<R> page, QueryWrapper queryWrapper, Class<R> asType, Consumer<FieldQueryBuilder<R>>... consumers)
default List<T>	selectAll() 查询全部数据
default long	selectCountByCondition(QueryCondition condition) 根据条件查询数据总量
default long	selectCountByQuery(QueryWrapper queryWrapper) 查询数据量
org.apache.ibatis.cursor.Cursor<T>	selectCursorByQuery(QueryWrapper queryWrapper) 根据 query 来构建条件查询游标数据 Cursor 该方法必须在事务中才能正常使用，非事务下无法获取数据
default List<T>	selectListByCondition(QueryCondition condition) 根据 condition 来查询数据
default List<T>	selectListByCondition(QueryCondition condition, int count) 根据 condition 来查询数据
List<T>	selectListByIds(Collection<? extends Serializable> ids) 根据多个主键来查询多条数据
default List<T>	selectListByMap(Map<String,Object> whereConditions) 根据 map 来构建查询条件，查询多条数据
default List<T>	selectListByMap(Map<String,Object> whereConditions, int count) 根据 map 来构建查询条件，查询多条数据
List<T>	selectListByQuery(QueryWrapper queryWrapper) 根据 query 来构建条件查询数据列表
default List<T>	selectListByQuery(QueryWrapper queryWrapper, Consumer<FieldQueryBuilder<T>>... consumers)
default <R> List<R>	selectListByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 根据 query 来构建条件查询数据列表，要求返回的数据为 asType 这种场景一般用在 left join 时，有多出了 entity 本身的字段内容，可以转换为 dto、vo 等场景时
default <R> List<R>	selectListByQueryAs(QueryWrapper queryWrapper, Class<R> asType, Consumer<FieldQueryBuilder<R>>... consumers)
default Object	selectObjectByQuery(QueryWrapper queryWrapper) 根据 queryWrapper 1 条数据 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...
List<Object>	selectObjectListByQuery(QueryWrapper queryWrapper) 根据 queryWrapper 来查询数据列表 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...
default <R> List<R>	selectObjectListByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 对 selectObjectListByQuery(QueryWrapper) 进行数据转换 根据 queryWrapper 来查询数据列表 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...
default T	selectOneByCondition(QueryCondition condition) 根据 condition 来查询数据
T	selectOneById(Serializable id) 根据主键来选择数据
default T	selectOneByMap(Map<String,Object> whereConditions) 根据 map 构建的条件来查询数据
default T	selectOneByQuery(QueryWrapper queryWrapper) 根据 queryWrapper 构建的条件来查询 1 条数据
default <R> R	selectOneByQueryAs(QueryWrapper queryWrapper, Class<R> asType) 根据 queryWrapper 构建的条件来查询 1 条数据
default int	update(T entity) 根据主键来更新数据，若 entity 属性数据为 null，该属性不会新到数据库
int	update(T entity, boolean ignoreNulls) 根据主键来更新数据到数据库
default int	updateByCondition(T entity, boolean ignoreNulls, QueryCondition condition) 根据 condition 来更新数据
default int	updateByCondition(T entity, QueryCondition condition) 根据 condition 来更新数据
default int	updateByMap(T entity, Map<String,Object> map) 根据 map 构建的条件来更新数据
int	updateByQuery(T entity, boolean ignoreNulls, QueryWrapper queryWrapper) 根据 query 构建的条件来更新数据
default int	updateByQuery(T entity, QueryWrapper queryWrapper) 根据 query 构建的条件来更新数据
default int	updateNumberAddByQuery(LambdaGetter<T> fn, Number value, QueryWrapper queryWrapper) 执行类似 update table set field=field+1 where ...
int	updateNumberAddByQuery(String fieldName, Number value, QueryWrapper queryWrapper) 执行类似 update table set field=field+1 where ...

方法详细资料

insert

default int insert(T entity)

插入 entity 数据

参数:

entity - 实体类

返回:

返回影响的行数

insertSelective

default int insertSelective(T entity)

插入 entity 数据，但是忽略 null 的数据，只对有值的内容进行插入 这样的好处是数据库已经配置了一些默认值，这些默认值才会生效

参数:

entity - 实体类

返回:

返回影响的行数

insert

@InsertProvider(type=EntitySqlProvider.class,
                method="insert")
int insert(@Param(value="$$entity")
                                                                                          T entity,
                                                                                          @Param(value="$$ignoreNulls")
                                                                                          boolean ignoreNulls)

插入 entity 数据

参数:

entity - 实体类

返回:

返回影响的行数

另请参阅:

EntitySqlProvider.insert(Map, ProviderContext)

insertBatch

@InsertProvider(type=EntitySqlProvider.class,
                method="insertBatch")
int insertBatch(@Param(value="$$entities")
                                                                                                    List<T> entities)

批量插入 entity 数据，只会根据第一条数据来构建插入的字段内容

参数:

entities - 插入的数据列表

返回:

返回影响的行数

另请参阅:

EntitySqlProvider.insertBatch(Map, ProviderContext), FlexConsts.METHOD_INSERT_BATCH

insertBatch

default int insertBatch(List<T> entities,
                        int size)

批量插入 entity 数据，按 size 切分

参数:

entities - 插入的数据列表

size - 切分大小

返回:

影响行数

insertOrUpdate

default int insertOrUpdate(T entity)

新增 或者 更新，若主键有值，则更新，若没有主键值，则插入

参数:

entity - 实体类

返回:

返回影响的行数

deleteById

@DeleteProvider(type=EntitySqlProvider.class,
                method="deleteById")
int deleteById(@Param(value="$$primaryValue")
                                                                                                  Serializable id)

根据 id 删除数据 如果是多个主键的情况下，需要传入数组 new Object[]{100,101}

参数:

id - 主键数据

返回:

返回影响的行数

另请参阅:

EntitySqlProvider.deleteById(Map, ProviderContext)

deleteBatchByIds

@DeleteProvider(type=EntitySqlProvider.class,
                method="deleteBatchByIds")
int deleteBatchByIds(@Param(value="$$primaryValue")
                                                                                                              Collection<? extends Serializable> ids)

根据多个 id 批量删除数据

参数:

ids - ids 列表

返回:

返回影响的行数

另请参阅:

EntitySqlProvider.deleteBatchByIds(Map, ProviderContext)

deleteBatchByIds

default int deleteBatchByIds(List<? extends Serializable> ids,
                             int size)

根据多个 id 批量删除数据

参数:

ids - ids 列表

size - 切分大小

返回:

返回影响的行数

另请参阅:

EntitySqlProvider.deleteBatchByIds(Map, ProviderContext)

deleteByMap

default int deleteByMap(Map<String,Object> whereConditions)

根据 map 构建的条件来删除数据

参数:

whereConditions - 条件

返回:

返回影响的行数

deleteByCondition

default int deleteByCondition(QueryCondition condition)

根据条件来删除数据

参数:

condition - 条件

返回:

返回影响的行数

deleteByQuery

@DeleteProvider(type=EntitySqlProvider.class,
                method="deleteByQuery")
int deleteByQuery(@Param(value="$$query")
                                                                                                        QueryWrapper queryWrapper)

根据 query 构建的条件来数据吗

参数:

queryWrapper - query 条件

返回:

返回影响的行数

另请参阅:

EntitySqlProvider.deleteByQuery(Map, ProviderContext)

update

default int update(T entity)

根据主键来更新数据，若 entity 属性数据为 null，该属性不会新到数据库

参数:

entity - 数据内容，必须包含有主键

返回:

返回影响的行数

update

@UpdateProvider(type=EntitySqlProvider.class,
                method="update")
int update(@Param(value="$$entity")
                                                                                          T entity,
                                                                                          @Param(value="$$ignoreNulls")
                                                                                          boolean ignoreNulls)

根据主键来更新数据到数据库

参数:

entity - 数据内容

ignoreNulls - 是否忽略空内容字段

返回:

返回影响的行数

另请参阅:

EntitySqlProvider.update(Map, ProviderContext)

updateByMap

default int updateByMap(T entity,
                        Map<String,Object> map)

根据 map 构建的条件来更新数据

参数:

entity - 数据

map - where 条件内容

返回:

返回影响的行数

updateByCondition

default int updateByCondition(T entity,
                              QueryCondition condition)

根据 condition 来更新数据

参数:

entity - 数据

condition - 条件

返回:

返回影响的行数

updateByCondition

default int updateByCondition(T entity,
                              boolean ignoreNulls,
                              QueryCondition condition)

根据 condition 来更新数据

参数:

entity - 数据

ignoreNulls - 是否忽略 null 数据，默认为 true

condition - 条件

返回:

返回影响的行数

updateByQuery

default int updateByQuery(T entity,
                          QueryWrapper queryWrapper)

根据 query 构建的条件来更新数据

参数:

entity - 数据内容

queryWrapper - query 条件

返回:

返回影响的行数

updateByQuery

@UpdateProvider(type=EntitySqlProvider.class,
                method="updateByQuery")
int updateByQuery(@Param(value="$$entity")
                                                                                                        T entity,
                                                                                                        @Param(value="$$ignoreNulls")
                                                                                                        boolean ignoreNulls,
                                                                                                        @Param(value="$$query")
                                                                                                        QueryWrapper queryWrapper)

根据 query 构建的条件来更新数据

参数:

entity - 数据内容

ignoreNulls - 是否忽略空值

queryWrapper - query 条件

另请参阅:

EntitySqlProvider.updateByQuery(Map, ProviderContext)

updateNumberAddByQuery

@UpdateProvider(type=EntitySqlProvider.class,
                method="updateNumberAddByQuery")
int updateNumberAddByQuery(@Param(value="$$fieldName")
                                                                                                                          String fieldName,
                                                                                                                          @Param(value="$$value")
                                                                                                                          Number value,
                                                                                                                          @Param(value="$$query")
                                                                                                                          QueryWrapper queryWrapper)

执行类似 update table set field=field+1 where ... 的场景

参数:

fieldName - 字段名

value - 值（ >=0 加，小于 0 减）

queryWrapper - 条件

另请参阅:

EntitySqlProvider.updateNumberAddByQuery(Map, ProviderContext)

updateNumberAddByQuery

default int updateNumberAddByQuery(LambdaGetter<T> fn,
                                   Number value,
                                   QueryWrapper queryWrapper)

执行类似 update table set field=field+1 where ... 的场景

参数:

fn - 字段名

value - 值（ >=0 加，小于 0 减）

queryWrapper - 条件

另请参阅:

EntitySqlProvider.updateNumberAddByQuery(Map, ProviderContext)

selectOneById

@SelectProvider(type=EntitySqlProvider.class,
                method="selectOneById")
T selectOneById(@Param(value="$$primaryValue")
                                                                                                      Serializable id)

根据主键来选择数据

参数:

id - 多个主键

返回:

entity

另请参阅:

EntitySqlProvider.selectOneById(Map, ProviderContext)

selectOneByMap

default T selectOneByMap(Map<String,Object> whereConditions)

根据 map 构建的条件来查询数据

参数:

whereConditions - where 条件

返回:

entity 数据

selectOneByCondition

default T selectOneByCondition(QueryCondition condition)

根据 condition 来查询数据

参数:

condition - 条件

返回:

1 条数据

selectOneByQuery

default T selectOneByQuery(QueryWrapper queryWrapper)

根据 queryWrapper 构建的条件来查询 1 条数据

参数:

queryWrapper - query 条件

返回:

entity 数据

selectOneByQueryAs

default <R> R selectOneByQueryAs(QueryWrapper queryWrapper,
                                 Class<R> asType)

根据 queryWrapper 构建的条件来查询 1 条数据

参数:

queryWrapper - query 条件

asType - 接收类型

返回:

数据内容

selectListByIds

@SelectProvider(type=EntitySqlProvider.class,
                method="selectListByIds")
List<T> selectListByIds(@Param(value="$$primaryValue")
                                                                                                                Collection<? extends Serializable> ids)

根据多个主键来查询多条数据

参数:

ids - 主键列表

返回:

数据列表

另请参阅:

EntitySqlProvider.selectListByIds(Map, ProviderContext)

selectListByMap

default List<T> selectListByMap(Map<String,Object> whereConditions)

根据 map 来构建查询条件，查询多条数据

参数:

whereConditions - 条件列表

返回:

数据列表

selectListByMap

default List<T> selectListByMap(Map<String,Object> whereConditions,
                                int count)

根据 map 来构建查询条件，查询多条数据

参数:

whereConditions - 条件列表

返回:

数据列表

selectListByCondition

default List<T> selectListByCondition(QueryCondition condition)

根据 condition 来查询数据

参数:

condition - condition 条件

返回:

数据列表

selectListByCondition

default List<T> selectListByCondition(QueryCondition condition,
                                      int count)

根据 condition 来查询数据

参数:

condition - condition 条件

count - 数据量

返回:

数据列表

selectListByQuery

@SelectProvider(type=EntitySqlProvider.class,
                method="selectListByQuery")
List<T> selectListByQuery(@Param(value="$$query")
                                                                                                                    QueryWrapper queryWrapper)

根据 query 来构建条件查询数据列表

参数:

queryWrapper - 查询条件

返回:

数据列表

另请参阅:

EntitySqlProvider.selectListByQuery(Map, ProviderContext)

selectListByQuery

default List<T> selectListByQuery(QueryWrapper queryWrapper,
                                  Consumer<FieldQueryBuilder<T>>... consumers)

selectCursorByQuery

@SelectProvider(type=EntitySqlProvider.class,
                method="selectListByQuery")
org.apache.ibatis.cursor.Cursor<T> selectCursorByQuery(@Param(value="$$query")
                                                                                                                                                 QueryWrapper queryWrapper)

根据 query 来构建条件查询游标数据 Cursor 该方法必须在事务中才能正常使用，非事务下无法获取数据

参数:

queryWrapper - 查询条件

返回:

游标数据 Cursor

selectListByQueryAs

default <R> List<R> selectListByQueryAs(QueryWrapper queryWrapper,
                                        Class<R> asType)

根据 query 来构建条件查询数据列表，要求返回的数据为 asType 这种场景一般用在 left join 时，有多出了 entity 本身的字段内容，可以转换为 dto、vo 等场景时

参数:

queryWrapper - 查询条件

asType - 接收数据类型

返回:

数据列表

selectListByQueryAs

default <R> List<R> selectListByQueryAs(QueryWrapper queryWrapper,
                                        Class<R> asType,
                                        Consumer<FieldQueryBuilder<R>>... consumers)

selectAll

default List<T> selectAll()

查询全部数据

返回:

数据列表

selectObjectByQuery

default Object selectObjectByQuery(QueryWrapper queryWrapper)

根据 queryWrapper 1 条数据 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...

参数:

queryWrapper - 查询包装器

返回:

数据量

selectObjectListByQuery

@SelectProvider(type=EntitySqlProvider.class,
                method="selectObjectByQuery")
List<Object> selectObjectListByQuery(@Param(value="$$query")
                                                                                                                                 QueryWrapper queryWrapper)

根据 queryWrapper 来查询数据列表 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...

参数:

queryWrapper - 查询包装器

返回:

数据列表

另请参阅:

EntitySqlProvider.selectObjectByQuery(Map, ProviderContext)

selectObjectListByQueryAs

default <R> List<R> selectObjectListByQueryAs(QueryWrapper queryWrapper,
                                              Class<R> asType)

对 selectObjectListByQuery(QueryWrapper) 进行数据转换 根据 queryWrapper 来查询数据列表 queryWrapper 执行的结果应该只有 1 列，例如 QueryWrapper.create().select(ACCOUNT.id).where...

参数:

queryWrapper - 查询包装器

asType - 转换成的数据类型

返回:

数据列表

selectCountByQuery

default long selectCountByQuery(QueryWrapper queryWrapper)

查询数据量

参数:

queryWrapper - 查询包装器

返回:

数据量

selectCountByCondition

default long selectCountByCondition(QueryCondition condition)

根据条件查询数据总量

参数:

condition - 条件

返回:

数据量

paginate

default Page<T> paginate(int pageNumber,
                         int pageSize,
                         QueryWrapper queryWrapper)

分页查询

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

queryWrapper - 查询条件

返回:

返回 Page 数据

paginate

default Page<T> paginate(int pageNumber,
                         int pageSize,
                         QueryCondition condition)

根据条件分页查询

参数:

pageNumber - 当前页面

pageSize - 每页的数据量

condition - 查询条件

返回:

返回 Page 数据

paginate

default Page<T> paginate(int pageNumber,
                         int pageSize,
                         int totalRow,
                         QueryWrapper queryWrapper)

分页查询

参数:

pageNumber - 当前页码

pageSize - 每页的数据量

totalRow - 数据总量

queryWrapper - 查询条件

返回:

返回 Page 数据

paginate

default Page<T> paginate(int pageNumber,
                         int pageSize,
                         int totalRow,
                         QueryCondition condition)

根据条件分页查询

参数:

pageNumber - 当前页面

pageSize - 每页的数据量

totalRow - 数据总量

condition - 查询条件

返回:

返回 Page 数据

paginate

default Page<T> paginate(Page<T> page,
                         QueryWrapper queryWrapper,
                         Consumer<FieldQueryBuilder<T>>... consumers)

分页查询

参数:

page - page，其包含了页码、每页的数据量，可能包含数据总量

queryWrapper - 查询条件

返回:

page 数据

paginateAs

default <R> Page<R> paginateAs(Page<R> page,
                               QueryWrapper queryWrapper,
                               Class<R> asType,
                               Consumer<FieldQueryBuilder<R>>... consumers)