mmorpg-master框架分析

这个 `package.json` 文件是用于管理一个多人游戏服务器架构的，包含了多个服务，如 `auth`（认证）、`game`（游戏逻辑）、`gateway`（网关）、`scene`（场景管理）、`replication`（数据复制）。以下是文件关键部分的说明：

主要脚本部分：

1. **脚本**:
– `"gen-grpc"`：从 `.proto` 文件生成 gRPC 代码，输出 JavaScript、gRPC 和 TypeScript 绑定。
– `"gen-ws"`：从 `.proto` 文件生成 WebSocket 绑定，输出为 JSON 模块。
– `"gen-link"`：运行一个 TypeScript 文件，用于服务之间的连接（可能是内部服务间的链接操作）。
– `"auth"`, `"game"`, `"gateway"`, `"scene"`, `"replication"`：每个脚本分别启动相关服务，比如用户认证、游戏逻辑、网关、场景管理和数据复制服务。
– `"common"`：运行 gRPC、WebSocket 代码生成和服务链接操作。
– `"start"`：启动所有服务，使用 `concurrently` 来并发运行多个服务，同时会标注服务名称和时间戳。
– `"deploy"`：编译 TypeScript 代码，然后使用 `pm2` 启动各个服务，设置自动重启延迟为 3000 毫秒。
– `"test"`：运行测试脚本。

说明：

这个项目似乎是一个典型的微服务架构，每个服务模块化处理特定的任务，启动顺序和脚本的定义都已经配置好。
要分析和修改这个服务端项目，你可以从以下几个方面入手，根据你需要修改的功能范围进行选择：

1. **入口文件和服务启动流程**：

– **`src/index.ts`**: 这是项目的主入口文件，通常用于初始化项目的全局配置和启动各个服务。在分析和修改项目时，这是第一个应该查看的文件。
– **`auth/index.ts`**、**`game/index.ts`**、**`gateway/index.ts`**、**`scene/index.ts`**、**`replication/index.ts`**: 这些文件分别负责启动各个独立的服务，了解这些服务的逻辑如何运作。如果你需要修改某个特定模块（例如认证、场景、游戏逻辑等），需要查看并修改相应服务的入口文件。

2. **gRPC 和 WebSocket 通信**：

– **gRPC 服务生成脚本（`gen-grpc`）**: 这个脚本生成了 gRPC 的通信代码，位于 `common/idl/grpc/` 目录中的 `.proto` 文件定义了 gRPC 接口。查看和修改这些 `.proto` 文件可以帮助你修改服务间的通信协议。
– **WebSocket 服务生成脚本（`gen-ws`）**: 与 gRPC 类似，查看 `common/idl/ws/` 目录下的 `.proto` 文件来了解和修改 WebSocket 通信的定义。

3. **逻辑模块**：

– **`auth`（认证模块）**: 如果你想修改用户登录、注册或者角色创建的逻辑，可以从 `auth/index.ts` 开始查看。可能涉及用户身份验证和角色数据的存储和获取。
– **`game`（游戏逻辑）**: 游戏的核心逻辑通常在 `game/index.ts` 中处理，比如处理游戏规则、玩家交互等。如果你需要修改游戏的规则或状态管理，可以从这里入手。
– **`gateway`（网关服务）**: 网关负责将外部请求路由到适当的服务，处理网络层相关的逻辑。如果你需要修改请求的处理方式或者负载均衡策略，可以查看 `gateway/index.ts`。
– **`scene`（场景管理）**: 负责游戏中的不同场景（如地图、区域等）的管理逻辑，位于 `scene/index.ts` 中。你可以根据需要调整场景的逻辑和加载方式。
– **`replication`（数据复制）**: 这个服务通常用于保证游戏状态或玩家数据在多个服务器间的同步。查看 `replication/index.ts` 以修改同步逻辑。

4. **配置文件和依赖项**：

– **`package.json`**: 这里定义了项目的启动脚本、依赖项和开发命令。你可以在 `scripts` 部分找到如何生成 gRPC 和 WebSocket 代码，如何启动服务等。需要添加新的依赖或修改启动命令，可以从这里入手。
– **`tsconfig.json`**: TypeScript 配置文件，影响整个项目的编译过程。如果需要调整 TypeScript 的编译规则或模块解析规则，可以修改这个文件。

5. **通信协议和接口定义**：

– **`common/idl/grpc` 和 `common/idl/ws`**: 这些文件夹包含了 gRPC 和 WebSocket 的协议定义文件（`.proto`）。你可以在这些文件中查看服务之间如何通信，并修改接口或协议。如果你想增加新的功能或修改现有的接口协议，这里是关键。

