OSC编辑部系列直播：开源世界当中，到底存不存在“白嫖”?>>>>>

主要更新

#I5YM30

这是一个重磅更新

action调试工具，模拟客户端请求，大量减少开发者编写测试用工作量。

在介绍 ioGame action 调试工具之前，先简单说一下 ioGame 的文档生成；

ioGame 的文档中提到过对接方面这一环节，日常中，我们编写完成业务需求后，就会与游戏前端的同学进行联调对接的环节。在对接前需要提供相应的对接文档，如：如何访问该需求的业务方法、访问该业务方法需要什么参数、会得的响应是什么、对于该业务方法的描述等等。

对于这方面 ioGame 也提供了一些辅助游戏文档生成，通过该辅助可以做到代码即文档，就是说当你的业务编写完成后，不需要额外的编写业务对接文档了，框架会自动的生成最新的文档。

如果没有游戏文档生成，那么你将要抽出一些时间来维护文档的工作，而且当团队人数多了，就会很乱（文档不同步、不是最新的、或是忘记更新等等情况就会出现）。

现在我们知道了在对接方面，ioGame 提供了对接文档的自动生成，文档可以确保服务器提供的 action 所需要的信息，但不能确保 action 功能的正确性；

action调试工具使用场景举例：

试想一下，在联调时，如果我们提供的一个 action 不能得到期望值，这将会费前端人员的时间，比如我们与前端联调某个功能测试时，会跟前端哥们说：在点一下、在点一下、在点一下；这些的“在点一下”通常是断点调试某个功能，次数少还好，但是经常这样是不可取的；

因为游戏中的功能不止一个，所以我们要通过其他测试方式，来先行的进行功能测试，在到联调测试阶段；这样就可以做到，即不浪费前端哥们的时间，又可以做到功能测试，保证代码的质量；这时 ioGame action 调试工具就可以出场了；

虽然 ioGame 的 action 是可以在 test 测试用例中直接进行功能测试的，这一点在其他游戏框架是很难做到的，其他的游戏框架只能做到 service 这一层的功能测试；

ioGame action 调试工具介绍：

ioGame action 调试工具是一个用于知道 action 对接信息、方法、返回值、路由... ...等各种信息，提供调用和可视化的页面辅助工具；

ioGame action 调试工具，提供类似 Swagger 的能力，或者说是类似 postman 的能力，可以使得开发者不在需要编写模拟客户端的请求，来进行功能测试，而是直接使用 ioGame API调试工具，来测试某个功能；

通过 ioGame action 调试工具，可以解决功能测试问题、减少联调成本问题、减少编写用例的开发成本问题，从而达到减少开发者工作量；在者可以从 ioGame API 调试工具；

在使用 ioGame 开发游戏时，无论你的游戏提供的是 websocket 还是 tcp 进行连接，都可以使用该工具进行功能测试；

ioGame action 调试工具实际应用演示：

ioGame action 调试工具可以做到不需要对之前的项目变更代码或做适配工作，只需要添加一行代码就可以使用了；

首先我们定义一个 action 类和一个 pb 参数

 @Slf4j @ActionController(1) public class DemoAction {     @ActionMethod(1)     public HelloReq here(HelloReq helloReq) {         HelloReq newHelloReq = new HelloReq();         newHelloReq.id = helloReq.id;         newHelloReq.age = helloReq.age;         newHelloReq.name = helloReq.name + ", I'm here ";         return newHelloReq;     }      @ActionMethod(2)     public HelloReq jackson(HelloReq helloReq) {         helloReq.name = helloReq.name + ", hello, jackson !";         return helloReq;     } }  @ToString @ProtobufClass @FieldDefaults(level = AccessLevel.PUBLIC) public class HelloReq {     int id;     String name;     int age; }

一行代码启动 ioGame action 调试工具

启动后点击 http://localhost:18080 就可以来到工具页面了。

ioGame action 调试工具使用页面：

在 ioGame 综合示例项目中的演示：

只需要添加一行，不需要对之前的代码做任何改变；就可以使用 action 调度工具了。

目前的 action调试工具比较简陋，但我们还会持续的更新、改进；

此版本有 1 位开发者参与贡献

licheng1013 贡献的 ioGame action 调试工具前端页面

maven pom

ioGame 已经上传到中央仓库

https://search.maven.org/search?q=a:bolt-run-one

ioGame 是轻量级的网络游戏服务器框架，ioGame 没有中间件的强依赖，即无需安装任何其他的中间件产品；此时，你只需一个依赖即可获得整个框架，并同时支持开头介绍的全部功能特性。

 <dependency>     <groupId>com.iohao.game</groupId>     <artifactId>bolt-run-one</artifactId>     <version>x.y.z</version> </dependency>

ioGame 网络游戏服务器框架简介

