github.com/annwntech/go-micro/v2@v2.9.5/README.md (about)

     1  This is hard fork of go-micro which is initially developed by Asim Aslam.
     2  This fork will follow the same plugable architecture which was it's core feature. I have not decided for major v3 upgrade for now but later If it is needed upgrade will be done after proper discussion.
     3  
     4  Also I haven't thought about name. File/Folder structure is same as before.
     5  
     6  # Go Micro [![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Go.Dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/annwntech/go-micro/v2?tab=doc) [![Travis CI](https://api.travis-ci.org/annwntech/go-micro.svg?branch=master)](https://travis-ci.org/annwntech/go-micro) [![Go Report Card](https://goreportcard.com/badge/annwntech/go-micro)](https://goreportcard.com/report/github.com/annwntech/go-micro)
     7  
     8  Go Micro is a framework for distributed systems development.
     9  
    10  ## Overview
    11  
    12  Go Micro provides the core requirements for distributed systems development including RPC and Event driven communication.
    13  The **Micro** philosophy is sane defaults with a pluggable architecture. We provide defaults to get you started quickly
    14  but everything can be easily swapped out.
    15  
    16  ## Features
    17  
    18  Go Micro abstracts away the details of distributed systems. Here are the main features.
    19  
    20  - **Authentication** - Auth is built in as a first class citizen. Authentication and authorization enable secure
    21    zero trust networking by providing every service an identity and certificates. This additionally includes rule
    22    based access control.
    23  
    24  - **Dynamic Config** - Load and hot reload dynamic config from anywhere. The config interface provides a way to load application
    25    level config from any source such as env vars, file, etcd. You can merge the sources and even define fallbacks.
    26  
    27  - **Data Storage** - A simple data store interface to read, write and delete records. It includes support for memory, file and
    28    CockroachDB by default. State and persistence becomes a core requirement beyond prototyping and Micro looks to build that into the framework.
    29  
    30  - **Service Discovery** - Automatic service registration and name resolution. Service discovery is at the core of micro service
    31    development. When service A needs to speak to service B it needs the location of that service. The default discovery mechanism is
    32    multicast DNS (mdns), a zeroconf system.
    33  
    34  - **Load Balancing** - Client side load balancing built on service discovery. Once we have the addresses of any number of instances
    35    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
    36    across the services and retry a different node if there's a problem.
    37  
    38  - **Message Encoding** - Dynamic message encoding based on content-type. The client and server will use codecs along with content-type
    39    to seamlessly encode and decode Go types for you. Any variety of messages could be encoded and sent from different clients. The client
    40    and server handle this by default. This includes protobuf and json by default.
    41  
    42  - **gRPC Transport** - gRPC based request/response with support for bidirectional streaming. We provide an abstraction for synchronous communication. A request made to a service will be automatically resolved, load balanced, dialled and streamed.
    43  
    44  - **Async Messaging** - PubSub is built in as a first class citizen for asynchronous communication and event driven architectures.
    45    Event notifications are a core pattern in micro service development. The default messaging system is a HTTP event message broker.
    46  
    47  - **Synchronization** - Distributed systems are often built in an eventually consistent manner. Support for distributed locking and
    48    leadership are built in as a Sync interface. When using an eventually consistent database or scheduling use the Sync interface.
    49  
    50  - **Pluggable Interfaces** - Go Micro makes use of Go interfaces for each distributed system abstraction. Because of this these interfaces
    51    are pluggable and allows Go Micro to be runtime agnostic. You can plugin any underlying technology. Find plugins in
    52    [github.com/annwntech/go-micro-plugins](https://github.com/annwntech/go-micro-plugins).
    53  
    54  ## Getting Started
    55  
    56  To make use of Go Micro
    57  
    58  ```golang
    59  import "github.com/annwntech/go-micro/v2"
    60  
    61  // create a new service
    62  service := micro.NewService(
    63      micro.Name("helloworld"),
    64  )
    65  
    66  // initialise flags
    67  service.Init()
    68  
    69  // start the service
    70  service.Run()
    71  ```
    72  
    73  See the [docs](https://dev.m3o.com) for detailed information on the architecture, installation and use of go-micro.
    74  
    75  ## License
    76  
    77  Go Micro is Apache 2.0 licensed.