6. **测试文件**：

– **`test/index.ts`**: 测试文件可以帮助你理解项目的功能和行为，也可以通过修改或添加测试文件来验证修改后的功能。

7. **部署脚本**：

– **`deploy` 脚本**: 如果你需要修改项目的部署流程或添加新的服务，`deploy` 脚本中的 `pm2` 配置会帮助你理解如何管理多个服务的运行。

修改建议：

– **理解项目结构和依赖关系**：在修改之前，建议先了解项目的整体架构和各服务之间的依赖关系，这可以通过查看各服务的入口文件以及协议文件来实现。
– **逐个服务分析**：从最需要修改的服务入手，例如你要修改认证逻辑，可以先从 `auth/index.ts` 开始，逐步了解其依赖的协议和数据传输方式。

这样，你可以从关键模块入手，逐步分析和修改项目的代码。
在 `apps/server/auth` 目录下的 `index.ts` 文件中，主要做了两件事情：

1. **`rpcStart()`**：启动了与 gRPC（远程过程调用）相关的逻辑，可能用于处理不同服务之间的通信。
2. **`httpStart()`**：启动了与 HTTP 请求相关的逻辑，可能用于处理外部请求或用户的登录、注册、认证等操作。

分析与修改建议：

#

1. **`rpcStart()`**

– 这个函数启动 gRPC 服务，负责与其他服务（如游戏服务、场景服务等）进行通信。
– 你可以查看 `rpc.ts` 文件，分析 gRPC 服务是如何定义的，哪些 RPC 方法被暴露出来，特别是认证相关的 RPC 方法。如果你想修改认证相关的跨服务通信（比如用户角色的获取），需要在 `rpc.ts` 文件中进行修改。
– 如果要添加新的 gRPC 方法，可以在 `.proto` 文件中定义新的方法，然后在 `rpc.ts` 中实现这些方法。

#

2. **`httpStart()`**

– 这个函数启动 HTTP 服务，负责处理外部 HTTP 请求，可能用于用户注册、登录和其他与认证相关的操作。
– 你可以查看 `http.ts` 文件，了解 HTTP 路由和处理逻辑。一般情况下，这里会有一些 API 接口，比如 `/login`、`/register`，这些接口与数据库或其他服务进行交互以验证用户信息。
– 如果你需要修改用户认证逻辑或增加新功能（例如第三方登录、双因素认证等），可以在 `http.ts` 中修改相应的 API 路由和处理方法。

建议修改步骤：

1. **查看并分析 `rpc.ts` 文件**：
– 找到 `rpcStart` 函数的具体实现，分析它是如何启动 gRPC 服务的。
– 查看 gRPC 服务提供了哪些方法，是否有用户登录、角色获取等相关的方法。
– 如果需要修改服务之间的通信逻辑或增加新的功能，在对应的 `.proto` 文件中定义新接口，并在 `rpc.ts` 中实现。

2. **查看并分析 `http.ts` 文件**：
– 查看 `httpStart` 函数的实现，找到所有与认证相关的 API 路由。
– 修改或扩展认证逻辑，例如增加新接口或改进登录、注册的处理方式。
– 如果要增加与前端或其他服务的交互，可以在这里增加新的 HTTP API。

3. **修改通信协议和接口**：
– 如果需要修改服务之间的通信协议（gRPC 或 WebSocket），你需要查看 `common/idl/grpc` 或 `common/idl/ws` 目录下的 `.proto` 文件。根据需要，修改或添加新接口，再使用生成脚本重新生成对应的代码。

总结：

`index.ts` 文件主要是启动 gRPC 和 HTTP 服务的入口。为了进行更深入的修改，你需要分析 `rpc.ts` 和 `http.ts` 文件中的逻辑，查看 gRPC 方法的实现和 HTTP 路由的处理，进而对项目进行定制化修改。
从你提供的代码来看，这个 `rpcStart` 函数用于启动鉴权服务器，通过 gRPC 实现了 `checkToken` 的验证功能。这里是代码的主要功能分析以及建议修改的方向：

代码分析：

1. **`grpc.Server`**：
– 代码创建了一个 gRPC 服务器，并通过 `addService` 方法将 `AuthService` 服务添加到服务器上。
– 这个 `AuthService` 包含了 `checkToken` 方法，用于验证客户端发来的 token。

2. **`checkToken` 方法**：
– 该方法从客户端请求中获取 token，然后检查这个 token 是否存在于缓存 `cache` 中。
– 如果缓存中存在该 token，则会创建一个 `CheckTokenResData` 对象，并将对应的账户信息设置到响应中。
– 如果 token 不存在，返回一个错误信息 "token验证失败"。

