接口的使用
cn.org.atool.fluent.mybatis.base.IEntity

使用IEntity的程序包

程序包	说明
cn.org.atool.fluent.mybatis.base
cn.org.atool.fluent.mybatis.base.crud
cn.org.atool.fluent.mybatis.base.dao
cn.org.atool.fluent.mybatis.base.entity
cn.org.atool.fluent.mybatis.base.mapper
cn.org.atool.fluent.mybatis.functions
cn.org.atool.fluent.mybatis.mapper
cn.org.atool.fluent.mybatis.model
cn.org.atool.fluent.mybatis.segment
cn.org.atool.fluent.mybatis.utility

cn.org.atool.fluent.mybatis.base中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.base中的类

限定符和类型	接口和说明
interface	IBaseDao<E extends IEntity> IBaseDao Dao基本操作方法

实现IEntity的cn.org.atool.fluent.mybatis.base中的类

限定符和类型	类和说明
class	RichEntity Entity Rich基类

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.base中的方法

限定符和类型	方法和说明
default <E extends IEntity> E	IEntity.changeTableBelongTo(String supplier) 动态修改归属表, 默认无需设置 只有在插入数据时, 不想使用默认对应的数据库表, 想动态调整时才需要
<E extends IEntity> E	RichEntity.changeTableBelongTo(String table)
default <E extends IEntity> E	IEntity.changeTableBelongTo(TableSupplier supplier) 动态修改归属表, 默认无需设置 只有在插入数据时, 不想使用默认对应的数据库表, 想动态调整时才需要
<E extends IEntity> E	RichEntity.changeTableBelongTo(TableSupplier supplier)
default <E extends IEntity> E	IEntity.copy() 拷贝对象

返回变量类型为IEntity的类型的cn.org.atool.fluent.mybatis.base中的方法

限定符和类型	方法和说明
protected abstract Set<Class<? extends IEntity>>	IRefs.allEntityClass() 所有Entity Class
default Class<? extends IEntity>	IEntity.entityClass() 数据库实体对应的Entity类名称, 在具体的XyzEntity类中定义为final, 防止返回匿名子类名称
Class<? extends IEntity>	IRefs.findFluentEntityClass(Class clazz) 返回标注@FluentMybatis注解Entity类

参数类型为IEntity的cn.org.atool.fluent.mybatis.base中的方法

限定符和类型	方法和说明
BatchCrud	BatchCrud.addInsert(IEntity... entities) 按顺序添加Insert语句
default int	IBaseDao.deleteByEntityIds(E... entities) 根据entities中的id值，批量删除记录
default int	IBaseDao.logicDeleteByEntityIds(E... entities) 根据entities中的id值，批量逻辑删除记录
static IRichMapper	IRefs.mapper(IEntity entity) 返回spring管理对应的mapper bean
boolean	IBaseDao.updateEntityByIds(E... entities) 根据entity的主键批量修改entity中非null属性

类型变量类型为IEntity的cn.org.atool.fluent.mybatis.base中的方法参数

限定符和类型	方法和说明
abstract IQuery	IRefs.defaultQuery(Class<? extends IEntity> clazz) 返回clazz实体对应的默认Query实例
abstract IUpdate	IRefs.defaultUpdater(Class<? extends IEntity> clazz) 返回clazz实体对应的默认Updater实例
abstract IQuery	IRefs.emptyQuery(Class<? extends IEntity> clazz) 返回clazz实体对应的空Query实例
abstract IUpdate	IRefs.emptyUpdater(Class<? extends IEntity> clazz) 返回clazz实体对应的空Updater实例
protected abstract IRichMapper	IRefs.getMapper(Class<? extends IEntity> clazz)
static IRichMapper	IRefs.mapper(Class<? extends IEntity> clazz) 返回spring管理对应的mapper bean

cn.org.atool.fluent.mybatis.base.crud中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.base.crud中的类

