io.mybatis.provider.SqlSourceCustomize 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 org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlSource;

import java.util.List;

/**
 * 支持定制化处理 {@link SqlSource}
 */
public interface SqlSourceCustomize {

  SqlSourceCustomize SPI = new SqlSourceCustomize() {
    private final List customizes = ServiceLoaderUtil.getInstances(SqlSourceCustomize.class);

    @Override
    public SqlSource customize(SqlSource sqlSource, EntityTable entity, MappedStatement ms, ProviderContext context) {
      for (SqlSourceCustomize customize : customizes) {
        sqlSource = customize.customize(sqlSource, entity, ms, context);
      }
      return sqlSource;
    }
  };

  /**
   * 定制化 sqlSource
   *
   * @param sqlSource 原始 sqlSource
   * @param entity    实体
   * @param ms        MappedStatement
   * @param context   调用方法上下文
   */
  SqlSource customize(SqlSource sqlSource, EntityTable entity, MappedStatement ms, ProviderContext context);

}