序列化表格 (ioGame 21.20 API)

程序包 com.iohao.game.action.skeleton.core.exception
- 异常错误类 com.iohao.game.action.skeleton.core.exception.MsgException
  
  class MsgException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  -4977523514509693190L
  - 序列化字段
    
    msgCode
    
    int msgCode
    
    异常消息码
    
    msgExceptionInfo
    
    MsgExceptionInfo msgExceptionInfo
程序包 com.iohao.game.action.skeleton.core.flow
程序包 com.iohao.game.action.skeleton.eventbus
- 类 com.iohao.game.action.skeleton.eventbus.EventBrokerClientMessage
  
  class EventBrokerClientMessage extends Object implements Serializable
  - 序列化字段
    
    appName
    
    String appName
    
    brokerClientId
    
    String brokerClientId
    
    brokerClientType
    
    String brokerClientType
    
    tag
    
    String tag
- 类 com.iohao.game.action.skeleton.eventbus.EventBusMessage
  
  class EventBusMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -1661393033598374515L
  - 序列化字段
    
    eventBrokerClientMessages
    
    Collection<EventBrokerClientMessage> eventBrokerClientMessages
    
    其他进程的信息
    
    eventSource
    
    Object eventSource
    
    事件源
    
    threadIndex
    
    long threadIndex
    
    threadIndex 主要作用是确定使用哪个线程执行器。
    当该值为 0 时，框架会分配一个值。
    
    traceId
    
    String traceId

程序包 com.iohao.game.action.skeleton.protocol

类 com.iohao.game.action.skeleton.protocol.BarMessage

class BarMessage extends Object implements Serializable

serialVersionUID:

562068269463876111L
- 序列化字段
  - data
    
    byte[] data
    
    实际请求的业务参数 byte[]
  - dataClass
    
    String dataClass
    
    业务数据的 class 信息
  - headMetadata
    
    HeadMetadata headMetadata
    
    元信息
  - responseStatus
    
    int responseStatus
    
    响应码: 0:成功, 其他表示有错误
  - validatorMsg
    
    String validatorMsg
    
    异常信息、JSR380 验证信息

类 com.iohao.game.action.skeleton.protocol.HeadMetadata

class HeadMetadata extends Object implements Serializable

serialVersionUID:: -472575113683576693L

序列化字段

attachmentData

byte[] attachmentData

扩展字段

     开发者有特殊业务可以通过这个字段来扩展元信息，该字段的信息会跟随每一个请求；

bindingLogicServerIds

int[] bindingLogicServerIds

玩家绑定的多个游戏逻辑服 id

     所有与该游戏逻辑服相关的请求都将被分配给已绑定的游戏逻辑服处理。
     即使启动了多个同类型的游戏逻辑服，该请求仍将被分配给已绑定的游戏逻辑服处理。

cacheCondition
```
int cacheCondition
```
框架自用字段。将来变化可能较大，开发者请不要使用。

channelId

String channelId

netty 的 channelId。

     框架存放 netty 的 channelId 是为了能在对外服查找到对应的连接。
     当玩家登录后，框架将会使用玩家的 userId 来查找对应的连接（channel），而不是 channelId ；
     因为 channelId 的字符串太长了，每次将该值传输到逻辑服会小小的影响性能。

     当玩家登录后，框架将不会使用该属性了；开发者如果有需要，可以把这个字段利用起来。

cmdMerge

int cmdMerge

合并两个参数,分别存放在 [高16 和低16]

     cmd 目标路由
     subCmd 目标子路由

     例如 cmd = 600; subCmd = 700;
     merge 的结果: 39322300
     那么merge对应的二进制是: 0000 0010 0101 1000 0000 0010 1011 1100

     see CmdInfo

customData

byte[] customData

自定义数据，专为开发者预留的一个字段，开发者可以利用该字段来传递自定义数据

     该字段由开发者自己定义，框架不会对数据做任何处理，也不会做任何检查，
     开发者可以利用该字段来传递任何数据，包括自定义对象。

endPointClientId

int endPointClientId

