Interfaces on Go Micro

Client Server

Mon, 01 Jan 0001 00:00:00 +0000

The client is used to make requests to other services.
The server handles incoming requests.

Both client and server are pluggable and support middleware wrappers for additional functionality.

Example Usage

Here’s how to define a simple handler and register it with a Go Micro server:

package main

import (
 "context"
 "go-micro.dev/v6"
 "log"
)

type Greeter struct{}

func (g *Greeter) Hello(ctx context.Context, req *struct{}, rsp *struct{Msg string}) error {
 rsp.Msg = "Hello, world!"
 return nil
}

func main() {
 service := micro.NewService("greeter",
 )
 service.Init()
 micro.RegisterHandler(service.Server(), new(Greeter))
 if err := service.Run(); err != nil {
 log.Fatal(err)
 }
}

Registry

Mon, 01 Jan 0001 00:00:00 +0000

Features

Service registration and deregistration
Service lookup
Watch for changes

Implementations

Go Micro supports multiple registry backends, including:

MDNS (default)
Consul
Etcd
NATS

You can configure the registry when initializing your service.

Plugins Location

Registry plugins live in this repository under go-micro.dev/v6/registry/<plugin> (e.g., consul, etcd, nats). Import the desired package and pass it via micro.Registry(...).

Broker

Mon, 01 Jan 0001 00:00:00 +0000

Features

Publish messages to topics
Subscribe to topics
Multiple broker implementations

Implementations

Supported brokers include:

HTTP (default)
NATS (go-micro.dev/v6/broker/nats)
RabbitMQ (go-micro.dev/v6/broker/rabbitmq)
Memory (go-micro.dev/v6/broker/memory)

Plugins are scoped under go-micro.dev/v6/broker/<plugin>.

Configure the broker in code or via environment variables.

Example Usage

Here’s how to use the broker in your Go Micro service:

Transport

Mon, 01 Jan 0001 00:00:00 +0000

Features

Pluggable transport implementations
Secure and efficient communication

Implementations

Supported transports include:

HTTP (default)
NATS (go-micro.dev/v6/transport/nats)
gRPC (go-micro.dev/v6/transport/grpc)
Memory (go-micro.dev/v6/transport/memory)

Important: Transport vs Native gRPC

The gRPC transport uses gRPC as an underlying communication protocol, similar to how NATS or RabbitMQ might be used. It does not provide native gRPC compatibility with tools like grpcurl or standard gRPC clients generated by protoc.

Store

Mon, 01 Jan 0001 00:00:00 +0000

Features

Key-value storage
Multiple backend support

Implementations

Supported stores include:

Memory (default)
File (go-micro.dev/v6/store/file)
MySQL (go-micro.dev/v6/store/mysql)
Postgres (go-micro.dev/v6/store/postgres)
NATS JetStream KV (go-micro.dev/v6/store/nats-js-kv)

Plugins are scoped under go-micro.dev/v6/store/<plugin>.

Configure the store in code or via environment variables.

Example Usage

Here’s how to use the store in your Go Micro service:

package main

import (
 "go-micro.dev/v6"
 "go-micro.dev/v6/store"
 "log"
)

func main() {
 service := micro.NewService("store-example")
 service.Init()

 // Write a record
 if err := store.Write(&store.Record{Key: "foo", Value: []byte("bar")}); err != nil {
 log.Fatal(err)
 }

 // Read a record
 recs, err := store.Read("foo")
 if err != nil {
 log.Fatal(err)
 }
 log.Printf("Read value: %s", string(recs[0].Value))
}

Configure a specific store in code

Postgres:

Plugins

Mon, 01 Jan 0001 00:00:00 +0000

Common interfaces and locations:

Registry: go-micro.dev/v6/registry/* (e.g. consul, etcd, nats, mdns)
Broker: go-micro.dev/v6/broker/* (e.g. nats, rabbitmq, http, memory)
Transport: go-micro.dev/v6/transport/* (e.g. nats, default http)
Server: go-micro.dev/v6/server/* (e.g. grpc for native gRPC compatibility)
Client: go-micro.dev/v6/client/* (e.g. grpc for native gRPC compatibility)
Store: go-micro.dev/v6/store/* (e.g. postgres, mysql, nats-js-kv, memory)
Auth, Cache, etc. follow the same pattern under their respective directories.

Registry Examples

Consul:

import (
 "go-micro.dev/v6"
 "go-micro.dev/v6/registry/consul"
)

func main() {
 reg := consul.NewConsulRegistry()
 svc := micro.NewService("plugin-example",
 micro.Registry(reg),
 )
 svc.Init()
 svc.Run()
}

Etcd: