hessian2

Documentation

Index

• Constants
• Variables
• func CopyMap(inMapValue, outMapValue reflect.Value) error
• func CopySlice(inSlice, outSlice reflect.Value) error
• func GetClassDesc(v interface{}) string
• func GetJavaName(obj interface{}) (string, error)
• func ReflectResponse(in interface{}, out interface{}) error
• func ToMapStringInterface(origin map[interface{}]interface{}) map[string]interface{}
• type DubboHeader
• type DubboRequest
  • func EnsureRequest(body interface{}) *DubboRequest
  • func NewRequest(params interface{}, atta map[string]interface{}) *DubboRequest
• type DubboResponse
  • func EnsureResponse(body interface{}) *DubboResponse
  • func NewResponse(rspObj interface{}, exception error, attachments map[string]interface{}) *DubboResponse
• type HessianCodec
  • func NewHessianCodec(reader *bufio.Reader) *HessianCodec
  • func NewHessianCodecCustom(pkgType PackageType, reader *bufio.Reader, bodyLen int) *HessianCodec
  • func (h *HessianCodec) ReadAttachments() (map[string]interface{}, error)
  • func (h *HessianCodec) ReadBody(rspObj interface{}) error
  • func (h *HessianCodec) ReadHeader(header *DubboHeader) error
  • func (h *HessianCodec) Write(service Service, header DubboHeader, body interface{}) ([]byte, error)
• type PackageType
• type Service

Constants

const (
	TAG_READ        = int32(-1)
	ASCII_GAP       = 32
	CHUNK_SIZE      = 4096
	BC_BINARY       = byte('B') // final chunk
	BC_BINARY_CHUNK = byte('A') // non-final chunk

	BC_BINARY_DIRECT  = byte(0x20) // 1-byte length binary
	BINARY_DIRECT_MAX = byte(0x0f)
	BC_BINARY_SHORT   = byte(0x34) // 2-byte length binary
	BINARY_SHORT_MAX  = 0x3ff      // 0-1023 binary

	BC_DATE        = byte(0x4a) // 64-bit millisecond UTC date
	BC_DATE_MINUTE = byte(0x4b) // 32-bit minute UTC date

	BC_DOUBLE = byte('D') // IEEE 64-bit double

	BC_DOUBLE_ZERO  = byte(0x5b)
	BC_DOUBLE_ONE   = byte(0x5c)
	BC_DOUBLE_BYTE  = byte(0x5d)
	BC_DOUBLE_SHORT = byte(0x5e)
	BC_DOUBLE_MILL  = byte(0x5f)

	BC_FALSE = byte('F') // boolean false

	BC_INT = byte('I') // 32-bit int

	INT_DIRECT_MIN = -0x10
	INT_DIRECT_MAX = byte(0x2f)
	BC_INT_ZERO    = byte(0x90)

	INT_BYTE_MIN     = -0x800
	INT_BYTE_MAX     = 0x7ff
	BC_INT_BYTE_ZERO = byte(0xc8)

	BC_END = byte('Z')

	INT_SHORT_MIN     = -0x40000
	INT_SHORT_MAX     = 0x3ffff
	BC_INT_SHORT_ZERO = byte(0xd4)

	BC_LIST_VARIABLE         = byte(0x55)
	BC_LIST_FIXED            = byte('V')
	BC_LIST_VARIABLE_UNTYPED = byte(0x57)
	BC_LIST_FIXED_UNTYPED    = byte(0x58)

	BC_LIST_DIRECT         = byte(0x70)
	BC_LIST_DIRECT_UNTYPED = byte(0x78)
	LIST_DIRECT_MAX        = byte(0x7)

	BC_LONG         = byte('L') // 64-bit signed integer
	LONG_DIRECT_MIN = -0x08
	LONG_DIRECT_MAX = byte(0x0f)
	BC_LONG_ZERO    = byte(0xe0)

	LONG_BYTE_MIN     = -0x800
	LONG_BYTE_MAX     = 0x7ff
	BC_LONG_BYTE_ZERO = byte(0xf8)

	LONG_SHORT_MIN     = -0x40000
	LONG_SHORT_MAX     = 0x3ffff
	BC_LONG_SHORT_ZERO = byte(0x3c)

	BC_LONG_INT = byte(0x59)

	BC_MAP         = byte('M')
	BC_MAP_UNTYPED = byte('H')

	BC_NULL = byte('N') // x4e

	BC_OBJECT     = byte('O')
	BC_OBJECT_DEF = byte('C')

	BC_OBJECT_DIRECT  = byte(0x60)
	OBJECT_DIRECT_MAX = byte(0x0f)

	BC_REF = byte(0x51)

	BC_STRING       = byte('S') // final string
	BC_STRING_CHUNK = byte('R') // non-final string

	BC_STRING_DIRECT  = byte(0x00)
	STRING_DIRECT_MAX = byte(0x1f)
	BC_STRING_SHORT   = byte(0x30)
	STRING_SHORT_MAX  = 0x3ff

	BC_TRUE = byte('T')

	P_PACKET_CHUNK = byte(0x4f)
	P_PACKET       = byte('P')

	P_PACKET_DIRECT   = byte(0x80)
	PACKET_DIRECT_MAX = byte(0x7f)

	P_PACKET_SHORT   = byte(0x70)
	PACKET_SHORT_MAX = 0xfff
	ARRAY_STRING     = "[string"
	ARRAY_INT        = "[int"
	ARRAY_DOUBLE     = "[double"
	ARRAY_FLOAT      = "[float"
	ARRAY_BOOL       = "[boolean"
	ARRAY_LONG       = "[long"

	PATH_KEY      = "path"
	GROUP_KEY     = "group"
	INTERFACE_KEY = "interface"
	VERSION_KEY   = "version"
	TIMEOUT_KEY   = "timeout"

	STRING_NIL   = ""
	STRING_TRUE  = "true"
	STRING_FALSE = "false"
	STRING_ZERO  = "0.0"
	STRING_ONE   = "1.0"
)