目标逻辑服 endPointClientId

     用于指定请求由哪个服务器处理

     比如两个象棋服（游戏逻辑服） A，B
     玩家李雷和韩梅梅在对局时，如果在 象棋服A 玩的，那么之后的请求都要分配给 象棋服A 来处理。

     endPointClientId 指的是 服务器的唯一id

     see HashKit

executorSelect
```
ExecutorSelectEnum executorSelect
```
所选执行器
msgId
```
int msgId
```
消息标记号；由前端请求时设置，服务器响应时会携带上

rpcCommandType

byte rpcCommandType

rpc type

     see : com.alipay.remoting.rpc.RpcCommandType

     在 bolt 中， 调用方使用 com.alipay.remoting.rpc.RpcServer或 com.alipay.remoting.rpc.RpcClient 的 oneway 方法，
     则 AsyncContext.sendResponse 无法回传响应；原因可阅读 com.alipay.remoting.rpc.protocol.RpcRequestProcessor#sendResponseIfNecessary 源码。

     业务框架保持与 bolt 的风格一至，使用 RpcCommandType。不同的是，业务框架会用 RpcCommandType 区别使用什么方式来发送响应。

     如果 rpcCommandType != RpcCommandType.REQUEST_ONEWAY，就使用 com.alipay.remoting.AsyncContext#sendResponse 来发送响应。
     具体发送逻辑可读 DefaultActionAfter 源码

sourceClientId

int sourceClientId

来源逻辑服 client id

     比如是对外服发起的请求，这个来源就是对外服的 clientId
     clientId 指的是 服务器的唯一id

     see HashKit

stick
```
int stick
```
框架自用字段。将来变化可能较大，开发者请不要使用。
traceId
```
String traceId
```
traceId
userId
```
long userId
```
userId
userProcessorExecutorSelectorBytes
```
byte[] userProcessorExecutorSelectorBytes
```
框架自用字段。将来变化可能较大，开发者请不要使用。

类 com.iohao.game.action.skeleton.protocol.RequestMessage

class RequestMessage extends BarMessage implements Serializable

serialVersionUID:

8564408386704453534L
类 com.iohao.game.action.skeleton.protocol.ResponseMessage

class ResponseMessage extends BarMessage implements Serializable

serialVersionUID:

2501490581523234975L

程序包 com.iohao.game.action.skeleton.protocol.collect
- 类 com.iohao.game.action.skeleton.protocol.collect.RequestCollectMessage
  
  class RequestCollectMessage extends Object implements Serializable
  
  serialVersionUID:
  
  4271692369352579162L
  - 序列化字段
    
    requestMessage
    
    RequestMessage requestMessage
- 类 com.iohao.game.action.skeleton.protocol.collect.ResponseCollectItemMessage
  
  class ResponseCollectItemMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -7655620321337836719L
  - 序列化字段
    
    logicServerId
    
    String logicServerId
    
    responseMessage
    
    ResponseMessage responseMessage
- 类 com.iohao.game.action.skeleton.protocol.collect.ResponseCollectMessage
  
  class ResponseCollectMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -2510491415150451094L
  - 序列化字段
    
    messageList
    
    List<ResponseCollectItemMessage> messageList
    
    statusCode
    
    int statusCode
    
    响应码: 0:成功, 其他表示有错误
    通常情况下，如果这里有错误码，基本是没有请求对应的逻辑服
    
    statusMes
    
    String statusMes
    
    错误信息
程序包 com.iohao.game.action.skeleton.protocol.external
- 类 com.iohao.game.action.skeleton.protocol.external.RequestCollectExternalMessage
  
  class RequestCollectExternalMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -1661393033598374514L
  - 序列化字段
    
    bizCode
    
    int bizCode
    
    业务码
    游戏开发者从正数开始使用框架会使用负数游戏开发者可以通过自定义业务码，来获取一些对外服的业务数据，方便进行一些特殊的业务
    
    data
    
    Serializable data
    
    请求业务数据
    
    sourceClientId
    
    int sourceClientId
    
    游戏对外服 idHash
    当 sourceClientId == 0 时，将访问【所有的】游戏对外服。当 sourceClientId != 0 时，将访问【指定的】游戏对外服。为方便记忆，与
    
    引用无效
    
    HeadMetadata#setSourceClientId(int)
    
    同名
    
    traceId
    
    String traceId
    
    traceId MDC
    
    userId
    
    long userId
    
    发起请求的 userId
