Registry - Consul Integration

Code Source: https://github.com/gogf/examples/tree/main/registry/consul

Description

This example demonstrates how to integrate Consul service registry with GoFrame applications. It shows how to:

• Register services with Consul
• Discover services using Consul
• Implement service health checks
• Build distributed systems

Structure

.
├── docker-compose/      # Docker compose files for running Consul
├── grpc/                # gRPC service examples
│   ├── client/          # gRPC client implementation
│   ├── controller/      # gRPC service controllers
│   ├── protobuf/        # Protocol buffer definitions
│   └── server/          # gRPC server implementation
│       ├── main.go      # Server startup code
│       └── config.yaml  # Server configuration
├── http/                # HTTP service examples
│   ├── client/          # HTTP client implementation
│   └── server/          # HTTP server implementation
├── go.mod               # Go module file
└── go.sum               # Go module checksums

Features

The example showcases the following features:

1. Service Registration

   • Automatic service registration
   • Health check configuration
   • Metadata management

2. Service Discovery

   • Dynamic service discovery
   • Load balancing
   • Failover support

3. Protocol Support

   • HTTP services
   • gRPC services
   • Custom protocols

Requirements

• Go 1.22 or higher
• Git
• GoFrame
• GoFrame Consul Registry
• Consul

Prerequisites

1. Running Consul server:

   # Using docker-compose
   cd docker-compose
   docker-compose up -d

Usage

HTTP Example

1. Start the HTTP server:

   cd http/server
   go run server.go

2. Run the HTTP client:

   cd http/client
   go run client.go

gRPC Example

1. Start the gRPC server:

   cd grpc/server
   go run server.go

2. Run the gRPC client:

   cd grpc/client
   go run client.go

Implementation Details

The example demonstrates:

1. Consul client configuration
2. Service registration process
3. Service discovery mechanism
4. Health check implementation
5. Load balancing strategies