skynet框架应用 (三) 构建服务的基础API

3 构建服务的基础API

local skynet = require "skynet" 
​
--conf配置信息已经写入到注册表中，通过该函数获取注册表的变量值
skynet.getenv(varName) 。
​
--设置注册表信息，varValue一般是number或string，但是不能设置已经存在的varname
skynet.setenv(varName, varValue) 
​
--打印函数
skynet.error(...)
​
--用 func 函数初始化服务，并将消息处理函数注册到 C 层，让该服务可以工作。
skynet.start(func) 
​
--若服务尚未初始化完成，则注册一个函数等服务初始化阶段再执行；若服务已经初始化完成，则立刻运行该函数。
skynet.init(func) 
​
--结束当前服务
skynet.exit() 
​
--获取当前服务的句柄handler
skynet.self()
​
--将handle转换成字符串
skynet.address(handler)
​
--退出skynet进程
require "skynet.manager"   --除了需要引入skynet包以外还要再引入skynet.manager包。
skynet.abort()
​
--强制杀死其他服务
skynet.kill(address) --可以用来强制关闭别的服务。但强烈不推荐这样做。因为对象会在任意一条消息处理完毕后，毫无征兆的退出。所以推荐的做法是，发送一条消息，让对方自己善后以及调用 skynet.exit 。注：skynet.kill(skynet.self()) 不完全等价于 skynet.exit() ，后者更安全。

3.1 编写一个test服务

1. 编写一个最简单的服务test.lua

   --引入或者说是创建一个skynet服务
   local skynet = require "skynet" 
   --调用skynet.start接口，并定义传入回调函数
   skynet.start(function()
   skynet.error("Server First Test")
   end)

2. 修改exmaple/config文件中的start的值为test，表示启动test.lua，修改之前请备份

   include "config.path"
   -- preload = "./examples/preload.lua"   -- run preload.lua before every lua service run
   thread = 2
   logger = nil
   logpath = "."
   harbor = 1
   address = "127.0.0.1:2526"
   master = "127.0.0.1:2013"
   start = "test"  -- main script  --将start的值修改为test
   bootstrap = "snlua bootstrap"   -- The service for bootstrap
   standalone = "0.0.0.0:2013"
   -- snax_interface_g = "snax_g"
   cpath = root.."cservice/?.so"
   -- daemon = "./skynet.pid"

3. 通过skynet来运行test.lua

   $ ./skynet examples/config

   运行结果

   $ ./skynet examples/config
   [:01000001] LAUNCH logger 
   [:01000002] LAUNCH snlua bootstrap
   [:01000003] LAUNCH snlua launcher
   [:01000004] LAUNCH snlua cmaster
   [:01000004] master listen socket 0.0.0.0:2013
   [:01000005] LAUNCH snlua cslave
   [:01000005] slave connect to master 127.0.0.1:2013
   [:01000004] connect from 127.0.0.1:52132 4
   [:01000006] LAUNCH harbor 1 16777221
   [:01000004] Harbor 1 (fd=4) report 127.0.0.1:2526
   [:01000005] Waiting for 0 harbors
   [:01000005] Shakehand ready
   [:01000007] LAUNCH snlua datacenterd
   [:01000008] LAUNCH snlua service_mgr
   [:01000009] LAUNCH snlua test
   [:01000009] Server First Test
   [:01000002] KILL self

   注意：千万不要在skynet根目录以外的地方执行skynet，例如：

   $ cd examples
   $ ../skynet config
   try open logger failed : ./cservice/logger.so: cannot open shared object file: No such file or directory
   Can't launch logger service
   $ 

​ 以上出现找不到logger.so的情况，其实不仅仅是这个模块找不到，所有的模块都找不到了，因为在config包含的路劲conf.path中，所有的模块路劲的引入全部依靠着相对路劲。一旦执行skynet程序的位置不一样了，相对路劲也会不一样。

4. 添加自己的LUA脚本路劲

   例如：添加my_workspace目录，则只需在luaservice值的基础上再添加一个root.."my_workspace/？.lua;",注意：各个路劲通过一个; 隔开。

   

   把我们的刚才写的test.lua丢到my_workspace中

   $ mv examples/test.lua my_workspace/

   顺便将example下的conf以及conf.path也拷贝一份到my_workspace

   $ cp examples/config my_workspace/
   $ cp examples/config.path my_workspace/

   这次运行的时候就可以这样了：

   $ ./skynet my_workspace/conf

3.2 另外一个种启动服务的方式

另一种方式启动想要的服务，可以在main.lua运行后，在console直接输入需要启动的服务名称.

