MapperUtils (ibit-mybatis-码云(gitee.com))

java.lang.Object
- tech.ibit.mybatis.utils.MapperUtils

```
public class MapperUtils
extends Object
```
Mapper工具类

Author:

IBIT程序猿

Constructor Summary

Constructors
Constructor and Description

MapperUtils()

Constructors
Constructor and Description
`MapperUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addExactKeywords(WhereSupport<?> sql, String keyword, List<Column> searchColumns, List<Column> exactSearchColumns)` 增加精确搜索关键字
`static void`	`addKeywords(WhereSupport<?> sql, String keyword, List<Column> searchColumns)` 增加关键字查询参数
`static <T> void`	`batchUpdateById(Mapper<T> mapper, List<T> entities)` 通过主键批量更新实体
`static <T> void`	`batchUpdateById(Mapper<T> mapper, List<T> entities, List<Column> columns)` 通过主键批量更新实体
`static <T> void`	`batchUpdateByIdAndIgnoreColumns(Mapper<T> mapper, List<T> entities, List<Column> ignoreColumns)` 通过主键更新非忽略的列
`static <T,K> int`	`deleteById(SingleIdMapper<T,K> mapper, K id)` 通过主键删除
`static <T,K> int`	`deleteByIds(SingleIdMapper<T,K> mapper, Collection<K> ids)` 通过主键批量删除
`static <T,K extends MultiId> int`	`deleteByMultiId(MultipleIdMapper<T,K> mapper, K id)` 通过主键删除
`static <T,K extends MultiId> int`	`deleteByMultiIds(MultipleIdMapper<T,K> mapper, Collection<K> ids)` 通过主键批量删除
`static <T> int`	`deleteByUniqueKey(Mapper<T> mapper, UniqueKey uniqueKey)` 通过 unique key 删除
`static <T> int`	`deleteByUniqueKeys(Mapper<T> mapper, Collection<UniqueKey> uniqueKeys)` 通过 unique key 批量删除
`static <T,K> T`	`getById(SingleIdMapper<T,K> mapper, K id)` 通过主键获取实体
`static <T,K> List<T>`	`getByIds(SingleIdMapper<T,K> mapper, Collection<K> ids)` 通过主键批量获取实体
`static <T,K extends MultiId> T`	`getByMultiId(MultipleIdMapper<T,K> mapper, K id)` 通过主键获取实体
`static <T,K extends MultiId> List<T>`	`getByMultiIds(MultipleIdMapper<T,K> mapper, Collection<K> ids)` 通过主键批量获取实体
`static <T> T`	`getByUniqueKey(Mapper<T> mapper, UniqueKey uniqueKey)` 通过 unique key 获取实体
`static <T> List<T>`	`getByUniqueKeys(Mapper<T> mapper, Collection<UniqueKey> uniqueKeys)` 通过 unique key 批量获取实体
`static String`	`getExactKeyWord(String keyword)` 获取精确的关键字
`static String`	`getKeyword(String keyword)` 获取keyword
`static <T,K,P> P`	`getPoById(SingleIdMapper<T,K> mapper, Class<P> clazz, K id)` 通过主键获取某个类型的持久化对象
`static <T,K,P> List<P>`	`getPoByIds(SingleIdMapper<T,K> mapper, Class<P> clazz, Collection<K> ids)` 通过主键批量获取某个类型的持久化对象
`static <T,K extends MultiId,P> P`	`getPoByMultiId(MultipleIdMapper<T,K> mapper, Class<P> clazz, K id)` 通过主键获取某个类型的持久化对象
`static <T,K extends MultiId,P> List<P>`	`getPoByMultiIds(MultipleIdMapper<T,K> mapper, Class<P> clazz, Collection<K> ids)` 通过主键批量获取某个类型的持久化对象
`static <T,P> P`	`getPoByUniqueKey(Mapper<T> mapper, Class<P> clazz, UniqueKey uniqueKey)` 通过 unique key 获取某个类型的持久化对象
`static <T,P> List<P>`	`getPoByUniqueKeys(Mapper<T> mapper, Class<P> clazz, Collection<UniqueKey> uniqueKeys)` 通过 unique key 批量获取某个类型的持久化对象
`static <T> int`	`insert(Mapper<T> mapper, T entity)` 插入实体
`static <T> int`	`updateById(Mapper<T> mapper, T entity)` 通过主键更新实体
`static <T> int`	`updateById(Mapper<T> mapper, T entity, List<Column> columns)` 通过主键更新实体指定字段
`static <T> int`	`updateByIdAndIgnoreColumns(Mapper<T> mapper, T entity, List<Column> ignoreColumns)` 通过主键更新非忽略的列
`static <T,K> int`	`updateByIdAndIgnoreColumns(SingleIdMapper<T,K> mapper, T entity, List<Column> ignoreColumns, Collection<K> ids)` 通过主键更新非忽略的列
`static <T,K> int`	`updateByIds(SingleIdMapper<T,K> mapper, T entity, Collection<K> ids)` 通过主键更新实体
`static <T,K> int`	`updateByIds(SingleIdMapper<T,K> mapper, T entity, List<Column> columns, Collection<K> ids)` 通过主键更新实体指定列
`static <T,K extends MultiId> int`	`updateByMultiIds(MultipleIdMapper<T,K> mapper, T entity, Collection<K> ids)` 通过主键更新实体
`static <T,K extends MultiId> int`	`updateByMultiIds(MultipleIdMapper<T,K> mapper, T entity, List<Column> columns, Collection<K> ids)` 通过主键更新实体指定列
`static <T> int`	`updateByUniqueKey(Mapper<T> mapper, T entity, List<Column> columns, UniqueKey uniqueKey)` 通过 unique key 更新实体指定列
`static <T> int`	`updateByUniqueKey(Mapper<T> mapper, T entity, UniqueKey uniqueKey)` 通过 unique key 更新实体
`static <T> int`	`updateByUniqueKeys(Mapper<T> mapper, T entity, Collection<UniqueKey> uniqueKeys)` 通过 unique key 更新实体
`static <T> int`	`updateByUniqueKeys(Mapper<T> mapper, T entity, List<Column> columns, Collection<UniqueKey> uniqueKeys)` 通过 unique key 更新实体指定列

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MapperUtils
```
public MapperUtils()
```