- 类 com.iohao.game.action.skeleton.protocol.external.ResponseCollectExternalItemMessage
  
  class ResponseCollectExternalItemMessage extends Object implements Serializable
  
  serialVersionUID:
  
  8687159017486669115L
  - 序列化字段
    
    data
    
    Serializable data
    
    响应数据，通常是（游戏对外服提供）
    
    errorMsg
    
    String errorMsg
    
    错误消息
    
    logicServerId
    
    String logicServerId
    
    由框架赋值
    
    responseStatus
    
    int responseStatus
    
    响应码: 0:成功, 其他表示有错误
- 类 com.iohao.game.action.skeleton.protocol.external.ResponseCollectExternalMessage
  
  class ResponseCollectExternalMessage extends Object implements Serializable
  
  serialVersionUID:
  
  44170975617598505L
  - 序列化字段
    
    messageList
    
    List<ResponseCollectExternalItemMessage> messageList
    
    由于是调用多个游戏对外服，每条数据来自游戏对外服
程序包 com.iohao.game.action.skeleton.protocol.login
- 类 com.iohao.game.action.skeleton.protocol.login.SettingUserIdMessage
  
  class SettingUserIdMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -7385687951893601229L
  - 序列化字段
    
    headMetadata
    
    HeadMetadata headMetadata
    
    userId
    
    long userId
    
    userId
- 类 com.iohao.game.action.skeleton.protocol.login.SettingUserIdMessageResponse
  
  class SettingUserIdMessageResponse extends Object implements Serializable
  
  serialVersionUID:
  
  -3776596417948970990L
  - 序列化字段
    
    success
    
    boolean success
    
    true: userId 设置成功
    
    userId
    
    long userId
    
    变更后的 userId
程序包 com.iohao.game.action.skeleton.protocol.processor
- 类 com.iohao.game.action.skeleton.protocol.processor.EndPointLogicServerMessage
  
  class EndPointLogicServerMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -281565377520818401L
  - 序列化字段
    
    logicServerIdSet
    
    Set<String> logicServerIdSet
    
    需要绑定的多个游戏逻辑服 id
    
    operation
    
    EndPointOperationEnum operation
    
    userList
    
    List<Long> userList
    
    用户 id
- 类 com.iohao.game.action.skeleton.protocol.processor.SimpleServerInfo
  
  class SimpleServerInfo extends Object implements Serializable
  
  serialVersionUID:
  
  -4231013083939730244L
  - 序列化字段
    
    brokerClientType
    
    String brokerClientType
    
    逻辑服类型
    
    id
    
    String id
    
    服务器唯一标识
    
    idHash
    
    int idHash
    
    服务器唯一标识 hash
    
    name
    
    String name
    
    模块名
    
    startTime
    
    long startTime
    
    启动时间
    
    status
    
    int status
    
    逻辑服状态
    
    tag
    
    String tag
    
    逻辑服标签（tag 相当于归类）
    用于逻辑服的归类假设逻辑服：战斗逻辑服启动了两台或以上，为了得到启动连接的逻辑服，我们可以通过 tag 在后台查找相同的逻辑服一定要用相同的 tag
程序包 com.iohao.game.action.skeleton.pulse.message
- 类 com.iohao.game.action.skeleton.pulse.message.EmptyMessage
  
  class EmptyMessage extends Object implements Serializable
  
  serialVersionUID:
  
  6890608282265776947L
- 类 com.iohao.game.action.skeleton.pulse.message.PulseSignalMessage
  
  class PulseSignalMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -954007335024894018L
  - 序列化字段
    
    channel
    
    String channel
    
    信号频道
    不需要开发者设置，所在 PulseChannel 的 channel 值
    
    data
    
    Serializable data
    
    业务数据
    
    signalType
    
    int signalType
    
    信号类型 see SignalType
    
    sourceClientId
    
    int sourceClientId
    
    来源逻辑服 client id
    see HashKit
