net.hasor.core.AppContext Maven / Gradle / Ivy

/*
 * Copyright 2008-2009 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 net.hasor.core;
import net.hasor.utils.StringUtils;

import java.io.Closeable;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;

/**
 * Hasor的核心接口，它为应用程序提供了一个统一的配置界面和运行环境。
 * @version : 2013-3-26
 * @author 赵永春 ([email protected])
 */
public interface AppContext extends MetaInfo, Closeable {
    /** 容器事件，在所有模块 start 阶段之后引发。
     * @see net.hasor.core.context.TemplateAppContext*/
    public static final String ContextEvent_Started  = "ContextEvent_Started";
    /** 容器事件，在所有模块 start 阶段之后引发。
     * @see net.hasor.core.context.TemplateAppContext*/
    public static final String ContextEvent_Shutdown = "ContextEvent_Shutdown";

    /** @return 获取 {@link Environment} */
    public Environment getEnvironment();

    /** 获取当创建Bean时使用的{@link ClassLoader} */
    public default ClassLoader getClassLoader() {
        return this.getEnvironment().getClassLoader();
    }

    /**
     * 启动，如果在启动期间发生异常，将会抛出该异常。该方式不会等待异步的 doStartCompleted 任务执行完。
     * @param modules 启动时使用的模块。
     * @throws Throwable 启动过程中引发的异常。
     */
    public void start(Module... modules) throws Throwable;

    /**
     * 确定 AppContext 目前状态是否处于启动状态。
     * @return 返回 true 表示已经完成初始化并且启动完成。false表示尚未完成启动过程。
     */
    public boolean isStart();

    /** 发送停止通知（非线程安全） */
    public void shutdown();

    public default void close() {
        this.shutdown();
    }

    /** 阻塞当前线程的继续执行，直到 {@link AppContext#shutdown()} 被调用 */
    public default void join() {
        this.join(0, null);
    }

    /** 阻塞当前线程的继续执行，直到 {@link AppContext#shutdown()} 被调用 */
    public void join(long timeout, TimeUnit unit);

    /** 阻塞当前线程的继续执行，直到 signal 的 notify 或 notifyAll 被调用 */
    public default void waitSignal(Object signal) throws InterruptedException {
        this.waitSignal(signal, 0, null);
    }

    /** 阻塞当前线程的继续执行，直到 signal 的 notify 或 notifyAll 被调用 */
    public void waitSignal(Object signal, long timeout, TimeUnit unit) throws InterruptedException;

    /*---------------------------------------------------------------------------------------Bean*/

    /** 通过 bindID 获取 Bean 的类型 */
    public Class getBeanType(String bindID);

    /** @return 获取当前所有 bindID */
    public String[] getBindIDs();

    /** @return 如果存在目标类型的 Bean 则返回 Bean 的名称 */
    public default String[] getNames(final Class targetClass) {
        Objects.requireNonNull(targetClass, "targetClass is null.");
        List> infoList = findBindingRegister(targetClass);
        return infoList.stream()                                            //
                .map((Function, String>) BindInfo::getBindName) //
                .filter(StringUtils::isNotBlank)                            //
                .toArray(String[]::new);
    }

    /** @return 判断是否存在某个 bindID */
    public boolean containsBindID(String bindID);

    /** 是否为单例 */
    public boolean isSingleton(BindInfo bindInfo);

    /** 是否为单例 */
    public boolean isSingleton(Class targetType);

    /** 根据 bindID 获取{@link BindInfo} */
    public  BindInfo getBindInfo(String bindID);

    /** 根据类型获取{@link BindInfo}，该方法相当于 findBindingRegister(null,bindType) */
    public default  BindInfo getBindInfo(Class bindType) {
        return findBindingRegister(null, bindType);
    }

    /** 根据ID 类型创建 Bean */
    public default  T getInstance(String bindID) {
        Objects.requireNonNull(bindID, "bindID is null.");
        BindInfo bindInfo = getBindInfo(bindID);
        if (bindInfo != null) {
            return this.getInstance(bindInfo);
        }
        return null;
    }

    /** 根据类型创建 Bean */
    public default  T getInstance(Class targetClass) {
        Objects.requireNonNull(targetClass, "targetClass is null.");
        return this.getProvider(targetClass, new Object[0]).get();
    }

    /** 根据类型创建 Bean */
    public default  T getInstance(Class targetClass, Object... params) {
        Objects.requireNonNull(targetClass, "targetClass is null.");
        return this.getProvider(targetClass, params).get();
    }

    /** 根据构造方法创建 Bean */
    public default  T getInstance(Constructor targetConstructor, Object... params) {
        Objects.requireNonNull(targetConstructor, "targetConstructor is null.");
        return this.getProvider(targetConstructor, params).get();
    }

    /** 根据 BindInfo 创建 Bean */
    public default  T getInstance(BindInfo info) {
        Supplier provider = this.getProvider(info);
        if (provider != null) {
            return provider.get();
        }
        return null;
    }

