dubbo服务提供者无法捕捉自定义异常的问题解决

1
package org.apache.dubbo.rpc.filter;
2

3
import org.apache.dubbo.common.constants.CommonConstants;
4
import org.apache.dubbo.common.extension.Activate;
5
import org.apache.dubbo.common.logger.Logger;
6
import org.apache.dubbo.common.logger.LoggerFactory;
7
import org.apache.dubbo.common.utils.ReflectUtils;
8
import org.apache.dubbo.common.utils.StringUtils;
9
import org.apache.dubbo.rpc.Filter;
10
import org.apache.dubbo.rpc.Invocation;
11
import org.apache.dubbo.rpc.Invoker;
12
import org.apache.dubbo.rpc.Result;
13
import org.apache.dubbo.rpc.RpcContext;
14
import org.apache.dubbo.rpc.RpcException;
15
import org.apache.dubbo.rpc.service.GenericService;
16

17
import java.lang.reflect.Method;
18

19
/**
20
 * ExceptionInvokerFilter
21
 * <p>
22
 * Functions:
23
 * <ol>
24
 * <li>unexpected exception will be logged in ERROR level on provider side. Unexpected exception are unchecked
25
 * exception not declared on the interface</li>
26
 * <li>Wrap the exception not introduced in API package into RuntimeException. Framework will serialize the outer exception but stringnize its cause in order to avoid of possible serialization problem on client side</li>
27
 * </ol>
28
 */
29
@Activate(group = CommonConstants.PROVIDER)
30
public class ExceptionFilter implements Filter, Filter.Listener {
31
    private Logger logger = LoggerFactory.getLogger(ExceptionFilter.class);
32

33
    @Override
34
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
35
        return invoker.invoke(invocation);
36
    }
37

38
    @Override
39
    public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
40
        if (appResponse.hasException() && GenericService.class != invoker.getInterface()) {
41
            try {
42
                Throwable exception = appResponse.getException();
43

44
                // directly throw if it's checked exception
45
                // 检查是否是RuntimeException或者Exception 我的自定义异常继承自RuntimeException 不满足此条件
46
                if (!(exception instanceof RuntimeException) && (exception instanceof Exception)) {
47
                    return;
48
                }
49
                // directly throw if the exception appears in the signature
50
                // 方法上也没有声明我的自定义异常 不满足此条件
51
                try {
52
                    Method method = invoker.getInterface().getMethod(invocation.getMethodName(), invocation.getParameterTypes());
53
                    Class<?>[] exceptionClassses = method.getExceptionTypes();
54
                    for (Class<?> exceptionClass : exceptionClassses) {
55
                        if (exception.getClass().equals(exceptionClass)) {
56
                            return;
57
                        }
58
                    }
59
                } catch (NoSuchMethodException e) {
60
                    return;
61
                }
62

63
                // for the exception not found in method's signature, print ERROR message in server's log.
64
                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);
65

66
                // directly throw if exception class and interface class are in the same jar file.
67
                // 如果异常类和接口类在同一jar文件中，则直接抛出 接口和异常不在同一个jar包中 不满足
68
                String serviceFile = ReflectUtils.getCodeBase(invoker.getInterface());
69
                String exceptionFile = ReflectUtils.getCodeBase(exception.getClass());
70
                if (serviceFile == null || exceptionFile == null || serviceFile.equals(exceptionFile)) {
71
                    return;
72
                }
73
                // directly throw if it's JDK exception
74
                // 如果是JDK异常 直接抛出 我的是自定义异常  不满足
75
                String className = exception.getClass().getName();
76
                if (className.startsWith("java.") || className.startsWith("javax.")) {
77
                    return;
78
                }
79
                // directly throw if it's dubbo exception
80
                // 如果是dubbo的异常 直接抛出 我的自定义异常 不满足
81
                if (exception instanceof RpcException) {
82
                    return;
83
                }
84

85
                // otherwise, wrap with RuntimeException and throw back to the client
86
                // 这里就说明了,其它异常会包装成一个RuntimeException并返回给客户端
87
                appResponse.setException(new RuntimeException(StringUtils.toString(exception)));
88
            } catch (Throwable e) {
89
                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);