3. **缓存 `cache`**：
– `cache` 可能是一个内存缓存，用于存储和快速访问 token 和用户账号之间的映射关系。这个 `cache` 可能在 `http.ts` 中定义或初始化。

4. **`ServerPort.AuthRpc`**：
– gRPC 服务器绑定到 `ServerPort.AuthRpc` 端口，监听并处理 gRPC 请求。你可以查看 `ServerPort` 的定义，确定具体的端口号配置。

修改建议：

1. **扩展 `checkToken` 的功能**：
– **Token 过期检测**：你可以引入 token 的过期时间，确保 token 在验证时没有过期。例如，可以在缓存中存储 token 的创建时间，并在验证时检查时间戳。
– **JWT 或其他 token 验证**：如果你使用 JWT 或其他形式的 token，应该在 `checkToken` 中加入验证逻辑，如解析 JWT 并验证其签名和有效性。
– **多种 token 存储方式**：目前的实现使用内存缓存，但你可以扩展支持其他存储方式，例如 Redis 或数据库，以便更好地处理大规模用户的 token 验证。

2. **添加更多的鉴权功能**：
– **权限检查**：你可以在 `checkToken` 的基础上，添加权限检查的逻辑，验证 token 所代表的用户是否具备执行某些操作的权限。
– **日志记录**：目前使用了简单的日志记录（`logger.info`），你可以扩展日志系统，记录每次鉴权请求的详细信息（如请求时间、来源 IP 等），以便于审计。

3. **安全性提升**：
– **gRPC 安全认证**：目前代码中使用了 `grpc.ServerCredentials.createInsecure()`，这意味着 gRPC 服务没有启用任何加密或认证。你可以考虑使用 SSL/TLS 证书来加密通信，确保 token 不会在传输过程中被拦截。
– **错误处理**：可以增强错误处理机制，记录更多关于错误的上下文信息，帮助诊断和解决问题。

4. **性能优化**：
– **缓存管理**：如果 token 缓存较大，或者用户量较多，建议引入 Redis 这样的分布式缓存来代替本地缓存，以提升性能和可扩展性。
– **并发处理**：gRPC 支持高并发的请求处理，如果负载较高，可以进一步优化服务器的并发处理性能。

示例修改（添加过期时间检测）：

const TOKEN_EXPIRATION_TIME = 60 * 60 * 1000; // 1小时

export const rpcStart = () => {
  const server = new grpc.Server();
  server.addService(AuthService, {
    checkToken(call: any, callback: any) {
      const token = call.request.getToken();
      const res = new CheckTokenRes();
      if (cache.has(token)) {
        const { account, timestamp } = cache.get(token)!;
        const now = Date.now();
        if (now - timestamp > TOKEN_EXPIRATION_TIME) {
          res.setError("token已过期");
        } else {
          const data = new CheckTokenResData();
          data.setAccount(account);
          res.setData(data);
        }
      } else {
        res.setError("token验证失败");
      }
      callback(null, res);
    },
  });

  server.bindAsync(`localhost:${ServerPort.AuthRpc}`, grpc.ServerCredentials.createInsecure(), () => {
    server.start();
    logger.info("Auth RPC服务启动");
  });
};

在这个修改中，`cache.get(token)` 返回的不仅是 `account`，还有 `timestamp`（token 存储的时间戳），从而可以进行 token 的过期时间检查。

总结：

你可以根据项目需求，扩展 `checkToken` 的功能，如加入过期时间检查、增强安全性和日志记录等。同时，可以根据实际情况优化 gRPC 服务的安全性和性能。
这段代码实现了一个基于 `express` 的 HTTP 鉴权服务器，提供了用户 **注册** 和 **登录** 的功能，并且通过 `uuid` 生成的 token 存储在内存缓存 `cache` 中，用于后续的用户身份验证。下面是对代码的详细分析和一些可能的修改建议。

代码分析：

1. **`cache`**:
– `cache` 是一个 `Map`，用于将用户登录生成的 token 与其账号 `account` 进行映射。这样，后续的 gRPC 鉴权服务可以通过 token 验证用户身份。

2. **数据库连接**:
– 通过 `createDBConnection()` 创建数据库连接，并在注册和登录的过程中与 `user` 表进行交互。
– 数据库中的 `user` 表存储了用户账号和加密后的密码。

3. **中间件 `verifyAndParse`**:
– `verifyAndParse` 是一个中间件，可能负责请求数据的验证和解析。该中间件用于确保请求体中的数据格式正确并且合法。

