pbgo是一个基于Protobuf的迷你RPC/REST框架

pbgo是一个基于Protobuf的迷你RPC/REST框架

赞助 BTC: 1Cbd6oGAUUyBi7X7MaR4np4nTmQZXVgkCW赞助 ETH: 0x623A3C3a72186A6336C79b18Ac1eD36e1c71A8a6Go语言付费QQ群: 1055927514

pbgo: mini rpc/rest framework based on Protobuf

Features

protoc plugin generate codedefine rpc api with Protobuf, generate stub code, work with standard net/rpc frameworkdefine rest api with Protobuf, and generate service and client codework with grpc framework

Install

install protoc at first: http://github.com/google/protobuf/releasesgo get github.com/chai2010/pbgogo get github.com/chai2010/pbgo/protoc-gen-pbgogo run hello.go

Example (net/rpc)

create proto file:

syntax = "proto3";package hello_pb;message String { string value = 1;}message Message { string value = 1;}service HelloService { rpc Hello (String) returns (String); rpc Echo (Message) returns (Message);}

generate rpc code:

$ protoc -I=. -I=$GOPATH/src --pbgo_out=. hello.proto

use generate code:

package mainimport ( "fmt" "log" "net" "net/rpc" "github.com/chai2010/pbgo/examples/hello.pb")type HelloService struct{}func (p *HelloService) Hello(request *hello_pb.String, reply *hello_pb.String) error { reply.Value = "hello:" + request.GetValue() return nil}func (p *HelloService) Echo(request *hello_pb.Message, reply *hello_pb.Message) error { *reply = *request return nil}func startRpcServer() { hello_pb.RegisterHelloService(rpc.DefaultServer, new(HelloService)) listener, err := net.Listen("tcp", ":1234") if err != nil { log.Fatal("ListenTCP error:", err) } for { conn, err := listener.Accept() if err != nil { log.Fatal("Accept error:", err) } go rpc.ServeConn(conn) }}func tryRpcClient() { client, err := hello_pb.DialHelloService("tcp", "localhost:1234") if err != nil { log.Fatal(err) } reply, err := client.Hello(&hello_pb.String{Value: "gopher"}) if err != nil { log.Fatal(err) } fmt.Println(reply.GetValue())}func main() { go startRpcServer() tryRpcClient()}

Example (rest api)

create proto file:

syntax = "proto3";package hello_pb;import "github.com/chai2010/pbgo/pbgo.proto";message String { string value = 1;}message Message { string value = 1; repeated int32 array = 2; map dict = 3; String subfiled = 4;}message StaticFile { string content_type = 1; bytes content_body = 2;}service HelloService { rpc Hello (String) returns (String) { option (pbgo.rest_api) = { get: "/hello/:value" post: "/hello" additional_bindings { method: "DELETE"; url: "/hello" } additional_bindings { method: "PATCH"; url: "/hello" } }; } rpc Echo (Message) returns (Message) { option (pbgo.rest_api) = { get: "/echo/:subfiled.value" }; } rpc Static(String) returns (StaticFile) { option (pbgo.rest_api) = { additional_bindings { method: "GET"; url: "/static/:value"; content_type: ":content_type"; content_body: ":content_body" } }; }}

generate rpc/rest code:

$ protoc -I=. -I=$GOPATH/src --pbgo_out=. hello.proto

use generate code:

package mainimport ( "io/ioutil" "log" "mime" "net/http" "time" "github.com/chai2010/pbgo/examples/hello.pb")type HelloService struct{}func (p *HelloService) Hello(request *hello_pb.String, reply *hello_pb.String) error { reply.Value = "hello:" + request.GetValue() return nil}func (p *HelloService) Echo(request *hello_pb.Message, reply *hello_pb.Message) error { *reply = *request return nil}func (p *HelloService) Static(request *hello_pb.String, reply *hello_pb.StaticFile) error { data, err := ioutil.ReadFile("./testdata/" + request.Value) if err != nil { return err } reply.ContentType = mime.TypeByExtension(request.Value) reply.ContentBody = data return nil}func someMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(wr http.ResponseWriter, r *http.Request) { timeStart := time.Now() defer func() { timeElapsed := time.Since(timeStart) log.Println(r.Method, r.URL, timeElapsed) }() next.ServeHTTP(wr, r) })}func main() { router := hello_pb.HelloServiceHandler(new(HelloService)) log.Fatal(http.ListenAndServe(":8080", someMiddleware(router)))}