Method Detail

insert
```
public static <T> int insert(Mapper<T> mapper,
                             T entity)
```
插入实体

Type Parameters:

T - 实体类类型

Parameters:

mapper - 实体对应mapper

entity - 实体对象

Returns:

插入条数

deleteById
```
public static <T,K> int deleteById(SingleIdMapper<T,K> mapper,
                                   K id)
```
通过主键删除

Type Parameters:

T - 实体类类型

K - 主键值类型

Parameters:

mapper - 实体对应mapper

id - 主键

Returns:

删除条数

deleteByIds
```
public static <T,K> int deleteByIds(SingleIdMapper<T,K> mapper,
                                    Collection<K> ids)
```
通过主键批量删除

Type Parameters:

T - 实体类类型

K - 主键值类型

Parameters:

mapper - 实体对应mapper

ids - 主键列表

Returns:

删除条数

deleteByMultiId
```
public static <T,K extends MultiId> int deleteByMultiId(MultipleIdMapper<T,K> mapper,
                                                        K id)
```
通过主键删除

Type Parameters:

T - 实体类类型

K - 主键值类型

Parameters:

mapper - 实体对应mapper

id - 主键对象

Returns:

删除条数

deleteByMultiIds

public static <T,K extends MultiId> int deleteByMultiIds(MultipleIdMapper<T,K> mapper,
                                                         Collection<K> ids)

通过主键批量删除

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; ids - 主键对象
Returns:: 删除条数

updateById
```
public static <T> int updateById(Mapper<T> mapper,
                                 T entity)
```
通过主键更新实体

Type Parameters:

T - 实体类类型

Parameters:

mapper - 实体对应mapper

entity - 实体对象

Returns:

更新条数

updateById

public static <T> int updateById(Mapper<T> mapper,
                                 T entity,
                                 List<Column> columns)

通过主键更新实体指定字段

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; columns - 更新字段列表
Returns:: 更新条数

batchUpdateById

public static <T> void batchUpdateById(Mapper<T> mapper,
                                       List<T> entities)

通过主键批量更新实体

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entities - 实体对象列表

batchUpdateById

public static <T> void batchUpdateById(Mapper<T> mapper,
                                       List<T> entities,
                                       List<Column> columns)

通过主键批量更新实体

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entities - 实体对象列表; columns - 更新列

batchUpdateByIdAndIgnoreColumns

public static <T> void batchUpdateByIdAndIgnoreColumns(Mapper<T> mapper,
                                                       List<T> entities,
                                                       List<Column> ignoreColumns)

通过主键更新非忽略的列

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entities - 实体对象列表; ignoreColumns - 忽略的列

updateByIdAndIgnoreColumns

public static <T> int updateByIdAndIgnoreColumns(Mapper<T> mapper,
                                                 T entity,
                                                 List<Column> ignoreColumns)

通过主键更新非忽略的列

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; ignoreColumns - 忽略的列
Returns:: 更新条数

updateByIdAndIgnoreColumns

