io.mybatis.provider.SqlScriptWrapper 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 org.apache.ibatis.builder.annotation.ProviderContext;

import java.util.List;

/**
 * SPI 接口：对最终的SQL进行处理
 *
 * @author liuzh
 */
public interface SqlScriptWrapper extends Order {

  /**
   * 包装 SQL
   *
   * @param context   当前接口和方法信息
   * @param entity    实体类
   * @param sqlScript sql脚本
   * @return
   */
  static SqlScript wrapSqlScript(ProviderContext context, EntityTable entity, SqlScript sqlScript) {
    for (SqlScriptWrapper wrapper : Instance.getEntityTableFactoryChain()) {
      sqlScript = wrapper.wrap(context, entity, sqlScript);
    }
    return sqlScript;
  }

  /**
   * 对 script 包装中的 SQL 进行加工处理
   *
   * @param context   当前接口和方法信息
   * @param entity    实体类
   * @param sqlScript sql脚本
   * @return
   */
  SqlScript wrap(ProviderContext context, EntityTable entity, SqlScript sqlScript);

  /**
   * 实例
   */
  class Instance {
    private static volatile List sqlScriptWrappers;

    /**
     * 获取处理实体的工厂链
     *
     * @return 实例
     */
    public static List getEntityTableFactoryChain() {
      if (sqlScriptWrappers == null) {
        synchronized (EntityFactory.class) {
          if (sqlScriptWrappers == null) {
            sqlScriptWrappers = ServiceLoaderUtil.getInstances(SqlScriptWrapper.class);
          }
        }
      }
      return sqlScriptWrappers;
    }
  }

}