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

使用IEntity的程序包

程序包	说明
cn.org.atool.fluent.form
cn.org.atool.fluent.form.registrar
cn.org.atool.fluent.form.setter
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.intf
cn.org.atool.fluent.mybatis.base.mapper
cn.org.atool.fluent.mybatis.base.model
cn.org.atool.fluent.mybatis.base.provider
cn.org.atool.fluent.mybatis.functions
cn.org.atool.fluent.mybatis.mapper
cn.org.atool.fluent.mybatis.segment
cn.org.atool.fluent.mybatis.utility

cn.org.atool.fluent.form中IEntity的使用

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

限定符和类型	方法和说明
<E extends IEntity> E	Form.findOne() 按表单返回一条记录
<E extends IEntity> E	Form.insert() 按表单新增记录
<E extends IEntity> List<E>	Form.list() 按表单条件查询记录列表
<E extends IEntity> Form	Form.set(IGetter<E> getter, Object value)
<E extends IEntity> StdPagedList<E>	Form.stdPage() 按表单返回标准分页记录
<E extends IEntity> TagPagedList<E>	Form.tagPage() 按表单返回Tag分页记录
static <E extends IEntity> Form	Form.with(Class<E> eClass, Object o, Consumer<IFormApply> apply)
static <E extends IEntity> Form	Form.with(Class<E> eClass, String json)
static <E extends IEntity> Form	Form.with(E o, Consumer<IFormApply> apply)

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

限定符和类型	方法和说明
static void	FormKit.mapping(String table, Class<? extends IEntity> entityClass) 定义映射关系

cn.org.atool.fluent.form.registrar中IEntity的使用

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

限定符和类型	方法和说明
static Class<? extends IEntity>	FormServiceKit.getEntityClass(String table) 根据表名称获取实例类型

cn.org.atool.fluent.form.setter中IEntity的使用

类型参数类型为IEntity的cn.org.atool.fluent.form.setter中的方法

限定符和类型	方法和说明
static <E extends IEntity> E	FormHelper.newEntity(MethodMeta method, Object[] args) 构造Entity对象
static <E extends IEntity> IQuery<E>	FormHelper.newQuery(MethodArgs args) 构造查询条件
static <E extends IEntity> IUpdate<E>	FormHelper.newUpdate(MethodArgs args) 构造更新条件

参数类型为IEntity的cn.org.atool.fluent.form.setter中的方法

限定符和类型	方法和说明
static <R> R	FormHelper.entity2result(IEntity entity, Class<R> rClass) 将Entity实例转换为指定类的实例

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

限定符和类型	方法和说明
static <R> List<R>	FormHelper.entities2result(List<IEntity> entities, Class<R> rClass) 将Entity列表转换为指定类的实例列表

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	BaseEntity Entity基类, 非充血模式
class	RichEntity Entity基类, 充血模式

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

限定符和类型	方法和说明
default <E extends IEntity> E	IEntity.copy() 拷贝对象
static <E extends IEntity,R extends IEntity> void	EntityRefKit.groupRelation(RefKey<E,R> refKey, List<E> srcEntities, List<R> refEntities) 根据RefKey信息, 设置srcEntities里里面的关联数据
static <E extends IEntity,R extends IEntity> void	EntityRefKit.groupRelation(RefKey<E,R> refKey, List<E> srcEntities, List<R> refEntities) 根据RefKey信息, 设置srcEntities里里面的关联数据
default <E extends IEntity> E	IEntity.tableSupplier(String supplier) 动态修改归属表, 默认无需设置 只有在插入数据时, 不想使用默认对应的数据库表, 想动态调整时才需要
<E extends IEntity> E	BaseEntity.tableSupplier(String table)
default <E extends IEntity> E	IEntity.tableSupplier(TableSupplier supplier) 动态修改归属表, 默认无需设置 只有在插入数据时, 不想使用默认对应的数据库表, 想动态调整时才需要
<E extends IEntity> E	BaseEntity.tableSupplier(TableSupplier supplier)

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

