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

自定义dubbo异常过滤器

  • 一、前置问题介绍：
    • 问题一
    • 问题二
  • 二、Dubbo的异常过滤器源码如下：
  • 三、实现方案 - 重写Dubbo的Filter异常过滤器
  • 至此，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类注释 ~~~

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/626621.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

多臂老虎机

多臂老虎机

多臂老虎机 有n根拉杆的的老虎机&#xff0c;每根拉杆获得奖励(值为1)的概率各不相同。 期望奖励更新 Q k 1 k ∑ i 1 k r i 1 k ( r k ∑ i 1 k − 1 r i ) 1 k ( r k k Q k − 1 − Q k − 1 ) Q k − 1 1 k [ r k − Q k − 1 ] Q_k\frac 1k \sum^{k}_{i1}r_i\\…
阅读更多...
oracle10g dbca和netca报错

oracle10g dbca和netca报错

oracle10g dbca和netca报错 [oraclecqnew database]$ netcaOracle Net Services Configuration: Warning: Cannot convert string "-b&h-lucida-medium-r-normal-sans-*-140-*-*-p-*-iso8859-1" to type FontStruct Configuring Listener:LISTENER不影响使用&am…
阅读更多...
一键监控多台服务器磁盘使用情况的神奇脚本！

一键监控多台服务器磁盘使用情况的神奇脚本！

在当今这个数据为王的时代&#xff0c;服务器的磁盘空间使用情况成为了系统管理员日常关注的重要指标之一。磁盘空间不足可能导致服务中断&#xff0c;数据丢失&#xff0c;甚至整个系统崩溃。因此&#xff0c;及时监控磁盘空间&#xff0c;预防潜在风险&#xff0c;成为了每个…
阅读更多...
上下左右翻转照片以及标注信息扩充数据集

上下左右翻转照片以及标注信息扩充数据集

目录 前言&#xff1a; 示例项目数据结构&#xff1a; 源代码&#xff1a; 运行代码后生成的项目结构&#xff1a; 效果&#xff1a; 前言&#xff1a; 使用yolo训练模型时&#xff0c;遇到数据集很小的情况&#xff08;一两百张&#xff09;&#xff0c;训练出来的模型效…
阅读更多...
2024年电工杯数学建模B题思路 中国电机工程学会杯建模思路分析

2024年电工杯数学建模B题思路 中国电机工程学会杯建模思路分析

文章目录 1 赛题思路2 比赛日期和时间3 竞赛信息4 建模常见问题类型4.1 分类问题4.2 优化问题4.3 预测问题4.4 评价问题 5 建模资料 1 赛题思路 (赛题出来以后第一时间在CSDN分享) https://blog.csdn.net/dc_sinor?typeblog 2 比赛日期和时间 报名截止时间&#xff1a;2024…
阅读更多...
四天学会JS高阶（学好vue的关键）——作用域解构箭头函数（理论+实战）（第一天）

四天学会JS高阶（学好vue的关键）——作用域解构箭头函数（理论+实战）（第一天）

一、作用域 提到作用域&#xff08;作用域又分为局部作用域和全局作用域&#xff09;&#xff0c;就要想到变量。因为作用域规定了变量能够被访问的范围&#xff08;也就是作用域是为变量而服务的&#xff09;&#xff0c;为了避免全局变量污染这一情况&#xff0c;所以需要使…
阅读更多...
关闭 Visual Studio Code 项目中 的eslint的语法校验 lintOnSave: false；； 项目运行起来之后 自动打开浏览器 端口

关闭 Visual Studio Code 项目中 的eslint的语法校验 lintOnSave: false；； 项目运行起来之后 自动打开浏览器 端口

1、在 vue.config.js 配置 一个属性 lintOnSave: false 2、配置两个属性 open: true, // 自动打开浏览器 port: 3000 // 端口 port 端口号根据自己的项目实际开发来 配置
阅读更多...
C++类细节，反汇编，面试题02

C++类细节，反汇编，面试题02

文章目录 2. 虚函数vs纯虚函数3. 重写vs重载vs隐藏3.1. 为什么C可以重载&#xff1f; 4. struct vs union4.1. 为什么要内存对齐&#xff1f; 5. static作用6. 空类vs空结构体6.1. 八个默认函数&#xff1a;6.2. 为什么空类占用1字节 7. const作用7.1 指针常量vs常量指针vs常量…
阅读更多...
用友网络的危与机：2023年亏损约10亿元，王文京面临严肃拷问

用友网络的危与机：2023年亏损约10亿元，王文京面临严肃拷问

“企业在新的产业浪潮来临时&#xff0c;应该主动推进新阶段的产品和业务创新&#xff0c;这样才能够在新的浪潮成为主流的时候&#xff0c;走到行业前面&#xff0c;否则就会从产业发展的潮流中掉下来”。用友网络创始人王文京&#xff0c;曾用“冲浪理论”形容一家企业成功的…
阅读更多...
国内好用的测试用例管理工具有哪些？

国内好用的测试用例管理工具有哪些？

目前市面上的测试用例管理工具有很多&#xff0c;但由于针对的项目、领域、目标用户&#xff0c;功能也并不一致&#xff0c;所以选择一款适合的测试管理平台并不轻松。做好这件事&#xff0c;首先要需求明确你用测试管理工具干什么&#xff1f;最终想要达到什么目标&#xff1…
阅读更多...
C语言学习（八）typedef 虚拟内存 malloc/free