限定符和类型	类和说明
class	BaseQuery<E extends IEntity,Q extends BaseQuery<E,Q>> AbstractQueryWrapper
class	BaseSqlProvider<E extends IEntity> SqlProvider: 动态SQL构造基类
class	BaseUpdate<E extends IEntity,U extends IBaseUpdate<E,U,NQ>,NQ extends IBaseQuery<E,NQ>> AbstractUpdateWrapper
interface	IBaseQuery<E extends IEntity,Q extends IBaseQuery<E,Q>> IEntityQuery: 查询接口
interface	IBaseUpdate<E extends IEntity,U extends IBaseUpdate<E,U,NQ>,NQ extends IBaseQuery<E,NQ>> IEntityUpdate: 更新接口
interface	IQuery<E extends IEntity> 查询构造器基类
interface	IUpdate<E extends IEntity> 更新构造器基类
interface	IWrapper<E extends IEntity,W extends IWrapper<E,W,NQ>,NQ extends IBaseQuery<E,NQ>> IWrapper: 查询和更新都用到的接口

参数类型为IEntity的cn.org.atool.fluent.mybatis.base.crud中的方法

限定符和类型	方法和说明
BatchCrud	BatchCrudImpl.addInsert(IEntity... entities)
void	IDefaultGetter.setEntityByDefault(IEntity entity) 对entity设置默认值 默认值行为根据 IDefaultSetter.setInsertDefault(IEntity)来
protected abstract void	BaseSqlProvider.setEntityByDefault(IEntity entity) 根据IDefaultSetter.setInsertDefault(IEntity)设置默认值
default void	IDefaultSetter.setInsertDefault(IEntity entity) 对保存的entity类设置默认值 比如: 数据隔离的环境值, 租户值等等

cn.org.atool.fluent.mybatis.base.dao中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.base.dao中的类

限定符和类型	类和说明
class	BaseDao<E extends IEntity> BaseDaoImpl
interface	IProtectedDao<E extends IEntity> IDaoProtected: 被限制在Dao类中使用的方法, 只允许在子类中调用，不暴露给更高层的Service外部直接访问 * * ！！！！！！！！！！！！

参数类型为IEntity的cn.org.atool.fluent.mybatis.base.dao中的方法

限定符和类型	方法和说明
static IUpdate	DaoHelper.buildUpdateByEntityNoN(Supplier<IUpdate> supplier, IEntity update, IEntity where) 根据entity非空字段构建update和where条件
static IUpdate	DaoHelper.buildUpdateEntityById(Supplier<IUpdate> supplier, IEntity entity)
boolean	BaseDao.updateEntityByIds(E... entities)

cn.org.atool.fluent.mybatis.base.entity中IEntity的使用

cn.org.atool.fluent.mybatis.base.entity中IEntity的子接口

限定符和类型	接口和说明
interface	IRichEntity 只需要Entity属性就可以执行的数据操作方法

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.base.entity中的方法

限定符和类型	方法和说明
<E extends IEntity> E	IEntityHelper.copy(IEntity entity) 拷贝一个entity对象
default <E extends IEntity> E	IRichEntity.findById() 根据id查找entity, 调用 EntityMapper.findById(id)方法
default <E extends IEntity> List<E>	IRichEntity.listByNotNull() entity非空字段作为条件查询列表, 调用 EntityMapper.listByMap(map)方法
default <E extends IEntity> E	IRichEntity.save() 持久化entity到数据库, 调用 EntityMapper.insert(Entity)方法
<E extends IEntity> E	IEntityHelper.toEntity(Map<String,Object> map) map对应属性值设置到Entity对象中
default <E extends IEntity> E	IRichEntity.updateById() 按entity的主键更新entity非空字段, 调用 EntityMapper.updateById(id)方法

参数类型为IEntity的cn.org.atool.fluent.mybatis.base.entity中的方法

