类 com.alipay.sofa.rpc.core.request.SofaRequest
的使用

使用SofaRequest的程序包

程序包	说明
com.alipay.sofa.rpc.bootstrap
com.alipay.sofa.rpc.client
com.alipay.sofa.rpc.client.lb
com.alipay.sofa.rpc.client.router
com.alipay.sofa.rpc.codec.protobuf
com.alipay.sofa.rpc.codec.sofahessian
com.alipay.sofa.rpc.context
com.alipay.sofa.rpc.core.request
com.alipay.sofa.rpc.event
com.alipay.sofa.rpc.filter
com.alipay.sofa.rpc.filter.sofatracer
com.alipay.sofa.rpc.invoke
com.alipay.sofa.rpc.message
com.alipay.sofa.rpc.message.bolt
com.alipay.sofa.rpc.message.http
com.alipay.sofa.rpc.server
com.alipay.sofa.rpc.server.bolt
com.alipay.sofa.rpc.server.http
com.alipay.sofa.rpc.tracer
com.alipay.sofa.rpc.tracer.sofatracer
com.alipay.sofa.rpc.transport
com.alipay.sofa.rpc.transport.bolt
com.alipay.sofa.rpc.transport.http
com.alipay.sofa.rpc.transport.rest

com.alipay.sofa.rpc.bootstrap中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.bootstrap中的方法

限定符和类型	方法和说明
protected void	DefaultClientProxyInvoker.decorateRequest(SofaRequest request)

com.alipay.sofa.rpc.client中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.client中的方法

限定符和类型	方法和说明
protected void	AbstractCluster.checkAlias(ProviderInfo providerInfo, SofaRequest message) 检查分组映射
protected void	AbstractCluster.checkProviderVersion(ProviderInfo providerInfo, SofaRequest request) 检查服务端版本，特殊处理
protected void	ClientProxyInvoker.decorateRequest(SofaRequest request) 包装请求
SofaResponse	FailoverCluster.doInvoke(SofaRequest request)
SofaResponse	FailFastCluster.doInvoke(SofaRequest request)
protected abstract SofaResponse	AbstractCluster.doInvoke(SofaRequest msg) 子类实现各自逻辑的调用，例如重试等
abstract ProviderInfo	AbstractLoadBalancer.doSelect(SofaRequest invocation, List<ProviderInfo> providerInfos) 根据负载均衡筛选
protected SofaResponse	AbstractCluster.doSendMsg(ProviderInfo providerInfo, ClientTransport transport, SofaRequest request) 调用客户端
protected SofaResponse	AbstractCluster.filterChain(ProviderInfo providerInfo, SofaRequest request) 发起调用链
SofaResponse	ExcludeRouter.invoke(SofaRequest request)
SofaResponse	ClientProxyInvoker.invoke(SofaRequest request) proxy拦截的调用
SofaResponse	AbstractCluster.invoke(SofaRequest request)
List<ProviderInfo>	RouterChain.route(SofaRequest request, List<ProviderInfo> providerInfos) 筛选Provider
abstract List<ProviderInfo>	Router.route(SofaRequest request, List<ProviderInfo> providerInfos) 筛选Provider
List<ProviderInfo>	ExcludeRouter.route(SofaRequest request, List<ProviderInfo> providerInfos)
protected ProviderInfo	AbstractCluster.select(SofaRequest message) 根据规则进行负载均衡
abstract ProviderInfo	LoadBalancer.select(SofaRequest request, List<ProviderInfo> providerInfos) 选择服务
ProviderInfo	AbstractLoadBalancer.select(SofaRequest request, List<ProviderInfo> providerInfos)
protected ProviderInfo	AbstractCluster.select(SofaRequest message, List<ProviderInfo> invokedProviderInfos) 根据规则进行负载均衡
protected ClientTransport	AbstractCluster.selectByProvider(SofaRequest message, ProviderInfo providerInfo) 得到provider得到连接
abstract SofaResponse	Cluster.sendMsg(ProviderInfo providerInfo, SofaRequest request) 调用远程地址发送消息
SofaResponse	AbstractCluster.sendMsg(ProviderInfo providerInfo, SofaRequest request)

com.alipay.sofa.rpc.client.lb中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.client.lb中的方法

