org.apache.shenyu.plugin.busilog.capture

类 ResponseBodyCapture

java.lang.Object

org.springframework.http.server.reactive.ServerHttpResponseDecorator

org.apache.shenyu.plugin.busilog.capture.ResponseBodyCapture

所有已实现的接口:

org.springframework.http.HttpMessage, org.springframework.http.ReactiveHttpOutputMessage, org.springframework.http.server.reactive.ServerHttpResponse

public class ResponseBodyCapture
extends org.springframework.http.server.reactive.ServerHttpResponseDecorator

Captures response body bytes while passing them through to the original response.

Installed by BusiLogResponseCaptureFilter (WebFilter) BEFORE the ShenYu plugin chain. This ensures that when the response plugin (order=420) writes the body, it goes through this decorator. BusiLogPlugin (order=1050) registers a callback via exchange attribute; the callback is triggered from writeWith(org.reactivestreams.Publisher<? extends org.springframework.core.io.buffer.DataBuffer>) when the body is actually written.

If no callback is registered (request doesn't match busiLog rules), writeWith() passes through without any buffering overhead.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CALLBACK_ATTR Exchange attribute key: stores a Runnable callback to invoke after body is captured.
static java.lang.String	CAPTURE_ATTR Exchange attribute key: stores the ResponseBodyCapture instance.

构造器概要

构造器

构造器和说明
ResponseBodyCapture(org.springframework.http.server.reactive.ServerHttpResponse delegate, org.springframework.web.server.ServerWebExchange exchange) Constructor.

方法概要

限定符和类型	方法和说明
java.lang.String	getCapturedBody() Get the captured response body as string.
org.springframework.http.HttpStatus	getCapturedStatus() Get the captured HTTP status code.
reactor.core.publisher.Mono<java.lang.Void>	writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends org.springframework.core.io.buffer.DataBuffer>> body)
reactor.core.publisher.Mono<java.lang.Void>	writeWith(org.reactivestreams.Publisher<? extends org.springframework.core.io.buffer.DataBuffer> body)

从类继承的方法 org.springframework.http.server.reactive.ServerHttpResponseDecorator

addCookie, beforeCommit, bufferFactory, getCookies, getDelegate, getHeaders, getNativeResponse, getRawStatusCode, getStatusCode, isCommitted, setComplete, setRawStatusCode, setStatusCode, toString

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

CAPTURE_ATTR

public static final java.lang.String CAPTURE_ATTR

Exchange attribute key: stores the ResponseBodyCapture instance.

另请参阅:

常量字段值

CALLBACK_ATTR

public static final java.lang.String CALLBACK_ATTR

Exchange attribute key: stores a Runnable callback to invoke after body is captured.

另请参阅:

常量字段值

构造器详细资料

ResponseBodyCapture

public ResponseBodyCapture(org.springframework.http.server.reactive.ServerHttpResponse delegate,
                           org.springframework.web.server.ServerWebExchange exchange)

Constructor.

参数:

delegate - the original ServerHttpResponse

exchange - the server web exchange (for reading callback attribute)

方法详细资料

writeWith

public reactor.core.publisher.Mono<java.lang.Void> writeWith(org.reactivestreams.Publisher<? extends org.springframework.core.io.buffer.DataBuffer> body)

指定者:

writeWith 在接口中 org.springframework.http.ReactiveHttpOutputMessage

覆盖:

writeWith 在类中 org.springframework.http.server.reactive.ServerHttpResponseDecorator

writeAndFlushWith

public reactor.core.publisher.Mono<java.lang.Void> writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends org.springframework.core.io.buffer.DataBuffer>> body)

指定者:

writeAndFlushWith 在接口中 org.springframework.http.ReactiveHttpOutputMessage

覆盖:

writeAndFlushWith 在类中 org.springframework.http.server.reactive.ServerHttpResponseDecorator

getCapturedBody

public java.lang.String getCapturedBody()

Get the captured response body as string.

返回:

captured body, empty string if not yet written

getCapturedStatus

public org.springframework.http.HttpStatus getCapturedStatus()

Get the captured HTTP status code.

返回:

HTTP status, may be null if not yet written