com.baidu.brpc.protocol.http

类 HttpRpcProtocol

java.lang.Object

com.baidu.brpc.protocol.AbstractProtocol

com.baidu.brpc.protocol.http.HttpRpcProtocol

所有已实现的接口:

Protocol

public class HttpRpcProtocol
extends AbstractProtocol

处理http rpc协议，包括四种序列化格式： 1、http + protobuf 2、http + json

字段概要

字段

限定符和类型	字段和说明
protected String	encoding
static String	PROTOCOL_TYPE
protected int	protocolType

从类继承的字段 com.baidu.brpc.protocol.AbstractProtocol

notEnoughDataException

构造器概要

构造器

构造器和说明
HttpRpcProtocol(int protocolType, String encoding)

方法概要

限定符和类型	方法和说明
void	addHttpResponseHeaders(io.netty.handler.codec.http.FullHttpResponse fullHttpResponse, Response response, io.netty.handler.codec.http.FullHttpRequest fullHttpRequest) fill http response headers
void	afterResponseSent(Request request, Response response, io.netty.channel.ChannelFuture channelFuture) do something if needed after server channel writeAndFlush
void	beforeRequestSent(Request request, RpcClient rpcClient, BrpcChannel channelGroup) do something if needed before client send request
String	buildHttpUri(String serviceName, String methodName)
Request	createRequest() create a new request instance
Response	createResponse() create a new response instance
Object	decode(io.netty.channel.ChannelHandlerContext ctx, DynamicCompositeByteBuf in, boolean isDecodingRequest) 客户端/服务端解析请求包成header+body buffer
Object	decodeBody(int protocolType, String encoding, byte[] bytes)
Request	decodeRequest(Object packet) 服务端反序列化rpc请求
Response	decodeResponse(Object msg, io.netty.channel.ChannelHandlerContext ctx) 客户端反序列化rpc响应
byte[]	encodeBody(int protocolType, String encoding, Object body, RpcMethodInfo rpcMethodInfo)
io.netty.buffer.ByteBuf	encodeRequest(Request request) 客户端序列化请求对象
io.netty.buffer.ByteBuf	encodeResponse(Request request, Response response) 服务端序列化返回结果。
byte[]	encodeResponseBody(int protocolType, Request request, Response response)
String	getContentType(Integer protocolType)
Request	getRequest() get a reusable request instance from threadLocal or pool the request instance must be reset before reuse
Response	getResponse() get a reusable response instance from threadLocal or pool the response instance must be reset before reuse
boolean	isCoexistence() 该协议是否可以和其他协议共存。
Object	makeRequest(int id, String methodName, Object[] args)
Object	makeResponse(int protocolType, Response response)
long	parseCorrelationId(String headerCorrelationId, Long channelAttachCorrelationId)
Object	parseHttpResponse(Object body, RpcMethodInfo rpcMethodInfo)
static int	parseProtocolType(String contentType)
Object[]	parseRequestParam(int protocolType, Object body, RpcMethodInfo rpcMethodInfo)
boolean	returnChannelBeforeResponse() 连接被归还入池的时机

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

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

字段详细资料

PROTOCOL_TYPE

public static final String PROTOCOL_TYPE

另请参阅:

常量字段值

protocolType

protected int protocolType

encoding

protected String encoding

构造器详细资料

HttpRpcProtocol

public HttpRpcProtocol(int protocolType,
                       String encoding)

方法详细资料

createRequest

public Request createRequest()

从接口复制的说明: Protocol

create a new request instance

指定者:

createRequest 在接口中 Protocol

覆盖:

createRequest 在类中 AbstractProtocol

createResponse

public Response createResponse()

从接口复制的说明: Protocol

create a new response instance

指定者:

createResponse 在接口中 Protocol

覆盖:

createResponse 在类中 AbstractProtocol

getRequest

public Request getRequest()

从接口复制的说明: Protocol

get a reusable request instance from threadLocal or pool the request instance must be reset before reuse

指定者:

getRequest 在接口中 Protocol

覆盖:

getRequest 在类中 AbstractProtocol

getResponse

public Response getResponse()

从接口复制的说明: Protocol

get a reusable response instance from threadLocal or pool the response instance must be reset before reuse

指定者:

getResponse 在接口中 Protocol

覆盖:

getResponse 在类中 AbstractProtocol