限定符和类型	方法和说明
ProviderInfo	WeightRoundRobinLoadBalancer.doSelect(SofaRequest request, List<ProviderInfo> providerInfos) 已过时。
ProviderInfo	RoundRobinLoadBalancer.doSelect(SofaRequest request, List<ProviderInfo> providerInfos)
ProviderInfo	RandomLoadBalancer.doSelect(SofaRequest invocation, List<ProviderInfo> providerInfos)
ProviderInfo	LocalPreferenceLoadBalancer.doSelect(SofaRequest invocation, List<ProviderInfo> providerInfos)
ProviderInfo	ConsistentHashLoadBalancer.doSelect(SofaRequest request, List<ProviderInfo> providerInfos)

com.alipay.sofa.rpc.client.router中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.client.router中的方法

限定符和类型	方法和说明
List<ProviderInfo>	RegistryRouter.route(SofaRequest request, List<ProviderInfo> providerInfos)
List<ProviderInfo>	DirectUrlRouter.route(SofaRequest request, List<ProviderInfo> providerInfos)

com.alipay.sofa.rpc.codec.protobuf中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.codec.protobuf中的方法

限定符和类型	方法和说明
protected AbstractByteBuf	ProtobufSerializer.encodeSofaRequest(SofaRequest sofaRequest, Map<String,String> context)

com.alipay.sofa.rpc.codec.sofahessian中SofaRequest的使用

返回SofaRequest的com.alipay.sofa.rpc.codec.sofahessian中的方法

限定符和类型	方法和说明
protected SofaRequest	SofaHessianSerializer.decodeSofaRequest(AbstractByteBuf data, Map<String,String> context) Do decode SofaRequest

参数类型为SofaRequest的com.alipay.sofa.rpc.codec.sofahessian中的方法

限定符和类型	方法和说明
protected void	SofaHessianSerializer.decodeSofaRequestByTemplate(AbstractByteBuf data, Map<String,String> context, SofaRequest template) Do decode SofaRequest
protected AbstractByteBuf	SofaHessianSerializer.encodeSofaRequest(SofaRequest sofaRequest, Map<String,String> context) Do encode SofaRequest

com.alipay.sofa.rpc.context中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.context中的方法

限定符和类型	方法和说明
static void	BaggageResolver.carryWithRequest(RpcInvokeContext context, SofaRequest request) 通过请求透传数据
static void	BaggageResolver.pickupFromRequest(RpcInvokeContext context, SofaRequest request) 从请求里获取透传数据
static void	BaggageResolver.pickupFromRequest(RpcInvokeContext context, SofaRequest request, boolean init) 从请求里获取透传数据

com.alipay.sofa.rpc.core.request中SofaRequest的使用

返回SofaRequest的com.alipay.sofa.rpc.core.request中的方法

限定符和类型	方法和说明
SofaRequest	SofaRequest.setData(AbstractByteBuf data) Sets data.
SofaRequest	SofaRequest.setInvokeType(String invokeType) Sets invoke type.
SofaRequest	SofaRequest.setSerializeType(byte serializeType) Sets serialize type.
SofaRequest	SofaRequest.setSofaResponseCallback(SofaResponseCallback sofaResponseCallback) Sets sofa response callback.
SofaRequest	SofaRequest.setTimeout(Integer timeout) Sets timeout.

com.alipay.sofa.rpc.event中SofaRequest的使用

返回SofaRequest的com.alipay.sofa.rpc.event中的方法

限定符和类型	方法和说明
SofaRequest	ServerSendEvent.getRequest()
SofaRequest	ServerReceiveEvent.getRequest()
SofaRequest	ClientSyncReceiveEvent.getRequest()
SofaRequest	ClientStartInvokeEvent.getRequest()
SofaRequest	ClientEndInvokeEvent.getRequest()
SofaRequest	ClientBeforeSendEvent.getRequest()
SofaRequest	ClientAsyncReceiveEvent.getRequest()
SofaRequest	ClientAfterSendEvent.getRequest()

参数类型为SofaRequest的com.alipay.sofa.rpc.event中的构造器

构造器和说明
ClientAfterSendEvent(SofaRequest request)
ClientAsyncReceiveEvent(ConsumerConfig consumerConfig, ProviderInfo providerInfo, SofaRequest request, SofaResponse response, Throwable throwable)
ClientBeforeSendEvent(SofaRequest request)
ClientEndInvokeEvent(SofaRequest request, SofaResponse response, Throwable throwable)
ClientStartInvokeEvent(SofaRequest request)
ClientSyncReceiveEvent(ConsumerConfig consumerConfig, ProviderInfo providerInfo, SofaRequest request, SofaResponse response, Throwable throwable)
ServerReceiveEvent(SofaRequest request)
ServerSendEvent(SofaRequest request, SofaResponse response, Throwable throwable)