限定符和类型	方法和说明
default Class<? extends IEntity>	IEntity.entityClass() 数据库实体对应的Entity类名称 在具体的XyzEntity类中定义为final

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

限定符和类型	方法和说明
static void	EntityRefKit.cache(IEntity entity, String keyName, List list, boolean isList) 将关联数据放到RichEntity的缓存中
default int	IBaseDao.deleteByEntityIds(E... entities) 根据entities中的id值，批量删除记录
static Object	EntityRefKit.findRefData(Class<IEntity> entityClass, IEntity entity, String method)
default int	IBaseDao.logicDeleteByEntityIds(E... entities) 根据entities中的id值，批量逻辑删除记录
boolean	IBaseDao.updateEntityByIds(E... entities) 根据entity的主键批量修改entity中非null属性

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

限定符和类型	方法和说明
static Object	EntityRefKit.findRefData(Class<IEntity> entityClass, IEntity entity, String method)

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

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

限定符和类型	类和说明
class	BaseDefaults<E extends IEntity,Q extends IQuery<E>,U extends IUpdate<E>> 默认行为接口
class	BaseQuery<E extends IEntity,Q extends BaseQuery<E,Q>> AbstractQueryWrapper
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)
default Supplier<Object>	IDefaultSetter.pkGenerator(IEntity entity) entity主键生成器
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,Q extends IQuery<E>,U extends IUpdate<E>> 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的使用

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

限定符和类型	类和说明
class	AMapping<E extends IEntity,Q extends IQuery<E>,U extends IUpdate<E>> 字段映射抽象类

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

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

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

限定符和类型	方法和说明
<E extends IEntity> E	IEntityKit.copy(IEntity entity) 拷贝一个entity对象
<T extends IEntity> T	AMapping.copy(IEntity entity)
default <E extends IEntity> E	IRichEntity.findById() 根据id查找entity, 调用 EntityMapper.findById(id)方法
default <S extends IEntity,R extends IEntity> RefKey<S,R>	IMapping.findRefKey(String refKey) 返回指定关联关系设置
default <S extends IEntity,R extends IEntity> RefKey<S,R>	IMapping.findRefKey(String refKey) 返回指定关联关系设置
default <E extends IEntity> Optional<E>	IRichEntity.firstByNotNull() entity非空字段作为条件查询列表, 返回符合条件的第一条数据
default <E extends IEntity> List<E>	IRichEntity.listByNotNull() entity非空字段作为条件查询列表, 调用 EntityMapper.listByMap(map)方法
<E extends IEntity> E	IEntityKit.newEntity() new Entity
default <E extends IEntity> E	IRichEntity.save() 持久化entity到数据库, 调用 EntityMapper.insert(Entity)方法
<E extends IEntity> E	IEntityKit.toEntity(Map<String,Object> map) map对应属性值设置到Entity对象中, 同JSON反序列化
<T extends IEntity> T	AMapping.toEntity(Map<String,Object> map)
default <E extends IEntity> E	IRichEntity.updateById() 按entity的主键更新entity非空字段, 调用 EntityMapper.updateById(id)方法

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

限定符和类型	方法和说明
<E extends IEntity> E	IEntityKit.copy(IEntity entity) 拷贝一个entity对象
<T extends IEntity> T	AMapping.copy(IEntity entity)
static void	PkGeneratorKits.setPkByGenerator(IEntity entity) 设置主键值
Map<String,Object>	IEntityKit.toColumnMap(IEntity entity, boolean allowedNull) entity对象转换为map对象 key值为对应的数据库表字段名
Map<String,Object>	AMapping.toColumnMap(IEntity entity, boolean allowedNull)
Map<String,Object>	IEntityKit.toEntityMap(IEntity entity, boolean allowedNull) entity对象转换为map对象 key值为entity的属性字段名
Map<String,Object>	AMapping.toEntityMap(IEntity entity, boolean allowedNull)
<T> T	IEntityKit.valueByColumn(IEntity entity, String column) 根据数据库字段名称返回属性值
<T> T	AMapping.valueByColumn(IEntity entity, String column)
<T> T	IEntityKit.valueByField(IEntity entity, String fieldName) 根据实体属性名称返回属性值
<T> T	AMapping.valueByField(IEntity entity, String prop)

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

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

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

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