90
            }
91
        }
92
    }
93

94
    @Override
95
    public void onError(Throwable e, Invoker<?> invoker, Invocation invocation) {
96
        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);
97
    }
98

99
    // For test purpose
100
    public void setLogger(Logger logger) {
101
        this.logger = logger;
102
    }
103
}

1
import com.tianch.platform.common.log.exception.PException;
2
import com.tianch.platform.common.log.exception.enmus.PExceptionEnum;
3
import lombok.extern.slf4j.Slf4j;
4
import org.apache.dubbo.common.constants.CommonConstants;
5
import org.apache.dubbo.common.extension.Activate;
6
import org.apache.dubbo.common.utils.ReflectUtils;
7
import org.apache.dubbo.rpc.*;
8
import org.apache.dubbo.rpc.service.GenericService;
9

10
import java.lang.reflect.Method;
11

12
@Slf4j
13
@Activate(group = CommonConstants.PROVIDER)
14
public class DubboProviderFilter implements Filter, Filter.Listener {
15

16
    @Override
17
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws org.apache.dubbo.rpc.RpcException {
18
        return invoker.invoke(invocation);
19
    }
20

21
    @Override
22
    public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
23
        if (appResponse.hasException() && GenericService.class != invoker.getInterface()) {
24
            try {
25
                Throwable exception = appResponse.getException();
26

27
                // directly throw if it's checked exception
28
                if (!(exception instanceof RuntimeException) && (exception instanceof Exception)) {
29
                    return;
30
                }
31
                // directly throw if the exception appears in the signature
32
                try {
33
                    Method method = invoker.getInterface().getMethod(invocation.getMethodName(), invocation.getParameterTypes());
34
                    Class<?>[] exceptionClassses = method.getExceptionTypes();
35
                    for (Class<?> exceptionClass : exceptionClassses) {
36
                        if (exception.getClass().equals(exceptionClass)) {
37
                            return;
38
                        }
39
                    }
40
                } catch (NoSuchMethodException e) {
41
                    return;
42
                }
43

44
                // for the exception not found in method's signature, print ERROR message in server's log.
45
                log.error("Got unchecked and undeclared exception which called by " + org.apache.dubbo.rpc.RpcContext.getContext().getRemoteHost() + ". service: " + invoker.getInterface().getName() + ", method: " + invocation.getMethodName() + ", exception: " + exception.getClass().getName() + ": " + exception.getMessage(), exception);
46

47
                // directly throw if exception class and interface class are in the same jar file.
48
                String serviceFile = ReflectUtils.getCodeBase(invoker.getInterface());
49
                String exceptionFile = ReflectUtils.getCodeBase(exception.getClass());
50
                if (serviceFile == null || exceptionFile == null || serviceFile.equals(exceptionFile)) {
51
                    return;
52
                }
53
                // directly throw if it's JDK exception
54
                String className = exception.getClass().getName();
55
                if (className.startsWith("java.") || className.startsWith("javax.")) {
56
                    return;
57
                }
58
                // directly throw if it's dubbo exception
59
                if (exception instanceof RpcException) {
60
                    return;
61
                }
62

63
                // 如果是我们的自定义异常
64
                if (exception instanceof PException) {
65
                    return;
66
                }
67

68
                 // otherwise, 包装成我们的自定义异常
69
                String application = invoker.getUrl().getParameter(CommonConstants.APPLICATION_KEY);
70
                PException pException = new PException(application, PExceptionEnum.SYSTEM_EXCEPTION.getCode(), exception.getMessage());
71
                appResponse.setException(pException);
72
            } catch (Throwable e) {
73
                log.warn("Fail to ExceptionFilter when called by " + org.apache.dubbo.rpc.RpcContext.getContext().getRemoteHost() + ". service: " + invoker.getInterface().getName() + ", method: " + invocation.getMethodName() + ", exception: " + e.getClass().getName() + ": " + e.getMessage(), e);
74
            }
75
        }
76
    }
77

78
    @Override
79
    public void onError(Throwable e, Invoker<?> invoker, Invocation invocation) {
80
        log.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);
81
    }
82

83
}