com.alipay.sofa.rpc.filter中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.filter中的方法

限定符和类型	方法和说明
abstract SofaResponse	Filter.invoke(FilterInvoker invoker, SofaRequest request) Do filtering doBeforeInvoke(); // the code before invoke, even new dummy response for return (skip all next invoke).
SofaResponse	ExcludeFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	ProviderExceptionFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	ConsumerExceptionFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	ProviderBaggageFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	ConsumerGenericFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	RpcServiceContextFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	RpcReferenceContextFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	ProviderInvoker.invoke(SofaRequest request)
SofaResponse	FilterInvoker.invoke(SofaRequest request)
SofaResponse	FilterChain.invoke(SofaRequest sofaRequest)
SofaResponse	ConsumerInvoker.invoke(SofaRequest sofaRequest)
void	FilterChain.onAsyncResponse(ConsumerConfig config, SofaRequest request, SofaResponse response, Throwable throwable) Do filtering when async respond from server
void	Filter.onAsyncResponse(ConsumerConfig config, SofaRequest request, SofaResponse response, Throwable exception) Do filtering after asynchronous respond, only supported in CONSUMER SIDE.

com.alipay.sofa.rpc.filter.sofatracer中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.filter.sofatracer中的方法

限定符和类型	方法和说明
SofaResponse	ProviderTracerFilter.invoke(FilterInvoker invoker, SofaRequest request)
SofaResponse	ConsumerTracerFilter.invoke(FilterInvoker invoker, SofaRequest request)

com.alipay.sofa.rpc.invoke中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.invoke中的方法

限定符和类型	方法和说明
SofaResponse	Invoker.invoke(SofaRequest request) 执行调用

com.alipay.sofa.rpc.message中SofaRequest的使用

返回SofaRequest的com.alipay.sofa.rpc.message中的方法

限定符和类型	方法和说明
static SofaRequest	MessageBuilder.buildSofaRequest(Class<?> clazz, Method method, Class[] argTypes, Object[] args) 构建请求，常用于代理类拦截
static SofaRequest	MessageBuilder.buildSofaRequest(Class<?> clazz, String method, Class[] argTypes, Object[] args) 已过时。 use MessageBuilder.buildSofaRequest(Class, Method, Class[], Object[])

com.alipay.sofa.rpc.message.bolt中SofaRequest的使用

声明为SofaRequest的com.alipay.sofa.rpc.message.bolt中的字段

限定符和类型	字段和说明
protected SofaRequest	BoltSendableResponseCallback.request
protected SofaRequest	BoltResponseFuture.request sofa请求
protected SofaRequest	AbstractInvokeCallback.request 请求

参数类型为SofaRequest的com.alipay.sofa.rpc.message.bolt中的构造器

构造器和说明
AbstractInvokeCallback(ConsumerConfig consumerConfig, ProviderInfo providerInfo, SofaRequest request, RpcInternalContext context, ClassLoader classLoader)
BoltFutureInvokeCallback(ConsumerConfig consumerConfig, ProviderInfo providerInfo, BoltResponseFuture rpcFuture, SofaRequest request, RpcInternalContext context, ClassLoader classLoader) Instantiates a new Bolt future invoke callback.
BoltInvokerCallback(ConsumerConfig consumerConfig, ProviderInfo providerInfo, SofaResponseCallback listener, SofaRequest request, RpcInternalContext context, ClassLoader classLoader) Instantiates a new Bolt invoker callback.
BoltResponseFuture(SofaRequest request, int timeout) 构造函数

com.alipay.sofa.rpc.message.http中SofaRequest的使用

声明为SofaRequest的com.alipay.sofa.rpc.message.http中的字段

限定符和类型	字段和说明
protected SofaRequest	HttpResponseFuture.request sofa请求

参数类型为SofaRequest的com.alipay.sofa.rpc.message.http中的构造器

构造器和说明
HttpResponseFuture(SofaRequest request, int timeout) 构造函数

com.alipay.sofa.rpc.server中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.server中的方法

限定符和类型	方法和说明
SofaResponse	ProviderProxyInvoker.invoke(SofaRequest request) proxy拦截的调用

com.alipay.sofa.rpc.server.bolt中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.server.bolt中的方法

限定符和类型	方法和说明
void	BoltServerProcessor.handleRequest(com.alipay.remoting.BizContext bizCtx, com.alipay.remoting.AsyncContext asyncCtx, SofaRequest request)

com.alipay.sofa.rpc.server.http中SofaRequest的使用

声明为SofaRequest的com.alipay.sofa.rpc.server.http中的字段

