• Home
• io.mybatis
• mybatis-mapper
• 2.2.4
• source code
• ExampleWrapper.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.mybatis.mapper.example.ExampleWrapper Maven / Gradle / Ivy

/*
 * Copyright 2020-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.mybatis.mapper.example;

import io.mybatis.common.util.Assert;
import io.mybatis.mapper.BaseMapper;
import io.mybatis.mapper.fn.Fn;
import org.apache.ibatis.exceptions.TooManyResultsException;
import org.apache.ibatis.session.RowBounds;

import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * 封装 Example 的查询条件，方便链式调用
 *
 * @param  实体类类型
 * @param  主键类型
 * @author liuzh
 */
public class ExampleWrapper {
  private final BaseMapper    baseMapper;
  private final Example          example;
  private       Example.Criteria current;

  public ExampleWrapper(BaseMapper baseMapper, Example example) {
    this.baseMapper = baseMapper;
    this.example = example;
    this.current = example.createCriteria();
  }

  /**
   * or 一组条件
   *
   * @return 条件
   */
  public ExampleWrapper or() {
    this.current = this.example.or();
    return this;
  }

  /**
   * 获取查询条件
   */
  public Example example() {
    return example;
  }

  /**
   * 清除条件，可重用
   */
  public ExampleWrapper clear() {
    this.example.clear();
    this.current = example.createCriteria();
    return this;
  }

  /**
   * 指定查询列
   *
   * @param fns 方法引用
   */
  @SafeVarargs
  public final ExampleWrapper select(Fn... fns) {
    this.example.selectColumns(fns);
    return this;
  }

  /**
   * 排除指定查询列
   *
   * @param fns 方法引用
   */
  @SafeVarargs
  public final ExampleWrapper exclude(Fn... fns) {
    this.example.excludeColumns(fns);
    return this;
  }

  /**
   * 设置起始 SQL
   *
   * @param startSql 起始 SQL，添加到 SQL 前，注意防止 SQL 注入
   */
  public ExampleWrapper startSql(String startSql) {
    this.example.setStartSql(startSql);
    return this;
  }

  /**
   * 设置结尾 SQL
   *
   * @param endSql 结尾 SQL，添加到 SQL 最后，注意防止 SQL 注入
   */
  public ExampleWrapper endSql(String endSql) {
    this.example.setEndSql(endSql);
    return this;
  }

  /**
   * 通过方法引用方式设置排序字段
   *
   * @param fn    排序列的方法引用
   * @param order 排序方式
   * @return Example
   */
  public ExampleWrapper orderBy(Fn fn, Example.Order order) {
    this.example.orderBy(fn, order);
    return this;
  }

  /**
   * 支持使用字符串形式来设置 order by，用以支持一些特殊的排序方案
   *
   * @param orderByCondition 排序字符串（不会覆盖已有的排序内容）
   * @return Example
   */
  public ExampleWrapper orderBy(String orderByCondition) {
    this.example.orderBy(orderByCondition);
    return this;
  }

  /**
   * 支持使用字符串形式来设置 order by，用以支持一些特殊的排序方案
   *
   * @param orderByCondition 排序字符串构造方法,比如通过数组集合循环拼接等
   * @return Example
   */
  public ExampleWrapper orderBy(Supplier orderByCondition) {
    this.example.orderBy(orderByCondition);
    return this;
  }

  /**
   * 支持使用字符串形式来设置 order by，用以支持一些特殊的排序方案
   *
   * @param useOrderBy       条件表达式，true使用，false不使用 字符串排序
   * @param orderByCondition 排序字符串构造方法，比如通过数组集合循环拼接等
   * @return Example
   */
  public ExampleWrapper orderBy(boolean useOrderBy, Supplier orderByCondition) {
    return useOrderBy ? this.orderBy(orderByCondition) : this;
  }

  /**
   * 通过方法引用方式设置排序字段，升序排序
   *
   * @param fns 排序列的方法引用
   * @return Example
   */
  @SafeVarargs
  public final ExampleWrapper orderByAsc(Fn... fns) {
    this.example.orderByAsc(fns);
    return this;
  }

  /**
   * 通过方法引用方式设置排序字段，降序排序
   *
   * @param fns 排序列的方法引用
   * @return Example
   */
  @SafeVarargs
  public final ExampleWrapper orderByDesc(Fn... fns) {
    this.example.orderByDesc(fns);
    return this;
  }

  /**
   * 设置 distince
   */
  public ExampleWrapper distinct() {
    this.example.setDistinct(true);
    return this;
  }

  /**
   * 设置更新字段和值
   *
   * @param useSet 表达式条件, true 使用，false 不使用
   * @param setSql "column = value"
   */
  public ExampleWrapper set(boolean useSet, String setSql) {
    return useSet ? set(setSql) : this;
  }

  /**
   * 设置更新字段和值
   *
   * @param setSql "column = value"
   */
  public ExampleWrapper set(String setSql) {
    this.example.set(setSql);
    return this;
  }

  /**
   * 设置更新字段和值
   *
   * @param useSet 表达式条件, true 使用，false 不使用
   * @param fn     字段
   * @param value  值
   */
  public ExampleWrapper set(boolean useSet, Fn fn, Object value) {
    return useSet ? set(fn, value) : this;
  }


  /**
   * 设置更新字段和值
   *
   * @param useSet   表达式条件, true 使用，false 不使用
   * @param fn       字段
   * @param supplier 值构造函数
   */
  public ExampleWrapper set(boolean useSet, Fn fn, Supplier