io.mybatis.mapper.BaseMapper 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;
import io.mybatis.mapper.base.EntityMapper;
import io.mybatis.mapper.cursor.CursorMapper;
import io.mybatis.mapper.example.Example;
import io.mybatis.mapper.example.ExampleMapper;
import io.mybatis.mapper.example.ExampleWrapper;
import io.mybatis.mapper.fn.Fn;
import io.mybatis.mapper.fn.FnProvider;
import io.mybatis.provider.Caching;
import org.apache.ibatis.annotations.Lang;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.UpdateProvider;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
/**
* 基础 Mapper 方法，可以在此基础上继承覆盖已有方法
*
* @param 实体类类型
* @param 主键类型
* @author liuzh
*/
public interface BaseMapper
extends EntityMapper, ExampleMapper>, CursorMapper> {
/**
* Example 查询封装
*/
default ExampleWrapper wrapper() {
return new ExampleWrapper<>(BaseMapper.this, example());
}
/**
* 根据主键更新实体中不为空的字段，强制字段不区分是否 null，都更新
*
* 当前方法来自 {@link io.mybatis.mapper.fn.FnMapper}，该接口中的其他方法用 {@link ExampleMapper} 也能实现
*
* @param entity 实体类
* @param forceUpdateFields 强制更新的字段，不区分字段是否为 null，通过 {@link Fn#of(Fn...)} 创建 {@link Fn.Fns}
* @return 1成功，0失败
*/
@Lang(Caching.class)
@UpdateProvider(type = FnProvider.class, method = "updateByPrimaryKeySelectiveWithForceFields")
int updateByPrimaryKeySelectiveWithForceFields(@Param("entity") S entity, @Param("fns") Fn.Fns forceUpdateFields);
/**
* 根据主键更新指定的字段
*
* @param entity 实体类型
* @param updateFields 指定更新的字段
* @return 1成功，0失败
*/
@Lang(Caching.class)
@UpdateProvider(type = FnProvider.class, method = "updateForFieldListByPrimaryKey")
int updateForFieldListByPrimaryKey(@Param("entity") S entity, @Param("fns") Fn.Fns updateFields);
/**
* 根据指定字段集合查询：field in (fieldValueList)
*
* 这个方法是个示例，你也可以使用 Java8 的默认方法实现一些通用方法
*
* @param field 字段
* @param fieldValueList 字段值集合
* @param 字段类型
* @return 实体列表
*/
default List selectByFieldList(Fn field, Collection fieldValueList) {
Example example = new Example<>();
example.createCriteria().andIn((Fn) field.in(entityClass()), fieldValueList);
return selectByExample(example);
}
/**
* 根据指定字段集合删除：field in (fieldValueList)
*
* 这个方法是个示例，你也可以使用 Java8 的默认方法实现一些通用方法
*
* @param field 字段
* @param fieldValueList 字段值集合
* @param 字段类型
* @return 实体列表
*/
default int deleteByFieldList(Fn field, Collection fieldValueList) {
Example example = new Example<>();
example.createCriteria().andIn((Fn) field.in(entityClass()), fieldValueList);
return deleteByExample(example);
}
}