springboot集成iogame 客服端无法收到逻辑服返回的数据

本人在springboot里分别拆分了 broker external logic 三个独立的springbootjava项目，集成模块如下
```
1.broker 集成如下
 
        <dependency>
            <groupId>com.iohao.game</groupId>
            <artifactId>bolt-broker-server</artifactId>
            <version>17.1.1</version>
        </dependency>

@SpringBootApplication
 public class UtonGameBrokerApplication {

public static void main(String[] args) {
        SpringApplication.run(UtonGameBrokerApplication.class, args);

// broker （游戏网关） 构建器
        BrokerServerBuilder brokerServerBuilder = BrokerServer.newBuilder();
        BrokerServer brokerServer = brokerServerBuilder.build();
        // 启动游戏网关
        brokerServer.startup();
    }

```

```
2.external 集成如下
       <dependency>
            <groupId>com.iohao.game</groupId>
            <artifactId>bolt-external</artifactId>
            <version>17.1.1</version>
        </dependency>

@SpringBootApplication
public class UtonGameExternalApplication {

public static void main(String[] args) {
        SpringApplication.run(UtonGameExternalApplication.class, args);
        // 对外开放的端口
        int externalPort = 10088;
        ExternalGlobalConfig.verifyIdentity =false;
        // 游戏对外服 - 构建器
        ExternalServerBuilder builder = ExternalServer.newBuilder(externalPort)
                // websocket 方式连接
                .externalJoinEnum(ExternalJoinEnum.WEBSOCKET)
                // Broker （游戏网关）的连接地址；如果不设置，默认也是这个配置
                .brokerAddress(new BrokerAddress("127.0.0.1", BrokerGlobalConfig.brokerPort));

// 构建游戏对外服
        ExternalServer externalServer = builder.build();
        // 启动游戏对外服
        externalServer.startup();
    }

```

```
3.logic集成
       <dependency>
            <groupId>com.iohao.game</groupId>
            <artifactId>bolt-client</artifactId>
            <version>17.1.1</version>
        </dependency>

public class LogicClient extends AbstractBrokerClientStartup {
    @Override
    public BarSkeleton createBarSkeleton() {
        // 业务框架构建器 配置
        BarSkeletonBuilderParamConfig config = new BarSkeletonBuilderParamConfig()
                // 扫描 DemoAction.class 所在包
                .addActionController(LoginAction.class);

// 业务框架构建器
        BarSkeletonBuilder builder = config.createBuilder();

// 添加控制台输出插件
        builder.addInOut(new DebugInOut());

return builder.build();
    }

@Override
    public BrokerClientBuilder createBrokerClientBuilder() {
        BrokerClientBuilder builder = BrokerClient.newBuilder();
        builder.appName("游戏逻辑服");
        return builder;
    }

@Override
    public BrokerAddress createBrokerAddress() {
        // 类似 127.0.0.1 ，但这里是本机的 ip
        String localIp = NetworkKit.LOCAL_IP;
        // broker （游戏网关）默认端口
        int brokerPort = 10200;
        return new BrokerAddress(localIp, brokerPort);
    }

启动代码：
    @SpringBootApplication
public class UtonGameLogicApplication {

public static void main(String[] args) {
        SpringApplication.run(UtonGameLogicApplication.class, args);

//        // 逻辑服列表
//        List<AbstractBrokerClientStartup> logicServer = List.of(new LogicServer());
//
//        new SimpleRunOne()
//                // 逻辑服列表
//                .setLogicServerList(logicServer).startup();

LogicClient logicClient = new LogicClient();
        BrokerClientApplication.start(logicClient);
    }
```

4.模拟调用代码

```
 public static void main(String[] args) throws Exception {
        // 这里模拟游戏客户端

// 连接游戏服务器的地址
        String wsUrl = "ws://127.0.0.1:10088/websocket";

WebSocketClient webSocketClient = new WebSocketClient(new URI(wsUrl), new Draft_6455()) {
            @Override
            public void onOpen(ServerHandshake handshakedata) {
                // 建立连接后 发送一条消息给游戏服务器
                LogicRequest helloReq = new LogicRequest();
                helloReq.setName("222");

// 路由, 对应服务端逻辑服的业务类路由地址
                int cmd = 1;
                int subCmd = 0;

// 游戏框架内置的协议， 与游戏前端相互通信的协议
                ExternalMessage externalMessage = new ExternalMessage();
                // 请求命令类型: 0 心跳，1 业务
                externalMessage.setCmdCode(1);
                // 路由
                externalMessage.setCmdMerge(cmd, subCmd);
                // 业务数据
                byte[] data = ProtoDataCodec.me().encode(helloReq);
                externalMessage.setData(data);
                log.info("消息体：{}", JSON.toJSONString(externalMessage));

// 转为 pb 字节
                byte[] bytes = ProtoKit.toBytes(externalMessage);
                // 发送数据到游戏服务器
                this.send(bytes);
            }

@Override
            public void onMessage(String s) {

}

@Override
            public void onClose(int i, String s, boolean b) {

}

@Override
            public void onError(Exception e) {

}

@Override
            public void onMessage(ByteBuffer byteBuffer) {
                // 接收服务器返回的消息
                byte[] dataContent = byteBuffer.array();
                ExternalMessage message = ProtoKit.parseProtoByte(dataContent, ExternalMessage.class);
                log.info("收到消息 ExternalMessage ========== \n{}", message);
                byte[] data = message.getData();
                if (data != null) {
                    LogicRequest helloReq = ProtoKit.parseProtoByte(data, LogicRequest.class);
                    log.info("helloReq ========== \n{}", helloReq);
                }
            }
        };

// 开始连接服务器
        webSocketClient.connect();
    }

在逻辑服 能看到以下日志但是  onMessage无任何执行 我的路由地址都是正确的。

┏━━━━━ Debug. [(LoginAction.java:25).here] ━━━ [cmd:1 - subCmd:0 - cmdMerge:65536] ━━━ [逻辑服 [游戏逻辑服] - id:[b0530b92-618d-4202-b9d8-0f2d16bc5567]]
┣ userId: 0
┣ 参数: helloReq : LogicRequest(name=222)
┣ 响应: LogicRequest(name=222, I'm here )
┣ 时间: 1 ms (业务方法总耗时)
┗━━━━━ Debug [LoginAction.java] ━━━

```