4. **注册接口 `/register`**:
– 该接口通过 `POST` 请求处理用户注册。
– 它将用户的 `account` 和经过 MD5 加密的 `password` 插入到数据库中。
– 如果 `account` 已经存在（MySQL 错误码 1062），则返回 `AccountExist` 错误；如果其他 SQL 错误发生，则返回 `SqlError`。

5. **登录接口 `/login`**:
– 该接口通过 `POST` 请求处理用户登录。
– 首先根据 `account` 查询数据库，如果账号不存在或密码不匹配，则返回 `UsernameOrPasswordError` 错误。
– 登录成功后，生成一个 token，并将 token 与该用户的账号映射存储在 `cache` 中。
– 返回的响应包含该 token，用于后续的身份验证。

6. **服务器启动**:
– 通过 `app.listen()` 启动 HTTP 服务器，监听 `ServerPort.AuthHttp` 端口。

修改建议：

1. **Token 过期管理**:
– 当前的 `cache` 只是在内存中简单保存了 token 和账号的映射，但没有设置过期时间。如果应用长时间运行，`cache` 可能会持续增长，导致内存占用增加。你可以通过添加 token 的过期时间来优化缓存管理。
– 例如，使用 `Map` 的同时，保存 token 的生成时间，并定期清理过期的 token。
– 你也可以考虑使用 Redis 这样的外部缓存来存储 token，Redis 本身就提供了过期机制。

// 使用 Map 来存储 token 和过期时间
   const TOKEN_EXPIRATION_TIME = 60 * 60 * 1000; // 1小时
   export const cache = new Map<string, { account: string; createdAt: number }>();

   // 在登录时保存 token 和创建时间
   const token = uuid();
   cache.set(token, { account, createdAt: Date.now() });

   // 定期清理过期的 token
   setInterval(() => {
     const now = Date.now();
     cache.forEach((value, key) => {
       if (now - value.createdAt > TOKEN_EXPIRATION_TIME) {
         cache.delete(key);
       }
     });
   }, 60 * 1000); // 每分钟检查一次

2. **密码安全性改进**:
– 当前使用 MD5 对密码进行加密存储，这种方式较为简单，容易受到彩虹表攻击。建议使用更安全的哈希算法，如 `bcrypt`，来加密存储密码。
– 你可以使用 `bcrypt` 来替换 MD5，增强密码的安全性。

import bcrypt from "bcrypt";

   // 注册时加密密码
   const saltRounds = 10;
   const hashedPassword = await bcrypt.hash(password, saltRounds);

   connection.query(
     `insert into user (account, password, created_time) VALUES (?, ?, ?)`,
     [account, hashedPassword, dayjs().format("YYYY-MM-DD HH:mm:ss")],
     (err) => {
       // 错误处理逻辑...
     }
   );

   // 登录时验证密码
   const isPasswordMatch = await bcrypt.compare(password, user.password);
   if (!isPasswordMatch) {
     res.json(createRes(CodeEnum.UsernameOrPasswordError));
     return;
   }

3. **错误处理改进**:
– 当前的错误处理只返回 SQL 错误或者简单的错误信息。可以考虑增加日志记录，将重要的错误信息记录到日志中，以便于后续调试和追踪问题。

4. **日志增强**:
– 虽然已经有基础的日志记录功能 (`logger.info("Auth HTTP服务启动")`)，但可以在用户注册、登录成功或失败时加入更多的日志记录，帮助管理员跟踪用户操作。

5. **安全性提升**:
– **CORS 限制**：目前 `cors()` 没有设置任何限制，默认允许所有源访问。你可以根据应用需求限制允许的源，提高安全性。
– **HTTPS**：确保生产环境中使用 HTTPS 来加密传输数据，避免 token 或密码等敏感信息在传输过程中被拦截。

// 限制 CORS 源
   app.use(cors({ origin: "https://your-allowed-origin.com" }));

6. **数据库连接池**：
– 如果你的应用需要处理大量的并发请求，建议使用数据库连接池而不是每次请求都新建连接，以提高性能和资源管理。

总结：

当前代码实现了基本的用户注册和登录功能，可以进一步优化 token 的管理、密码加密方式以及安全性。通过添加 token 过期机制、使用 `bcrypt` 加密密码、增强日志记录和改进错误处理，可以提升系统的安全性和稳定性。

这个 `GameManager` 类的代码实现了游戏服务器的核心功能，主要处理玩家的登录、角色管理、场景切换、副本管理等操作，并通过 RPC 进行服务间的通信。它利用 `RpcServer` 进行跨服务调用，并通过数据库管理玩家和角色的数据。以下是对代码的详细分析和建议修改的方向：