- 类 com.iohao.game.action.skeleton.pulse.message.PulseSignalRequest
  
  class PulseSignalRequest extends PulseSignalMessage implements Serializable
  
  serialVersionUID:
  
  5222065267195783170L
- 类 com.iohao.game.action.skeleton.pulse.message.PulseSignalResponse
  
  class PulseSignalResponse extends PulseSignalMessage implements Serializable
  
  serialVersionUID:
  
  -5782262610772950867L
  - 序列化字段
    
    simpleServerInfo
    
    SimpleServerInfo simpleServerInfo
程序包 com.iohao.game.bolt.broker.cluster
- 类 com.iohao.game.bolt.broker.cluster.Broker
  
  class Broker extends Object implements Serializable
  
  serialVersionUID:
  
  -221407958089075449L
  - 序列化字段
    
    brokerAddress
    
    String brokerAddress
    
    broker （游戏网关）地址格式 ip:port
    
    clusterAddress
    
    String clusterAddress
    
    cluster 格式 ip:port
    
    id
    
    String id
    
    服务器唯一标识
    如果没设置，会随机分配一个逻辑服的模块id，标记不同的逻辑服模块。开发者随意定义，只要确保每个逻辑服的模块 id 不相同就可以
    
    ip
    
    String ip
    
    broker （游戏网关） ip
    
    port
    
    int port
    
    broker （游戏网关） port
    
    startedAt
    
    long startedAt
程序包 com.iohao.game.bolt.broker.core.message
- 类 com.iohao.game.bolt.broker.core.message.BroadcastMessage
  
  class BroadcastMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -8781053474740658678L
  - 序列化字段
    
    broadcastAll
    
    boolean broadcastAll
    
    true 给全体广播
    
    responseMessage
    
    ResponseMessage responseMessage
    
    广播的消息
    
    userIdList
    
    Collection<Long> userIdList
    
    接收广播的用户列表
- 类 com.iohao.game.bolt.broker.core.message.BroadcastOrderMessage
  
  class BroadcastOrderMessage extends BroadcastMessage implements Serializable
- 类 com.iohao.game.bolt.broker.core.message.BrokerClientItemConnectMessage
  
  class BrokerClientItemConnectMessage extends Object implements Serializable
  
  serialVersionUID:
  
  1148652635062833923L
- 类 com.iohao.game.bolt.broker.core.message.BrokerClientModuleMessage
  
  class BrokerClientModuleMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -1570849960266785141L
  - 序列化字段
    
    address
    
    String address
    
    逻辑服地址
    
    brokerClientType
    
    BrokerClientType brokerClientType
    
    逻辑服类型
    
    cmdMergeList
    
    List<Integer> cmdMergeList
    
    header
    
    Map<String,Object> header
    
    id
    
    String id
    
    服务器唯一标识
    
    idHash
    
    int idHash
    
    服务器唯一标识 hash
    
    ioGamePid
    
    String ioGamePid
    
    模拟的同进程 pid
    
    name
    
    String name
    
    模块名
    
    status
    
    int status
    
    逻辑服状态
    
    tag
    
    String tag
    
    逻辑服标签（tag 相当于归类）
    用于逻辑服的归类假设逻辑服：战斗逻辑服启动了两台或以上，为了得到启动连接的逻辑服，我们可以通过 tag 在后台查找相同的逻辑服一定要用相同的 tag 注意，如果没设置这个值，会使用 this.name 的值
    
    withNo
    
    int withNo
- 类 com.iohao.game.bolt.broker.core.message.BrokerClientOfflineMessage
  
  class BrokerClientOfflineMessage extends Object implements Serializable
  - 序列化字段
    
    moduleMessage
    
    BrokerClientModuleMessage moduleMessage
- 类 com.iohao.game.bolt.broker.core.message.BrokerClientOnlineMessage
  
  class BrokerClientOnlineMessage extends Object implements Serializable
  - 序列化字段
    
    moduleMessage
    
    BrokerClientModuleMessage moduleMessage
