io.mybatis.provider.EntityClassFinder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mybatis-provider Show documentation
MyBatis Provider 扩展
There is a newer version: 2.2.5
/*
 * 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.provider;

import io.mybatis.provider.util.ServiceLoaderUtil;

import java.lang.reflect.Method;
import java.util.List;
import java.util.Objects;
import java.util.Optional;

/**
 * 根据类型和方法等信息获取实体类类型，可以通过 SPI 方式替换默认实现
 *
 * @author liuzh
 */
public interface EntityClassFinder extends Order {

  /**
   * 查找当前方法对应的实体类
   *
   * @param mapperType   Mapper 接口，不能为空
   * @param mapperMethod Mapper 接口方法，可以为空
   * @return
   */
  static Optional> find(Class mapperType, Method mapperMethod) {
    Objects.requireNonNull(mapperType);
    for (EntityClassFinder instance : EntityClassFinderInstance.getInstances()) {
      Optional> optionalClass = instance.findEntityClass(mapperType, mapperMethod);
      if (optionalClass.isPresent()) {
        return optionalClass;
      }
    }
    return Optional.empty();
  }

  /**
   * 查找当前方法对应的实体类
   *
   * @param mapperType   Mapper 接口，不能为空
   * @param mapperMethod Mapper 接口方法，可以为空
   * @return 实体类类型
   */
  Optional> findEntityClass(Class mapperType, Method mapperMethod);

  /**
   * 指定的类型是否为定义的实体类类型
   *
   * @param clazz 类型
   * @return 是否为实体类类型
   */
  boolean isEntityClass(Class clazz);

  /**
   * 实例
   */
  class EntityClassFinderInstance {
    private static volatile List INSTANCES;

    /**
     * 通过 SPI 获取扩展的实现或使用默认实现
     *
     * @return 实例
     */
    public static List getInstances() {
      if (INSTANCES == null) {
        synchronized (EntityClassFinder.class) {
          if (INSTANCES == null) {
            INSTANCES = ServiceLoaderUtil.getInstances(EntityClassFinder.class);
          }
        }
      }
      return INSTANCES;
    }
  }

}