constansts

const (
	Response_OK                byte = 20
	Response_CLIENT_TIMEOUT    byte = 30
	Response_SERVER_TIMEOUT    byte = 31
	Response_BAD_REQUEST       byte = 40
	Response_BAD_RESPONSE      byte = 50
	Response_SERVICE_NOT_FOUND byte = 60
	Response_SERVICE_ERROR     byte = 70
	Response_SERVER_ERROR      byte = 80
	Response_CLIENT_ERROR      byte = 90

	// According to "java dubbo" There are two cases of response:
	// 		1. with attachments
	// 		2. no attachments
	RESPONSE_WITH_EXCEPTION                  int32 = 0
	RESPONSE_VALUE                           int32 = 1
	RESPONSE_NULL_VALUE                      int32 = 2
	RESPONSE_WITH_EXCEPTION_WITH_ATTACHMENTS int32 = 3
	RESPONSE_VALUE_WITH_ATTACHMENTS          int32 = 4
	RESPONSE_NULL_VALUE_WITH_ATTACHMENTS     int32 = 5
)

DubboResponse related consts

const (
	// header length.
	HEADER_LENGTH = 16

	// magic header
	MAGIC      = uint16(0xdabb)
	MAGIC_HIGH = byte(0xda)
	MAGIC_LOW  = byte(0xbb)

	// message flag.
	FLAG_REQUEST = byte(0x80)
	FLAG_TWOWAY  = byte(0x40)
	FLAG_EVENT   = byte(0x20) // for heartbeat
	SERIAL_MASK  = 0x1f

	DUBBO_VERSION                          = "2.5.4"
	DUBBO_VERSION_KEY                      = "dubbo"
	DEFAULT_DUBBO_PROTOCOL_VERSION         = "2.0.2" // Dubbo RPC protocol version, for compatibility, it must not be between 2.0.10 ~ 2.6.2
	LOWEST_VERSION_FOR_RESPONSE_ATTACHMENT = 2000200
	DEFAULT_LEN                            = 8388608 // 8 * 1024 * 1024 default body max length
)

*

• the dubbo protocol header length is 16 Bytes.
• the first 2 Bytes is magic code '0xdabb'
• the next 1 Byte is message flags, in which its 16-20 bit is serial id, 21 for event, 22 for two way, 23 for request/response flag
• the next 1 Bytes is response state.
• the next 8 Bytes is package DI.
• the next 4 Bytes is package length. *

const (
	JAVA_IDENT_REGEX = "(?:[_$a-zA-Z][_$a-zA-Z0-9]*)"
	CLASS_DESC       = "(?:L" + JAVA_IDENT_REGEX + "(?:\\/" + JAVA_IDENT_REGEX + ")*;)"
	ARRAY_DESC       = "(?:\\[+(?:(?:[VZBCDFIJS])|" + CLASS_DESC + "))"
	DESC_REGEX       = "(?:(?:[VZBCDFIJS])|" + CLASS_DESC + "|" + ARRAY_DESC + ")"
)

regular

const (
	PackageError              = PackageType(0x01)
	PackageRequest            = PackageType(0x02)
	PackageResponse           = PackageType(0x04)
	PackageHeartbeat          = PackageType(0x08)
	PackageRequest_TwoWay     = PackageType(0x10)
	PackageResponse_Exception = PackageType(0x20)
	PackageType_BitSize       = 0x2f
)