decode

public Object decode(io.netty.channel.ChannelHandlerContext ctx,
                     DynamicCompositeByteBuf in,
                     boolean isDecodingRequest)
              throws BadSchemaException,
                     TooBigDataException,
                     NotEnoughDataException

从接口复制的说明: Protocol

客户端/服务端解析请求包成header+body buffer

in - 输入byte buf

返回:

header+body buffer

抛出:

BadSchemaException - header格式不对

TooBigDataException - body太大

NotEnoughDataException - 可读长度不够，由于粘包拆包问题。

encodeRequest

public io.netty.buffer.ByteBuf encodeRequest(Request request)
                                      throws Exception

从接口复制的说明: Protocol

客户端序列化请求对象

参数:

request - 待发送给服务端的对象

抛出:

Exception - 序列化异常

beforeRequestSent

public void beforeRequestSent(Request request,
                              RpcClient rpcClient,
                              BrpcChannel channelGroup)

从接口复制的说明: Protocol

do something if needed before client send request

指定者:

beforeRequestSent 在接口中 Protocol

覆盖:

beforeRequestSent 在类中 AbstractProtocol

decodeResponse

public Response decodeResponse(Object msg,
                               io.netty.channel.ChannelHandlerContext ctx)

从接口复制的说明: Protocol

客户端反序列化rpc响应

参数:

msg - header & body的buf

ctx - netty channel context

decodeRequest

public Request decodeRequest(Object packet)

从接口复制的说明: Protocol

服务端反序列化rpc请求

参数:

packet - header & body的buf

encodeResponse

public io.netty.buffer.ByteBuf encodeResponse(Request request,
                                              Response response)

从接口复制的说明: Protocol

服务端序列化返回结果。

response - 服务端要返回给客户端的对象

afterResponseSent

public void afterResponseSent(Request request,
                              Response response,
                              io.netty.channel.ChannelFuture channelFuture)

从接口复制的说明: Protocol

do something if needed after server channel writeAndFlush

指定者:

afterResponseSent 在接口中 Protocol

覆盖:

afterResponseSent 在类中 AbstractProtocol

channelFuture - the return value of writeAndFlush

encodeResponseBody

public byte[] encodeResponseBody(int protocolType,
                                 Request request,
                                 Response response)

returnChannelBeforeResponse

public boolean returnChannelBeforeResponse()

从接口复制的说明: Protocol

连接被归还入池的时机

指定者:

returnChannelBeforeResponse 在接口中 Protocol

覆盖:

returnChannelBeforeResponse 在类中 AbstractProtocol

返回:

true代表请求发送后立即归还连接，false表示收到响应后归还。

isCoexistence

public boolean isCoexistence()

从接口复制的说明: Protocol

该协议是否可以和其他协议共存。

指定者:

isCoexistence 在接口中 Protocol

覆盖:

isCoexistence 在类中 AbstractProtocol

返回:

true可以共存，false不能共存。

parseProtocolType

public static int parseProtocolType(String contentType)

getContentType

public String getContentType(Integer protocolType)

encodeBody

public byte[] encodeBody(int protocolType,
                         String encoding,
                         Object body,
                         RpcMethodInfo rpcMethodInfo)

decodeBody

public Object decodeBody(int protocolType,
                         String encoding,
                         byte[] bytes)

addHttpResponseHeaders

public void addHttpResponseHeaders(io.netty.handler.codec.http.FullHttpResponse fullHttpResponse,
                                   Response response,
                                   io.netty.handler.codec.http.FullHttpRequest fullHttpRequest)

fill http response headers

参数:

fullHttpResponse - netty http response

response - brpc standard response

fullHttpRequest - netty http request

makeRequest

public Object makeRequest(int id,
                          String methodName,
                          Object[] args)

makeResponse

public Object makeResponse(int protocolType,
                           Response response)

buildHttpUri

public String buildHttpUri(String serviceName,
                           String methodName)

parseCorrelationId

public long parseCorrelationId(String headerCorrelationId,
                               Long channelAttachCorrelationId)

parseHttpResponse

public Object parseHttpResponse(Object body,
                                RpcMethodInfo rpcMethodInfo)

parseRequestParam

public Object[] parseRequestParam(int protocolType,
                                  Object body,
                                  RpcMethodInfo rpcMethodInfo)