public static <T,K> int updateByIdAndIgnoreColumns(SingleIdMapper<T,K> mapper,
                                                   T entity,
                                                   List<Column> ignoreColumns,
                                                   Collection<K> ids)

通过主键更新非忽略的列

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; ignoreColumns - 忽略的列; ids - 主键列表
Returns:: 更新条数

updateByIds

public static <T,K> int updateByIds(SingleIdMapper<T,K> mapper,
                                    T entity,
                                    Collection<K> ids)

通过主键更新实体

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; ids - 主键列表
Returns:: 更新条数

updateByIds

public static <T,K> int updateByIds(SingleIdMapper<T,K> mapper,
                                    T entity,
                                    List<Column> columns,
                                    Collection<K> ids)

通过主键更新实体指定列

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; ids - 主键列表; columns - 更新列
Returns:: 更新条数

updateByMultiIds

public static <T,K extends MultiId> int updateByMultiIds(MultipleIdMapper<T,K> mapper,
                                                         T entity,
                                                         Collection<K> ids)

通过主键更新实体

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; ids - 主键列表
Returns:: 更新条数

updateByMultiIds

public static <T,K extends MultiId> int updateByMultiIds(MultipleIdMapper<T,K> mapper,
                                                         T entity,
                                                         List<Column> columns,
                                                         Collection<K> ids)

通过主键更新实体指定列

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; ids - 主键列表; columns - 更新列
Returns:: 更新条数

getById
```
public static <T,K> T getById(SingleIdMapper<T,K> mapper,
                              K id)
```
通过主键获取实体

Type Parameters:

T - 实体类类型

K - 主键值类型

Parameters:

mapper - 实体对应mapper

id - 主键

Returns:

实体

getByIds

public static <T,K> List<T> getByIds(SingleIdMapper<T,K> mapper,
                                     Collection<K> ids)

通过主键批量获取实体

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; ids - 主键列表
Returns:: 实体列表

getByMultiId
```
public static <T,K extends MultiId> T getByMultiId(MultipleIdMapper<T,K> mapper,
                                                   K id)
```
通过主键获取实体

Type Parameters:

T - 实体类类型

K - 主键值类型

Parameters:

mapper - 实体对应mapper

id - 主键

Returns:

实体

getByMultiIds

public static <T,K extends MultiId> List<T> getByMultiIds(MultipleIdMapper<T,K> mapper,
                                                          Collection<K> ids)

通过主键批量获取实体

Type Parameters:: T - 实体类类型; K - 主键值类型
Parameters:: mapper - 实体对应mapper; ids - 主键列表
Returns:: 实体列表

getPoById
```
public static <T,K,P> P getPoById(SingleIdMapper<T,K> mapper,
                                  Class<P> clazz,
                                  K id)
```
通过主键获取某个类型的持久化对象

Type Parameters:

T - 实体类类型

K - 主键值类型

P - 持久化对象类类型

Parameters:

mapper - 实体对应的mapper

clazz - 持久化对象类

id - 主键

Returns:

持久化对象

getPoByIds

public static <T,K,P> List<P> getPoByIds(SingleIdMapper<T,K> mapper,
                                         Class<P> clazz,
                                         Collection<K> ids)

通过主键批量获取某个类型的持久化对象

Type Parameters:: T - 实体类类型; K - 主键值类型; P - 持久化对象类类型
Parameters:: mapper - 实体对应的mapper; clazz - 持久化对象类; ids - 主键列表
Returns:: 持久化对象列表

getPoByMultiId

public static <T,K extends MultiId,P> P getPoByMultiId(MultipleIdMapper<T,K> mapper,
                                                       Class<P> clazz,
                                                       K id)

通过主键获取某个类型的持久化对象

Type Parameters:: T - 实体类类型; K - 主键值类型; P - 持久化对象类类型
Parameters:: mapper - 实体对应的mapper; clazz - 持久化对象类; id - 主键
Returns:: 持久化对象

getPoByMultiIds

public static <T,K extends MultiId,P> List<P> getPoByMultiIds(MultipleIdMapper<T,K> mapper,
                                                              Class<P> clazz,
                                                              Collection<K> ids)

通过主键批量获取某个类型的持久化对象

Type Parameters:: T - 实体类类型; K - 主键值类型; P - 持久化对象类类型
Parameters:: mapper - 实体对应的mapper; clazz - 持久化对象类; ids - 主键列表
Returns:: 持久化对象列表

getByUniqueKey

public static <T> T getByUniqueKey(Mapper<T> mapper,
                                   UniqueKey uniqueKey)

通过 unique key 获取实体

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; uniqueKey - unique key
Returns:: 实体

getByUniqueKeys

