Dubbo全局处理业务异常 (自定义dubbo异常过滤器)

于 2024-05-14 15:33:40 发布
阅读量684 收藏 21
点赞数 5
分类专栏： dubbo 文章标签： dubbo java spring java-zookeeper idea 程序员创富 程序人生
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hbtstsxy/article/details/138855324
版权

自定义dubbo异常过滤器

一、前置问题介绍：

问题一

在dubbo框架中，由于一些 interface 接口未显示的声明抛出异常，导致dubbo在捕获异常时发现抛出的异常为非声明的异常，其也不属于jdk的异常，则dubbo框架会自动封装成 new RuntimeException(StringUtils.toString(exception))) 异常抛出；

问题二

针对一些自定义的异常，不希望被Dubbo框架捕获，只希望逐级向上抛出，直到业务的最顶层在捕获异常的code和message，并返回给前端显示code(这种情况适用于系统内部有自己定义的一套异常码，通过前端显示的code值能清晰的知道异常的问题是什么)

二、Dubbo的异常过滤器源码如下：

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>
 * 
 */
@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;
        }
    }

}

三、实现方案 - 重写Dubbo的Filter异常过滤器

1、将上述 Dubbo 源码中 ExceptionFilter 复制到我们的项目改名为 DubboExceptionFilter

可直接粘贴本代码片段到IDEA中，只需将内部 start - end 中间的代码替换成自己实际的业务异常处理逻辑；


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.*;
import com.alibaba.dubbo.rpc.service.GenericService;

/**
 * @author : gaogao
 * @version 1.0
 * @date : 2024-03-14 10:08
 *
 * 由于dubbo异常过滤器源码的问题，如果自定义的异常未在方法上声明，导致异常无法正常抛出，而是被过滤器包装成RuntimeException抛给客户端
 * 此工具类为重写dubbo异常拦截器，支持抛出自定义的异常！！！
 *
 * 如果使用此工具类需要注意几点：
 * 1、拦截器只拦截provider端，consumer端不需要拦截器
 * 2、需要在resources目录下创建 META-INF/dubbo目录，并创建 com.alibaba.dubbo.rpc.Filter 文件(注意文件层级：resources/META-INF/dubbo/com.alibaba.dubbo.rpc.Filter)，
 * 文件内容为：dubboExceptionFilter=com.bosssoft.cloud.coreservice.base.config.DubboExceptionFilter
 * 解释说明：dubboExceptionFilter：即你给这个过滤器取的名称，com.bosssoft.cloud.coreservice.base.config.DubboExceptionFilter：表示过滤器对应的完整路径
 *
 * 3、在ProviderConfig【此处为java代码示例，若为.xml配置文件可使用<dubbo:provider filter="dubboExceptionFilter,-exception"/>】 的配置中设置 ：
 *   providerConfig.setFilter("dubboExceptionFilter,-exception");
 *   解释说明：dubboExceptionFilter为自己定义的过滤器名称；额外追加的 -exception ，是因为如果不加上 -exception 我们自己重写的过滤器确实生效了，但Dubbo自身默认的 ExceptionFilte 任然在工作
 *   （一个异常抛出会依次进入两个过滤器）所以我们需要 禁用 掉Dubbo默认的过滤器；同理，如果想禁用其它的过滤器，都可以通过 -过滤器名称来实现；
 *
 *  如果想更加深入了解dubbo的过滤器源码，可翻看阿里巴巴的com.alibaba.dubbo.rpc.filter.ExceptionFilter
 *
 */

@Activate(group = Constants.PROVIDER)
public class DubboExceptionFilter implements Filter {

    private final Logger logger;

    public DubboExceptionFilter() {
        this(LoggerFactory.getLogger(DubboExceptionFilter.class));
    }

    public DubboExceptionFilter(Logger logger) {
        this.logger = logger;
    }

    @Override
    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;
                    }

                    String className = exception.getClass().getName();
                    
					//-----------------------------start--------------------------------------------
					//    在此可针对捕获到的异常，实现自己本身系统内部的异常业务逻辑
					
                    // 由于自身业务系统的业务，在此捕获自定义的异常直接返回，向上抛出；避免后续包装成RuntimeException抛给客户端
                    if (className.contains("com.cloud.component.exception.XXXXXXException")
                        || className.contains("com.cloud.component.exception.XXXXXXException")) {
                        return result;
                    }
					//-------------------------------end--------------------------------------------
					
                    // 在方法签名上有声明，直接抛出
                    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("未在方法签名上定义的异常： " + 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自带的异常，直接抛出
                    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;
        }
    }
}

2、在resources目录下添加纯文本文件 META-INF/dubbo/com.alibaba.dubbo.rpc.Filter 并在文件中添加如下内容：

dubboExceptionFilter=com.cloud.util.dubbo.DubboExceptionFilter