国内首个基于蚂蚁金服 SOFABolt 的 java 网络游戏服务器框架；无锁异步化、事件驱动的架构设计
通过 ioGame 可以很容易的搭建出一个集群无中心节点、有状态多进程的分步式游戏服务器
无中间件依赖、代码即文档、JSR380、断言 + 异常机制 = 更少的维护成本、开发成本
同样的一套业务代码无需变更，可以同时支持多种协议：websocket、socket
轻量级、启动快、更节约、更简单、开箱即用、无配置文件、超高性能
近原生的快、业务框架平均每秒可以执行 1152 万次业务逻辑
在业务开发中自带神级特性：业务代码访问定位与跳转
架构部署多样性：即可相互独立，又可相互融合
各个逻辑服之间可以相互的进行跨进程通信
可同时与同类型多个游戏逻辑服通信
支持玩家动态绑定逻辑服节点
对 webMVC 开发者友好

ioGame 是一个由 java 语言编写的网络游戏服务器框架。支持 websocket、tcp ，适用于全球同服、回合制游戏、策略游戏、即时战斗等游戏服务器的开发。具有高性能、稳定、易用易扩展、超好编程体验等特点。可做为 H5、手游、端游的 java 游戏服务器。

ioGame 是轻量级的网络游戏服务器框架，在使用 ioGame 时，只需一个依赖即可获得整个框架，而无需在安装其他服务，如： Nginx、Redis、MQ、Mysql、ZooKeeper、Protobuf 协议编译工具 ... ... 等。简单点说，就是无需安装其他产品，就能支持开头介绍的内容特性；这意味着在使用上简单了，在部署上也为企业节约了成本。

通过 ioGame 你可以很容易的搭建出一个稳定、高性能、集群无中心节点、分步式、自带负载均衡、跨进程通信、避免类爆炸设计的网络游戏服务器。游戏框架借助于蚂蚁金服 sofa-bolt 通信框架来提供通信方面的稳定与高性能。

在 ioGame 中能让你遗忘 Netty，你几乎没有机会能直接的接触到 Netty 的复杂，但却能享受 Netty 带来的高性能。对开发者要求极低，为开发者节约开发时间。

即使之前没有游戏编程的经验，也能参与到游戏编程中。如果你之前具备一些游戏开发或者 webMVC 相关的知识，则会更容易上手游戏服务器的开发。

开发者基于 ioGame 编写的项目、模块通常是条理清晰的，得益于框架对路由的合理设计。当我们整理好这些模块后，对于其他开发者接管项目或后续的维护中，会是一个不错的帮助（模块的整理与建议）。

基于 ioGame 编写的项目，通常是语法简洁的、高性能的、低延迟的。框架最低要求使用 JDK17，这样即可以让项目享受到 ZGC 带来的改进，还能享受语法上的简洁。从 JDK17 开始 GC 已经处理得越来越好了，JDK17 中的 ZGC 远低于其亚毫秒级暂停时间的目标；当开发者使用 JDK17 时，相当于在你们的项目中变相的引入了一位 JVM 调优大师，详细请看 JDK17 垃圾回收 GC 性能飞跃提升。

在部署上，支持多服单进程的方式部署（类似单体应用、在分步式开发时，调试更加方便）、也支持多服多进程多机器的方式部署。在部署方式上可以随意切换，而不需要更改代码；日常中按照单体思维开发，在生产上可以使用多进程的方式部署；当然，也可以使用单进程的方式部署。

ioGame 框架职责清晰、业务开发几乎零学习成本、源码有高质量注释、示例多、使用文档多，开发体验最佳、业务代码自动生成与游戏前端对接的文档、逻辑服之间可跨进程跨机器通信、业务代码定位 -- 神级特性、异常机制。提供了丰富的在线高质量使用文档，为你的团队助力，带上你们的小伙伴一起，这样就不用手把手的教了。

ioGame 可以很方便的与 spring 集成（5 行代码）。

ioGame 是国内首个基于蚂蚁金服 sofa-bolt 的网络游戏框架，游戏框架由 [网络通信框架] 和 [业务框架] 组成。

网络通信框架：职责是各服务器之间的网络通信
业务框架：职责是业务逻辑的处理方式和编写方式

网络通信框架 - SOFABolt

SOFABolt 是蚂蚁金融服务集团开发的一套基于 Netty 实现的网络通信框架。

为了让 Java 程序员能将更多的精力放在基于网络通信的业务逻辑实现上，而不是过多的纠结于网络底层 NIO 的实现以及处理难以调试的网络问题，Netty 应运而生。
为了让中间件开发者能将更多的精力放在产品功能特性实现上，而不是重复地一遍遍制造通信框架的轮子，SOFABolt 应运而生。

Bolt 名字取自迪士尼动画 - 闪电狗，是一个基于 Netty 最佳实践的轻量、易用、高性能、易扩展的通信框架。