1. 先启动main.lua服务，注意还原examples/conf默认配置，并且在example/conf.path添加自己的服务目录。

   $ ./skynet examples/conf  #conf中start配置为启动main.lua
   [:01000001] LAUNCH logger 
   [:01000002] LAUNCH snlua bootstrap
   [:01000003] LAUNCH snlua launcher
   [:01000004] LAUNCH snlua cmaster
   [:01000004] master listen socket 0.0.0.0:2013
   [:01000005] LAUNCH snlua cslave
   [:01000005] slave connect to master 127.0.0.1:2013
   [:01000004] connect from 127.0.0.1:52698 4
   [:01000006] LAUNCH harbor 1 16777221
   [:01000004] Harbor 1 (fd=4) report 127.0.0.1:2526
   [:01000005] Waiting for 0 harbors
   [:01000005] Shakehand ready
   [:01000007] LAUNCH snlua datacenterd
   [:01000008] LAUNCH snlua service_mgr
   [:01000009] LAUNCH snlua main
   [:01000009] Server start
   [:0100000a] LAUNCH snlua protoloader
   [:0100000b] LAUNCH snlua console
   [:0100000c] LAUNCH snlua debug_console 8000
   [:0100000c] Start debug console at 127.0.0.1:8000
   [:0100000d] LAUNCH snlua simpledb
   [:0100000e] LAUNCH snlua watchdog
   [:0100000f] LAUNCH snlua gate
   [:0100000f] Listen on 0.0.0.0:8888
   [:01000009] Watchdog listen on 8888
   [:01000009] KILL self
   [:01000002] KILL self

​ 2. 在启动的main服务中，直接输入test，回车

   $ ./skynet examples/config
   [:01000001] LAUNCH logger 
   [:01000002] LAUNCH snlua bootstrap
   [:01000003] LAUNCH snlua launcher
   [:01000004] LAUNCH snlua cmaster
   [:01000004] master listen socket 0.0.0.0:2013
   [:01000005] LAUNCH snlua cslave
   [:01000005] slave connect to master 127.0.0.1:2013
   [:01000004] connect from 127.0.0.1:52698 4
   [:01000006] LAUNCH harbor 1 16777221
   [:01000004] Harbor 1 (fd=4) report 127.0.0.1:2526
   [:01000005] Waiting for 0 harbors
   [:01000005] Shakehand ready
   [:01000007] LAUNCH snlua datacenterd
   [:01000008] LAUNCH snlua service_mgr
   [:01000009] LAUNCH snlua main
   [:01000009] Server start
   [:0100000a] LAUNCH snlua protoloader
   [:0100000b] LAUNCH snlua console
   [:0100000c] LAUNCH snlua debug_console 8000
   [:0100000c] Start debug console at 127.0.0.1:8000
   [:0100000d] LAUNCH snlua simpledb
   [:0100000e] LAUNCH snlua watchdog
   [:0100000f] LAUNCH snlua gate
   [:0100000f] Listen on 0.0.0.0:8888
   [:01000009] Watchdog listen on 8888
   [:01000009] KILL self
   [:01000002] KILL self
   test    #终端输入
   [:01000010] LAUNCH snlua test 
   [:01000010] Server First Test   #服务已经启动

3.3 环境变量

​ 1、预先加载的环境变量是在conf中配置的，加载完成后，所有的service都能去获取这些变量。

​ 2、也可以去设置环境变量，但是不能修改已经存在的环境变量。

​ 3、环境变量设置完成后，当前节点上的所有服务都能访问的到。

​ 4、环境变量设置完成后，及时服务退出了，环境变量依然存在，所以不要滥用环境变量。

例如在conf中添加：

myname = "Dmaker"
myage = 20

示例代码：testenv.lua

local skynet = require "skynet" 
​
skynet.start(function()
    --获取环境变量myname和myage的值，成功返回其值，如果该环境变量不存在返回nil
    local name = skynet.getenv("myname")    
    local age = skynet.getenv("myage")  
    skynet.error("My name is", name, ",", age, "years old.")
    
    --skynet.setenv("myname", "coder")  --不要尝试设置已经存在的变量值，会报错
    --skynet.setenv("myage", 21)
​
    skynet.setenv("mynewname", "coder") --设置一个新的变量
    skynet.setenv("mynewage", 21)
​
    name = skynet.getenv("mynewname")   
    age = skynet.getenv("mynewage") 
    skynet.error("My new name is", name, ",", age, "years old soon.")
    skynet.exit()
end)

3.4 skynet.init的使用

​ skynet.init用来注册服务初始化之前，需要执行的函数。也就是在skynet.start之前运行。

示例代码：testinit.lua

local skynet = require "skynet" 
​
skynet.init(function()
        skynet.error("service init")
end)
​
skynet.start(function()
    skynet.error("service start")
end)

运行结果：

[:01000009] service init    #先运行skynet.init
[:01000009] service start   #运行skynet.start函数