C语言学习（八）typedef 虚拟内存 malloc/free

目录 一、typedef 类型重定义&#xff08;一&#xff09;使用&#xff08;二&#xff09;define和typedef的区别1. 编译处理的阶段不同2. 功能不同 二、虚拟内存&#xff08;一&#xff09;虚拟内存分布&#xff08;二&#xff09;内存分布1. 静态分配2. 动态分配 三、malloc/f…
阅读更多...
用sunoAI写粤语歌的方法，博主已经亲自实践可行

用sunoAI写粤语歌的方法，博主已经亲自实践可行

粤语歌还是很好听的&#xff0c;那么如何使用suno进行粤语歌的创作呢&#xff1f; 本文和大家进行分享下如何进行粤语歌曲的创作。 访问地址如下&#xff08;电脑端/手机端一个地址&#xff09;&#xff1a; ​https://suno3.cn/#/?i8NCBS8_WXTT 在微信浏览器中也可以直接…
阅读更多...
RT-DETR改进教程|加入SCNet中的SCConv[CVPR2020]自校准卷积模块！

RT-DETR改进教程|加入SCNet中的SCConv[CVPR2020]自校准卷积模块！

⭐⭐ RT-DETR改进专栏|包含主干、模块、注意力机制、检测头等前沿创新 ⭐⭐ 一、 论文介绍 论文链接&#xff1a;http://mftp.mmcheng.net/Papers/20cvprSCNet.pdf 代码链接&#xff1a;https://gitcode.com/MCG-NKU/SCNet/ 文章摘要&#xff1a; CNN的最新进展主要致力于设计更…
阅读更多...
文字转成活码的3步操作，手机扫码即可查看文本信息

文字转成活码的3步操作，手机扫码即可查看文本信息

现在经常会通过二维码的方式来传递通知的文字信息&#xff0c;只需要分享文字生成二维码的图片到微信群或者印刷出来&#xff0c;其他人就可以通过扫码来查看文字内容&#xff0c;有利于其他人更快速的获取信息。 目前文本静态码无法通过微信来扫码展示&#xff0c;那么想要解…
阅读更多...
服务器被后台爆破怎么处理

服务器被后台爆破怎么处理

服务器后台遭受密码爆破攻击是网络安全中常见的威胁之一&#xff0c;这种攻击通过不断尝试不同的用户名和密码组合来破解系统登录凭证&#xff0c;一旦成功&#xff0c;攻击者便能非法访问系统资源。 本文将介绍如何识别此类攻击&#xff0c;并采取有效措施进行防御&#xff0c…
阅读更多...
ETL-kettle数据转换及组件使用详解

ETL-kettle数据转换及组件使用详解

目录 一、txt文本转换成excel 1、新建、转换 2、构建流程图 3、配置数据流图中的各个组件 3.1、配置文件文本输入组件 3.2、 配置Excel输出组件 4、保存执行 二、excel转换成mysql &#xff08;1&#xff09;在MySQL数据库中创建数据库&#xff0c;这个根据自身情况。我…
阅读更多...
(python)cryptography-安全的加密

(python)cryptography-安全的加密

前言 cryptography 是一个广泛使用的 Python 加密库&#xff0c;提供了各种加密、哈希和签名算法的实现。它支持多种加密算法&#xff0c;如 AES、RSA、ECC 等&#xff0c;以及哈希函数&#xff08;如 SHA-256、SHA-384 等&#xff09;和数字签名算法(如 DSA、ECDSA 等). 目录 …
阅读更多...
一本书打通SLAM在智能汽车/自动驾驶领域应用

一本书打通SLAM在智能汽车/自动驾驶领域应用

自动驾驶技术已成为当今数字化时代汽车行业的热点话题之一。随着技术的不断成熟&#xff0c;越来越多的车辆采用激光SLAM&#xff08;即时定位与地图构建&#xff09;和视觉SLAM技术&#xff0c;实现更高层次的智能网联汽车。SLAM技术在智能网联汽车中的应用是非常重要的&#…
阅读更多...
[XYCTF新生赛]-PWN:baby_gift解析（函数调用前需清空eax）

[XYCTF新生赛]-PWN:baby_gift解析（函数调用前需清空eax）

查看保护 查看ida 这里有一处栈溢出&#xff0c;并且从汇编上看&#xff0c;程序将rbp0x20处设置为了rdi&#xff0c;让我们可以控制rdi的值。而程序没有可利用的pop。 完整exp&#xff1a; from pwn import* pprocess(./babygift) premote(gz.imxbt.cn,20833) printf_plt0x4…
阅读更多...
如何通过ETL工具对数据进行去重

如何通过ETL工具对数据进行去重

在数据处理流程中&#xff0c;数据去重是一个至关重要的环节&#xff0c;它能够确保数据分析的准确性和效率。ETL&#xff08;Extract, Transform, Load&#xff09;工具作为数据集成的重要组成部分&#xff0c;提供了强大的功能来帮助用户实现数据的抽取、转换和加载&#xff…
阅读更多...
最新文章

Copyright @ 2022~2023