业务框架

如果说 sofa-bolt 是为了让 Java 程序员能将更多的精力放在基于网络通信的业务逻辑实现上。而业务框架正是解决业务逻辑如何方便实现这一问题上。业务框架是游戏框架的一部份，职责是简化程序员的业务逻辑实现，业务框架使程序员能够快速的开始编写游戏业务。

业务框架对于每个 action （即业务的处理类）都是通过 asm 与 Singleton、Flyweight 、Command 等设计模式结合，对 action 的获取上通过 array 来得到，是一种近原生的方式。

业务框架平均每秒可以执行 1152 万次业务逻辑。

架构简图

通过 ioGame 你可以很容易的搭建出一个集群、分步式的网络游戏服务器！

无锁异步化与事件驱动的架构设计、集群无中心节点、自带负载均衡、分布式支持、可动态增减机器、避免类爆炸的设计；

图中的每个对外服、每个游戏逻辑服、每个 broker （游戏网关）都可以在单独的进程中部署，逻辑服之间可以跨进程通信（对外服也是逻辑服的一种）。

游戏网关集群

broker （游戏网关）可以集群的方式部署，集群无中心节点、自带负载均衡。ioGame 本身就包含服务注册，你不需要外接一个服务注册中心，如 Eureka，ZooKeeper 等（变相的节约服务器成本）。

通过 broker （游戏网关）的介入，之前非常复杂的负载均衡设计，如服务注册、健康度检查（后续版本提供）、到服务端的连接维护等这些问题，在 ioGame 中都不需要了，结构也简单了很多。实际上单台 broker （游戏网关）性能已经能够满足了，因为游戏网关只做了转发。

逻辑服

逻辑服通常说的是游戏对外服和游戏逻辑服。逻辑服可以有很多个，逻辑服扩展数量的理论上限是 netty 的连接上限。

游戏对外服

对外服保持与用户（玩家）的长连接。先来个假设，假如我们的一台硬件支持我们建立用户连接的上限是 5000 人，当用户量达到 7000 人时，我们可以多加一个对外服务器来进行分流减压。由于游戏对外服扩展的简单性，意味着支持同时在线玩家可以轻松的达到百万、千万甚至更多。

即使我们启动了多个游戏对外服，开发者也不需要关心这些玩家连接到了哪个游戏对外服的问题，这些玩家总是能接收到广播（推送）消息的，因为框架已经把这些事情给做了；在玩家的角度我们只有 “一个” 服务器，同样的，在开发者的角度我们只有 “一个” 游戏对外服；

在结构组合上（部署多样性）

架构由三部分组成：1. 游戏对外服、2.Broker（游戏网关）、3. 游戏逻辑服；三者既是相互独立的，又是可以相互融合的（相互独立、相互融合；话虽简单，实际实现却不简单）。如：

游戏对外服、Broker（游戏网关）、游戏逻辑服这三部分，在一个进程中；【单体应用；在开发分步式时，调试更加方便】
游戏对外服、Broker（游戏网关）、游戏逻辑服这三部分，在多个进程中；【分布式】
游戏对外服、Broker（游戏网关）这两部分在一个进程中；而游戏逻辑服在多个进程中；【类似之前游戏的传统架构】
甚至可以不需要游戏对外服，只使用 Broker（游戏网关）和游戏逻辑服这两部分，用于其他系统业务；

因为 ioGame 遵循面向对象的设计原则（单一职责原则、开闭原则、里式替换原则、依赖倒置原则、接口隔离原则、迪米特法则）等，所以使得架构的职责分明，可以灵活的进行组合；

游戏对外服是架构的三部分之一，默认的游戏对外服是基于 netty 实现的。如果有需要，将来我们还可以使用基于 mina、smart-socket 等通信框架编写，额外提供一个游戏对外服的实现；即使是使用 mina、smart-socket 提供的游戏对外服，也并不会影响现有的游戏逻辑服业务逻辑，因为游戏对外服满足单一职责原则，只维护用户（玩家）长连接相关的。

开发人员几乎都遇见过这么一种情况；在项目初期阶段，通常是以单体项目的方式进行开发，随着需求不断的增加与迭代，会演变成一个臃肿的项目；此时在对一个整体进行拆分是困难的，成本是极高的。甚至是不可完成的，最后导致完全的重新重构；

ioGame 提供了在结构组合上的部署多样性，通过组合的方式，在项目初期就可以避免这些拆分问题。在开发阶段中，我们可以使用单体应用开发思维，降低了开发成本。通过单体应用的开发方式，在开发分步式项目时，调试更加的方便；这既能兼顾分步式开发、项目模块的拆分，又能降低团队的开发成本；

架构优点

架构有很高程度的抽象，让设计者更加关注于业务，而无需考虑底层的实现、通信参数等问题。

