micro/README.md

460 lines
12 KiB
Markdown
Raw Normal View History

2016-06-20 02:54:06 +01:00
# Go Micro [![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GoDoc](https://godoc.org/github.com/micro/go-micro?status.svg)](https://godoc.org/github.com/micro/go-micro) [![Travis CI](https://api.travis-ci.org/micro/go-micro.svg?branch=master)](https://travis-ci.org/micro/go-micro) [![Go Report Card](https://goreportcard.com/badge/micro/go-micro)](https://goreportcard.com/report/github.com/micro/go-micro)
2015-01-13 23:31:27 +00:00
2017-11-30 09:16:54 +00:00
Go Micro is a pluggable RPC framework for distributed systems development.
2015-11-29 20:46:31 +00:00
2018-03-19 10:21:46 +00:00
The **micro** philosophy is sane defaults with a pluggable architecture. We provide defaults to get you started quickly but everything can be easily swapped out. It comes with built in support for {json,proto}-rpc encoding, consul or multicast dns for service discovery, http for communication and random hashed client side load balancing.
2016-06-20 02:52:38 +01:00
2018-03-19 10:21:46 +00:00
Plugins are available at [github.com/micro/go-plugins](https://github.com/micro/go-plugins).
2015-01-14 08:38:39 +00:00
2017-07-16 14:58:31 +01:00
Follow us on [Twitter](https://twitter.com/microhq) or join the [Slack](http://slack.micro.mu/) community.
2016-12-25 20:53:08 +00:00
2016-12-07 16:54:19 +00:00
## Features
2016-07-03 02:49:13 +01:00
2017-06-15 19:57:27 +01:00
Go Micro abstracts away the details of distributed systems. Here are the main features.
2016-07-03 02:49:13 +01:00
2018-01-30 16:18:11 +00:00
- **Service Discovery** - Automatic service registration and name resolution
- **Load Balancing** - Client side load balancing built on discovery
2018-04-05 13:50:10 +01:00
- **Message Encoding** - Dynamic encoding based on content-type with protobuf and json support
- **Sync Streaming** - RPC based communication with support for bidirectional streaming
- **Async Messaging** - Native PubSub messaging built in for event driven architectures
2016-07-03 02:49:13 +01:00
2017-06-01 12:26:57 +01:00
Go Micro supports both the Service and Function programming models. Read on to learn more.
2017-02-10 12:36:42 +00:00
## Docs
For more detailed information on the architecture, installation and use of go-micro checkout the [docs](https://micro.mu/docs).
2016-07-03 02:49:13 +01:00
## Learn By Example
2017-10-03 11:03:46 +01:00
An example service can be found in [**examples/service**](https://github.com/micro/examples/tree/master/service) and function in [**examples/function**](https://github.com/micro/examples/tree/master/function).
2015-01-14 08:38:39 +00:00
2017-10-03 11:03:46 +01:00
The [**examples**](https://github.com/micro/examples) directory contains examples for using things such as middleware/wrappers, selector filters, pub/sub, grpc, plugins and much more. For the complete greeter example look at [**examples/greeter**](https://github.com/micro/examples/tree/master/greeter). Other examples can be found throughout the GitHub repository.
Watch the [Golang UK Conf 2016](https://www.youtube.com/watch?v=xspaDovwk34) video for a high level overview.
2016-04-13 11:30:17 +01:00
2017-10-26 12:16:17 +01:00
## Getting started
2015-01-14 10:50:43 +00:00
2018-02-28 15:38:50 +00:00
- [Install Protobuf](#install-protobuf)
2017-10-26 12:16:17 +01:00
- [Service Discovery](#service-discovery)
- [Writing a Service](#writing-a-service)
- [Writing a Function](#writing-a-function)
2018-03-22 16:43:57 +00:00
- [Publish & Subscribe](#publish--subscribe)
2017-10-26 12:16:17 +01:00
- [Plugins](#plugins)
- [Wrappers](#wrappers)
2016-02-06 13:32:01 +00:00
2018-02-28 15:38:50 +00:00
## Install Protobuf
Protobuf is required for code generation
You'll need to install:
- [protoc-gen-micro](https://github.com/micro/protoc-gen-micro)
2017-10-26 12:16:17 +01:00
## Service Discovery
2017-10-03 11:03:46 +01:00
2018-02-28 15:40:41 +00:00
Service discovery is used to resolve service names to addresses.
2016-11-19 14:31:07 +00:00
2017-01-22 14:12:53 +00:00
### Consul
2016-11-19 14:31:07 +00:00
2017-10-26 12:19:42 +01:00
[Consul](https://www.consul.io/) is used as the default service discovery system.
2016-11-19 14:31:07 +00:00
2017-10-26 12:19:42 +01:00
Discovery is pluggable. Find plugins for etcd, kubernetes, zookeeper and more in the [micro/go-plugins](https://github.com/micro/go-plugins) repo.
2016-11-19 14:31:07 +00:00
2017-10-26 12:19:42 +01:00
[Install guide](https://www.consul.io/intro/getting-started/install.html)
2017-01-22 14:12:53 +00:00
2017-10-26 12:16:17 +01:00
### Multicast DNS
2017-10-03 11:03:46 +01:00
2017-10-26 12:16:17 +01:00
[Multicast DNS](https://en.wikipedia.org/wiki/Multicast_DNS) is a built in service discovery plugin for a zero dependency configuration.
2015-01-14 08:38:39 +00:00
2018-02-01 13:54:37 +00:00
Pass `--registry=mdns` to any command or the enviroment variable `MICRO_REGISTRY=mdns`
2017-10-03 11:03:46 +01:00
```
2018-02-28 15:40:41 +00:00
MICRO_REGISTRY=mdns go run main.go
2015-01-14 08:38:39 +00:00
```
2015-01-14 10:50:43 +00:00
## Writing a service
2017-10-03 11:03:46 +01:00
This is a simple greeter RPC service example
Find this example at [examples/service](https://github.com/micro/examples/tree/master/service).
2016-12-07 16:54:19 +00:00
### Create service proto
2016-03-11 23:58:55 +00:00
2017-10-03 11:03:46 +01:00
One of the key requirements of microservices is strongly defined interfaces. Micro uses protobuf to achieve this.
2016-03-11 23:58:55 +00:00
2017-10-03 11:03:46 +01:00
Here we define the Greeter handler with the method Hello. It takes a HelloRequest and HelloResponse both with one string arguments.
2015-01-14 10:50:43 +00:00
2016-01-03 23:36:14 +00:00
```proto
2015-05-25 18:16:42 +01:00
syntax = "proto3";
2015-01-14 10:50:43 +00:00
2016-01-02 00:38:57 +00:00
service Greeter {
rpc Hello(HelloRequest) returns (HelloResponse) {}
2015-01-14 10:50:43 +00:00
}
2016-01-02 00:38:57 +00:00
message HelloRequest {
string name = 1;
2015-01-14 10:50:43 +00:00
}
2016-01-02 00:38:57 +00:00
message HelloResponse {
string greeting = 2;
}
```
2017-10-03 11:03:46 +01:00
### Generate the proto
2016-03-12 00:04:33 +00:00
2017-10-03 11:03:46 +01:00
After writing the proto definition we must compile it using protoc with the micro plugin.
2016-03-12 00:04:33 +00:00
2016-11-20 15:02:05 +00:00
```shell
2018-02-28 15:38:50 +00:00
protoc --proto_path=$GOPATH/src:. --micro_out=. --go_out=. path/to/greeter.proto
2016-03-12 00:04:33 +00:00
```
2015-01-14 10:50:43 +00:00
2017-10-03 11:03:46 +01:00
### Write the service
Below is the code for the greeter service.
2016-03-12 00:04:33 +00:00
2017-10-03 11:03:46 +01:00
It does the following:
2016-03-12 00:04:33 +00:00
2017-10-03 11:03:46 +01:00
1. Implements the interface defined for the Greeter handler
2. Initialises a micro.Service
3. Registers the Greeter handler
4. Runs the service
2015-01-14 10:50:43 +00:00
2015-02-02 18:53:16 +00:00
```go
2016-01-02 00:38:57 +00:00
package main
2015-01-14 10:50:43 +00:00
import (
2018-03-03 11:53:52 +00:00
"context"
2016-01-02 00:38:57 +00:00
"fmt"
2015-01-14 10:50:43 +00:00
2016-01-02 00:38:57 +00:00
micro "github.com/micro/go-micro"
2017-01-05 15:09:27 +00:00
proto "github.com/micro/examples/service/proto"
2015-01-14 10:50:43 +00:00
)
2016-01-02 00:38:57 +00:00
type Greeter struct{}
2015-01-14 10:50:43 +00:00
2016-01-02 00:38:57 +00:00
func (g *Greeter) Hello(ctx context.Context, req *proto.HelloRequest, rsp *proto.HelloResponse) error {
rsp.Greeting = "Hello " + req.Name
2015-11-08 11:12:09 +00:00
return nil
2015-01-14 10:50:43 +00:00
}
2016-01-02 00:38:57 +00:00
func main() {
// Create a new service. Optionally include some options here.
service := micro.NewService(
micro.Name("greeter"),
)
2017-07-14 08:24:46 +01:00
// Init will parse the command line flags.
2016-01-02 00:38:57 +00:00
service.Init()
// Register handler
proto.RegisterGreeterHandler(service.Server(), new(Greeter))
// Run the server
if err := service.Run(); err != nil {
fmt.Println(err)
}
}
2015-01-14 10:50:43 +00:00
```
2016-01-02 00:38:57 +00:00
### Run service
```
2016-03-14 11:01:10 +00:00
go run examples/service/main.go
2017-10-03 11:03:46 +01:00
```
Output
```
2016-03-14 11:01:10 +00:00
2016/03/14 10:59:14 Listening on [::]:50137
2016/03/14 10:59:14 Broker Listening on [::]:50138
2016/03/14 10:59:14 Registering node: greeter-ca62b017-e9d3-11e5-9bbb-68a86d0d36b6
2016-01-02 00:38:57 +00:00
```
### Define a client
2017-10-03 11:03:46 +01:00
Below is the client code to query the greeter service.
2016-03-12 00:04:33 +00:00
2017-10-03 11:03:46 +01:00
The generated proto includes a greeter client to reduce boilerplate code.
2015-01-14 10:50:43 +00:00
2015-02-02 18:53:16 +00:00
```go
2015-01-14 10:50:43 +00:00
package main
import (
2018-03-03 11:53:52 +00:00
"context"
2016-01-02 00:38:57 +00:00
"fmt"
micro "github.com/micro/go-micro"
2017-01-05 15:09:27 +00:00
proto "github.com/micro/examples/service/proto"
2015-01-14 10:50:43 +00:00
)
2015-05-25 18:16:42 +01:00
2016-01-02 00:38:57 +00:00
func main() {
// Create a new service. Optionally include some options here.
service := micro.NewService(micro.Name("greeter.client"))
2018-02-28 15:38:50 +00:00
service.Init()
2015-01-14 10:50:43 +00:00
2016-01-02 00:38:57 +00:00
// Create new greeter client
2018-04-25 16:03:22 +01:00
greeter := proto.NewGreeterService("greeter", service.Client())
2015-01-14 10:50:43 +00:00
2016-01-02 00:38:57 +00:00
// Call the greeter
rsp, err := greeter.Hello(context.TODO(), &proto.HelloRequest{Name: "John"})
if err != nil {
fmt.Println(err)
2015-01-14 10:50:43 +00:00
}
2016-01-02 00:38:57 +00:00
// Print response
fmt.Println(rsp.Greeting)
2015-01-14 10:50:43 +00:00
}
```
2016-01-02 00:38:57 +00:00
### Run the client
```shell
go run client.go
2017-10-03 11:03:46 +01:00
```
Output
```
2016-01-02 00:38:57 +00:00
Hello John
2015-01-14 10:50:43 +00:00
```
2016-03-12 00:07:14 +00:00
2017-06-01 12:26:57 +01:00
## Writing a Function
2017-10-03 11:03:46 +01:00
Go Micro includes the Function programming model.
A Function is a one time executing Service which exits after completing a request.
2017-06-01 12:26:57 +01:00
### Defining a Function
```go
package main
import (
2018-03-03 11:53:52 +00:00
"context"
2017-06-01 12:26:57 +01:00
proto "github.com/micro/examples/function/proto"
"github.com/micro/go-micro"
)
type Greeter struct{}
func (g *Greeter) Hello(ctx context.Context, req *proto.HelloRequest, rsp *proto.HelloResponse) error {
rsp.Greeting = "Hello " + req.Name
return nil
}
func main() {
// create a new function
fnc := micro.NewFunction(
2018-03-09 19:11:42 +00:00
micro.Name("greeter"),
2017-06-01 12:26:57 +01:00
)
// init the command line
fnc.Init()
// register a handler
fnc.Handle(new(Greeter))
// run the function
fnc.Run()
}
```
It's that simple.
2018-03-22 16:43:57 +00:00
## Publish & Subscribe
Go-micro has a built in message broker interface for event driven architectures.
PubSub operates on the same protobuf generated messages as RPC. They are encoded/decoded automatically and sent via the broker.
By default go-micro includes a point-to-point http broker but this can be swapped out via go-plugins.
2018-03-22 16:44:40 +00:00
### Publish
2018-03-22 16:43:57 +00:00
Create a new publisher with a `topic` name and service client
2018-03-22 17:32:16 +00:00
```go
2018-03-22 16:43:57 +00:00
p := micro.NewPublisher("events", service.Client())
```
2018-03-22 16:44:40 +00:00
Publish a proto message
2018-03-22 16:43:57 +00:00
2018-03-22 17:32:16 +00:00
```go
2018-03-22 16:43:57 +00:00
p.Publish(context.TODO(), &proto.Event{Name: "event"})
```
### Subscribe
Create a message handler. It's signature should be `func(context.Context, v interface{}) error`.
2018-03-22 17:32:16 +00:00
```go
2018-03-22 16:43:57 +00:00
func ProcessEvent(ctx context.Context, event *proto.Event) error {
fmt.Printf("Got event %+v\n", event)
return nil
}
```
Register the message handler with a `topic`
2018-03-22 17:32:16 +00:00
```go
2018-03-22 16:43:57 +00:00
micro.RegisterSubscriber("events", ProcessEvent)
```
2018-03-22 16:46:34 +00:00
See [examples/pubsub](https://github.com/micro/examples/tree/master/pubsub) for a complete example.
2016-12-07 16:54:19 +00:00
## Plugins
2016-10-04 17:34:45 +01:00
By default go-micro only provides a few implementation of each interface at the core but it's completely pluggable. There's already dozens of plugins which are available at [github.com/micro/go-plugins](https://github.com/micro/go-plugins). Contributions are welcome!
2017-01-04 14:54:31 +00:00
### Build with plugins
If you want to integrate plugins simply link them in a separate file and rebuild
Create a plugins.go file
2017-02-15 15:17:10 +00:00
2017-01-04 14:54:31 +00:00
```go
import (
// etcd v3 registry
_ "github.com/micro/go-plugins/registry/etcdv3"
// nats transport
_ "github.com/micro/go-plugins/transport/nats"
// kafka broker
_ "github.com/micro/go-plugins/broker/kafka"
2017-01-04 16:43:43 +00:00
)
2017-01-04 14:54:31 +00:00
```
Build binary
2017-02-15 15:17:10 +00:00
2017-01-04 14:54:31 +00:00
```shell
// For local use
go build -i -o service ./main.go ./plugins.go
```
Flag usage of plugins
```shell
service --registry=etcdv3 --transport=nats --broker=kafka
```
2018-01-30 16:18:11 +00:00
### Plugin as option
Alternatively you can set the plugin as an option to a service
```go
import (
"github.com/micro/go-micro"
// etcd v3 registry
"github.com/micro/go-plugins/registry/etcdv3"
// nats transport
"github.com/micro/go-plugins/transport/nats"
// kafka broker
"github.com/micro/go-plugins/broker/kafka"
)
func main() {
registry := etcdv3.NewRegistry()
broker := kafka.NewBroker()
transport := nats.NewTransport()
service := micro.NewService(
micro.Name("greeter"),
micro.Registry(registry),
micro.Broker(broker),
micro.Transport(transport),
)
service.Init()
service.Run()
}
```
### Write plugins
Plugins are a concept built on Go's interface. Each package maintains a high level interface abstraction.
Simply implement the interface and pass it in as an option to the service.
The service discovery interface is called [Registry](https://godoc.org/github.com/micro/go-micro/registry#Registry).
Anything which implements this interface can be used as a registry. The same applies to the other packages.
```go
type Registry interface {
Register(*Service, ...RegisterOption) error
Deregister(*Service) error
GetService(string) ([]*Service, error)
ListServices() ([]*Service, error)
Watch() (Watcher, error)
String() string
}
```
Browse [go-plugins](https://github.com/micro/go-plugins) to get a better idea of implementation details.
2017-10-26 12:02:10 +01:00
## Wrappers
Go-micro includes the notion of middleware as wrappers. The client or handlers can be wrapped using the decorator pattern.
### Handler
Here's an example service handler wrapper which logs the incoming request
2017-10-26 12:02:52 +01:00
```go
2017-10-26 12:02:10 +01:00
// implements the server.HandlerWrapper
func logWrapper(fn server.HandlerFunc) server.HandlerFunc {
return func(ctx context.Context, req server.Request, rsp interface{}) error {
fmt.Printf("[%v] server request: %s", time.Now(), req.Method())
return fn(ctx, req, rsp)
}
}
```
It can be initialised when creating the service
2017-10-26 12:02:52 +01:00
```go
2017-10-26 12:02:10 +01:00
service := micro.NewService(
micro.Name("greeter"),
// wrap the handler
micro.WrapHandler(logWrapper),
)
```
### Client
Here's an example of a client wrapper which logs requests made
2017-10-26 12:02:52 +01:00
```go
2017-10-26 12:02:10 +01:00
type logWrapper struct {
client.Client
}
func (l *logWrapper) Call(ctx context.Context, req client.Request, rsp interface{}, opts ...client.CallOption) error {
fmt.Printf("[wrapper] client request to service: %s method: %s\n", req.Service(), req.Method())
return l.Client.Call(ctx, req, rsp)
}
// implements client.Wrapper as logWrapper
func logWrap(c client.Client) client.Client {
return &logWrapper{c}
}
```
It can be initialised when creating the service
2017-10-26 12:02:52 +01:00
```go
2017-10-26 12:02:10 +01:00
service := micro.NewService(
micro.Name("greeter"),
// wrap the client
micro.WrapClient(logWrap),
)
```
2017-02-07 18:33:50 +00:00
## Other Languages
2017-02-15 14:31:20 +00:00
Check out [ja-micro](https://github.com/Sixt/ja-micro) to write services in Java
2017-02-07 18:33:50 +00:00
2016-04-26 12:18:18 +01:00
## Sponsors
2018-04-12 12:09:36 +01:00
Sixt is an Enterprise Sponsor of Micro
2016-04-26 12:18:18 +01:00
2017-02-11 14:26:47 +00:00
<a href="https://micro.mu/blog/2016/04/25/announcing-sixt-sponsorship.html"><img src="https://micro.mu/sixt_logo.png" width=150px height="auto" /></a>
2018-04-12 12:09:36 +01:00
Become a sponsor by backing micro on [Patreon](https://www.patreon.com/microhq)