请将 = 后边的内容换成 DubboExceptionFilter 自定义过滤器的实际类路径

如下图：
在这里插入图片描述

3、修改dubbo 的配置文件，将 DubboExceptionFilter 加载进去并且去掉自身的 ExceptionFilter

1)若采用 .xml配置文件，则补充如下内容：

<dubbo:providerfilter="dubboExceptionFilter,-exception"/>

2)若采用 java代码，使用@Bean装配时，请在 DubboProviderConfig dubbo的提供者中补充如下内容：

 @Bean
 public ProviderConfig providerConfig() {
        ProviderConfig providerConfig = new ProviderConfig();
        providerConfig.setId("proload");
        providerConfig.setPayload(52428800);
        providerConfig.setFilter("dubboExceptionFilter,-exception");
        return providerConfig;
 }

至此，Dubbo自定义异常过滤器已完结！

如果流程中哪里不懂，请仔细认真阅读 3.1章节 中的 DubboExceptionFilter类注释 ~~~

@ Gao
关注
  • 5
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
dubbo捕获自定义异常_dubbo异常捕获_dubbo异常_自定义异常_捕捉异常_
10-01
解决dubbo接口自定义异常的捕捉问题，dubbo消费者可以捕捉到提供者所抛出的自定义异常。
dubbo项目全局异常处理
hero_hope的博客
11-11 2849
一. 问题 dubbo项目中, 定义了全局异常处理类以后, 在provider中抛出的自定义异常在consumer中捕获不到 二. 原因 dubbo源码中对异常进行了异常过滤处理, 源码入下: package com.alibaba.dubbo.rpc.filter; import ... @Activate(group = Constants.PROVIDER) public class Exc...
Dubbo异常处理
li12412414的博客
01-13 1457
在使用Dubbo进行系统间的调用的时候，我们有时候可能会遇到这样的问题:服务提供者抛出了自定义的业务异常，但是服务消费者接收到的却是RunTimeException。这是为什么呢？这就得从Dubbo的ExceptionFilter说起。
Dubbo如何处理业务异常，这个一定要知道哦！
最新发布
2401_83916394的博客
04-08 689
在这个部分总结了2019年到目前为止Java常见面试问题，取其面试核心编写成这份文档笔记，从中分析面试官的心理，摸清面试官的“套路”，可以说搞定90%以上的Java中高级面试没一点难度。本节总结的内容涵盖了：消息队列、Redis缓存、分库分表、读写分离、设计高并发系统、分布式系统、高可用系统、SpringCloud微服务架构等一系列互联网主流高级技术的知识点。（上述只是一个整体目录大纲，每个点里面都有如下所示的详细内容，从面试问题——分析面试官心理——剖析面试题——完美解答的一个过程）
dubbo 统一异常处理
一生编程，快乐编程
04-03 425
指定切入点，进行环绕通知。如果有异常，就捕获后处理。
dubbo参数校验&统一异常转response处理
u014551778的博客
03-16 1304
这样之后发现普通的抛出异常可以catch，但是参数校验的异常直接catch不到，原因大概是默认的参数校验filter在异常处理filter之前就返回了。因此要自定义exceptionFilter取代自带的异常处理，在dubbo自带的基础上增加转换response的逻辑。在网上还看到可以覆盖filter 的，但是实测不行，会走到ExtensionLoader的判重逻辑里面，报。先读内部的，再读外部的。目标：能把参数校验异常、自定义异常转化为自定义的response结构。尝试第二种：全局异常处理放到最前面。
dubbo(四)异常处理
m0_67392126的博客
08-14 1281
想当然的就用spring的AOP功能来实现.(解决一个bug,引入另外的bug[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TJTpaeOZ-1660432261097)(http://static.blog.csdn.net/xheditor/xheditor_emot/default/laugh.gif)]).5)自定义异常的包名以java.或javax.开头(dubbo判断jdk自带异常的条件,一般项目都有自己的命名规范,这样干的估计很少)...
SpringBoot统一处理dubbo接口异常和错误
佳豪的博客
02-28 1545
无controller层的dubbo接口的统一异常处理
Dubbo自定义异常全局统一处理
qq_42865087的博客
05-11 2811
前言： 在业务的开发过程当中，我们往往会有各种各样的业务性异常，比如创建订单操作。 假如创建订单操作分成两步，第一步是先创建订单消息，第二步是扣除用户余额。 假如在扣除用户余额的过程中，发现该用户的余额不足，那么我们可能需要给用户反馈一个余额不足的提醒。那么就有两种方式。 第一种，返回一个自己包装的响应对象，return出去（这种如果操作涉及多个事务修改操作，那么之前的事务是可以正常提交的，会有问题，需要视情况而定）。 第二种，直接throw一个自定义的业务异常，然后全局异常统一处理成响应对象再retur.
Dubbo主要的异常类型及处理
王文萱的博客
03-11 3794
Dubbo主要的异常类型及处理
dubbo traceid
01-10
在Dubbo的配置文件中（如`dubbo.properties`或XML配置），需要将我们的`TraceIdFilter`注册为一个服务过滤器，这样它将在每次服务调用时自动生效。 6. **日志处理** 最后，我们需要对日志系统进行适配，使其能够...
dubbo入门及高级特性资料
12-02
- **服务过滤器（Filter）**：在调用前后插入自定义逻辑，如日志记录、权限验证等。 - **服务路由（Router）**：可以根据不同的规则，如IP、版本等，动态改变服务调用路径。 - **服务调用链跟踪（Tracer）**：如...
dubbo xsd的支持
04-16
10. `<dubbo:filter>` 和 `<dubbo:executor>`：分别用于添加服务过滤器和定制线程池，增强服务行为。 了解这些知识点后，开发者可以根据实际需求，通过XML配置文件灵活地调整和优化Dubbo服务的运行行为。正确理解和...
dubbo整合spring
06-03
- 服务过滤器：Dubbo允许自定义过滤器，实现请求拦截、数据校验、限流等功能。 - 异步调用：通过配置`async`属性，可以使服务调用变为异步，提高系统响应速度。 总的来说，"dubbo整合spring"项目展示了如何利用...
Dubbo——全局异常拦截
看不懂的男孩的博客
10-31 1118
经常对web接口进行全局异常拦截，那Dubbo的RPC调用是否有异常拦截呢？我们如何自定义RPC调用的异常拦截？
Dubbo异常拦截ExceptionFilter异常处理,服务端抛出的异常与消费端接收异常不一致解决方案
朝夕不待人的博客
08-06 2963
起因 发现这个问题的起因是前端联调接口的时候发现统一的异常处理没有发挥作用,我们定义的处理的异常类型为AppException(国际惯例继承于RuntimeException),但是Dubbo服务端实际返回的异常变成了RuntimeException,我们自定义的异常处理没有发生作用. 深入研究Dubbo的异常处理 针对发现的问题,查阅了相关的代码和源码发现Dubbo有一个自带的过滤器接口声明了,并且实现了一个异常过滤器,当服务端抛出异常给消费端时异常都会被该异常过滤器处理(其实可以转换思维理解一下,rpc
Dubbo如何处理业务异常
hober的专栏
06-14 1828
最近产线上出现了一个下游服务抛出的Error，传递到上游的问题。引发了大家对于Dubbo异常处理的讨论。 Dubbo实际上不处理异常，只是做异常的传递。下游业务系统如果没有catch住自己内部系统的异常，经由Dubbo调用后，上游系统会收到同样的异常。
Dubbo分布式服务框架常见问题解答汇总
热门推荐
杨春建的博客
08-19 4万+
1. 如果服务注册不上怎么办？ (1) 检查dubbo的jar包有没有在classpath中，以及有没有重复的jar包 (2) 检查有没有重复的dubbo.properties配置文件 (3) 检查暴露服务的spring配置有没有加载 (4) 检查beanId或beanName有没有重复 (5) 查看有没有错误日志： cat ~/output/logs/webx
dubbo怎么设置全局异常捕获
05-17
在 Dubbo 中，可以通过实现 `Filter` 接口来设置全局异常捕获。具体步骤如下： 1. 创建一个实现了 `Filter` 接口的全局异常处理类，例如： ```java public class DubboExceptionFilter implements Filter { @Override public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException { try { // 执行 RPC 调用 return invoker.invoke(invocation); } catch (Exception e) { // 异常处理逻辑 throw new RpcException("Dubbo Exception Filter caught exception: " + e.getMessage(), e); } } } ``` 2. 在 Dubbo 的配置文件 `dubbo.xml` 中配置该全局异常处理类，例如： ```xml <dubbo:protocol name="dubbo" port="20880"/> <dubbo:service interface="com.example.service.SomeService" ref="someService"/> <dubbo:reference interface="com.example.service.SomeService" id="someService"/> <dubbo:consumer filter="dubboExceptionFilter"/> <dubbo:provider filter="dubboExceptionFilter"/> <dubbo:protocol name="dubbo" port="20880"> <dubbo:service interface="com.example.service.SomeService" ref="someService"/> </dubbo:protocol> ``` 在上面的配置中，`<dubbo:consumer>` 和 `<dubbo:provider>` 标签分别用于设置消费者和提供者的过滤器，`filter` 属性值为全局异常处理类的类名。同时，也可以在 `<dubbo:protocol>` 标签中设置过滤器。 这样，当 Dubbo 服务出现异常时，就会通过该全局异常处理类进行处理。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值