funkygao/cp-ddd-framework

/*
 * Copyright DDDplus Authors.
 *
 * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */
package io.github.dddplus.runtime.registry;

import io.github.dddplus.ext.IDomainExtension;
import io.github.dddplus.ext.IPolicy;
import io.github.dddplus.ext.IIdentity;
import io.github.dddplus.runtime.BaseRouter;
import io.github.dddplus.runtime.interceptor.IExtensionInterceptor;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;

import java.util.*;
import java.util.concurrent.ConcurrentHashMap;

/**
 * 注册表索引, internal usage only.
 */
@Slf4j
public class InternalIndexer {
    private InternalIndexer() {
    }

    private static final List<StepDef> emptySteps = Collections.emptyList();

    static final Map<String, DomainDef> domainDefMap = new HashMap<>(); // {code, def}
    static final Map<Class<? extends BaseRouter>, RouterDef> routerDefMap = new HashMap<>();
    static final Map<String, Map<String, StepDef>> domainStepDefMap = new HashMap<>(); // {activityCode, {stepCode, def}}

    // 扩展点 Pattern
    static final Map<String, PatternDef> patternDefMap = new HashMap<>();
    static final Map<Class<? extends IDomainExtension>, List<PatternDef>> sortedPatternMap = new HashMap<>();

    // 扩展点 Partner
    static final Map<String, PartnerDef> partnerDefMap = new ConcurrentHashMap<>();
    static PartnerDef partnerDefPrepared = null;

    // 扩展点 Policy
    static final Map<Class<? extends IDomainExtension>, PolicyDef> policyDefMap = new HashMap<>();
    static final Map<Class<? extends IPolicy>, PolicyDef> policyClazzMap = new HashMap<>();

    // 扩展点 Interceptor
    static IExtensionInterceptor extensionInterceptor = null;

    /**
     * 根据路由器类型找到一个扩展点路由器实例, internal usage only.
     *
     * @param clazz 扩展点路由器类型
     * @param <T>
     * @return 扩展点路由器实例, null if not found
     */
    public static <T extends BaseRouter> T findRouter(@NonNull Class<? extends T> clazz) {
        RouterDef routerDef = routerDefMap.get(clazz);
        if (routerDef == null) {
            /**
             * 研发忘记使用注解{@link io.github.dddplus.annotation.Router}了，线上bug
             * 但如果没有关闭架构守护神ArchitectureEnforcer，则不可能出现该bug
             */
            log.error("{} forgot to apply @Router, ArchitectureEnforcer turned off? indexed:{}", clazz.getCanonicalName(), routerDefMap.keySet());
            return null;
        }

        return (T) routerDef.getBaseRouterBean();
    }

    /**
     * 根据{@link IPolicy}类型寻找其对应的扩展点{@link IDomainExtension}类型.
     *
     * @param policyClazz 策略类型
     * @param <Ext>       扩展点类型
     * @return 该策略对应的扩展点
     */
    public static <Ext extends IDomainExtension> Class<Ext> extClazzOfPolicy(@NonNull Class<? extends IPolicy<Ext, ? extends IIdentity>> policyClazz) {
        PolicyDef policyDef = policyClazzMap.get(policyClazz);
        return (Class<Ext>) policyDef.getExtClazz();
    }

    /**
     * 给定一个扩展点路由器，找到它定义的扩展点接口, internal usage only.
     *
     * @param clazz
     */
    public static Class<? extends IDomainExtension> getBaseRouterExtDeclaration(@NonNull Class<? extends BaseRouter> clazz) {
        RouterDef routerDef = routerDefMap.get(clazz);
        if (routerDef == null) {
            /**
             * 研发忘记使用注解{@link io.github.dddplus.annotation.Router}了，线上bug
             * 但如果没有关闭架构守护神ArchitectureEnforcer，则不可能出现该bug
             */
            log.error("{} not apply @Router, ArchitectureEnforcer turned off?", clazz.getCanonicalName());
            return null;
        }

        return routerDef.getExtClazz();
    }

    /**
     * 获取扩展点拦截器实例.
     *
     * <p>目前只支持单例，还没看到注册多个必要.</p>
     */
    public static IExtensionInterceptor registeredInterceptor() {
        return extensionInterceptor;
    }

