apache dubbo 2.7.3 源代码片段 - Protocol扩展的Filter机制

org.apache.dubbo.rpc.protocol.ProtocolFilterWrapper

package org.apache.dubbo.rpc.protocol;

import org.apache.dubbo.common.URL;
import org.apache.dubbo.common.constants.CommonConstants;
import org.apache.dubbo.common.extension.ExtensionLoader;
import org.apache.dubbo.rpc.Exporter;
import org.apache.dubbo.rpc.Filter;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.ListenableFilter;
import org.apache.dubbo.rpc.Protocol;
import org.apache.dubbo.rpc.Result;
import org.apache.dubbo.rpc.RpcException;

import java.util.List;

import static org.apache.dubbo.common.constants.RegistryConstants.REGISTRY_PROTOCOL;
import static org.apache.dubbo.rpc.Constants.REFERENCE_FILTER_KEY;
import static org.apache.dubbo.rpc.Constants.SERVICE_FILTER_KEY;

/**
 * ListenerProtocol
 */
public class ProtocolFilterWrapper implements Protocol {

    private final Protocol protocol;

    public ProtocolFilterWrapper(Protocol protocol) {
        if (protocol == null) {
            throw new IllegalArgumentException("protocol == null");
        }
        this.protocol = protocol;
    }

    private static <T> Invoker<T> buildInvokerChain(final Invoker<T> invoker, String key, String group) {
        Invoker<T> last = invoker;

        // echo=org.apache.dubbo.rpc.filter.EchoFilter
        // generic=org.apache.dubbo.rpc.filter.GenericFilter
        // genericimpl=org.apache.dubbo.rpc.filter.GenericImplFilter
        // token=org.apache.dubbo.rpc.filter.TokenFilter
        // accesslog=org.apache.dubbo.rpc.filter.AccessLogFilter
        // activelimit=org.apache.dubbo.rpc.filter.ActiveLimitFilter
        // classloader=org.apache.dubbo.rpc.filter.ClassLoaderFilter
        // context=org.apache.dubbo.rpc.filter.ContextFilter
        // consumercontext=org.apache.dubbo.rpc.filter.ConsumerContextFilter
        // exception=org.apache.dubbo.rpc.filter.ExceptionFilter
        // executelimit=org.apache.dubbo.rpc.filter.ExecuteLimitFilter
        // deprecated=org.apache.dubbo.rpc.filter.DeprecatedFilter
        // compatible=org.apache.dubbo.rpc.filter.CompatibleFilter
        // timeout=org.apache.dubbo.rpc.filter.TimeoutFilter

        // 获取过滤器列表
        // key === "reference.filter"
        // key === "service.filter"
        List<Filter> filters = ExtensionLoader.getExtensionLoader(Filter.class)
                // url.getParameter("service.filter")
                .getActivateExtension(invoker.getUrl(), key, group);

        if (!filters.isEmpty()) {
            // 构建过滤器链
            for (int i = filters.size() - 1; i >= 0; i--) { // 倒排
                final Filter filter = filters.get(i);
                final Invoker<T> next = last;
                last = new Invoker<T>() {

                    @Override
                    public Class<T> getInterface() {
                        return invoker.getInterface();
                    }

                    @Override
                    public URL getUrl() {
                        return invoker.getUrl();
                    }

                    @Override
                    public boolean isAvailable() {
                        return invoker.isAvailable();
                    }

                    @Override
                    public Result invoke(Invocation invocation) throws RpcException {
                        Result asyncResult;
                        try {
                            asyncResult = filter.invoke(next, invocation); // 调用过滤器
                        } catch (Exception e) {
                            // onError callback
                            if (filter instanceof ListenableFilter) {
                                Filter.Listener listener = ((ListenableFilter) filter).listener(); // 调用出现异常，有配置监听器
                                if (listener != null) {
                                    listener.onError(e, invoker, invocation); // 触发 onError 方法
                                }
                            }
                            throw e;
                        }
                        return asyncResult;
                    }

                    @Override
                    public void destroy() {
                        invoker.destroy();
                    }

                    @Override
                    public String toString() {
                        return invoker.toString();
                    }
                };
            }
        }

        //
        return new CallbackRegistrationInvoker<>(last, filters); // !!!
    }

    @Override
    public int getDefaultPort() {
        return protocol.getDefaultPort();
    }

    @Override
    public <T> Exporter<T> export(Invoker<T> invoker) throws RpcException {
        if (REGISTRY_PROTOCOL.equals(invoker.getUrl().getProtocol())) {  // 不处理 registry 机制
            return protocol.export(invoker);
        }

        return protocol.export(
                // 构建《过滤器链》
                buildInvokerChain(invoker, SERVICE_FILTER_KEY, CommonConstants.PROVIDER)
        );
    }

    @Override
    public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
        if (REGISTRY_PROTOCOL.equals(url.getProtocol())) { // 不处理 registry 机制
            return protocol.refer(type, url);
        }
        return buildInvokerChain(protocol.refer(type, url), REFERENCE_FILTER_KEY, CommonConstants.CONSUMER);
    }

    @Override
    public void destroy() {
        protocol.destroy();
    }

    /**
     * Register callback for each filter may be better, just like {@link java.util.concurrent.CompletionStage}, each callback
     * registration generates a new CompletionStage whose status is determined by the original CompletionStage.
     *
     * If bridging status between filters is proved to not has significant performance drop, consider revert to the following commit:
     * https://github.com/apache/dubbo/pull/4127
     */
    static class CallbackRegistrationInvoker<T> implements Invoker<T> {

        private final Invoker<T> filterInvoker;
        private final List<Filter> filters;

        public CallbackRegistrationInvoker(Invoker<T> filterInvoker, List<Filter> filters) {
            this.filterInvoker = filterInvoker; // 第一个过滤器
            this.filters = filters;
        }

        @Override
        public Result invoke(Invocation invocation) throws RpcException {
            Result asyncResult = filterInvoker.invoke(invocation); // 调用过滤器

            asyncResult = asyncResult.whenCompleteWithContext((r, t) -> {
                for (int i = filters.size() - 1; i >= 0; i--) { // 倒排
                    Filter filter = filters.get(i);
                    // onResponse callback
                    if (filter instanceof ListenableFilter) {
                        Filter.Listener listener = ((ListenableFilter) filter).listener();
                        if (listener != null) {
                            if (t == null) {
                                listener.onResponse(r, filterInvoker, invocation); // 响应
                            } else {
                                listener.onError(t, filterInvoker, invocation); // 出错
                            }
                        }
                    } else {
                        filter.onResponse(r, filterInvoker, invocation);
                    }
                }
            });
            return asyncResult;
        }

        @Override
        public Class<T> getInterface() {
            return filterInvoker.getInterface();
        }

        @Override
        public URL getUrl() {
            return filterInvoker.getUrl();
        }

        @Override
        public boolean isAvailable() {
            return filterInvoker.isAvailable();
        }

        @Override
        public void destroy() {
            filterInvoker.destroy();
        }
    }
}