- 类 com.iohao.game.bolt.broker.core.message.BrokerClusterMessage
  
  class BrokerClusterMessage extends Object implements Serializable
  
  serialVersionUID:
  
  2753485289174578530L
  - 序列化字段
    
    brokerMessageList
    
    List<BrokerMessage> brokerMessageList
    
    name
    
    String name
- 类 com.iohao.game.bolt.broker.core.message.BrokerMessage
  
  class BrokerMessage extends Object implements Serializable
  
  serialVersionUID:
  
  7360874461048656701L
  - 序列化字段
    
    address
    
    String address
    
    broker （游戏网关）地址格式 ip:port
    
    id
    
    String id
    
    broker （游戏网关）的服务器 id
- 类 com.iohao.game.bolt.broker.core.message.InnerModuleMessage
  
  class InnerModuleMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -5352732154154036339L
  - 序列化字段
    
    requestMessage
    
    RequestMessage requestMessage
- 类 com.iohao.game.bolt.broker.core.message.InnerModuleVoidMessage
  
  class InnerModuleVoidMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -5740054570053626336L
  - 序列化字段
    
    requestMessage
    
    RequestMessage requestMessage
- 类 com.iohao.game.bolt.broker.core.message.RequestBrokerClientModuleMessage
  
  class RequestBrokerClientModuleMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -8701320309480192037L
  - 序列化字段
    
    withNo
    
    int withNo
程序包 com.iohao.game.common.kit
- 类 com.iohao.game.common.kit.TimeBetweenKit
  
  class TimeBetweenKit extends Object implements Serializable
程序包 com.iohao.game.common.kit.asm
- 类 com.iohao.game.common.kit.asm.ClassRefInfo
  
  class ClassRefInfo extends Object implements Serializable
  
  serialVersionUID:
  
  -4297558765639660029L
  - 序列化字段
    
    clazz
    
    Class<?> clazz
    
    类信息
    
    constructorAccess
    
    com.esotericsoftware.reflectasm.ConstructorAccess<?> constructorAccess
    
    构造访问器
    
    filedRefInfoMap
    
    Map<String,FieldRefInfo> filedRefInfoMap
    
    以属性名作为key
    
    methodAccess
    
    com.esotericsoftware.reflectasm.MethodAccess methodAccess
    
    方法访问器
    
    methodRefInfoMap
    
    Map<String,MethodRefInfo> methodRefInfoMap
    
    以方法名作为key
- 类 com.iohao.game.common.kit.asm.FieldRefInfo
  
  class FieldRefInfo extends Object implements Serializable
  
  serialVersionUID:
  
  -5717006947739357125L
  - 序列化字段
    
    field
    
    Field field
    
    原生字段
    
    fieldName
    
    String fieldName
    
    字段名
    
    methodGetIndex
    
    int methodGetIndex
    
    字段对应的 get 方法下标
    
    methodGetName
    
    String methodGetName
    
    字段对应的 get 方法名
    
    methodSetIndex
    
    int methodSetIndex
    
    字段对应的 set 方法下标
    
    methodSetName
    
    String methodSetName
    
    字段对应的 set 方法名
    
    returnType
    
    Class<?> returnType
    
    返回值类型
程序包 com.iohao.game.common.kit.attr
- 类 com.iohao.game.common.kit.attr.AttrOption
  
  class AttrOption extends Object implements Serializable
  - 序列化字段
    
    defaultValue
    
    T defaultValue
    
    name
    
    String name
    
    supplier
    
    Supplier<T> supplier
- 类 com.iohao.game.common.kit.attr.AttrOptions
  
  class AttrOptions extends Object implements Serializable
  
  serialVersionUID:
  
  9042891580724596100L
  - 序列化字段
    
    options
    
    Map<AttrOption<?>,Object> options
程序包 com.iohao.game.common.kit.exception
- 异常错误类 com.iohao.game.common.kit.exception.CommonIllegalArgumentException
  
  class CommonIllegalArgumentException extends IllegalArgumentException implements Serializable
- 异常错误类 com.iohao.game.common.kit.exception.CommonNullPointerException
  
  class CommonNullPointerException extends NullPointerException implements Serializable
- 异常错误类 com.iohao.game.common.kit.exception.CommonRuntimeException
  
  class CommonRuntimeException extends RuntimeException implements Serializable