    /**
     * 获取某一个扩展点的所有实现实例.
     *
     * @param extClazz  extension interface
     * @param identity  业务身份
     * @param firstStop 是否找到一个就返回
     * @return 有效的扩展点列表, empty List if not found
     */
    @NonNull
    public static List<ExtensionDef> findEffectiveExtensions(@NonNull Class<? extends IDomainExtension> extClazz, @NonNull IIdentity identity, boolean firstStop) {
        List<ExtensionDef> effectiveExtensions = new LinkedList<>();

        // O(1) extension locating by Policy
        PolicyDef policyDef = policyDefMap.get(extClazz);
        if (policyDef != null) {
            // bingo! this extension is located by policy
            ExtensionDef extensionByPolicy = policyDef.getExtension(identity);
            if (extensionByPolicy != null) {
                log.info("{} ident:{} use policy:{}", extClazz.getSimpleName(), identity, extensionByPolicy.getCode());
            } else {
                log.info("{} ident:{} use null policy", extClazz.getSimpleName(), identity);
            }
            if (extensionByPolicy == null) {
                // found no extension for this identity
                return effectiveExtensions;
            }

            effectiveExtensions.add(extensionByPolicy);
            return effectiveExtensions;
        }

        // Pattern优先：细粒度的扩展点
        // 否则，Pattern下的扩展点可能会被粗粒度的Partner下扩展点给盖住，无法执行
        // Partner=KA，在Partner下它实现了一个扩展点，这时候签约了一个新KA客户(宝胜)的逻辑稍有不同，因此实现了一个Pattern下的扩展点
        // 如果Partner优先，那么宝胜的扩展点实现永远不会被执行：它被Partner下的扩展点盖住了 -:(
        // 同时，Pattern是有优先级的，典型场景：一个Seller有一个Pattern，该Seller下有2个特殊的Dept，各自有自己的Pattern
        List<PatternDef> sortedPatternDefs = sortedPatternMap.get(extClazz);
        if (sortedPatternDefs != null && !sortedPatternDefs.isEmpty()) {
            // 该扩展点在一些Pattern上有实现，那么通过Pattern把扩展点实例找到
            log.debug("{} found patterns:{}", extClazz.getCanonicalName(), sortedPatternDefs);

            for (PatternDef patternDef : sortedPatternDefs) {
                if (!patternDef.match(identity)) {
                    continue;
                }

                // 找该Pattern下实现了该扩展点接口的实例
                ExtensionDef extensionDef = patternDef.getExtension(extClazz);
                if (extensionDef != null) {
                    effectiveExtensions.add(extensionDef);
                }

                if (firstStop && !effectiveExtensions.isEmpty()) {
                    return effectiveExtensions;
                }
            }
        }

        // 之后再找Partner，也就几个，因此不在意这个遍历的性能损耗
        for (PartnerDef partnerDef : partnerDefMap.values()) {
            ExtensionDef extensionDef = partnerDef.getExtension(extClazz);
            if (extensionDef != null) {
                if (!partnerDef.match(identity)) {
                    continue;
                }

                effectiveExtensions.add(extensionDef);
                break; // 垂直业务是互斥的，不可叠加的
            }
        }

        return effectiveExtensions;
    }

    /**
     * 根据指定条件获取匹配的领域活动步骤列表.
     *
     * @param activityCode 领域活动码，即该步骤属于哪一个领域活动
     * @param stepCodeList 活动步骤的编号{@code code}列表
     * @return 匹配的活动步骤列表, will never be null
     */
    @NonNull
    public static List<StepDef> findDomainSteps(@NonNull String activityCode, @NonNull List<String> stepCodeList) {
        Map<String, StepDef> childMap = domainStepDefMap.get(activityCode);
        if (childMap == null || childMap.isEmpty()) {
            log.error("found NO activity:{}", activityCode);
            return emptySteps;
        }

        List<StepDef> result = new LinkedList<>();
        for (String code : stepCodeList) {
            StepDef stepDef = childMap.get(code);
            if (stepDef != null) {
                result.add(stepDef);
            }
        }

        if (result.size() != stepCodeList.size()) {
            log.warn("expected:{}, got:{} domain steps", stepCodeList.size(), result.size());
        }

        return result;
    }

    static void index(InterceptorDef interceptorDef) {
        if (extensionInterceptor != null) {
            throw BootstrapException.ofMessage("ExtensionInterceptor can only be registered once! " + extensionInterceptor.getClass().getCanonicalName());
        }

        extensionInterceptor = interceptorDef.getInterceptorBean();
    }

    static void index(StepDef stepDef) {
        if (!domainStepDefMap.containsKey(stepDef.getActivity())) {
            domainStepDefMap.put(stepDef.getActivity(), new HashMap<>());
        }

        Map<String, StepDef> childMap = domainStepDefMap.get(stepDef.getActivity());
        if (childMap.containsKey(stepDef.getCode())) {
            throw BootstrapException.ofMessage("duplicated step code: ", stepDef.getCode());
        }

        childMap.put(stepDef.getCode(), stepDef);
        log.debug("indexed {} ", stepDef);
    }

    static void index(DomainDef domainDef) {
        if (domainDefMap.containsKey(domainDef.getCode())) {
            throw BootstrapException.ofMessage("duplicated domain code: ", domainDef.getCode());
        }

        domainDefMap.put(domainDef.getCode(), domainDef);
        log.debug("indexed {}", domainDef);
    }

    static void index(RouterDef routerDef) {
        if (routerDefMap.containsKey(routerDef.getBaseRouterClazz())) {
            throw BootstrapException.ofMessage("duplicated router: ", routerDef.getBaseRouterBean().toString());
        }

        routerDefMap.put(routerDef.getBaseRouterClazz(), routerDef);
        log.debug("indexed {}", routerDef);
    }

