npm 包 pinus 使用教程

阅读时长 6 分钟读完

介绍

Pinus 是一个快速、可扩展的游戏服务器框架,它在 Node.js 平台上运行。Pinus 的诞生是为了处理大规模的多人在线游戏(MMOG)而设计的,它的目标是提供一个开发简单、性能优越、扩展性良好的游戏服务器框架。

安装

使用 npm 进行安装:

安装完成后,你可以在命令行中输入以下命令来验证是否安装成功:

命令执行结果会显示当前安装的 Pinus 版本号。

快速开始

创建应用程序:

如果是在本地执行,在 myapp 目录下运行:

在浏览器中打开 http://127.0.0.1:3000 就可以看到 Pinus 的欢迎页了。

Pinus 的基本概念

在开始使用 Pinus 之前,先了解一下 Pinus 的基本概念。

应用程序

应用程序是 Pinus 的最上层概念,一个应用程序可以包含多个服务器(Server),可以是前端服务器(frontend server)或者后端服务器(backend server),也可以是网关服务器(gate server)。

服务器

服务器是应用程序的基本组成部分,它负责处理客户端连接、逻辑处理、消息转发等任务。Pinus 中每个服务器都有自己的 ServerType,比如 frontend server、backend server 或者 gate server。

路由

路由用来确定消息从哪个服务器传递到哪个服务器。Pinus 自带了几种路由算法,比如按照服务器负载均衡、按照规则分配等。

组件

组件是 Pinus 中的核心概念,它是服务器的一些可复用的功能模块,包括连接器(connector)、编码验证器(encoder)、路由(route)、数据管理器(data manager)等等。在启动服务器时,可以为每个组件指定不同的参数和配置,以满足不同的需求。

使用 Pinus 进行开发

启动服务器

启动 Pinus 服务器非常简单,只需要运行下面的命令:

如果想指定使用哪个配置文件启动服务器,可以运行下面这个命令:

编写服务器逻辑

在 Pinus 中,服务器逻辑是通过编写 Handler 来实现的。Handler 可以理解为服务器上的一个函数,它可以在接收到客户端的消息时被调用。下面是一个简单的示例:

-- -------------------- ---- -------
-------------- - ------------- -
  ------ --- -------------
--

--- ------- - ------------- -
  -------- - ----
--

------------------------------ - ------------- --- -
  --- --- - --------
  -------------------------------------- ---- ----
--

以上代码中,我们通过 module.exports 返回一个构造函数,此处构造函数的名称为 Handler。当某个客户端发来一条 invokeRemote 的消息时,Handler 中的 invokeRemote 函数会被调用。该函数中的 this.app.rpc.chat.chatRemote.ping(uid, msg, cb) 可以将这条消息转发给 chat Remote 上的 ping 函数。

定义前端服务器

在使用 Pinus 开发游戏服务器时,必须要了解前端服务器的概念。前端服务器负责处理客户端的连接、断开、请求等。下面是一个简单的定义:

-- -------------------- ---- -------
--- ----- - -----------------

--- --- - --------

--------------------------------------- ------------ ---------- -
  -------------------------- -
    ---------- ---------------------------------
    ---------- --
  ---
---

------------

其中,app.configure 中的参数分别为环境、connector 类型和回调函数。connector 类型可以是 socketiosioconnectorhybridconnector 等,这里我们选择的是 hybridconnector。heartbeat 参数指定了心跳检测的时间间隔,单位为秒。

定义后端服务器

后端服务器通常用于处理业务逻辑,包括游戏数据管理、聊天室管理、战斗数据计算等。下面是一个简单的定义:

-- -------------------- ---- -------
--- ----- - -----------------
--- ---- - ----------------

-- ------ ------- ------
--- ------------- - ---------------------
------------------------- -----------
------------------------- -------------
------------------------- ------

-- ----- ------- ------
------------------------------ -
  -------------------- ------ ------- -- ---- -------
---

-- ------ ------
--------------------------- ------------- -------- ----- -
  -------------------- ------- ---- --------- -----
  ---------- ------ ------
---

以上代码中,我们首先使用 pinus.createServer() 创建了一个后端服务器实例,然后指定服务器的名称、IP 和端口号。接着使用 backendServer.start() 启动服务器,并使用 backendServer.route() 指定了路由。如果客户端发来的消息的服务名为 “chat”,则该服务器会接收到消息,执行路由中的回调函数,并返回一个 code 为 200 的响应。

总结

Pinus 是一个强大的游戏服务器框架,它提供了非常方便的开发工具,如路由算法、组件管理、配置管理等等。在开发过程中,我们可以使用 Pinus 的组件来加速开发、提高代码复用性。通过本文的介绍,希望你已经掌握了如何使用 Pinus 进行服务器开发。如果你想了解更多关于 Pinus 的知识,可以查阅官方文档。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/157260