Skip to content

samuelyao314/terminator

Repository files navigation

介绍

terminator 是基于 skynet 服务端开发方案.

编译和运行

项目只支持在 Linux 下编译和运行。 需要提前安装构建工具 cmake, 以及 python.

编译项目

$ git clone https://github.com/samuelyao314/workspace terminator
$ cd terminator
$ make

下一步,运行服务

$ ./run.sh test # test 是服务名

如果需要部署,执行

$ make dev

最后,复制 deploy 目录到目标机器。

项目结构

lualib(公共lua库)
	base(通用库)
	perf(性能相关)
	test(单元测试)
  bw (基于skynet的公共库)
	  hotfix (热更新机制)
etc(启动配置)
  config.test  (test 服务配置)
  config.chat  (chat 服务配置)
service(服务入口)
  test (简单测试服务)
  chat  (聊天服务)
skynet
tools(辅助工具)
	deploy.py (生成部署目录)
	unittest.py. (单元测试驱动)
	new_service.py  (创建自定义服务)
thirdparty (第三方依赖)

创建新服务

新的项目,通常都需要创建新服务。一般情况,用模版工具生成。

$ python tools/new_service.py hello "just test"   # 参数1是服务名称(保证唯一),参数2是描述信息

执行后,会生成以下文件。如果需要删除服务,手动清除以下文件。

etc
    config.hello  (配置)
service
    hello
        init.lua (服务的入口)

接着,启动新服务

    $ ./run.sh hello

静态检测

使用 luacheck进行静态检查,配置文件.luacheckrc.

安装完 luacheck 后 (建议用 hererock + luarocks 进行安装)

$ make check

单元测试

单元测试文件, 是 xx_test.lua 命名的文件。 执行单元测试

$ make test

代码热更新

热更新机制可以在开发阶段,帮忙更好地调试代码。 因为Lua的灵活性以及游戏逻辑的复杂,热更新很难做完备,因此不建议应用在生产环境。 生产环境,需要临时修复代码,可以用 skynet 自带的 inject 机制。

启动热更新,需要配置当前环境为开发环境

	# config 文件
	need_hotfix=true

接着,import 加载的文件,一旦文件被修改,就会自动热加载。

	local mod = import("mod")

更多细节看 services/service/hotfix.

内存泄露

内存泄露,可以通过2次对Lua State 进行切片,比较差异,进行分析。 具体的接口使用见例子 perf .

$ ./run.sh perf
# 启动后,在skynet 目录,这个服务会产生一个内存切片。
# 例如产生类似这种文件:LuaMemRefInfo-All-[XXX]-[simulate_memory:00000008].txt。
# 等待少许时间,该服务会分配一些对象
# debug_console 服务提供了管理端工具,通过它再生成一份切片
$ telnet 127.0.0.1 8000
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
call 8 "dump_memory",1,2    # 这个是输入, 8 代表perf服务的ID
n	0     # 这个是返回
<CMD OK>

# 下一步,利用2个切片文件,得到内存差异
$ 3rd/lua/lua ../tools/compare_memory_snapshot.lua LuaMemRefInfo-All*
# 当前目录会生成一个  LuaMemRefInfo-All-[XXX]-[Compared].txt
# 比较代码,以及这个差异,就可以知道是否存在内存泄露

具体实现细节见:关于 Lua 内存泄漏的检测

单步调试

结合 VSCode 的插件Skynet Debugger, 本项目支持单步调试。

例如服务 chat,进行单步调试。 VSCode 的配置文件 launch.json 设置如下

{
    // 这个版本号,根据实际的插件版本号,进行修改
    "version": "1.0.0",
    "configurations": [
        {
            "name": "skynet debugger",
            "type": "lua",
            "request": "launch",
            "program": "${workspaceFolder}/skynet",
            "config": "../etc/config.chat"
        }
    ]
}

配置 config.chat 里,加了以下4行配置

logger = "vscdebuglog"
logservice = "snlua"
vscdbg_open = "$vscdbg_open"
vscdbg_bps = [=[$vscdbg_bps]=]

然后,点击菜单:Debug-Start Debugging. 最后就可以设置断点,进行调试了。

火焰图

TODO

Lua 第3方模块

参考资料

About

基于skynet 的通用服务器框架

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published