逻辑服的位置透明性；同时，由于模块化、抽象化，使得整个架构各服务器之间耦合度很低，逻辑服注册即可用，大大增加了可伸缩性、可维护性，动态扩展变得简单而高效。由于逻辑服是注册到 Broker（游戏网关）上的，所以逻辑服可以动态的增加、删除、改变；由于逻辑服之间耦合度较小，调试和测试的工作也是可控的；

架构比较清晰的就是，游戏对外服负责维护客户端的接入（用户、玩家的连接），游戏逻辑服专心负责业务逻辑，他们之间的调度由 Broker（游戏网关）来负责；因为架构拆分的合理，所以特别方便用 k8s 来自由伸缩部署这三种服，哪个服水位高就扩容哪个，水位过去了又可以缩容。

通过 ioGame 可以使得游戏编程变得简单，下面是一个业务示例

Proto 协议文件定义

首先我们自定义一个协议文件，这个协议文件作为我们的业务载体描述。这个协议是纯 java 代码编写的，使用的是 jprotobuf，jprotobuf 是对 google protobuf 的简化使用，性能同等。

可以把这理解成 DTO、POJO、业务数据载体等，其主要目的是用于业务数据的传输；

 /** 请求 */ @ProtobufClass @FieldDefaults(level = AccessLevel.PUBLIC) public class HelloReq {     String name; }

Action

游戏服务器的编程，游戏服务器接收业务数据后，对业务数据进行处理

 @ActionController(1) public class DemoAction {     @ActionMethod(0)     public HelloReq here(HelloReq helloReq) {         HelloReq newHelloReq = new HelloReq();         newHelloReq.name = helloReq.name + ", I'm here ";         return newHelloReq;     } }

一个方法在业务框架中表示一个 Action（即一个业务动作）。

方法声名的参数是用于接收前端传入的业务数据，在方法 return 时，数据就可以被游戏前端接收到。程序员可以不需要关心业务框架的内部细节。

从上面的示例可以看出，这和普通的 java 类并无区别，同时这种设计方式避免了类爆炸。如果只负责编写游戏业务，那么对于业务框架的学习可以到此为止了。

游戏编程就是如此简单！

问：我可以开始游戏服务器的编程了吗？

是的，你已经可以开始游戏服务器的编程了。

访问示例（控制台）

当我们访问 here 方法时（通常由游戏前端来请求），控制台将会打印

 ┏━━━━━ Debug. [(DemoAction.java:4).here] ━━━ [cmd:1 - subCmd:0 - cmdMerge:65536] ┣ userId : 888 ┣ 参数: helloReq : HelloReq(name=塔姆) ┣ 响应: HelloReq(name=塔姆, I'm here ) ┣ 时间: 0 ms (业务方法总耗时) ┗━━━━━ Debug [DemoAction.java] ━━━

控制台打印说明

 Debug. [(DemoAction.java:4).here]：     表示执行业务的是 DemoAction 类下的 here 方法，4 表示业务方法所在的代码行数。     在工具中点击控制台的 DemoAction.java:4 这条信息，就可以跳转到对应的代码中（快速导航到对应的代码），这是一个开发良好体验的开始！ userId :       当前发起请求的 用户 id。 参数 :       通常是游戏前端传入的值。 响应：     通常是业务方法返回的值 ，业务框架会把这个返回值推送到游戏前端。 时间：     执行业务方法总耗时，我们可根据业务方法总耗时的时长来优化业务。 路由信息：[cmd - subCmd]     路由是唯一的访问地址。

有了以上信息，游戏开发者可以很快的定位问题。如果没有可视化的信息，开发中会浪费很多时间在前后端的沟通上。问题包括：

是否传参问题（游戏前端说传了）
是否响应问题（游戏后端说返回了）
业务执行时长问题（游戏前端说没收到响应，游戏后端说早就响应了）

其中代码导航可以让开发者快速的跳转到业务类对应代码中，在多人合作的项目中，可以快速的知道业务经过了哪些方法的执行，使得我们可以快速的进行阅读或修改；

框架内置功

内置多种可选模块，可按需选择，以方便应用开发：

领域事件（轻量级单机最快 MQ -- disruptor；通过领域事件模块，可为你的系统实现类似 Guava-EventBus、Spring 事件驱动模型 ApplicationEvent、业务解耦、规避并发、不阻塞主线程... 等，各种浪操作）
任务延时器（将来某个时间可对任务进行执行、暂停、取消等操作，并不是类似 Quartz 的任务调度）
多环境切换（不同运行环境下的配置支持）
light-jprotobuf （补足 jprotobuf 不能让多个对象在单个 .proto 源文件中生成的需求，并简化 jprotobuf 对源文件的注释）
分步式锁 (基于 Redisson 的简单实现)

内置的其他功能：