com.baidu.brpc.protocol.http

Class HttpRpcProtocol

java.lang.Object

com.baidu.brpc.protocol.AbstractProtocol

com.baidu.brpc.protocol.http.HttpRpcProtocol

All Implemented Interfaces:

Protocol

public class HttpRpcProtocol
extends AbstractProtocol

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	encoding
static String	PROTOCOL_TYPE
protected int	protocolType

Fields inherited from class com.baidu.brpc.protocol.AbstractProtocol

notEnoughDataException

Constructor Summary

Constructors

Constructor and Description
HttpRpcProtocol(int protocolType, String encoding)

Method Summary

Modifier and Type	Method and Description
void	addHostHeader(Request request)
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
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() 连接被归还入池的时机

Methods inherited from class com.baidu.brpc.protocol.AbstractProtocol

supportHeartbeat

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_TYPE

public static final String PROTOCOL_TYPE

See Also:

Constant Field Values

protocolType

protected int protocolType

encoding

protected String encoding

Constructor Detail

HttpRpcProtocol

public HttpRpcProtocol(int protocolType,
                       String encoding)

Method Detail

createRequest

public Request createRequest()

Description copied from interface: Protocol

create a new request instance

Specified by:

createRequest in interface Protocol

Overrides:

createRequest in class AbstractProtocol

createResponse

public Response createResponse()

Description copied from interface: Protocol

create a new response instance

Specified by:

createResponse in interface Protocol

Overrides:

createResponse in class AbstractProtocol

getRequest

public Request getRequest()

Description copied from interface: Protocol

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

Specified by:

getRequest in interface Protocol

Overrides:

getRequest in class AbstractProtocol

getResponse

public Response getResponse()

Description copied from interface: Protocol

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

Specified by:

getResponse in interface Protocol

Overrides:

getResponse in class AbstractProtocol

decode

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

Description copied from interface: Protocol

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

in - 输入byte buf

Returns:

header+body buffer

Throws:

BadSchemaException - header格式不对

TooBigDataException - body太大

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

encodeRequest

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

Description copied from interface: Protocol

客户端序列化请求对象

Parameters:

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

Throws:

Exception - 序列化异常

addHostHeader

public void addHostHeader(Request request)

decodeResponse

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

Description copied from interface: Protocol

客户端反序列化rpc响应

Parameters:

msg - header & body的buf

ctx - netty channel context

decodeRequest

public Request decodeRequest(Object packet)

Description copied from interface: Protocol

服务端反序列化rpc请求

Parameters:

packet - header & body的buf

encodeResponse

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

Description copied from interface: Protocol

服务端序列化返回结果。

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

afterResponseSent

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

Description copied from interface: Protocol

do something if needed after server channel writeAndFlush

Specified by:

afterResponseSent in interface Protocol

Overrides:

afterResponseSent in class AbstractProtocol

channelFuture - the return value of writeAndFlush

encodeResponseBody

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

returnChannelBeforeResponse

public boolean returnChannelBeforeResponse()

Description copied from interface: Protocol

连接被归还入池的时机

Specified by:

returnChannelBeforeResponse in interface Protocol

Overrides:

returnChannelBeforeResponse in class AbstractProtocol

Returns:

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

isCoexistence

public boolean isCoexistence()

Description copied from interface: Protocol

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

Specified by:

isCoexistence in interface Protocol

Overrides:

isCoexistence in class AbstractProtocol

Returns:

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

Parameters:

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)