程序包 com.iohao.game.core.common.client
程序包 com.iohao.game.widget.light.room
- 类 com.iohao.game.widget.light.room.SimplePlayer
  
  class SimplePlayer extends Object implements Serializable
  
  serialVersionUID:
  
  -26338708253909097L
  - 序列化字段
    
    maybeRobot
    
    boolean maybeRobot
    
    true 模仿 robot 机制，但并不是真正的 robot，类似于 robot 托管
    
    ready
    
    boolean ready
    
    true - 已准备
    
    robot
    
    boolean robot
    
    true robot
    
    roomId
    
    long roomId
    
    房间 id
    
    seat
    
    int seat
    
    用户所在位置
    
    userId
    
    long userId
    
    userId 玩家 id
- 类 com.iohao.game.widget.light.room.SimpleRoom
  
  class SimpleRoom extends Object implements Serializable
  
  serialVersionUID:
  
  -6937915481102847959L
  - 序列化字段
    
    aggregationContext
    
    CommunicationAggregationContext aggregationContext
    
    playerMap
    
    Map<Long,Player> playerMap
    
    玩家
    key is userId value is player
    
    playerSeatMap
    
    Map<Integer,Long> playerSeatMap
    
    玩家位置
    key is seat value is userId
    
    roomCreateContext
    
    RoomCreateContext roomCreateContext
    
    创建房间信息
    
    roomId
    
    long roomId
    
    房间唯一 id
    
    roomStatusEnum
    
    RoomStatusEnum roomStatusEnum
    
    房间状态
    
    spaceSize
    
    int spaceSize
    
    房间空间大小: 4 就是4个人上限 (根据规则设置)

序列化表格

程序包 com.iohao.game.action.skeleton.core.exception

异常错误类 com.iohao.game.action.skeleton.core.exception.MsgException

序列化字段

msgCode

msgExceptionInfo

程序包 com.iohao.game.action.skeleton.core.flow

程序包 com.iohao.game.action.skeleton.eventbus

类 com.iohao.game.action.skeleton.eventbus.EventBrokerClientMessage

序列化字段

appName

brokerClientId

brokerClientType

tag

类 com.iohao.game.action.skeleton.eventbus.EventBusMessage

序列化字段

eventBrokerClientMessages

eventSource

threadIndex

traceId

程序包 com.iohao.game.action.skeleton.protocol

类 com.iohao.game.action.skeleton.protocol.BarMessage

序列化字段

data

dataClass

headMetadata

responseStatus

validatorMsg

类 com.iohao.game.action.skeleton.protocol.HeadMetadata

序列化字段

attachmentData

bindingLogicServerIds

cacheCondition

channelId

cmdMerge

customData

endPointClientId

executorSelect

msgId

rpcCommandType

sourceClientId

stick

traceId

userId

userProcessorExecutorSelectorBytes

类 com.iohao.game.action.skeleton.protocol.RequestMessage

类 com.iohao.game.action.skeleton.protocol.ResponseMessage

程序包 com.iohao.game.action.skeleton.protocol.collect

类 com.iohao.game.action.skeleton.protocol.collect.RequestCollectMessage

序列化字段

requestMessage

类 com.iohao.game.action.skeleton.protocol.collect.ResponseCollectItemMessage

序列化字段

logicServerId

responseMessage

类 com.iohao.game.action.skeleton.protocol.collect.ResponseCollectMessage

序列化字段

messageList

statusCode

statusMes

程序包 com.iohao.game.action.skeleton.protocol.external

类 com.iohao.game.action.skeleton.protocol.external.RequestCollectExternalMessage

序列化字段

bizCode

data

sourceClientId

traceId

userId

类 com.iohao.game.action.skeleton.protocol.external.ResponseCollectExternalItemMessage

序列化字段

data

errorMsg

logicServerId

responseStatus

类 com.iohao.game.action.skeleton.protocol.external.ResponseCollectExternalMessage

序列化字段

messageList

程序包 com.iohao.game.action.skeleton.protocol.login

类 com.iohao.game.action.skeleton.protocol.login.SettingUserIdMessage

序列化字段