SpringCloud系列之网关gateway-13.如何借助网关层对服务端各类异常做统一处理

异常的种类

网关层的异常分为以下两种:

调用请求异常 通常由调用请求直接抛出的异常,比如在订单服务中直接报错

throw new RuntimeException("error")

l 网关层异常 由网关层触发的异常,比如Gateway通过服务发现找不到可用节点,或者任何网关层内部的问题。这部分异常通常是在实际调用请求发起之前发生的。

在以上两种问题中,我认为网关层只应该关注第二个点,也就是自身异常。在实际应用中我们应该尽量保持网关层的“纯洁性”并且做好职责划分,Gateway只要做好路由的事情,不要牵扯到具体业务层的事儿,最好也不要替调用请求的异常操心。对于业务调用中的异常情况,如果需要采用统一格式封装调用异常,那就交给每个具体服务去定义结构,让各自业务方和前端页面协调好异常消息的结构。

但是在实际项目中,不能保证每个接口都实现了异常封装,如果想给前台页面一个统一风格的JSON格式异常结构,那就需要让Gateway做一些分外的事儿,比如拦截Response并修改返回值。(我还是强烈建议让服务端自己定义异常结构,因为Gateway本身不应该对这些异常做额外封装只是原封不动的返回)

Gateway已经将网关层直接抛出的异常(没有调用远程服务之前的异常)做了结构化封装,对于POST的调用来说其本身也会返回结构化的异常信息,但是对于GET接口的异常来说,则是直接返回一个HTML页面,前端根本无法抓取具体的异常信息。所以我们今天就主要聚焦在如何处理调用请求异常。

服务调用异常

我们定义一个主动抛出异常的GET接口,然后通过网关层发起调用,会发现默认返回了HTML的异常页面。

[图片上传失败...(image-879ec9-1631685916923)] 当我们使用常规的全局异常处理方式会发现根本不起作用,这是为什么呢?因为我们目前使用的Greenwich版本底层是基于WebFlux来实现的,并不是Pure Servlet应用,因此常规的手段在这里不起作用。那么接下来,我就带大家通过添加一个过滤器,来处理异常调用,并且将返回值改为JSON格式。

改造客户端异常

我们先来看一看Gateway网关层异常情况下的返回数据

{

"timestamp": "2019-10-26T15:13:29.870+0000",

"path": "/gateway/error",

"status": 500,

"error": "Internal Server Error",

"message": "Unable to find instance for FEIGN-SERVICE-PROVIDER"

}

看起来干净整洁,那我们是否可以在网关层对服务端返回的异常做一番改造,也呈现类似的效果呢?接下来,我们就运用最开始Eureka章节中学到的装饰器编程模式+代理模式,给Gateway加一层特效,改变ResponseBody中的数据结构,顺带也体验一下如何将编程模式运用到实际需求中。

代理模式 - BodyHackerFunction接口

在最开始我们先定义一个代理模式的接口

package com.imooc.training;

import org.reactivestreams.Publisher;

import org.springframework.core.io.buffer.DataBuffer;

import org.springframework.http.server.reactive.ServerHttpResponse;

import reactor.core.publisher.Mono;

import java.util.function.BiFunction;

public interface BodyHackerFunction extends

BiFunction<ServerHttpResponse, Publisher<? extends DataBuffer>, Mono<Void>> {

}

这里引入代理模式是为了将装饰器和具体业务代理逻辑拆分开来,在装饰器中只需要依赖一个代理接口,而不需要和具体的代理逻辑绑定起来。

装饰器模式 - BodyHackerDecrator

接下来我们定义一个装饰器类,这个装饰器继承自ServerHttpResponseDecorator类,我们这里就用装饰器模式给Response Body的构造过程加上一层特效。

public class BodyHackerHttpResponseDecorator extends ServerHttpResponseDecorator {

    /**
     * 负责具体写入Body内容的代理类
     */
    private BodyHackerFunction delegate = null;

    public BodyHackerHttpResponseDecorator(BodyHackerFunction bodyHandler, ServerHttpResponse delegate) {
        super(delegate);
        this.delegate = bodyHandler;
    }

    @Override
    public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
        return delegate.apply(getDelegate(), body);
    }

}

这个装饰器的构造方法接收一个BodyHancker代理类,其中的关键方法writeWith就是用来向Response Body中写入内容的。这里我们覆盖了该方法,使用代理类来托管方法的执行,而在整个装饰器类中看不到一点业务逻辑,这就是我们常说的单一职责。

创建Filter


@Component
@Slf4j
public class ErrorFilter implements GatewayFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        final ServerHttpRequest request = exchange.getRequest();
        BodyHackerFunction delegate = (resp, body) -> Flux.from(body)
                .flatMap(orgBody -> {
                    // 原始的response body
                    byte[] orgContent = new byte[orgBody.readableByteCount()];
                    orgBody.read(orgContent);

                    String content = new String(orgContent);
                    log.info("original content {}", content);

                    // 如果500错误,则替换
                    if (resp.getStatusCode().value() == 500) {
                        content = String.format("{\"status\": %d,\"path\":\"%s\"}",
                                resp.getStatusCode().value(),
                                request.getPath().value());
                    }


                    // 告知客户端Body的长度,如果不设置的话客户端会一直处于等待状态不结束
                    HttpHeaders headers = resp.getHeaders();
                    headers.setContentLength(content.length());
                    return resp.writeWith(Flux.just(content)
                            .map(bx -> resp.bufferFactory().wrap(bx.getBytes())));
                }).then();

        // 将装饰器当做Response返回
        BodyHackerHttpResponseDecorator responseDecorator = new BodyHackerHttpResponseDecorator(delegate, exchange.getResponse());

        return chain.filter(exchange.mutate().response(responseDecorator).build());
    }

    @Override
    public int getOrder() {
        // WRITE_RESPONSE_FILTER的执行顺序是-1,我们的Hacker在它之前执行
        return -2;
    }

}

在这个Filter中,我们定义了一个装饰器类BodyHackerHttpResponseDecorator,同时声明了一个匿名内部类(代码TODO部分),实现了BodyHackerFunction代理类的Body替换逻辑,并且将这个代理类传入了装饰器。这个装饰器将直接参与构造Response Body。

我们还覆盖了getOrder方法,是为了确保我们的filter在默认的Response构造器之前执行。

我们对500的HTTP Status做了特殊定制,使用我们自己的JSON内容替换了原始内容,同学们可以根据需要向JSON中加入其它参数。对于其他非500 Status的Response来说,我们还是返回初始的Body。

这里有个需要注意的地方就是记得在header中设置content-length,让客户端知道Response中内容的长度,否则的话客户端会认为传输未结束,一直等在那里。

使用Filter

上面步骤都完成以后,接着我们就可以将这个filter应用在指定的路由规则中,或者定义成global filter,对所有路由规则生效。经过这次的改造,远程服务抛出的异常也在网关层做了统一处理,从HTML页面转为了JSON格式的数据。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,047评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,807评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,501评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,839评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,951评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,117评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,188评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,929评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,372评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,679评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,837评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,536评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,168评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,886评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,129评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,665评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,739评论 2 351

推荐阅读更多精彩内容