Update wrapper and examples

This commit is contained in:
Asim 2015-12-02 11:54:36 +00:00
parent c5a08d3159
commit b1511ed813
7 changed files with 130 additions and 86 deletions

View File

@ -56,14 +56,6 @@ type client struct {
shutdown bool shutdown bool
} }
// A clientCodec implements writing of RPC requests and
// reading of RPC responses for the client side of an RPC session.
// The client calls WriteRequest to write a request to the connection
// and calls ReadResponseHeader and ReadResponseBody in pairs
// to read responses. The client calls Close when finished with the
// connection. ReadResponseBody may be called with a nil
// argument to force the body of the response to be read and then
// discarded.
type clientCodec interface { type clientCodec interface {
WriteRequest(*request, interface{}) error WriteRequest(*request, interface{}) error
ReadResponseHeader(*response) error ReadResponseHeader(*response) error
@ -224,8 +216,6 @@ func (call *call) done() {
} }
} }
// NewclientWithCodec is like Newclient but uses the specified
// codec to encode requests and decode responses.
func newClientWithCodec(codec clientCodec) *client { func newClientWithCodec(codec clientCodec) *client {
client := &client{ client := &client{
codec: codec, codec: codec,

View File

@ -2,7 +2,6 @@ package main
import ( import (
"fmt" "fmt"
"time"
"github.com/micro/go-micro/client" "github.com/micro/go-micro/client"
"github.com/micro/go-micro/cmd" "github.com/micro/go-micro/cmd"
@ -11,41 +10,6 @@ import (
"golang.org/x/net/context" "golang.org/x/net/context"
) )
// wrapper example code
// log wrapper logs every time a request is made
type logWrapper struct {
client.Client
}
func (l *logWrapper) Call(ctx context.Context, req client.Request, rsp interface{}) error {
md, _ := c.GetMetadata(ctx)
fmt.Printf("[Log Wrapper] ctx: %v service: %s method: %s\n", md, req.Service(), req.Method())
return l.Client.Call(ctx, req, rsp)
}
// trace wrapper attaches a unique trace ID - timestamp
type traceWrapper struct {
client.Client
}
func (t *traceWrapper) Call(ctx context.Context, req client.Request, rsp interface{}) error {
ctx = c.WithMetadata(ctx, map[string]string{
"X-Trace-Id": fmt.Sprintf("%d", time.Now().Unix()),
})
return t.Client.Call(ctx, req, rsp)
}
// Implements client.Wrapper as logWrapper
func logWrap(c client.Client) client.Client {
return &logWrapper{c}
}
// Implements client.Wrapper as traceWrapper
func traceWrap(c client.Client) client.Client {
return &traceWrapper{c}
}
// publishes a message // publishes a message
func pub() { func pub() {
msg := client.NewPublication("topic.go.micro.srv.example", &example.Message{ msg := client.NewPublication("topic.go.micro.srv.example", &example.Message{
@ -120,7 +84,6 @@ func stream() {
func main() { func main() {
cmd.Init() cmd.Init()
fmt.Println("\n--- Call example ---\n") fmt.Println("\n--- Call example ---\n")
for i := 0; i < 10; i++ { for i := 0; i < 10; i++ {
call(i) call(i)
@ -131,19 +94,4 @@ func main() {
fmt.Println("\n--- Publisher example ---\n") fmt.Println("\n--- Publisher example ---\n")
pub() pub()
fmt.Println("\n--- Wrapper example ---\n")
// Wrap the default client
client.DefaultClient = logWrap(client.DefaultClient)
call(0)
// Wrap using client.Wrap option
client.DefaultClient = client.NewClient(
client.Wrap(traceWrap),
client.Wrap(logWrap),
)
call(1)
} }

View File

@ -0,0 +1,91 @@
package main
import (
"fmt"
"time"
"github.com/micro/go-micro/client"
"github.com/micro/go-micro/cmd"
c "github.com/micro/go-micro/context"
example "github.com/micro/go-micro/examples/server/proto/example"
"golang.org/x/net/context"
)
// wrapper example code
// log wrapper logs every time a request is made
type logWrapper struct {
client.Client
}
func (l *logWrapper) Call(ctx context.Context, req client.Request, rsp interface{}) error {
md, _ := c.GetMetadata(ctx)
fmt.Printf("[Log Wrapper] ctx: %v service: %s method: %s\n", md, req.Service(), req.Method())
return l.Client.Call(ctx, req, rsp)
}
// trace wrapper attaches a unique trace ID - timestamp
type traceWrapper struct {
client.Client
}
func (t *traceWrapper) Call(ctx context.Context, req client.Request, rsp interface{}) error {
ctx = c.WithMetadata(ctx, map[string]string{
"X-Trace-Id": fmt.Sprintf("%d", time.Now().Unix()),
})
return t.Client.Call(ctx, req, rsp)
}
// Implements client.Wrapper as logWrapper
func logWrap(c client.Client) client.Client {
return &logWrapper{c}
}
// Implements client.Wrapper as traceWrapper
func traceWrap(c client.Client) client.Client {
return &traceWrapper{c}
}
func call(i int) {
// Create new request to service go.micro.srv.example, method Example.Call
req := client.NewRequest("go.micro.srv.example", "Example.Call", &example.Request{
Name: "John",
})
// create context with metadata
ctx := c.WithMetadata(context.Background(), map[string]string{
"X-User-Id": "john",
"X-From-Id": "script",
})
rsp := &example.Response{}
// Call service
if err := client.Call(ctx, req, rsp); err != nil {
fmt.Println("call err: ", err, rsp)
return
}
fmt.Println("Call:", i, "rsp:", rsp.Msg)
}
func main() {
cmd.Init()
fmt.Println("\n--- Log Wrapper example ---\n")
// Wrap the default client
client.DefaultClient = logWrap(client.DefaultClient)
call(0)
fmt.Println("\n--- Log+Trace Wrapper example ---\n")
// Wrap using client.Wrap option
client.DefaultClient = client.NewClient(
client.Wrap(traceWrap),
client.Wrap(logWrap),
)
call(1)
}

View File

@ -6,15 +6,25 @@ import (
"github.com/micro/go-micro/examples/server/handler" "github.com/micro/go-micro/examples/server/handler"
"github.com/micro/go-micro/examples/server/subscriber" "github.com/micro/go-micro/examples/server/subscriber"
"github.com/micro/go-micro/server" "github.com/micro/go-micro/server"
"golang.org/x/net/context"
) )
func logWrapper(fn server.HandlerFunc) server.HandlerFunc {
return func(ctx context.Context, req interface{}, rsp interface{}) error {
log.Infof("[Log Wrapper] Before serving request")
err := fn(ctx, req, rsp)
log.Infof("[Log Wrapper] After serving request")
return err
}
}
func main() { func main() {
// optionally setup command line usage // optionally setup command line usage
cmd.Init() cmd.Init()
// server.DefaultServer = server.NewServer( server.DefaultServer = server.NewServer(
// server.Codec("application/bson", bson.Codec), server.WrapHandler(logWrapper),
// ) )
// Initialise Server // Initialise Server
server.Init( server.Init(

View File

@ -8,17 +8,18 @@ import (
) )
type options struct { type options struct {
codecs map[string]codec.NewCodec codecs map[string]codec.NewCodec
broker broker.Broker broker broker.Broker
registry registry.Registry registry registry.Registry
transport transport.Transport transport transport.Transport
metadata map[string]string metadata map[string]string
name string name string
address string address string
advertise string advertise string
id string id string
version string version string
wrappers []Wrapper wrappers []HandlerWrapper
subWrappers []SubscriberWrapper
} }
func newOptions(opt ...Option) options { func newOptions(opt ...Option) options {
@ -156,8 +157,15 @@ func Metadata(md map[string]string) Option {
} }
// Adds a handler Wrapper to a list of options passed into the server // Adds a handler Wrapper to a list of options passed into the server
func Wrap(w Wrapper) Option { func WrapHandler(w HandlerWrapper) Option {
return func(o *options) { return func(o *options) {
o.wrappers = append(o.wrappers, w) o.wrappers = append(o.wrappers, w)
} }
} }
// Adds a subscriber Wrapper to a list of options passed into the server
func WrapSubscriber(w SubscriberWrapper) Option {
return func(o *options) {
o.subWrappers = append(o.subWrappers, w)
}
}

View File

@ -75,7 +75,7 @@ type server struct {
freeReq *request freeReq *request
respLock sync.Mutex // protects freeResp respLock sync.Mutex // protects freeResp
freeResp *response freeResp *response
wrappers []Wrapper wrappers []HandlerWrapper
} }
// Is this an exported - upper case - name? // Is this an exported - upper case - name?
@ -465,13 +465,6 @@ func (server *server) readRequestHeader(codec serverCodec) (service *service, mt
return return
} }
// A serverCodec implements reading of RPC requests and writing of
// RPC responses for the server side of an RPC session.
// The server calls ReadRequestHeader and ReadRequestBody in pairs
// to read requests from the connection, and it calls WriteResponse to
// write a response back. The server calls Close when finished with the
// connection. ReadRequestBody may be called with a nil
// argument to force the body of the request to be read and discarded.
type serverCodec interface { type serverCodec interface {
ReadRequestHeader(*request) error ReadRequestHeader(*request) error
ReadRequestBody(interface{}) error ReadRequestBody(interface{}) error

View File

@ -6,4 +6,8 @@ import (
type HandlerFunc func(ctx context.Context, req interface{}, rsp interface{}) error type HandlerFunc func(ctx context.Context, req interface{}, rsp interface{}) error
type Wrapper func(HandlerFunc) HandlerFunc type SubscriberFunc func(ctx context.Context, msg interface{}) error
type HandlerWrapper func(HandlerFunc) HandlerFunc
type SubscriberWrapper func(SubscriberFunc) SubscriberFunc