代码分析

#

1. **单例模式和依赖注入**

– 通过 `Singleton` 类实现了单例模式，使得 `GameManager` 只能有一个实例。`@Inject` 注解用于注入日志记录器 `Logger`，方便在整个类中记录日志。

#

2. **RPC 服务与事件处理**

– `RpcServer` 用于启动 RPC 服务，监听特定端口（`ServerPort.Game`）来处理请求。通过 `handleRegister` 方法处理不同类型客户端（如网关、场景服务器）连接的注册逻辑。
– 服务器在注册过程中会为不同的 `ServerId`（如 `Gateway`, `Scene1`, `Scene2`）定义不同的关闭行为，例如网关服务断开时清空所有玩家，场景服务器断开时通知网关断开特定玩家。

#

3. **玩家管理与角色系统**

– 通过 `PlayerManager` 管理玩家，玩家进入游戏时会从数据库中加载其所有角色（`Actor`），并且创建玩家实例。
– `enterGame` 和 `leaveGame` 方法分别用于玩家进入和离开游戏。进入游戏时，会从数据库中读取角色信息并创建 `Player`，离开游戏时会从场景和副本中移除角色。

#

4. **场景与副本管理**

– 玩家可以通过 `enterScene` 和 `leaveScene` 方法进入或离开场景，通过 `createReplication` 和 `leaveReplication` 方法进入或离开副本。
– `changeScene` 方法用于切换场景，首先从旧场景中离开，然后更新数据库中的场景信息，再进入新场景。

#

5. **客户端输入处理**

– `inputFromClient` 方法将来自客户端的输入传递给当前场景或副本服务器。
– `stateFromServer` 方法则从服务器端获取游戏状态并将其发送回客户端。

修改建议

1. **数据库连接优化**
– 当前的数据库连接 `connection` 是通过 `mysql2` 创建的，但每次查询都是直接执行，没有考虑连接池或连接复用。如果并发量较大，建议改为使用数据库连接池，避免重复创建连接和提高性能。

import { createPool } from "mysql2/promise";
   
   const pool = createPool({
     host: 'localhost',
     user: 'root',
     database: 'game',
     waitForConnections: true,
     connectionLimit: 10,
     queueLimit: 0
   });
   
   export const connection = pool;

2. **异步操作与错误处理**
– `handleRegister` 和一些数据库查询操作中没有全面的错误处理。可以在数据库查询或 RPC 操作中使用 `try-catch` 块捕获错误，并记录到日志系统中。进一步完善错误处理逻辑，避免服务器崩溃。

async handleRegister(client: RpcClient) {
     try {
       this.logger.info("register", client.id);
       // 处理注册逻辑
     } catch (error) {
       this.logger.error(`Error registering client ${client.id}: ${error.message}`);
     }
   }

3. **多线程或多进程支持**
– 当前服务器架构主要基于单线程处理，可以考虑将计算密集型任务或长时间执行的任务交给工作线程或使用 `Node.js` 的 `cluster` 模块以提高并发性能。

4. **缓存机制的改进**
– 如果系统玩家较多，可以将玩家角色信息和场景信息放入缓存中（例如 Redis）。通过缓存可以减少对数据库的直接依赖，提高响应速度。

5. **Token 管理**
– 代码中涉及到玩家与场景、角色等数据的管理，可以增加 token 或 session 管理，确保玩家登录后每次操作都能进行身份验证和授权。

6. **日志增强**
– 日志记录器 `Logger` 目前只记录了简单的操作和错误，可以改进日志的详细程度。例如，记录每个 RPC 调用的输入和输出，捕获性能瓶颈，帮助日后排查问题。

this.logger.info(`Client ${client.id} registered at ${new Date().toISOString()}`);

其他优化点

– **增加负载均衡**：如果场景和副本服务比较多，可以通过增加负载均衡逻辑，自动分配玩家到负载较轻的服务器。

– **RPC 超时处理**：如果 `RpcServer` 的某个调用长时间没有返回，可以考虑引入超时处理逻辑，避免阻塞后续请求。

– **安全性增强**：可以在 RPC 调用前增加认证层，确保只有授权的服务才能发送和接受 RPC 调用。此外，对于客户端输入，需要做好数据的校验，防止恶意数据或攻击。

总结

`GameManager` 类已经实现了游戏服务器的基本功能，包括玩家管理、角色系统、场景和副本管理等。可以通过优化数据库连接、引入缓存机制、改进日志和错误处理来提升系统的性能和稳定性。同时，RPC 的负载均衡、超时处理和安全性也需要进一步加强。

Tags: mmorpg