限定符和类型	字段和说明
protected SofaRequest	AbstractHttpServerTask.request

参数类型为SofaRequest的com.alipay.sofa.rpc.server.http中的方法

限定符和类型	方法和说明
protected SofaResponse	AbstractHttpServerTask.doInvoke(String serviceName, Invoker invoker, SofaRequest request)
void	HttpServerHandler.handleHttp1Request(SofaRequest request, io.netty.channel.ChannelHandlerContext ctx, boolean keepAlive) Handle request from HTTP/1.1
void	HttpServerHandler.handleHttp2Request(int streamId, SofaRequest request, io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder) Handle request from HTTP/2

参数类型为SofaRequest的com.alipay.sofa.rpc.server.http中的构造器

构造器和说明
AbstractHttpServerTask(HttpServerHandler serverHandler, SofaRequest request, io.netty.channel.ChannelHandlerContext ctx)
Http1ServerTask(HttpServerHandler serverHandler, SofaRequest request, io.netty.channel.ChannelHandlerContext ctx, boolean keepAlive)
Http2ServerTask(HttpServerHandler serverHandler, SofaRequest request, io.netty.channel.ChannelHandlerContext ctx, Integer streamId, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder)

com.alipay.sofa.rpc.tracer中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.tracer中的方法

限定符和类型	方法和说明
static void	Tracers.clientAsyncAfterSend(SofaRequest request) 1.1.
abstract void	Tracer.clientAsyncAfterSend(SofaRequest request) 1.1.
static void	Tracers.clientBeforeSend(SofaRequest request) 1：客户端发送请求前
abstract void	Tracer.clientBeforeSend(SofaRequest request) 1：客户端发送请求前
static void	Tracers.clientReceived(SofaRequest request, SofaResponse response, Throwable throwable) 4.
abstract void	Tracer.clientReceived(SofaRequest request, SofaResponse response, Throwable throwable) 4.
static void	Tracers.serverReceived(SofaRequest request) 2.
abstract void	Tracer.serverReceived(SofaRequest request) 2.
static void	Tracers.serverSend(SofaRequest request, SofaResponse response, Throwable throwable) 3.
abstract void	Tracer.serverSend(SofaRequest request, SofaResponse response, Throwable throwable) 3.
static void	Tracers.startRpc(SofaRequest request) 0：开始
abstract void	Tracer.startRpc(SofaRequest request) 0：开始

com.alipay.sofa.rpc.tracer.sofatracer中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.tracer.sofatracer中的方法

限定符和类型	方法和说明
void	RpcSofaTracer.clientAsyncAfterSend(SofaRequest request)
void	RpcSofaTracer.clientBeforeSend(SofaRequest request)
void	RpcSofaTracer.clientReceived(SofaRequest request, SofaResponse response, Throwable exceptionThrow)
void	RpcSofaTracer.serverReceived(SofaRequest request)
void	RpcSofaTracer.serverSend(SofaRequest request, SofaResponse response, Throwable exception)
void	RpcSofaTracer.startRpc(SofaRequest request)

com.alipay.sofa.rpc.transport中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.transport中的方法

限定符和类型	方法和说明
protected void	AbstractProxyClientTransport.afterSend(RpcInternalContext context, SofaRequest request) 调用后设置一些属性（注意，在异步的情况较多下）
abstract ResponseFuture	ClientTransport.asyncSend(SofaRequest message, int timeout) 异步调用
ResponseFuture	AbstractProxyClientTransport.asyncSend(SofaRequest message, int timeout)
protected void	AbstractProxyClientTransport.beforeSend(RpcInternalContext context, SofaRequest request) 调用前设置一些属性
protected SofaResponse	AbstractProxyClientTransport.doInvokeSync(SofaRequest request, int timeoutMillis) 同步调用
protected abstract Method	AbstractProxyClientTransport.getMethod(SofaRequest request) 构造远程调用代理
abstract void	ClientTransport.handleRpcRequest(SofaRequest request) 客户端收到服务端的请求，可能是服务端Callback
void	AbstractProxyClientTransport.handleRpcRequest(SofaRequest request)
abstract void	ClientTransport.oneWaySend(SofaRequest message, int timeout) 单向调用
void	AbstractProxyClientTransport.oneWaySend(SofaRequest message, int timeout)
abstract SofaResponse	ClientTransport.syncSend(SofaRequest message, int timeout) 同步调用
SofaResponse	AbstractProxyClientTransport.syncSend(SofaRequest request, int timeout)

com.alipay.sofa.rpc.transport.bolt中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.transport.bolt中的方法

