origin 游戏服务器引擎简介
==================


origin 是一个由 Go 语言（golang）编写的分布式开源游戏服务器引擎。origin适用于各类游戏服务器的开发，包括 H5（HTML5）游戏服务器。

origin 解决的问题：
* origin总体设计如go语言设计一样，总是尽可能的提供简洁和易用的模式，快速开发。
* 能够根据业务需求快速并灵活的制定服务器架构。
* 利用多核优势，将不同的service配置到不同的node，并能高效的协同工作。
* 将整个引擎抽象三大对象，node,service,module。通过统一的组合模式管理游戏中各功能模块的关系。
* 有丰富并健壮的工具库。

Hello world!
---------------
下面我们来一步步的建立origin服务器,先下载[origin引擎](https://github.com/duanhf2012/origin "origin引擎"),或者使用如下命令：
```go
go get -v -u  github.com/duanhf2012/origin
```
于是下载到GOPATH环境目录中,在src中加入main.go,内容如下：
```go
package main

import (
	"github.com/duanhf2012/origin/originnode"
)

func main() {
	node := originnode.NewOriginNode()
	if node == nil {
		return
	}

	node.Init()
	node.Start()
}
```
一个origin服务器需要创建一个node对象，然后必需有Init和Start的流程。

origin引擎三大对象关系
---------------
* Node:   可以认为每一个Node代表着一个origin进程
* Service:一个独立的服务可以认为是一个大的功能模块，他是Node的子集，创建完成并安装Node对象中。服务可以支持外部RPC和HTTP接口对外功能。
* Module: 这是origin最小对象单元，强烈建议所有的业务模块都划分成各个小的Module组合。Module可以建立树状关系。Service本身也是Module的类型。

origin集群核心配置文件config/cluser.json如下:
---------------
```
{
	"SubNet": [{
			"Remark": "Manual,Full,Auto",
			"SubNetMode": "Full",
			"SubNetName": "SubNet1",
			"PublicServiceList": ["logiclog"],
			"NodeList": [{
				"NodeID": 1,
				"NodeName": "N_Node1",
				"ServiceList": [
					"HttpServerService",
					"SubNet1_Service",
					"SubNet1_Service1"
				],
				"ClusterNode":["SubNet2.N_Node1","N_Node2"]
			},
			{
				"NodeID": 2,
				"NodeName": "N_Node2",
				"ServiceList": [
					"SubNet1_Service2"
				],
				"ClusterNode":[]
			}
			]
		},
		
		
		{
			"Remark": "Manual,Full,Auto",
			"SubNetMode": "Full",
			"SubNetName": "SubNet2",
			"PublicServiceList": ["logiclog"],
			"NodeList": [{
					"NodeID": 3,
					"NodeName": "N_Node1",
					"ServiceList": [
						"SubNet2_Service1"
					],
					"ClusterNode":["URQ.N_Node1"]
				},
				{
					"NodeID": 4,
					"NodeName": "N_Node4",
					"ServiceList": [
						"SubNet2_Service2"
					],
					"ClusterNode":[]
				}
			]
		}
	]
}
```
origin集群配置以子网的模式配置，在每个子网下配置多个Node服务器,子网在应对复杂的系统时可以应用到各个子系统，方便每个子系统的隔离。

origin所有的结点与服务通过配置进行关联，配置文件分为两大配置结点：
* SubNet：配置子网，以上配置中包括子网名为SubNet1与SubNet2,每个子网包含多个Node结点。
    * SubNetMode：子网模式，Manual手动模式,Full通过配置全自动连接集群模式（推荐模式）,Auto自动模式
	* SubNetName：子网名称
	* PublicServiceList：用于公共服务配置，所有的结点默认会加载该服务列表
	* SubNetMode：子网集群模式，
    * NodeList：Node所有的列表
        * NodeId:     Node编号，用于标识唯一的进程id
	    * NodeName:   Node名称，用于区分Node结点功能。例如，可以是GameServer
	    * ServiceList:结点中允许开启的服务列表
	    * ClusterNode:将与列表中的Node产生集群关系。允许访问这些结点中所有的服务。允许集群其他子网结点，例如：URQ.N_Node1

origin集群核心配置文件config/nodeconfig.json如下:
---------------
```
{
	"Public": {
		"LogLevel": 1,
		"HttpPort": 9400,
		"WSPort": 9500,

		"CAFile": [{
				"CertFile": "",
				"KeyFile": ""
			},
			{
				"CertFile": "",
				"KeyFile": ""
			}
		],

		"Environment": "FS_Dev_LFY",
		"IsListenLog": 1,
		"IsSendErrorMail": 0
	},
	"NodeList": [{
			"NodeID": 1,
			"NodeAddr": "127.0.0.1:8081",
			"LogLevel": 1,
			"HttpPort": 7001,
			"WSPort": 7000,
			"CertFile": "",
			"KeyFile": ""
		},
		{
			"NodeID": 2,
			"NodeAddr": "127.0.0.1:8082"
		},
		{
			"NodeID": 3,
			"NodeAddr": "127.0.0.1:8083"
		},
		{
			"NodeID": 4,
			"NodeAddr": "127.0.0.1:8084"
		}
	]
}
```
针对cluster.json中NodeId在该文件中配置具体环境的信息
* Public：公共服务配置
    * LogLevel：日志等级 1:DEBUG 2:INFO 3:WARN 4:ERROR 5:FATAL。
	* HttpPort：当Node需要提供http服务时，安装HttpServerService后将使用该监听端口。
	* WSPort：当Node需要提供Websocket服务时，安装HttpServerService后将使用该监听端口。
	* CAFile：证书配置文件，支持多个。
* NodeList：
    * NodeID：结点ID，在cluster.json中所有的Node都需要在该文件中配置。
    * NodeAddr：监听RPC地址与端口。
    * 其他：该配置可以继承Public中所有的配置，可以在其中自定义LogLevel,HttpPort等。



origin第一个服务:
---------------
我们准备的NodeId为1的结点下新建两个服务，分别是CTestService1与CTestService2。
* config/cluster.json内容如下
```
{
	"SubNet": [{
			"Remark": "Manual,Full,Auto",
			"SubNetMode": "Full",
			"SubNetName": "SubNet1",
			"PublicServiceList": ["logiclog"],
			"NodeList": [{
				"NodeID": 1,
				"NodeName": "N_Node1",
				"ServiceList": [
					"TestService1",
					"TestService2"
				],
				"ClusterNode":[]
			},
			{
				"NodeID": 2,
				"NodeName": "N_Node2",
				"ServiceList": [
					"TestService3"
				],
				"ClusterNode":[]
			}
			]
		}
	]
}
```
* config/nodeconfig.json内容如下
```
{
	"Public": {
		"LogLevel": 1,
		"HttpPort": 9400,
		"WSPort": 9500,
		"Environment": "Test",
		"IsListenLog": 1,
		"IsSendErrorMail": 0
	},

	"NodeList": [{
			"NodeID": 1,
			"NodeAddr": "127.0.0.1:8081"
		},
		{
			"NodeID": 2,
			"NodeAddr": "127.0.0.1:8082"
		}
	]
}
```


* main.go运行代码

```go
package main

import (
	"github.com/duanhf2012/origin/originnode"
)

func main() {

	node := originnode.NewOriginNode()
	if node == nil {
		return
	}

	node.Init()
	node.Start()
}

```

* TestService1.go运行代码
```go
package main

import (
	"fmt"

	"github.com/duanhf2012/origin/cluster"
	"github.com/duanhf2012/origin/originnode"
	"github.com/duanhf2012/origin/service"
)

type TestService1 struct {
	service.BaseService
}

func init() {
	originnode.InitService(&TestService1{})
}

//OnInit ...
func (ws *TestService1) OnInit() error {

	return nil
}

//OnRun ...
func (ws *TestService1) OnRun() bool {
	var i InputData
	var j int
	i.A1 = 3
	i.A2 = 4
	err := cluster.Call("TestService2.RPC_Add", &i, &j)
	if err == nil {
		fmt.Printf(" TestService2.RPC_Add is %d\n", j)
	}

	err = cluster.Call("TestService3.RPC_Multi", &i, &j)
	if err == nil {
		fmt.Printf(" TestService2.RPC_Multi is %d\n", j)
	}

	return false
}

```



* TestService2.go运行代码
```go
package main

import (
	"github.com/duanhf2012/origin/originnode"
	"github.com/duanhf2012/origin/service"
)

type InputData struct {
	A1 int
	A2 int
}

type TestService2 struct {
	service.BaseService
}

func init() {
	originnode.InitService(&TestService2{})
}

//OnInit ...
func (ws *TestService2) OnInit() error {

	return nil
}

//OnRun ...
func (ws *TestService2) OnRun() bool {
	return false
}

//服务要对外的接口规划如下：
//RPC_MethodName(arg *DataType1, ret *DataType2) error
//如果不符合规范，在加载服务时，该函数将不会被映射，其他服务将不允能调用。
func (slf *TestService2) RPC_Add(arg *InputData, ret *int) error {

	*ret = arg.A1 + arg.A2

	return nil
}
```

* TestService3.go运行代码
```go
package main

import (
	"github.com/duanhf2012/origin/originnode"
	"github.com/duanhf2012/origin/service"
)

type TestService3 struct {
	service.BaseService
}

func init() {
	originnode.InitService(&TestService3{})
}

//OnInit ...
func (ws *TestService3) OnInit() error {
	return nil
}

//OnRun ...
func (ws *TestService3) OnRun() bool {
	return false
}

func (slf *TestService3) RPC_Multi(arg *InputData, ret *int) error {
	*ret = arg.A1 * arg.A2
	return nil
}
```



通过以下命令运行：
```
OriginServer.exe NodeId=2
OriginServer.exe NodeId=1
```
其中NodeId=1的进程输出结果：
```
TestService2.RPC_Add is 7
TestService2.RPC_Multi is 12
```
通过日志可以确认，在Node启动时分别驱动Service的OnInit,OnRun,OnEndRun，上面的日志中TestService1.OnRun会被调用，
因为在OnRun的返回是false，所以OnRun只会进入一次。当返回true时，会重复循环进入OnRun。如果你不需要OnRun可以不定义OnRun函数。
示例中，我们分别调用了本进程的TestService2服务中的RPC_Add的RPC接口，以及NodeId为2进程中服务为TestService3的接口RPC_Multi。

origin服务间通信:
---------------
origin是通过rpc的方式互相调用，当前结点只能访问cluster.json中有配置ClusterNode的结点或本地结点中所有的服务接口,下面我们来用实际例子来说明，如下代码所示：
```
package main

import (
	"Server/service/websockservice"
	"fmt"
	"time"

	"github.com/duanhf2012/origin/cluster"

	"github.com/duanhf2012/origin/sysservice"

	"github.com/duanhf2012/origin/originnode"
	"github.com/duanhf2012/origin/service"
)

type CTestService1 struct {
	service.BaseService
}

//输入参数，注意变量名首字母大写
type InputData struct {
	A1 int
	A2 int
}

func (slf *CTestService1) OnRun() bool {
	var ret int
	input := InputData{100, 11}
	
	//调用服务名.接口名称，传入传出参数必需为地址，符合RPC_Add接口规范
	//以下可以采用其他，注意如果在服务名前加入下划线"_"表示访问本node中的服务
	//_servicename.methodname
	//servicename.methodname
	err := cluster.Call("CTestService2.RPC_Add", &input, &ret)
	fmt.Print(err, "\n", ret)

	return false
}

type CTestService2 struct {
	service.BaseService
}

//注意格式一定要RPC_开头，函数第一个参数为输入参数，第二个为输出参数，只允许指针类型
//返回值必需为error，如果不满足格式，装载服务时将被会忽略。
func (slf *CTestService2) RPC_Add(arg *InputData, ret *int) error {
	*ret = arg.A1 + arg.A2
	return nil
}

func main() {
	node := originnode.NewOriginNode()
	if node == nil {
		return
	}
	//也可以通过以下方式安装服务CTestService1与CTestService2
	node.SetupService(&CTestService1{}, &CTestService2{})
	node.Init()
	node.Start()
}

```
输入结果为：
```
<nil>
111
```
cluster.Call只允许调用一个结点中的服务，如果服务在多个结点中，是不允许的。注意，Call方式是阻塞模式，只有当被调服务响应时才返回，或者超过最大超时时间。如果不想阻塞，可以采用Go方式调用。例如：cluster.Go(true,"CTestService2.RPC_Send", &input)
第一个参数代码是否广播，如果调用的服务接口在多个Node中存在，都将被调用。还可以向指定的NodeId调用，例如：
```
func (slf *CCluster) CallNode(nodeid int, servicemethod string, args interface{}, reply interface{}) error
func (slf *CCluster) GoNode(nodeid int, args interface{}, servicemethod string) error
```
在实际使用时，注意抽象service，只有合理的划分service，origin是以service为最小集群单元放到不同的node中，以达到动态移动service功能到不同的node进程中。

origin中Module使用:
---------------
module在origin引擎中是最小的对象单元，service本质上也是一个复杂的module。它同样有着以下方法:
```
OnInit() error //Module初始化时调用
OnRun() bool   //Module运行时调用
OnEndRun()
```
在使用规则上和service是一样的，因为本质上是一样的对象。看以下简单示例：
```
package main

import (
	"fmt"
	"time"

	"github.com/duanhf2012/origin/originnode"
	"github.com/duanhf2012/origin/service"
)

type CTestService1 struct {
	service.BaseService
}

type CTestModule1 struct {
	service.BaseModule
}

func (slf *CTestModule1) OnInit() error {
	fmt.Printf("CTestModule1::OnInit\n")
	return nil
}

func (slf *CTestModule1) OnRun() bool {
	fmt.Printf("CTestModule1::OnRun\n")
	time.Sleep(time.Second * 1)
	return true
}

func (slf *CTestModule1) OnEndRun() {
	fmt.Printf("CTestModule1::OnEndRun\n")
}

func (slf *CTestModule1) Add(a int, b int) int {
	return a + b
}

func (slf *CTestService1) OnRun() bool {
	testmodule := CTestModule1{}

	//可以设置自定义id
	//testmodule.SetModuleId(PLAYERID)

	//添加module到slf对象中
	moduleId := slf.AddModule(&testmodule)

	//获取module对象
	pModule := slf.GetModuleById(moduleId)
	//转换为CTestModule1类型
	ret := pModule.(*CTestModule1).Add(3, 4)
	fmt.Printf("ret is %d\n", ret)

	time.Sleep(time.Second * 4)
	//释放module
	slf.ReleaseModule(moduleId)

	return false
}

func main() {
	node := originnode.NewOriginNode()
	if node == nil {
		return
	}
	node.SetupService(&CTestService1{})
	node.Init()
	node.Start()
}
```
执行结果如下：
```
ret is 7
CTestModule1::OnInit
CTestModule1::OnRun
CTestModule1::OnRun
CTestModule1::OnRun
CTestModule1::OnRun
CTestModule1::OnEndRun
```
以上创建新的Module加入到当前服务对象中，可以获取释放动作。同样CTestModule1模块也可以加入子模块，使用方法一样。以上日志每秒钟CTestModule1::OnRun打印一次，4秒后ReleaseModule，对象被释放，执行CTestModule1::OnEndRun。

origin中其他重要服务:
---------------
* github.com\duanhf2012\origin\sysservice集成了系统常用的服务
	* httpserverervice:提供对外的http服务
	* wsserverservice :websocket服务
	* logservice      :日志服务
	
以上服务请参照github.com\duanhf2012\origin\Test目录使用方法
* github.com\duanhf2012\origin\sysmodule集成了系统常用的Module
	* DBModule: mysql数据库操作模块，支持异步调用
	* RedisModule: Redis操作模块，支持异步调用
	* LogModule: 日志模块，支持区分日志等级
	* HttpClientPoolModule:http客户端模块