    static void index(DomainServiceDef domainServiceDef) {
        if (!domainDefMap.containsKey(domainServiceDef.getDomain())) {
            throw BootstrapException.ofMessage("DomainService domain not found: ", domainServiceDef.getDomain());
        }
        log.debug("indexed {}", domainServiceDef);
    }

    static void index(ExtensionDef extensionDef) {
        if (policyDefMap.containsKey(extensionDef.getExtClazz())) {
            // this extension clazz will use policy
            PolicyDef policyDef = policyDefMap.get(extensionDef.getExtClazz());
            policyDef.registerExtensionDef(extensionDef);

            log.debug("indexed {} on {}", extensionDef, policyDef);
            return;
        }

        if (patternDefMap.containsKey(extensionDef.getCode())) {
            // 基于Pattern的扩展点，因为在pattern里找到了对应的code：extension.code = pattern.code
            PatternDef patternDef = patternDefMap.get(extensionDef.getCode());
            patternDef.registerExtensionDef(extensionDef);

            log.debug("indexed {} on {}", extensionDef, patternDef);
            return;
        }

        if (partnerDefMap.containsKey(extensionDef.getCode())) {
            // 基于垂直业务的扩展点
            PartnerDef partnerDef = partnerDefMap.get(extensionDef.getCode());
            partnerDef.registerExtensionDef(extensionDef);

            log.debug("indexed {} on {}", extensionDef, partnerDef);
            return;
        }

        if (!IDomainExtension.DefaultCode.equals(extensionDef.getCode())) {
            // 扩展点编码，不属于Pattern也不属于Partner，也不是默认的扩展点实现
            throw BootstrapException.ofMessage("invalid extension code: ", extensionDef.getCode());
        }
    }

    static void index(PatternDef patternDef) {
        if (patternDefMap.containsKey(patternDef.getCode())) {
            throw BootstrapException.ofMessage("duplicated pattern code: ", patternDef.getCode());
        }

        // pattern.code不能与partner.code冲突
        if (partnerDefMap.containsKey(patternDef.getCode())) {
            throw BootstrapException.ofMessage("pattern: ", patternDef.getCode(), " conflicts with partner code");
        }

        patternDefMap.put(patternDef.getCode(), patternDef);
        log.debug("indexed {}", patternDef);
    }

    static void index(PartnerDef partnerDef) {
        if (partnerDefMap.containsKey(partnerDef.getCode())) {
            throw BootstrapException.ofMessage("duplicated partner code: ", partnerDef.getCode());
        }

        if (patternDefMap.containsKey(partnerDef.getCode())) {
            throw BootstrapException.ofMessage("partner: ", partnerDef.getCode(), " conflicts with pattern code");
        }

        partnerDefMap.put(partnerDef.getCode(), partnerDef);
        log.debug("indexed {}", partnerDef);
    }

    static void index(PolicyDef policyDef) {
        if (policyDefMap.containsKey(policyDef.getExtClazz())) {
            // 一个扩展点定义只能有一个策略实例
            throw BootstrapException.ofMessage("1 Policy decides only 1 Extension:", policyDef.policyName(), ", ext:", policyDef.getExtClazz().getCanonicalName());
        }
        policyDefMap.put(policyDef.getExtClazz(), policyDef);
        log.debug("indexed {}", policyDef);

        policyClazzMap.put(policyDef.getPolicyClazz(), policyDef);
        log.debug("indexed ext for {}", policyDef.getPolicyBean());
    }

    static void postIndexing() {
        for (PatternDef patternDef : patternDefMap.values()) {
            for (Class<? extends IDomainExtension> extClazz : patternDef.extClazzSet()) {
                if (!sortedPatternMap.containsKey(extClazz)) {
                    sortedPatternMap.put(extClazz, new ArrayList<>());
                }

                sortedPatternMap.get(extClazz).add(patternDef);
            }
        }

        for (List<PatternDef> patternDefs : sortedPatternMap.values()) {
            Collections.sort(patternDefs, (p1, p2) -> p1.getPriority() - p2.getPriority());
        }

        // patternDefMap在运行时已经没有用了
        patternDefMap.clear();

        // 把内部注册表信息暴露，以便上层应用方便集成
        DomainArtifacts.getInstance().export();
    }

    static void prepare(PartnerDef partnerDef) {
        partnerDefPrepared = partnerDef;
    }

    static void prepare(ExtensionDef extensionDef) {
        if (partnerDefPrepared == null) {
            // implicit ordering: 框架内部永远会先 prepare(partnerDef)，再 prepare(extensionDef)
            // 由于这个顺序不会暴露外部，这个隐含的条件还OK
            throw BootstrapException.ofMessage("Partner must reside in Plugin Jar with its extensions!");
        }

        partnerDefPrepared.registerExtensionDef(extensionDef);
    }

    static void commitPartner() {
        partnerDefMap.put(partnerDefPrepared.getCode(), partnerDefPrepared);
        log.warn("Partner({}) committed", partnerDefPrepared.getCode());

        partnerDefPrepared = null;

        // refresh the exported domain artifacts
        DomainArtifacts.getInstance().export();
    }
}