com.github.edgar615.util.mybatis.BaseMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-boot-util-mybatis Show documentation
The newest version!
package com.github.edgar615.util.mybatis;

import com.github.edgar615.util.db.Page;
import com.github.edgar615.util.db.Pagination;
import com.github.edgar615.util.db.Persistent;
import com.github.edgar615.util.search.Example;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import java.util.List;
import java.util.Map;
import org.apache.ibatis.annotations.Param;

public interface BaseMapper> {

  /**
   * 新增数据.
   *
   * @param persistent 持久化对象
   */
  void insert(T persistent);

  /**
   * insert一条数据，并返回自增主键
   *
   * @param persistent 持久化对象
   */
  ID insertAndGeneratedKey(T persistent);

  /**
   * 根据主键删除.
   *
   * @param id 主键
   * @return 删除记录数
   */
  int deleteById(ID id);

  /**
   * 根据条件删除.
   *
   * @param example 查询条件
   * @return 删除记录数
   */
  int deleteByExample(@Param("example") Example example);

  /**
   * 根据主键更新，忽略实体中的null.
   *
   * @param persistent 持久化对象
   * @param id 主键
   * @return 修改记录数
   */
  int updateById(@Param("persistent") T persistent, @Param("id") ID id);

  /**
   * 根据条件更新，忽略实体中的null.
   *
   * @param persistent 持久化对象
   * @param example 查询条件
   * @return 修改记录数
   */
  int updateByExample(@Param("persistent") T persistent, @Param("example") Example example);

  /**
   * 根据主键更新，忽略实体中的null
   *
   * @param persistent 持久化对象
   * @param addOrSub 需要做增加或者减去的字段，value为正数表示增加，负数表示减少
   * @param nullFields 需要设为null的字段
   * @param id 主键ID
   * @return 修改记录数
   */
  int updateByIdWithNull(@Param("persistent") T persistent,
      @Param("addOrSub") Map addOrSub,
      @Param("nullFields") List nullFields,
      @Param("id") ID id);

  /**
   * 根据条件更新，忽略实体中的null
   *
   * @param persistent 持久化对象
   * @param addOrSub 需要做增加或者减去的字段，value为正数表示增加，负数表示减少
   * @param nullFields 需要设为null的字段
   * @param example 查询条件
   * @return 修改记录数
   */
  int updateByExampleWithNull(@Param("persistent") T persistent,
      @Param("addOrSub") Map addOrSub,
      @Param("nullFields") List nullFields, @Param("example") Example example);


  /**
   * 根据主键查找.
   *
   * @param id 主键
   * @return 持久化对象，如果未找到任何数据，返回null
   */
  T findById(ID id);

  /**
   * 根据主键查找.
   *
   * @param id 主键
   * @param fields 返回的属性列表
   * @return 持久化对象
   */
  T findCustomFieldById(@Param("id") ID id, @Param("fields") List fields);

  /**
   * 根据条件查找.
   *
   * @param example 查询参数的定义，包括查询条件、排序规则等
   * @return 持久化对象列表
   */
  List findByExample(@Param("example") Example example);

  /**
   * 根据条件查找.
   *
   * @param example 查询参数的定义，包括查询条件、排序规则等
   * @param start 开始索引
   * @param limit 查询数量
   * @return 持久化对象列表
   */
  List findByExampleWithLimit(@Param("example") Example example, @Param("offset") int start,
      @Param("limit") int limit);

  /**
   * 根据条件查找.
   *
   * @param example 查询条件
   * @return 记录数
   */
  int countByExample(@Param("example") Example example);

  /**
   * 分页查找.
   *
   * @param example 查询参数的定义，包括查询条件、排序规则等
   * @param page 页码
   * @param pageSize 每页数量
   * @return 分页对象
   */
  default Pagination pagination(Example example,
      int page, int pageSize) {
    Preconditions.checkArgument(page > 0, "page must greater than 0");
    Preconditions.checkArgument(pageSize > 0, "pageSize must greater than 0");
    //查询总数
    final int totalRecords = countByExample(example);
    if (totalRecords == 0) {
      return Pagination.newInstance(1, pageSize, totalRecords, Lists.newArrayList());
    }
    int pageCount = totalRecords / pageSize;
    if (totalRecords > pageSize * pageCount) {
      pageCount++;
    }
    if (pageCount < page) {
      page = pageCount;
    }
    int offset = (page - 1) * pageSize;
    List records = findByExampleWithLimit(example, offset, pageSize);
    return Pagination.newInstance(page, pageSize, totalRecords, records);
  }

  /**
   * 根据条件查找.
   *
   * @param example 查询参数的定义，包括查询条件、排序规则等
   * @return 持久化对象，如果未找到任何数据，返回null
   */
  default T findFirstByExample(Example example) {
    List result = findByExampleWithLimit(example, 0, 1);
    if (result == null || result.isEmpty()) {
      return null;
    }
    return result.get(0);
  }

  /**
   * 根据条件查找，并返回总数.
   *
   * @param example 查询参数的定义，包括查询条件、排序规则等
   * @param start 开始索引
   * @param limit 查询数量
   * @return 分页对象
   */
  default Page page(Example example, int start, int limit) {
    List records = findByExampleWithLimit(example, start, limit);
    //如果records的数量小于limit，说明已经没有记录，直接计算总数
    if (records.size() > 0 && records.size() < limit) {
      int total = start + records.size();
      return Page.newInstance(total, records);
    }
    //通过数据库查询总数
    final int totalRecords = countByExample(example);
    return Page.newInstance(totalRecords, records);
  }
}