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
|
|
|
|
2019-05-23 00:35:02 +01:00
|
|
|
Go Micro is a framework for microservice development.
|
2016-06-20 02:52:38 +01:00
|
|
|
|
2018-11-27 19:43:57 +00:00
|
|
|
## Overview
|
|
|
|
|
|
|
|
Go Micro provides the core requirements for distributed systems development including RPC and Event driven communication.
|
|
|
|
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.
|
|
|
|
|
2019-01-29 09:08:14 +00:00
|
|
|
<img src="https://micro.mu/docs/images/go-micro.svg" />
|
2018-11-29 09:02:15 +00: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
|
|
|
|
2020-01-19 13:55:23 +00:00
|
|
|
Follow us on [Twitter](https://twitter.com/microhq) or join the [Community](https://micro.mu/slack).
|
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-12-02 13:23:46 +00:00
|
|
|
- **Service Discovery** - Automatic service registration and name resolution. Service discovery is at the core of micro service
|
2019-01-16 13:12:21 +00:00
|
|
|
development. When service A needs to speak to service B it needs the location of that service. The default discovery mechanism is
|
2019-11-06 22:04:02 +00:00
|
|
|
multicast DNS (mdns), a zeroconf system.
|
2018-12-02 13:23:46 +00:00
|
|
|
|
|
|
|
- **Load Balancing** - Client side load balancing built on service discovery. Once we have the addresses of any number of instances
|
|
|
|
of a service we now need a way to decide which node to route to. We use random hashed load balancing to provide even distribution
|
|
|
|
across the services and retry a different node if there's a problem.
|
|
|
|
|
|
|
|
- **Message Encoding** - Dynamic message encoding based on content-type. The client and server will use codecs along with content-type
|
|
|
|
to seamlessly encode and decode Go types for you. Any variety of messages could be encoded and sent from different clients. The client
|
2018-12-26 12:03:08 +00:00
|
|
|
and server handle this by default. This includes protobuf and json by default.
|
2018-12-02 13:23:46 +00:00
|
|
|
|
2019-02-09 12:25:34 +00:00
|
|
|
- **Request/Response** - RPC based request/response with support for bidirectional streaming. We provide an abstraction for synchronous
|
2018-12-02 13:23:46 +00:00
|
|
|
communication. A request made to a service will be automatically resolved, load balanced, dialled and streamed. The default
|
2020-01-19 13:51:31 +00:00
|
|
|
transport is [gRPC](https://grpc.io/).
|
2018-12-02 13:23:46 +00:00
|
|
|
|
|
|
|
- **Async Messaging** - PubSub is built in as a first class citizen for asynchronous communication and event driven architectures.
|
2020-01-19 13:51:31 +00:00
|
|
|
Event notifications are a core pattern in micro service development. The default messaging system is an embedded [NATS](https://nats.io/)
|
|
|
|
server.
|
2018-11-27 19:43:57 +00:00
|
|
|
|
2018-12-02 13:26:38 +00:00
|
|
|
- **Pluggable Interfaces** - Go Micro makes use of Go interfaces for each distributed system abstraction. Because of this these interfaces
|
|
|
|
are pluggable and allows Go Micro to be runtime agnostic. You can plugin any underlying technology. Find plugins in
|
|
|
|
[github.com/micro/go-plugins](https://github.com/micro/go-plugins).
|
|
|
|
|
2018-11-14 15:18:13 +00:00
|
|
|
## Getting Started
|
2017-02-10 12:36:42 +00:00
|
|
|
|
2019-11-09 15:37:30 +00:00
|
|
|
See the [docs](https://micro.mu/docs/framework.html) for detailed information on the architecture, installation and use of go-micro.
|
2017-02-10 12:36:42 +00:00
|
|
|
|