public static <T> List<T> getByUniqueKeys(Mapper<T> mapper,
                                          Collection<UniqueKey> uniqueKeys)

通过 unique key 批量获取实体

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; uniqueKeys - 主键列表
Returns:: 实体列表

getPoByUniqueKey

public static <T,P> P getPoByUniqueKey(Mapper<T> mapper,
                                       Class<P> clazz,
                                       UniqueKey uniqueKey)

通过 unique key 获取某个类型的持久化对象

Type Parameters:: T - 实体类类型; P - 持久化对象类类型
Parameters:: mapper - 实体对应的mapper; clazz - 持久化对象类; uniqueKey - 主键
Returns:: 持久化对象

getPoByUniqueKeys

public static <T,P> List<P> getPoByUniqueKeys(Mapper<T> mapper,
                                              Class<P> clazz,
                                              Collection<UniqueKey> uniqueKeys)

通过 unique key 批量获取某个类型的持久化对象

Type Parameters:: T - 实体类类型; P - 持久化对象类类型
Parameters:: mapper - 实体对应的mapper; clazz - 持久化对象类; uniqueKeys - 主键列表
Returns:: 持久化对象列表

updateByUniqueKey

public static <T> int updateByUniqueKey(Mapper<T> mapper,
                                        T entity,
                                        UniqueKey uniqueKey)

通过 unique key 更新实体

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; uniqueKey - unique key
Returns:: 更新条数

updateByUniqueKey

public static <T> int updateByUniqueKey(Mapper<T> mapper,
                                        T entity,
                                        List<Column> columns,
                                        UniqueKey uniqueKey)

通过 unique key 更新实体指定列

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; uniqueKey - unique key; columns - 更新列
Returns:: 更新条数

updateByUniqueKeys

public static <T> int updateByUniqueKeys(Mapper<T> mapper,
                                         T entity,
                                         Collection<UniqueKey> uniqueKeys)

通过 unique key 更新实体

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; uniqueKeys - unique key 列表
Returns:: 更新条数

updateByUniqueKeys

public static <T> int updateByUniqueKeys(Mapper<T> mapper,
                                         T entity,
                                         List<Column> columns,
                                         Collection<UniqueKey> uniqueKeys)

通过 unique key 更新实体指定列

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; entity - 实体对象; uniqueKeys - unique key 列表; columns - 更新列
Returns:: 更新条数

deleteByUniqueKey

public static <T> int deleteByUniqueKey(Mapper<T> mapper,
                                        UniqueKey uniqueKey)

通过 unique key 删除

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; uniqueKey - 主键对象
Returns:: 删除条数

deleteByUniqueKeys

public static <T> int deleteByUniqueKeys(Mapper<T> mapper,
                                         Collection<UniqueKey> uniqueKeys)

通过 unique key 批量删除

Type Parameters:: T - 实体类类型
Parameters:: mapper - 实体对应mapper; uniqueKeys - 主键对象
Returns:: 删除条数

addExactKeywords

public static void addExactKeywords(WhereSupport<?> sql,
                                    String keyword,
                                    List<Column> searchColumns,
                                    List<Column> exactSearchColumns)

增加精确搜索关键字

Parameters:: sql - Sql对象; keyword - 查询关键字; searchColumns - 模糊查询列; exactSearchColumns - 精确查询列

addKeywords

public static void addKeywords(WhereSupport<?> sql,
                               String keyword,
                               List<Column> searchColumns)

增加关键字查询参数

Parameters:: sql - Sql对象; keyword - 查询关键字; searchColumns - 查询列

getKeyword
```
public static String getKeyword(String keyword)
```
获取keyword

Parameters:

keyword - 查询关键字

Returns:

结果

getExactKeyWord
```
public static String getExactKeyWord(String keyword)
```
获取精确的关键字

Parameters:

keyword - 关键字

Returns:

结果

Class MapperUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapperUtils

Method Detail

insert

deleteById

deleteByIds

deleteByMultiId

deleteByMultiIds

updateById

updateById

batchUpdateById

batchUpdateById

batchUpdateByIdAndIgnoreColumns

updateByIdAndIgnoreColumns

updateByIdAndIgnoreColumns

updateByIds

updateByIds

updateByMultiIds

updateByMultiIds

getById

getByIds

getByMultiId

getByMultiIds

getPoById

getPoByIds

getPoByMultiId

getPoByMultiIds

getByUniqueKey

getByUniqueKeys

getPoByUniqueKey

getPoByUniqueKeys

updateByUniqueKey

updateByUniqueKey

updateByUniqueKeys

updateByUniqueKeys

deleteByUniqueKey

deleteByUniqueKeys

addExactKeywords

addKeywords

getKeyword

getExactKeyWord