SparkServer 使用指南

SparkServer 使用指南

---

1. 项目目录结构及介绍

SparkServer 是一个基于 Actor 模型，使用 .NET Framework 的服务端框架。它旨在简化与 Unity 客户端的逻辑共享，并且能够融入 Skynet 集群生态系统。以下是 SparkServer 项目的基本目录结构及其简介：

SparkServer/
├── Framework               # 包含框架的核心类库，如ServiceContext基类和其他基本服务组件。
├── Game                     # 示例项目区域，Game内可能有多个子目录代表不同服务模块，如Process子目录存放具体服务实现。
│   ├── Process             # 具体业务处理服务的代码。
│   │   └── TestSender      # 例如，可能含测试发送服务的逻辑。
├── server                   # 主程序和测试相关代码。
│   ├── Test                 # 测试案例目录，包括与Skynet交互的测试。
│   │   ├── Gateway          # Gateway服务测试案例。
│   │   ├── Server           # 服务端测试逻辑。
│   ├── spark-server.sln     # Visual Studio解决方案文件，用于编译整个项目。
├── Tools                    # 工具集，可能包含编译辅助、脚本转换等工具。
│   ├── sproto2cs.bat        # 将sproto协议文件转换为C#代码的批处理文件。
├── TestDependency            # 测试依赖，包含环境搭建脚本和所需依赖。
│   ├── shell                # 环境配置脚本，如环境变量设定、工具安装等。
└── Docs                     # 可能包含API文档或更详细的开发者指导（此部分在实际项目中可能存在）。

2. 项目的启动文件介绍

启动SparkServer的主要入口是通过解决方案中的主程序，通常由spark-server.exe（Windows）或使用Mono在Linux上的等效可执行文件表示。在开发和测试环境中，可以通过Visual Studio打开solution file (.sln)来直接调试。

核心启动命令示例：

• Windows: 执行命令行 spark-server.exe SparkServer Game.Process.Battle.BattleTaskDispatcher /Game/Startconf/LocalSvr/Battle/BootConfig.json BattleTaskDispatcher
• Linux: 使用Mono执行 mono spark-server.exe SparkServer Game.Process.Battle.BattleTaskDispatcher /Game/Startconf/LocalSvr/Battle/BootConfig.json BattleTaskDispatcher

其中，SparkServer Game.Process.Battle.BattleTaskDispatcher指示了启动的第一个服务及其所在命名空间和类名，BootConfig.json为配置文件路径，最后的服务名称用于特定的初始化过程。

3. 项目的配置文件介绍

配置文件主要以JSON格式存在，如BootConfig.json。它们描述了如何启动服务、服务的网络配置、集群配置以及其他必要的环境参数。一个典型配置文件可能会包含以下几个关键字段：

• Gateway：用于配置客户端连接的网关服务，包括Host（服务的IP地址和端口）、Class（服务类的命名空间和类名）和Name（服务的标识名称）。
• Logger：日志输出的配置，定义日志文件的位置。
• ClusterConfig：集群配置文件的路径，当项目涉及集群部署时极为重要。
• ClusterName：在集群中的进程名称，影响跨进程的RPC调用识别。
• ThreadNum：定义Worker线程数量，默认8个，可根据CPU核心数调整优化性能。

配置文件是SparkServer启动和运行的关键，每一项配置都需要精确无误以确保服务正常运作。在复杂的分布式系统部署中，细致地管理和调整这些配置成为保证系统稳定性的基础。