go-lightrpc-example

协议描述

https://github.com/cc14514/go-lightrpc

安装example

• 假设 GOPATH=/usr/local/gopath
• cd /usr/local/gopath/src
• git clone https://github.com/cc14514/go-lightrpc-example.git
• cd /usr/local/gopath
• go install go-lightrpc-example
• bin/go-lightrpc-example -h

api 说明

Rpcserver 定义如下：
type Rpcserver struct {
	Pattern        string // url , 默认 /api/
	Port           int //端口	
	ServiceMap     map[string]ServiceReg //service服务映射	
	CheckToken     func(token TOKEN) bool //校验Token的回调函数	
	AllowedMethods []string //接受的方法，默认 [GET,POST] 
}

main.go 中初始化服务如下：
...
rs := &rpcserver.Rpcserver{
	
	//端口	
	Port:       ctx.GlobalInt("rpcport"),
	//服务映射
	ServiceMap: service.ServiceRegMap,
	// 校验请求中的 TOKEN 是否正确，根据不同的业务需求，会有不同实现
	CheckToken: func(token rpcserver.TOKEN) bool {
		log4go.Debug("Auth token = %s", token)
		if token == "123456" {
			return true
		} else {
			return false
		}
	},
}
rs.StartServer()
...

其中 service.ServiceRegMap 代码在 service/registry.go 中，
每次编写一个 service 时需要为其注册一个名字，
例如：
    下面这句将 UserService 注册为 "user"
    genServiceReg("user", vsn, &UserService{})
    在访问 user 服务时，报文中的service属性等于"user"即可，
    ?body={"service":"user",......}


注意 go 的方法名第一个字母必须大些才能对外使用，但是报文中可以忽略首字母的大小写，
即在报文中 method = getUser 和 method = GetUser 是同一个方法
编写service时，如果某个方法需要鉴权，则通过 rpcserver.TOKEN 这个参数来控制
例如：
    func (self *UserService) GetUser(params interface{}, token rpcserver.TOKEN)
rpcserver.Success 
    当访问 user 的 getUser 方法时,报文中不提供正确 token 则会返回一个错误；
    所提供的 token 正是由上文中的 CheckToken 回调函数校验的;
    ?body={"service":"user","method":"getUser","params":{"username":"foobar"},"token":"123456"}

可以访问 http://localhost:8080/api/?body={} 测试接口是否成功启动；