enum part

const (
	// Zero : byte zero
	Zero = byte(0x00)
)

Variables

var (
	DubboRequestHeaderBytesTwoWay = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_REQUEST | FLAG_TWOWAY}
	DubboRequestHeaderBytes       = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_REQUEST}
	DubboResponseHeaderBytes      = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, Zero, Response_OK}
	DubboRequestHeartbeatHeader   = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_REQUEST | FLAG_TWOWAY | FLAG_EVENT}
	DubboResponseHeartbeatHeader  = [HEADER_LENGTH]byte{MAGIC_HIGH, MAGIC_LOW, FLAG_EVENT}
)

Dubbo request response related consts

var (
	ErrHeaderNotEnough = perrors.New("header buffer too short")
	ErrBodyNotEnough   = perrors.New("body buffer too short")
	ErrJavaException   = perrors.New("got java exception")
	ErrIllegalPackage  = perrors.New("illegal package!")
)

Error part

var (
	NilError            = perrors.Errorf("object should not be nil")
	UnexpectedTypeError = perrors.Errorf("object should be a POJO")
)

var DescRegex, _ = regexp.Compile(DESC_REGEX)

nolint

var NilValue = reflect.Zero(reflect.TypeOf((*interface{})(nil)).Elem())

Functions

func CopyMap

func CopyMap(inMapValue, outMapValue reflect.Value) error

CopyMap copy from in map to out map

func CopySlice

func CopySlice(inSlice, outSlice reflect.Value) error

CopySlice copy from inSlice to outSlice

func GetClassDesc

func GetClassDesc(v interface{}) string

GetClassDesc get class desc. - boolean[].class => "[Z" - Object.class => "Ljava/lang/Object;"

func GetJavaName

func GetJavaName(obj interface{}) (string, error)

GetJavaName returns java name of an object

func ReflectResponse

func ReflectResponse(in interface{}, out interface{}) error

ReflectResponse reflect return value TODO response object should not be copied again to another object, it should be the exact type of the object

func ToMapStringInterface

func ToMapStringInterface(origin map[interface{}]interface{}) map[string]interface{}

Types

type DubboHeader

type DubboHeader struct {
	SerialID       byte
	Type           PackageType
	ID             int64
	BodyLen        int
	ResponseStatus byte
}

DubboHeader dubbo header

type DubboRequest

type DubboRequest struct {
	Params      interface{}
	Attachments map[string]interface{}
}

func EnsureRequest

func EnsureRequest(body interface{}) *DubboRequest

func NewRequest

func NewRequest(params interface{}, atta map[string]interface{}) *DubboRequest

NewRequest create a new DubboRequest

type DubboResponse

type DubboResponse struct {
	RspObj      interface{}
	Exception   error
	Attachments map[string]interface{}
}

DubboResponse dubbo response

func EnsureResponse

func EnsureResponse(body interface{}) *DubboResponse

EnsureResponse check body type, make sure it's a DubboResponse or package it as a DubboResponse

func NewResponse

func NewResponse(rspObj interface{}, exception error, attachments map[string]interface{}) *DubboResponse

NewResponse create a new DubboResponse

type HessianCodec

type HessianCodec struct {
	// contains filtered or unexported fields
}

HessianCodec defines hessian codec

func NewHessianCodec

func NewHessianCodec(reader *bufio.Reader) *HessianCodec

NewHessianCodec generate a new hessian codec instance

func NewHessianCodecCustom

func NewHessianCodecCustom(pkgType PackageType, reader *bufio.Reader, bodyLen int) *HessianCodec

NewHessianCodec generate a new hessian codec instance

func (*HessianCodec) ReadAttachments

func (h *HessianCodec) ReadAttachments() (map[string]interface{}, error)

ignore body, but only read attachments

func (*HessianCodec) ReadBody

func (h *HessianCodec) ReadBody(rspObj interface{}) error

ReadBody uses hessian codec to read response body

func (*HessianCodec) ReadHeader

func (h *HessianCodec) ReadHeader(header *DubboHeader) error

ReadHeader uses hessian codec to read dubbo header

func (*HessianCodec) Write

func (h *HessianCodec) Write(service Service, header DubboHeader, body interface{}) ([]byte, error)

type PackageType

type PackageType int

PackageType nolint

type Service

type Service struct {
	Path      string
	Interface string
	Group     string
	Version   string
	Method    string
	Timeout   time.Duration // request timeout
}

Service defines service instance