Go client:

func main() { var reply hello_pb.Message err := pbgo.HttpDo("GET", "http://127.0.0.1:8080/echo/xx", &hello_pb.Message{ Value: "chai2010", Array: []int32{1, 2, 3}, }, &reply, ) if err != nil { println("aaa") log.Fatal(err) } // {chai2010 [1 2 3] map[] value:"xx" {} [] 0} fmt.Println(reply)}

CURL client:

$ curl localhost:8080/hello/gopher{"value":"hello:gopher"}$ curl "localhost:8080/hello/gopher?value=vgo"{"value":"hello:vgo"}$ curl localhost:8080/hello -X POST --data '{"value":"cgo"}'{"value":"hello:cgo"}$ curl localhost:8080/echo/gopher{"subfiled":{"value":"gopher"}}$ curl "localhost:8080/echo/gopher?array=123&array=456"{"array":[123,456],"subfiled":{"value":"gopher"}}$ curl "localhost:8080/echo/gopher?dict%5Babc%5D=123"{"dict":{"abc":"123"},"subfiled":{"value":"gopher"}}$ curl localhost:8080/static/gopher.png$ curl localhost:8080/static/hello.txt

Rest Client

https://github.com/chubin/wttr.in

$ curl http://wttr.in/wuhan?format=j1$ curl http://wttr.in/武汉?format=j1

func main() { var reply struct { CurrentCondition []struct { FeelsLikeC string `json:"FeelsLikeC"` FeelsLikeF string `json:"FeelsLikeF"` Cloudcover string `json:"cloudcover"` Humidity string `json:"humidity"` LocalObsDateTime string `json:"localObsDateTime"` Observation_time string `json:"observation_time"` } `json:"current_condition"` } err := pbgo.HttpGet("http://wttr.in/wuhan?format=j1", nil, &reply) if err != nil { log.Fatal(err) } json, err := json.MarshalIndent(reply, "", " ") if err != nil { log.Fatal(err) } fmt.Println(string(json))}

Form Example

Create example/form_pb/comment.proto:

syntax = "proto3";package form_pb;message Comment { string user = 1; string email = 2; string url = 3; string text = 4; string next = 5; // redirect}

generate proto code:

$ protoc -I=. --go_out=. comment.proto

create web server:

package mainimport ( "github.com/chai2010/pbgo" "github.com/chai2010/pbgo/examples/form_pb" "github.com/julienschmidt/httprouter")func main() { router := httprouter.New() // http://localhost:8080 router.GET("/", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) { w.Header().Add("Content-Type", "text/html; charset=utf-8") fmt.Fprint(w, `

www Send Test

`) }) router.GET("/thanks", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) { fmt.Fprintln(w, "Thanks") }) // curl -d "user=chai&email=11@qq.com&text=hello&next=http://github.com" localhost:8080/api/comment router.POST("/api/comment", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) { var form form_pb.Comment if err := pbgo.BindForm(r, &form); err != nil { http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest) log.Println("err:", err) return } if form.Next != "" { http.Redirect(w, r, form.Next, http.StatusFound) } log.Println("form:", form) }) log.Fatal(http.ListenAndServe(":8080", router))}

$ curl -d "user=chai&email=11@qq.com&text=hello&next=http://github.com" localhost:8080/api/comment-form{"user":"chai","email":"11@qq.com","text":"hello","next":"http://github.com"}

gRPC & Rest Example

See https://github.com/chai2010/pbgo-grpc

BUGS

Report bugs to chaishushan@gmail.com.

Thanks!

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。