限定符和类型	方法和说明
<E extends IEntity> E	IEntityHelper.copy(IEntity entity) 拷贝一个entity对象
Map<String,Object>	IEntityHelper.toColumnMap(IEntity entity, boolean isNoN) entity对象转换为map对象 key值为对应的数据库表字段名
Map<String,Object>	IEntityHelper.toEntityMap(IEntity entity, boolean isNoN) entity对象转换为map对象 key值为entity的属性字段名

cn.org.atool.fluent.mybatis.base.mapper中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.base.mapper中的类

限定符和类型	接口和说明
interface	IEntityMapper<E extends IEntity> IEntityMapper: 实例Mapper基类，Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能
interface	IMapper<E extends IEntity> IMapper: mapper标识接口
interface	IRichMapper<E extends IEntity> IDaoMapper: 非mybatis mapper原子接口, 属于组装方法
interface	IWrapperMapper<E extends IEntity> 以下方法在EntityMapper中实现接口default方法
class	QueryExecutor<E extends IEntity> 查询条件执行器

参数类型为IEntity的cn.org.atool.fluent.mybatis.base.mapper中的方法

限定符和类型	方法和说明
default int	IRichMapper.deleteByEntityIds(E... entities) 根据entities中的id值，批量删除记录
default int	IRichMapper.logicDeleteByEntityIds(E... entities) 根据entities中的id值，批量删除记录

cn.org.atool.fluent.mybatis.functions中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.functions中的类

限定符和类型	类和说明
class	FormApply<E extends IEntity,S extends FormSetter> FormApply
interface	FormFunction<E extends IEntity,S extends FormSetter>

参数类型为IEntity的cn.org.atool.fluent.mybatis.functions中的方法

限定符和类型	方法和说明
String	TableSupplier.get(IEntity entity) 根据entity获取目标表

cn.org.atool.fluent.mybatis.mapper中IEntity的使用

类型变量类型为IEntity的cn.org.atool.fluent.mybatis.mapper中的方法参数

限定符和类型	方法和说明
protected static Set<ClassLoader>	EntityHelperFactory.getClassLoaders(Class<? extends IEntity> clazz)
static IEntityHelper	EntityHelperFactory.getInstance(Class<? extends IEntity> clazz) 采用反射构造方式

cn.org.atool.fluent.mybatis.model中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.model中的类

限定符和类型	类和说明
class	FormQuery<E extends IEntity,S extends FormSetter> 通用的Form形式查询
interface	IFormApply<E extends IEntity,S extends FormSetter> 简单表单查询
interface	IFormQuery<E extends IEntity,S extends FormSetter> 简单表单查询

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.model中的方法

限定符和类型	方法和说明
<E extends IEntity,S extends FormSetter> IFormApply<E,S>	Form.add(FormFunction<E,S> apply, Object value)
<E extends IEntity> IQuery<E>	Form.query(Class<E> entityClass)
<E extends IEntity> QueryExecutor<E>	Form.to(Class<E> entityClass)

返回变量类型为IEntity的类型的cn.org.atool.fluent.mybatis.model中的方法

限定符和类型	方法和说明
Class<? extends IEntity>	IFormQuery.entityClass() 对应的实体Entity类型
Class<? extends IEntity>	FormQuery.entityClass()

参数类型为IEntity的cn.org.atool.fluent.mybatis.model中的构造器

构造器和说明
FormQuery(@NonNull IEntity entity, @NonNull IQuery query, S setter)

cn.org.atool.fluent.mybatis.segment中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.segment中的类

限定符和类型	类和说明
class	BaseWrapper<E extends IEntity,W extends IWrapper<E,W,NQ>,NQ extends IBaseQuery<E,NQ>> 查询条件封装

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.segment中的方法