限定符和类型	方法和说明
protected void	BoltClientTransport.afterSend(RpcInternalContext context, com.alipay.remoting.InvokeContext invokeContext, SofaRequest request) 调用后设置一些属性（注意，在异步的情况较多下）
ResponseFuture	BoltClientTransport.asyncSend(SofaRequest request, int timeout)
protected void	BoltClientTransport.beforeSend(RpcInternalContext context, SofaRequest request) 调用前设置一些属性
protected com.alipay.remoting.InvokeContext	BoltClientTransport.createInvokeContext(SofaRequest request)
protected ResponseFuture	BoltClientTransport.doInvokeAsync(SofaRequest request, RpcInternalContext rpcContext, com.alipay.remoting.InvokeContext invokeContext, int timeoutMillis) 异步调用
protected SofaResponse	BoltClientTransport.doInvokeSync(SofaRequest request, com.alipay.remoting.InvokeContext invokeContext, int timeoutMillis) 同步调用
protected void	BoltClientTransport.doOneWay(SofaRequest request, com.alipay.remoting.InvokeContext invokeContext, int timeoutMillis) 同步调用
void	BoltClientTransport.handleRpcRequest(SofaRequest request)
void	BoltClientTransport.oneWaySend(SofaRequest request, int timeout)
SofaResponse	BoltClientTransport.syncSend(SofaRequest request, int timeout)

com.alipay.sofa.rpc.transport.http中SofaRequest的使用

声明为SofaRequest的com.alipay.sofa.rpc.transport.http中的字段

限定符和类型	字段和说明
protected SofaRequest	AbstractHttpClientHandler.request 请求

参数类型为SofaRequest的com.alipay.sofa.rpc.transport.http中的方法

限定符和类型	方法和说明
protected void	AbstractHttp2ClientTransport.afterSend(RpcInternalContext context, SofaRequest request) 调用后设置一些属性（注意，在异步的情况较多下）
ResponseFuture	AbstractHttp2ClientTransport.asyncSend(SofaRequest request, int timeout)
protected void	AbstractHttp2ClientTransport.beforeSend(RpcInternalContext context, SofaRequest request) 调用前设置一些属性
protected io.netty.handler.codec.http.FullHttpRequest	AbstractHttp2ClientTransport.convertToHttpRequest(SofaRequest request)
protected ResponseFuture	AbstractHttp2ClientTransport.doInvokeAsync(SofaRequest request, RpcInternalContext rpcContext, int timeoutMillis) 异步调用
protected SofaResponse	AbstractHttp2ClientTransport.doInvokeSync(SofaRequest request, int timeout) 同步调用
protected void	AbstractHttp2ClientTransport.doSend(SofaRequest request, AbstractHttpClientHandler callback, int timeoutMills)
void	AbstractHttp2ClientTransport.handleRpcRequest(SofaRequest request)
void	AbstractHttp2ClientTransport.oneWaySend(SofaRequest request, int timeout)
SofaResponse	AbstractHttp2ClientTransport.syncSend(SofaRequest request, int timeout)
protected SofaTimeOutException	AbstractHttp2ClientTransport.timeoutException(SofaRequest request, int timeout, Throwable e)

参数类型为SofaRequest的com.alipay.sofa.rpc.transport.http中的构造器

构造器和说明
AbstractHttpClientHandler(ConsumerConfig consumerConfig, ProviderInfo providerInfo, SofaRequest request, RpcInternalContext context, ClassLoader classLoader)
CallbackInvokeClientHandler(ConsumerConfig consumerConfig, ProviderInfo providerInfo, SofaResponseCallback listener, SofaRequest request, RpcInternalContext context, ClassLoader classLoader) Instantiates a CallbackInvokeClientHandler
FutureInvokeClientHandler(ConsumerConfig consumerConfig, ProviderInfo providerInfo, HttpResponseFuture rpcFuture, SofaRequest request, RpcInternalContext context, ClassLoader classLoader) Instantiates a new FutureInvokeClientHandler.
SyncInvokeClientHandler(ConsumerConfig consumerConfig, ProviderInfo providerInfo, HttpResponseFuture rpcFuture, SofaRequest request, RpcInternalContext context, ClassLoader classLoader) Instantiates a new SyncInvokeClientHandler.

com.alipay.sofa.rpc.transport.rest中SofaRequest的使用

参数类型为SofaRequest的com.alipay.sofa.rpc.transport.rest中的方法

限定符和类型	方法和说明
protected Method	RestClientTransport.getMethod(SofaRequest request)