com.github.yt.mybatis.dao.BaseMapper Maven / Gradle / Ivy

Go to download
package com.github.yt.mybatis.dao;

import com.github.yt.mybatis.dao.provider.ModifyProvider;
import com.github.yt.mybatis.dao.provider.RemoveProvider;
import com.github.yt.mybatis.dao.provider.SaveProvider;
import com.github.yt.mybatis.dao.provider.SearchProvider;
import org.apache.ibatis.annotations.*;

import javax.validation.Valid;
import java.io.Serializable;
import java.util.List;
import java.util.Map;


public interface BaseMapper {

    String ENTITY_CLASS = "entityClass";
    String ENTITY = "entity";
    String ENTITIES = "entities";
    String ID = "id";
    String DATA = "data";
    String START = "start";
    String LIMIT = "limit";

    /**
     * 插入一条记录
     *
     * @param entity 业务实体
     */
    @InsertProvider(type = SaveProvider.class, method = "save")
    void save(@Param(ENTITY) T entity);

    /**
     * 批量插入
     *
     * @param entities 插入结果集
     */
    @InsertProvider(type = SaveProvider.class, method = "saveBatch")
    void saveBatch(@Valid @Param(ENTITIES) List entities);

    /**
     * 插入非空字段
     *
     * @param entity 业务实体
     */
    @InsertProvider(type = SaveProvider.class, method = "saveForSelective")
    void saveForSelective(@Param(ENTITY) T entity);

    /**
     * 更新一条记录
     *
     * @param entity 业务实体
     */
    @UpdateProvider(type = ModifyProvider.class, method = "update")
    void update(@Param(ENTITY) T entity);

    /**
     * 更新非空字段
     *
     * @param entity 业务实体
     */
    @UpdateProvider(type = ModifyProvider.class, method = "updateForSelective")
    int updateForSelective(@Param(ENTITY) T entity);

    /**
     * 删除
     *
     * @param entityClass 实体类型
     * @param id          主键
     */
    @DeleteProvider(type = RemoveProvider.class, method = "delete")
    void delete(@Param(ENTITY_CLASS) Class entityClass, @Param(ID) Serializable id);

    /**
     * 逻辑删除
     *
     * @param entityClass 实体类型
     * @param id          主键
     */
    @DeleteProvider(type = RemoveProvider.class, method = "logicDelete")
    void logicDelete(@Param(ENTITY_CLASS) Class entityClass, @Param(ID) Serializable id);

    /**
     * 删除
     *
     * @param id 主键
     */
    @SelectProvider(type = SearchProvider.class, method = "findById")
    T find(@Param(ENTITY_CLASS) Class entityClass, @Param(ID) Serializable id);


    /**
     * 按条件查询记录集合
     * 此处来写注解，在子类里面生效
     *
     * @param entityClass 实体类型
     * @param data        查询条件
     * @return 查询结果列表
     */
    @SelectProvider(type = SearchProvider.class, method = "findAll")
    List findAll(@Param(ENTITY_CLASS) Class entityClass, @Param(DATA) Map data);


    /**
     * 获取分页记录总数
     * 此处来写注解，在子类里面生效
     *
     * @param entityClass 业务实体类
     * @param data        查询条件
     * @return 实体列表
     */
    @SelectProvider(type = SearchProvider.class, method = "findAll")
    List pageData(@Param(ENTITY_CLASS) Class entityClass, @Param(DATA) Map data);

    /**
     * 统计分页记录总数
     *
     * @param entityClass 业务实体类
     * @param data        查询条件
     * @return 实体列表
     */
    @SelectProvider(type = SearchProvider.class, method = "pageTotalRecord")
    Long pageTotalRecord(@Param(ENTITY_CLASS) Class entityClass, @Param(DATA) Map data);

}