    /** 根据 bindID 创建 Bean 的 Provider */
    public  Supplier getProvider(String bindID);

    /** 根据类型创建创建 Bean 的 Provider */
    public default  Supplier getProvider(Class targetClass) {
        Objects.requireNonNull(targetClass, "targetClass is null.");
        return this.getProvider(targetClass, new Object[0]);
    }

    /** 根据类型创建创建 Bean 的 Provider */
    public  Supplier getProvider(Class targetClass, Object... params);

    /** 根据构造方法创建 Bean 的 Provider */
    public  Supplier getProvider(Constructor targetConstructor, Object... params);

    /** 根据 BindInfo 创建 Bean 的 Provider */
    public  Supplier getProvider(BindInfo info);

    /** 将 AppContext 接口的 getInstance(Class) 能力转换为 TypeSupplier 接口形式。*/
    public default TypeSupplier wrapTypeSupplier() {
        return AppContext.this::getInstance;
    }

    /** 对 object 对象仅执行依赖注入，要注入的属性等信息参照：findBindingRegister(null,object.getClass())。
     * 如果参照信息为空，那么将直接 return object。 */
    public default  T justInject(T object) {
        if (object == null) {
            return null;
        }
        return this.justInject(object, object.getClass());
    }

    /** 对 object 对象仅执行依赖注入，要注入的属性等信息参照：findBindingRegister(null,bindType)。
     * 如果参照信息为空，那么将直接 return object。 */
    public  T justInject(T object, Class beanType);

    /** 对 object 对象仅执行依赖注入，要注入的属性等信息参照：bindInfo。
     * 如果参照信息为空，那么将直接 return object。 */
    public  T justInject(T object, BindInfo bindInfo);


    /*-------------------------------------------------------------------------------------Binder*/

    /**
     * 获取可以构建出 bindType 的所有 BindInfo，最后创建这些 Bean 对象。
     * @param bindType bean type
     * @return 返回符合条件的绑定对象。
     */
    public default  List findBindingBean(final Class bindType) {
        return this.findBindingRegister(bindType).stream()  //
                .map(this::getInstance)                     //
                .collect(Collectors.toList());
    }

    /**
     * 获取可以构建出 bindType 的所有 BindInfo，最后创建这些 Bean 对象
     * （Provider形式返回，真正创建 Bean 的时机是当调用 Provider.get 方法时，相当于Lazy）
     * @param bindType bean type
     * @return 返回符合条件的绑定对象。
     */
    public default  List> findBindingProvider(final Class bindType) {
        return this.findBindingRegister(bindType).stream()  //
                .map((Function, Supplier>) this::getProvider)//
                .collect(Collectors.toList());
    }

    /**
     * 根据名字和类型查找对应的 BindInfo 然后创建这个 Bean。
     * @param withName name
     * @param bindType bean type
     * @return 返回符合条件的绑定对象。
     */
    public default  T findBindingBean(final String withName, final Class bindType) {
        Objects.requireNonNull(bindType, "bindType is null.");
        BindInfo typeRegister = this.findBindingRegister(withName, bindType);
        if (typeRegister != null) {
            return this.getInstance(typeRegister);
        }
        return null;
    }

    /**
     * 根据名字和类型查找对应的 BindInfo 然后创建这个 Bean。
     * （Provider形式返回，真正创建 Bean 的时机是当调用 Provider.get 方法时，相当于Lazy）
     * @param withName 绑定名称。
     * @param bindType bean type
     * @return 返回{@link Provider}形式对象。
     */
    public default  Supplier findBindingProvider(final String withName, final Class bindType) {
        Objects.requireNonNull(bindType, "bindType is null.");
        return findBindingRegister(bindType).stream().filter(bindInfo -> {
            return StringUtils.equals(bindInfo.getBindName(), withName);
        }).findFirst().map((Function, Supplier>) this::getProvider).orElse(null);
    }

    /**
     * 获取可以构建出 bindType 的所有 BindInfo。
     * @param bindType bean type
     * @return 返回所有符合条件的绑定信息。
     */
    public  List> findBindingRegister(Class bindType);

    /**
     * 根据名字和类型查找对应的 BindInfo。
     * @param withName 绑定名
     * @param bindType bean type
     * @return 返回所有符合条件的绑定信息。
     */
    public default  BindInfo findBindingRegister(String withName, Class bindType) {
        Objects.requireNonNull(bindType, "bindType is null.");
        return findBindingRegister(bindType).stream().filter(bindInfo -> {
            return StringUtils.equals(bindInfo.getBindName(), withName);
        }).findFirst().orElse(null);
    }

    /** 根据类型查找作用域 */
    public default Supplier findScope(Class scopeType) {
        return findScope(scopeType.getName());
    }

    /** 根据名字查找作用域 */
    public Supplier findScope(String scopeName);
}