update plugin doc

zhangqijia
1 parent 69d286a7
Showing 8 changed files with 105 additions and 29 deletions Show diff stats
Makefile
README.md
cmd/gameserver/plugin/plugin.go
cmd/gameserver/plugin/plugin_test.go
common/components/plugin.go
common/components/server.go
conf/conf.yaml
doc/plugin.md
 all: gen game
 IMGTIME := $(shell date "+%G%m%d_%H%M%S")
-pname = plugin-$(IMGTIME).so
-
+pname = plugin-$(IMGTIME)
+race = -race
+#DEBUG = -gcflags "-l -N"
+DEBUG=
 gen:
 	protoc -I./protos --go_out=./protos  --go-grpc_out=./protos ./protos/*proto
 	protoc-go-inject-tag -input=./pb/*.pb.go
@@ -9,20 +11,20 @@ gen:
 test:
 	go run cmd/test/client.go
 http:
-	go run -race cmd/httpserver/http.go cmd/httpserver/AccountAction.go
+	go run $(race) cmd/httpserver/http.go cmd/httpserver/AccountAction.go
 game:
 	go run -race cmd/gameserver/*.go
 build:
-	go build -race -o bin/account cmd/http.go
-	go build -race -o bin/game cmd/gameserver/*.go
-	go build -race -o bin/test cmd/test/client.go
+	go build $(race) -o bin/account cmd/http.go
+	go build $(race) -o bin/game cmd/gameserver/*.go
+	go build $(race) -o bin/test cmd/test/client.go
 regame:plugin
 	lsof -i:8850 | grep "agent" | grep -v grep | awk '{print $$2}'  | xargs -I {} kill -USR1 {}
 plugin:
 	cd bin && rm -rf ./plugin*.so && cd -
-	go build -race --buildmode=plugin -o bin/$(pname) cmd/gameserver/plugin/*.go
-	cd bin && ln -s $(pname) plugin.so && cd -
+	go  build $(race) $(DEBUG)  --buildmode=plugin -o bin/$(pname).so cmd/gameserver/plugin/*.go  #--ldflags="-pluginpath=$(pname)"
+	cd bin && ln -s $(pname).so plugin.so && cd -
 .PHONY: all build protos test cert plugin
 \ No newline at end of file
@@ -7,16 +7,15 @@
 * 日志
 * 集群
 * 分布式
+* 热更
-技术点
-* golang 热更
-  
-组件名字
+技术点: 
 * mongo
+* redis
 * etcd
 * proto + models 查询
-* redis
+* golang plugin
 ## 目录结构
 ```text
@@ -60,17 +59,20 @@ $ go get google.golang.org/grpc/cmd/protoc-gen-go-grpc
 $ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc
 ```
 ## 文档
-[证书制作](doc/cret.md)
-[包组成结构](doc/proto.md)
-
+* [证书制作](doc/cret.md)
+* [包组成结构](doc/proto.md)
+* [go plugin热更的使用](doc/plugin.md)
 ## Usage
-编译 & 运行 游戏服 & 登录服务
+### 编译 & 运行 && 游戏服 & 登录服务
 ```shell
-$ make account
 $ make game
+$ make account
 ```
+
 测试
 ```shell
 $ make test
-```
 \ No newline at end of file
+```
+
+### 
 \ No newline at end of file
@@ -15,13 +15,13 @@ func init() {
 func GetActionMap() map[interface{}]interface{} {
 	logger.Debug("init protocode...")
 	am := make(map[interface{}]interface{})
-	am[uint32(pb.ProtoCode_LoginReq)] = LoginRpc
+	am[uint32(pb.ProtoCode_LoginReq)] = "LoginRpc"
 	return am
 }
 func LoginRpc(msg components.IMessage) (int32, interface{}) {
-	//logger.Debug("11111111cmd: %v, msg: %s", msg.GetHeader().GetMsgID(), msg.GetData())
+	logger.Debug("11111111cmd: %v, msg: %s", msg.GetHeader().GetMsgID(), msg.GetData())
 	req := pb.LoginReq{}
 	if err := proto.Unmarshal(msg.GetData(), &req); err != nil {
 		logger.Error("loginRpc err: %v", err)
@@ -0,0 +1,22 @@
+package main
+
+import (
+	"plugin"
+	"pro2d/common/logger"
+	"testing"
+)
+
+func TestGetActionMap(t *testing.T) {
+	p, err := plugin.Open("./bin/plugin.so")
+	if err != nil {
+		logger.Error("open error: ", err)
+		return
+	}
+	logger.Debug("open success")
+	symbol, err := p.Lookup("GetActionMap")
+	if err != nil {
+		logger.Error(err)
+		return
+	}
+	logger.Debug("%v", symbol)
+}
@@ -59,9 +59,12 @@ func (p *Plugin) GetAction(cmd uint32) interface{} {
 }
 func (p *Plugin) SetActions(am map[interface{}]interface{}) {
+	p.Actions.Range(func(key, value interface{}) bool {
+		p.Actions.Delete(key.(uint32))
+		return true
+	})
 	for k, v := range am {
 		cmd := k.(uint32)
-		p.Actions.Delete(cmd)
 		p.Actions.Store(cmd, v)
 	}
 }
@@ -115,12 +115,6 @@ func (s *Server) SetTimerCallback(cb TimerCallback) {
 }
 func (s *Server) Start() error {
-	if s.plugins != nil {
-		if err := s.plugins.LoadPlugin(); err != nil {
-			return err
-		}
-	}
-
 	port := fmt.Sprintf(":%d", s.port)
 	l, err := net.Listen("tcp", port)
 	if err != nil {
@@ -34,7 +34,7 @@ server_game:
   port: 8850
   pool_size: 1
   debugport: 6061
-  #  plugin_path: "./bin/plugin.so"
+  plugin_path: "./bin/plugin.so"
   mongo:
     <<: *default-mongo
     dbname: "game"
@@ -0,0 +1,53 @@
+
+## 热更golang有状态服务
+1. golang是有状态的
+2. 数据+逻辑代码分离
+3. 主要热更的是逻辑代码
+
+
+## 启用插件
+1. 启用插件, 配置文件 conf.yaml, 填入插件.so文件的路径
+```
+server_game:
+  plugin_path: "./bin/plugin.so"
+  mongo:
+    <<: *default-mongo
+    dbname: "game"
+```
+2. 编译程序 & 插件.
+```shell
+$ make plugin
+```
+* 程序和插件需要同一个golang的环境。
+* golang对同一个插件只能加载一次。可以修改.so文件名字 + 软连接的方式来处理
+
+
+## 写插件代码
+插件中的代码主要是对线上程序 `协议=>逻辑` 的热更.
+
+比如我们要修改游戏服务协议号为`1`的逻辑。 则在`cmd/gameserver/plugin/plugin.go`文件中修改。
+1. 在函数`GetActionMap`中增加一行
+```
+am[uint32(1)] = HotRpc
+```
+2. 增加函数`HotRpc`
+```
+func HotRpc(msg components.IMessage) (int32, interface{}) {
+}
+```
+
+3. 编译插件 & 可以参考Makefile:plugin
+```Makefile
+IMGTIME := $(shell date "+%G%m%d_%H%M%S")
+pname = plugin-$(IMGTIME).so
+plugin:
+	cd bin && rm -rf ./plugin*.so && cd -
+	go build -race --buildmode=plugin -o bin/$(pname) cmd/gameserver/plugin/*.go
+	cd bin && ln -s $(pname) plugin.so && cd -
+```
+
+4. 把插件放到指定位置, 并给游戏服发送热更指令。可以参考Makefile:regame
+```Makefile
+regame:plugin
+	lsof -i:8850 | grep "agent" | grep -v grep | awk '{print $$2}'  | xargs -I {} kill -USR1 {}
+```
 \ No newline at end of file