限定符和类型	方法和说明
<E extends IEntity> S	UpdateBase.byEntity(E entity, GetterFunc<E> getter, GetterFunc<E>... getters) 根据entity值更新 o 指定字段列表, 可以是 null 值 o 无指定字段时, 除主键外的非空entity字段
<E extends IEntity> S	UpdateBase.byExclude(E entity, GetterFunc<E> exclude, GetterFunc<E>... excludes) 根据entity字段(包括null字段), 但排除指定字段
<E extends IEntity> WHERE	WhereBase.eqByEntity(E entity, GetterFunc<E> column, GetterFunc<E>... columns) 根据entity指定字段(允许null)设置where条件
<E extends IEntity> WHERE	WhereBase.eqByExclude(E entity, GetterFunc<E> exclude, GetterFunc<E>... excludes)
<LE extends IEntity,RE extends IEntity> JoinOn<QL,QR,JB>	JoinOn.onEq(GetterFunc<LE> l, GetterFunc<RE> r) 关联关系设置 l(left column) = r(right column)
<LE extends IEntity,RE extends IEntity> JoinOn<QL,QR,JB>	JoinOn.onEq(GetterFunc<LE> l, GetterFunc<RE> r) 关联关系设置 l(left column) = r(right column)

参数类型为IEntity的cn.org.atool.fluent.mybatis.segment中的方法

限定符和类型	方法和说明
protected void	BaseSegment.byEntity(IEntity entity, BiConsumer<String,Object> consumer, boolean allowPk, List<String> columns) 根据entity设置where条件 o 指定字段列表, 可以是 null 值 o 无指定字段时, 所有非空entity字段
S	UpdateBase.byEntity(IEntity entity, FieldMapping column, FieldMapping... columns) 根据entity值更新 o 指定字段列表, 可以是 null 值 o 无指定字段时, 除主键外的非空entity字段
S	UpdateBase.byEntity(IEntity entity, String... columns) 根据entity值更新 o 指定字段列表, 可以是 null 值 o 无指定字段时, 除主键外的非空entity字段
protected void	BaseSegment.byExclude(IEntity entity, BiConsumer<String,Object> consumer, boolean allowPk, List<String> excludes)
S	UpdateBase.byExclude(IEntity entity, FieldMapping exclude, FieldMapping... excludes) 根据entity字段(包括null字段), 但排除指定字段
S	UpdateBase.byExclude(IEntity entity, String... excludes) 更新除指定的排除字段外其它entity字段值(包括null字段) 无排除字段时, 更新除主键外其它字段(包括null值字段)
WHERE	WhereBase.eqByEntity(IEntity entity, BiPredicate<String,Object> predicate) 根据entity和字段predicate判断来设置where条件
WHERE	WhereBase.eqByEntity(IEntity entity, FieldMapping column, FieldMapping... columns) 根据entity指定字段(允许null)设置where条件
WHERE	WhereBase.eqByEntity(IEntity entity, String... columns) 根据entity设置where条件 o 指定字段列表, 可以是 null 值 o 无指定字段时, 所有非空entity字段
WHERE	WhereBase.eqByExclude(IEntity entity, FieldMapping exclude, FieldMapping... excludes)
WHERE	WhereBase.eqByExclude(IEntity entity, String... excludes) 根据entity(排除指定字段)设置where条件 o 无指定字段时, 条件等于所有字段(包括null值)
WHERE	WhereBase.eqNotNull(IEntity entity) 已过时。

cn.org.atool.fluent.mybatis.utility中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.mybatis.utility中的方法

限定符和类型	方法和说明
static <E extends IEntity,S extends FormSetter> IFormApply<E,S>	FormHelper.by(Object object, Form form, Supplier<S> setterSupplier)
static <E extends IEntity> String	LambdaUtil.resolve(GetterFunc<E> getter) 返回getter lambda表达式
static <E extends IEntity> String	MappingKits.toColumn(Class<E> klass, GetterFunc<E> func) 根据getter函数返回数据库字段名称
static <E extends IEntity> String[]	MappingKits.toColumns(Class<E> klass, GetterFunc<E> getter, GetterFunc<E>... getters)
static <E extends IEntity> IQuery	FormHelper.toQuery(Class<E> entityClass, Form form) 将表单Form转换为entityClass对应的Query