Dubbo源码学习--ExceptionFilter 异常处理机制

逃离我推掉我的手 2022-01-26 05:11 138阅读 0赞

# 背景 #

我们的项目使用了dubbo进行不同系统之间的调用。  
每个项目都有一个全局的异常处理，对于业务异常，我们会抛出自定义的业务异常（继承RuntimeException）。  
全局的异常处理会根据不同的异常类型进行不同的处理。  
最近我们发现，某个系统调用dubbo请求，provider端（服务提供方）抛出了自定义的业务异常，但consumer端（服务消费方）拿到的并不是自定义的业务异常。  
这是为什么呢？还需要从dubbo的ExceptionFilter说起。

# ExceptionFilter #

如果Dubbo的 **provider端** 抛出异常（Throwable），则会被 **provider端** 的ExceptionFilter拦截到，执行以下invoke方法：

/*
     * Copyright 1999-2011 Alibaba Group.
     *  
     * 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 com.alibaba.dubbo.rpc.filter;
     
    import java.lang.reflect.Method;
     
    import com.alibaba.dubbo.common.Constants;
    import com.alibaba.dubbo.common.extension.Activate;
    import com.alibaba.dubbo.common.logger.Logger;
    import com.alibaba.dubbo.common.logger.LoggerFactory;
    import com.alibaba.dubbo.common.utils.ReflectUtils;
    import com.alibaba.dubbo.common.utils.StringUtils;
    import com.alibaba.dubbo.rpc.Filter;
    import com.alibaba.dubbo.rpc.Invocation;
    import com.alibaba.dubbo.rpc.Invoker;
    import com.alibaba.dubbo.rpc.Result;
    import com.alibaba.dubbo.rpc.RpcContext;
    import com.alibaba.dubbo.rpc.RpcException;
    import com.alibaba.dubbo.rpc.RpcResult;
    import com.alibaba.dubbo.rpc.service.GenericService;
     
    /**
     * ExceptionInvokerFilter
     * <p>
     * 功能：
     * <ol>
     * <li>不期望的异常打ERROR日志（Provider端）<br>
     *     不期望的日志即是，没有的接口上声明的Unchecked异常。
     * <li>异常不在API包中，则Wrap一层RuntimeException。<br>
     *     RPC对于第一层异常会直接序列化传输(Cause异常会String化)，避免异常在Client出不能反序列化问题。
     * </ol>
     * 
     * @author william.liangf
     * @author ding.lid
     */
    @Activate(group = Constants.PROVIDER)
    public class ExceptionFilter implements Filter {
     
        private final Logger logger;
        
        public ExceptionFilter() {
            this(LoggerFactory.getLogger(ExceptionFilter.class));
        }
        
        public ExceptionFilter(Logger logger) {
            this.logger = logger;
        }
        
        public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
            try {
                Result result = invoker.invoke(invocation);
                if (result.hasException() && GenericService.class != invoker.getInterface()) {
                    try {
                        Throwable exception = result.getException();
     
                        // 如果是checked异常，直接抛出
                        if (! (exception instanceof RuntimeException) && (exception instanceof Exception)) {
                            return result;
                        }
                        // 在方法签名上有声明，直接抛出
                        try {
                            Method method = invoker.getInterface().getMethod(invocation.getMethodName(), invocation.getParameterTypes());
                            Class<?>[] exceptionClassses = method.getExceptionTypes();
                            for (Class<?> exceptionClass : exceptionClassses) {
                                if (exception.getClass().equals(exceptionClass)) {
                                    return result;
                                }
                            }
                        } catch (NoSuchMethodException e) {
                            return result;
                        }
     
                        // 未在方法签名上定义的异常，在服务器端打印ERROR日志
                        logger.error("Got unchecked and undeclared exception which called by " + RpcContext.getContext().getRemoteHost()
                                + ". service: " + invoker.getInterface().getName() + ", method: " + invocation.getMethodName()
                                + ", exception: " + exception.getClass().getName() + ": " + exception.getMessage(), exception);
     
                        // 异常类和接口类在同一jar包里，直接抛出
                        String serviceFile = ReflectUtils.getCodeBase(invoker.getInterface());
                        String exceptionFile = ReflectUtils.getCodeBase(exception.getClass());
                        if (serviceFile == null || exceptionFile == null || serviceFile.equals(exceptionFile)){
                            return result;
                        }
                        // 是JDK自带的异常，直接抛出
                        String className = exception.getClass().getName();
                        if (className.startsWith("java.") || className.startsWith("javax.")) {
                            return result;
                        }
                        // 是Dubbo本身的异常，直接抛出
                        if (exception instanceof RpcException) {
                            return result;
                        }
     
                        // 否则，包装成RuntimeException抛给客户端
                        return new RpcResult(new RuntimeException(StringUtils.toString(exception)));
                    } catch (Throwable e) {
                        logger.warn("Fail to ExceptionFilter when called by " + RpcContext.getContext().getRemoteHost()
                                + ". service: " + invoker.getInterface().getName() + ", method: " + invocation.getMethodName()
                                + ", exception: " + e.getClass().getName() + ": " + e.getMessage(), e);
                        return result;
                    }
                }
                return result;
            } catch (RuntimeException e) {
                logger.error("Got unchecked and undeclared exception which called by " + RpcContext.getContext().getRemoteHost()
                        + ". service: " + invoker.getInterface().getName() + ", method: " + invocation.getMethodName()
                        + ", exception: " + e.getClass().getName() + ": " + e.getMessage(), e);
                throw e;
            }
        }
     
    }

# 如何正确捕获业务异常 #

了解了ExceptionFilter，解决上面提到的问题就很简单了。  
有多种方法可以解决这个问题，每种都有优缺点，这里不做详细分析，仅列出供参考：  
1. 将该异常的包名以"java.或者"javax. " 开头  
2. 使用受检异常（继承Exception）  
3. 不用异常，使用错误码  
4. 把异常放到provider-api的jar包中  
5. 判断异常message是否以XxxException.class.getName()开头（其中XxxException是自定义的业务异常）  
6. provider实现GenericService接口  
7. provider的api明确写明throws XxxException，发布provider（其中XxxException是自定义的业务异常）  
8. 实现dubbo的filter，自定义provider的异常处理逻辑（方法可参考之前的文章给dubbo接口添加白名单——dubbo Filter的使用）

原博客地址：[https://blog.csdn.net/mj158518/article/details/51228649][https_blog.csdn.net_mj158518_article_details_51228649]

[https_blog.csdn.net_mj158518_article_details_51228649]: https://blog.csdn.net/mj158518/article/details/51228649