com.mybatisflex.core.query.MapperQueryChain Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mybatis-flex-core Show documentation
There is a newer version: 1.10.5
/*
 *  Copyright (c) 2022-2025, Mybatis-Flex ([email protected]).
 *  
 *  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 com.mybatisflex.core.query;

import com.mybatisflex.core.BaseMapper;
import com.mybatisflex.core.paginate.Page;
import com.mybatisflex.core.relation.RelationManager;
import com.mybatisflex.core.util.LambdaGetter;
import com.mybatisflex.core.util.LambdaUtil;
import com.mybatisflex.core.util.SqlUtil;

import java.util.Arrays;
import java.util.List;
import java.util.Optional;

/**
 * 
链式 {@link BaseMapper} 查询。
 *
 * 
要求实现类除了包含有 {@link BaseMapper} 接口的引用外，还必须具有 {@link QueryWrapper}
 * 的查询条件构建功能。在使用时：
 * 

 *     通过 {@link #baseMapper()} 获取该实现类对应的 {@link BaseMapper} 引用。
 *     
通过 {@link #toQueryWrapper()} 将该实现类转换为 {@link QueryWrapper} 对象。
 * 
 *
 * @param  实体类类型
 * @author 王帅
 * @since 2023-08-08
 */
public interface MapperQueryChain extends ChainQuery {

    /**
     * 该实现类对应的 {@link BaseMapper} 对象。
     *
     * @return {@link BaseMapper}
     */
    BaseMapper baseMapper();

    /**
     * 将该实现类转换为 {@link QueryWrapper} 对象。
     *
     * @return {@link QueryWrapper}
     */
    QueryWrapper toQueryWrapper();

    /**
     * 查询数据数量。
     *
     * @return 数据数量
     */
    default long count() {
        return baseMapper().selectCountByQuery(toQueryWrapper());
    }

    /**
     * 判断数据是否存在。
     *
     * @return {@code true} 数据存在，{@code false} 数据不存在
     */
    default boolean exists() {
        return SqlUtil.toBool(count());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default T one() {
        return baseMapper().selectOneByQuery(toQueryWrapper());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default  R oneAs(Class asType) {
        return baseMapper().selectOneByQueryAs(toQueryWrapper(), asType);
    }

    /**
     * 获取第一列，且第一条数据。
     *
     * @return 第一列数据
     */
    default Object obj() {
        return baseMapper().selectObjectByQuery(toQueryWrapper());
    }

    /**
     * 获取第一列，且第一条数据并转换为指定类型，比如 {@code Long}, {@code String} 等。
     *
     * @param asType 接收数据类型
     * @param     接收数据类型
     * @return 第一列数据
     */
    default  R objAs(Class asType) {
        return baseMapper().selectObjectByQueryAs(toQueryWrapper(), asType);
    }

    /**
     * 获取第一列，且第一条数据，并封装为 {@link Optional} 返回。
     *
     * @return 第一列数据
     */
    default Optional