在 skynet 框架中提供了一個控制檯服務 debug_console ，用於幫助我們檢視 skynet 的一些執行時資料，而且在需要熱更程式碼的時候也需要藉助控制檯來實現。接下來，我們先看看如何使用控制檯，然後在大致看一遍底層的原始碼實現。

工具準備

由於啟動控制檯服務後，需要藉助 nc 或 telnet 來遠端連線控制檯，所需需要確保機器上已安裝了此類工具，這裡我使用的是 nc 6.40 ，可以先查詢本地是否已安裝了該工具：

$ nc --version
Ncat: Version 6.40 ( http://nmap.org/ncat )

假如未安裝，直接使用 yum 工具進行安裝：

$ yum install nc
 

啟動服務

在 skynet 的啟動會服務（通常是在 skynet 啟動時，也就是在 config 啟動配置檔案所指定的執行時第一個服務 start = "main" ，即 main.lua）中新增一句程式碼即可啟動控制檯服務：

skynet.newservice("debug_console", 8000)

第二個引數指定了遠端連線的埠號，此埠可以根據自己需要進行修改，在啟動 skynet 服務時看到如下 log 輸出代表控制檯啟動成功：

[:0100000a] LAUNCH snlua debug_console 8000
[:0100000a] Start debug console at 127.0.0.1:8000

然後在新的 shell 視窗中連線控制檯，連線成功如下：

$ nc 127.0.0.1 8000
Welcome to skynet console

官方建議：

出於安全考慮，除錯控制檯只能監聽本地地址 127.0.0.1 ，所以如果需要遠端使用，需要先登入到本機，然後再連線。

安裝使用 telnet 並連線控制檯服務其實也不難：

$ yum install telnet
$ telnet 127.0.0.1:8000
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
Welcome to skynet console

幫助文件

直接使用 help 指令查詢幫助文件，瞭解所有可用的指令 ：

[[email protected]
 
 ~]# nc 127.0.0.1 8000
Welcome to skynet console
help
callcall address ...
clearcacheclear lua code cache
cmemShow C memory info
debugdebug address : debug a lua service
exitexit address : kill a lua service
gcgc : force every lua service do garbage collect
helpThis help message
infoinfo address : get service infomation
injectinject address luascript.lua
killkill address : kill service
listList all the service
loglaunch a new lua service with log
logofflogoff address
logonlogon address
memmem : show memory status
pingping address
serviceList unique service
shrtblShow shared short string table info
signalsignal address sig
snaxlanuch a new snax service
startlanuch a new lua service
statDump all stats
tasktask address : show service task detail
<CMD OK>

直接在當前 shell 視窗輸入對應的指令並帶上引數即可，官方文件介紹引數格式：

命令的一般格式是 命令 地址 ，有些命令不帶地址，會針對所有的服務。當輸入地址時，可以使用 :01000001 這樣的格式指代一個服務地址：由冒號開頭的 8 位 16 進位制數字，也可以省略前面兩個數字的 harbor id 以及接下來的連續 0 ，比如 :01000001 可以簡寫為 1 。所有活動的服務可以輸入 list 列出。

原始碼解析

服務的 lua 原始碼在 service\debug_console.lua 中，從 skynet.start 方法開始：

skynet.start(function()
local listen_socket = socket.listen (ip, port)
skynet.error("Start debug console at " .. ip .. ":" .. port)
socket.start(listen_socket , function(id, addr)
        -- 返回執行結果給指令請求端
local function print(...)
local t = { ... }
for k,v in ipairs(t) do
t[k] = tostring(v)
end
socket.write(id, table.concat(t,"\t"))
socket.write(id, "\n")
end
socket.start(id)
skynet.fork(console_main_loop, id , print)
end)
end)

這裡啟動了一個 Socket 監聽：

local listen_socket = socket.listen (ip, port)

監聽的 ip 和埠可以在啟動服務時傳入：

local ip = (arg.n == 2 and arg[1] or "127.0.0.1")-- 預設是本地 ip 127.0.0.1 ，或者是傳入兩個引數時的第一個引數
local port = tonumber(arg[arg.n])-- 傳入引數的最後一個

啟動完監聽埠後，啟動一個協程來執行一個死迴圈，用於監控 socket 連線端輸入的命令，並解析執行命令，將結果通過 socket 返回給 socket 連線端：

skynet.fork(console_main_loop, id , print)

命令結果輸出：

此處傳入的最後一個引數 print 是一個 function ，用於向 socket 連線端返回執行指令的列印結果，以文字的形式，這裡可以簡單地理解為：socket 監聽端與連線端的一種聊天模式。

命令輸入：

在協程中的死迴圈用於監聽命令請求端輸入的命令，基本邏輯如下：

pcall(function()
while true do
local cmdline = socket.readline(stdin, "\n")
if not cmdline then
break
end
      -- http 命令資料解析
if cmdline:sub(1,4) == "GET " then
-- http
local code, url = httpd.read_request(sockethelper.readfunc(stdin, cmdline.. "\n"), 8192)
local cmdline = url:sub(2):gsub("/"," ")
docmd(cmdline, print, stdin)
break
end
      -- nc 或 telnet 命令資料解析
if cmdline ~= "" then
docmd(cmdline, print, stdin)
end
end
end)

• 通過 socket.readline 讀取最新的命令列，沒有新命令則結束本次；

• 有新命令，則解析命令，這裡接續要區分 nc 或 telnet 傳入的 socket 資料和通過 Http 請求發過來的資料。

docmd 是根據解析結果呼叫具體執行介面的方法：

local function docmd(cmdline, print, fd)
local split = split_cmdline(cmdline)
local command = split[1]
local cmd = COMMAND[command]
local ok, list
if cmd then
ok, list = pcall(cmd, table.unpack(split,2))
else
cmd = COMMANDX[command]
if cmd then
split.fd = fd
split[1] = cmdline
ok, list = pcall(cmd, split)
else
print("Invalid command, type help for command list")
end
end
​
if ok then
if list then
if type(list) == "string" then
print(list)
else
dump_list(print, list)
end
end
print("<CMD OK>")
else
print(list)
print("<CMD Error>")
end
end

重要介面

• info address

  檢視指定服務詳情的介面

• inject inject address

  熱更時常用到的介面

優化控制檯

在 skynet 的 debug_console 中不能使用鍵盤的上下鍵來追溯之前的輸入歷史命令，每次都要重新輸入命令。想優化這個操作，需要使用到 readline 的 history 特性，可以通過安裝 rlwrap 工具來實現。具體的安裝步驟如下：

• 安裝 readline ，因為 rlwrap 依賴於此工具，在 skynet 編譯的時候也依賴與此工具：

  $ yum -y install readline-devel

• 安裝 rlwrap ，這是一個開源的工具，原始碼在 Github 上可以找到，最新的版本是 v 0.43 ，可以下載原始碼來進行編譯安裝，但這裡為了節省時間還是建議直接到 這裡 下載安裝包 ，然後解壓安裝：

  $ tar -zxf rlwrap-0.43.tar.gz   
  $ cd rlwrap-0.43  
  $ ./configure -q # -q表示靜默不列印配置日誌 
  $ make && make install

  檢查安裝成功：

  $ rlwrap --version
  rlwrap 0.43

rlwrap 常用的快捷：

Ctrl+L 清屏，實際是將當前行置頂
Ctrl+P 上一條命令
Ctrl+N 下一條命令
Ctrl+U 從游標處刪除到行首
Ctrl+W 向前刪除一個單詞
Ctrl+B 游標向前移動一個位置
Ctrl+T 游標處字元與前一個字元交換位置
Ctrl+Z 後臺執行，使用fg調出
Ctrl+H 相當於刪除鍵
Ctrl+J 相當於回車鍵
Ctrl+O 相當於回車鍵
Ctrl+M 相當於回車鍵

需要在 nc 中使用到 rlwrap 的功能，連線時的指令需要加上 rlwrap 字首，變成：

rlwrap nc 127.0.0.1 8000

不加字首的話，rlwrap 工具是不起作用的。

參考