限定符和类型	方法和说明
BatchCrud	BatchCrud.addInsert(IEntity... entities) 按顺序添加Insert语句

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,Q extends IQuery<E>,U extends IUpdate<E>> 以下方法在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.base.model中IEntity的使用

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

限定符和类型	类和说明
class	FieldMapping<E extends IEntity> FieldMeta: 实体字段和数据库字段映射信息

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

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

限定符和类型	方法和说明
<E extends IEntity> String	SqlKit.insertBatch(IMapping mapping, Collection<E> entities, boolean withPk, TableId tableId) 批量插入
<E extends IEntity> String	CommonSqlKit.insertBatch(IMapping mapping, Collection<E> entities, boolean withPk, TableId tableId)
<E extends IEntity> String	SqlKit.insertEntity(IMapping mapping, String prefix, E entity, boolean withPk) 构建插入语句
<E extends IEntity> String	CommonSqlKit.insertEntity(IMapping mapping, String prefix, E entity, boolean withPk)
protected <E extends IEntity> List<Map>	CommonSqlKit.toMaps(IMapping mapping, Collection<E> entities, boolean withPk) 批量转换为Map

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

限定符和类型	方法和说明
IUpdate	SqlKit.updateById(IMapping mapping, IEntity entity) 根据Entity构造IUpdate
IUpdate	CommonSqlKit.updateById(IMapping mapping, IEntity entity)

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

参数类型为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中的方法

限定符和类型	方法和说明
int	PrinterMapper.insert(IEntity entity)
int	PrinterMapper.insertWithPk(IEntity entity)

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, IGetter<E> getter, IGetter<E>... getters) 根据entity值更新 o 指定字段列表, 可以是 null 值 o 无指定字段时, 除主键外的非空entity字段
<E extends IEntity> S	UpdateBase.byExclude(E entity, IGetter<E> exclude, IGetter<E>... excludes) 根据entity字段(包括null字段), 但排除指定字段
<E extends IEntity> WHERE	WhereBase.eqByEntity(E entity, IGetter<E> column, IGetter<E>... columns) 根据entity指定字段(允许null)设置where条件
<E extends IEntity> WHERE	WhereBase.eqByExclude(E entity, IGetter<E> exclude, IGetter<E>... excludes)
<LE extends IEntity,RE extends IEntity> JoinOn<QL,QR,JB>	JoinOn.onEq(IGetter<LE> l, IGetter<RE> r) 关联关系设置 l(left column) = r(right column)
<LE extends IEntity,RE extends IEntity> JoinOn<QL,QR,JB>	JoinOn.onEq(IGetter<LE> l, IGetter<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> String	RefKit.columnOfField(Class<E> eClass, String field) 返回clazz属性field对应的数据库字段名称
static <E extends IEntity> String	RefKit.primaryId(Class<E> eClass) 返回clazz实体的主键字段
static <E extends IEntity> void	RefKit.put(IGetter<E> finder) 设置实体类的关联自定义实现
static <E extends IEntity> String	MappingKits.toColumn(Class<E> klass, IGetter<E> func) 根据getter函数返回数据库字段名称
static <E extends IEntity> String[]	MappingKits.toColumns(Class<E> klass, IGetter<E> getter, IGetter<E>... getters)

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

限定符和类型	方法和说明
static Class<? extends IEntity>	MybatisUtil.entityClass(Class eClass) 返回标注@FluentMybatis注解Entity类

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

限定符和类型	方法和说明
static IRichMapper	RefKit.mapper(Class<? extends IEntity> eClass) 返回spring管理对应的mapper bean