这里简单的汇总 issu 所描述的，大概意思是当建立多个项目时，在游戏逻辑服处理完业务却无法响应数据到请求端；
但可以接收到来自请求端的请求数据；

---

造成这个原因是因为在响应类 ResponseMessage 有一个成员变量 dataClass，大概代码如下

```java
public class BarMessage {
    ... ... 省略部份代码
    /** 业务数据的 class 信息 */
    Class<?> dataClass;
}
```

也就是这个字段，导致响应消息给到 broker（游戏网关）时，网关进行消息解码时因为找不到 dataClass 导致 出现 ClassNotFoundException 的异常。

```
Caused by: com.caucho.hessian.io.HessianFieldException: com.iohao.game.action.skeleton.protocol.BarMessage.dataClass: java.lang.ClassNotFoundException: 
```

由于网关没有引入对应的 pb 类，所以是不可能找得到 dataClass。

之前一直没发现这个问题是因为在项目中，都会引入一个类似 “common-pb” 的模块，这个模块中存放了业务所需的 pb 类。为了省事，并把这个模块引入到游戏对外服、游戏网关、游戏逻辑服模块中；

也就出现了为什么会在单体应用中可以通信，因为单体应用中 classLoader 中是恰巧存在这些 pb 类的，所以这个问题引出得很巧！

---

但这个 ResponseMessage.dataClass 字段的作用是什么呢？这个字段用在广播时的日志，BroadcastDebug，我们先看一下广播的日志
```
┏━━━━━ 广播. [(DemoBroadcastApplication.java:40)] ━━━ [cmd:7 - subCmd:0 - cmdMerge:458752]
┣ userId: 1
┣ 广播数据: DemoBroadcastMessage(msg=broadcast hello ，1)
┣ 广播时间: 2022-05-19 21:32:42.732
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

┏━━━━━ 广播. [(DemoBroadcastApplication.java:40)] ━━━ [cmd:7 - subCmd:0 - cmdMerge:458752]
┣ userId: 36，72，18
┣ 广播数据: DemoBroadcastMessage(msg=broadcast hello ，42)
┣ 广播时间: 2022-05-19 21:32:47.732
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
```

广播日志可以打印出具体的业务数据，实际上是广播时是得不到，因为业务数据编码后是 byte[] 类型；为了能在广播日志中打印出具体的类型数据，就使用 ResponseMessage.dataClass 字段提前保存了业务数据的类型 class，目的是用于解码业务数据来打印具体的业务数据类型；

---

在实际处理这个问题中，花了几个小时，因为 bolt 也不在 idea 中显示的报错，甚至以为 bolt 把异常给吃了；

因此对于这个问题是分析了蛮久的。当解决的时候才TM 的发现，bolt 是有日志的，只不过是存放是当前用户目录下，不是在项目的目录中。

比如我现在的当前目录是
> /Users/join/logs/bolt

该目录下会有如下的 bolt 日志文件
```
.
├── common-default.log
├── common-error.log
├── connection-event.log
├── remoting-http.log
├── remoting-msg.log
├── remoting-rpc.log
└── remoting-tr-adapter.log
```

实际上如果能早点看见这些日志信息，发现这个问题的具体原因也是几分钟的事。

---

后续框架将会把 ResponseMessage.dataClass 改为 String 类型，通过 Class<?> aClass = Class.forName(name); 的方式来得到对应的 class，这样即使没有在 游戏对外服、游戏网关、游戏逻辑服中引入 PB 业务类，也不会引发这些问题！

将 dataClass 改为 String 类型，这些改动不会对开发者造成影响！

----

最后感谢哥们提出这个 issu ，否则很难发现，因为编码习惯的不同！

渔民小镇/ioGame

Content Risk Flag

Comments (6)

渔民小镇/ioGame .gitee-modal { width: 500px !important; }

Content Risk Flag