zdpgo_consul

README

zdpgo_consul

go使用consul作为注册中心

版本历史

• v0.1.2 2022/07/23 新增：负载均衡
• v0.1.3 2022/07/24 优化：注册和注销服务优化

Documentation

Index

• type Config
• type Consul
  • func New(config *Config) (*Consul, error)
  • func (c *Consul) Client() (*api.Client, error)
  • func (c *Consul) DeRegister(serviceId string) error
  • func (c *Consul) GetGrpcClientConn(serviceName string) (*grpc.ClientConn, error)
  • func (c *Consul) RegisterGrpc(config ServiceConfig) error
  • func (c *Consul) RegisterHTTP(config WebConfig) error
• type DeregisterHTTPConfig
• type ServiceConfig
• type WebConfig

Types

type Config

type Config struct {
	Host string // consul地址
	Port uint16 // consul端口号
}

Config consul配置对象

type Consul

type Consul struct {
	Config *Config // 配置对象
	// contains filtered or unexported fields
}

Consul consul核心对象

func New

func New(config *Config) (*Consul, error)

New 创建consul的实例 @param config consul配置对象

func (*Consul) Client

func (c *Consul) Client() (*api.Client, error)

Client 获取consul客户端

func (*Consul) DeRegister

func (c *Consul) DeRegister(serviceId string) error

DeRegister 注销服务

func (*Consul) GetGrpcClientConn

func (c *Consul) GetGrpcClientConn(serviceName string) (*grpc.ClientConn, error)

GetGrpcClientConn 获取GRPC的客户端连接 @param serviceName，consul中的grpc服务名称

func (*Consul) RegisterGrpc

func (c *Consul) RegisterGrpc(config ServiceConfig) error

RegisterGrpc 注册Grpc微服务到consul @param host 地址 @param port 端口号 @param name 名称 @param id ID @param tags 标签列表 @param isGrpc 是否为grpc

func (*Consul) RegisterHTTP

func (c *Consul) RegisterHTTP(config WebConfig) error

RegisterHTTP 注册HTTP服务

type DeregisterHTTPConfig

type DeregisterHTTPConfig struct {
	ConsulHost string // consul主机地址
	ConsulPort uint16 // consul端口号
	ServerId   string // 服务id
}

DeregisterHTTPConfig 注销http服务的配置

type ServiceConfig

type ServiceConfig struct {
	Host string   // 地址
	Port uint16   // 端口号
	Name string   // 名称
	Id   string   // ID
	Tags []string // 标签列表
}

ServiceConfig service服务配置对象

type WebConfig

type WebConfig struct {
	Host      string   // 地址
	Port      uint16   // 端口号
	Name      string   // 名称
	Id        string   // ID
	HealthUrl string   // 健康检查地址
	Tags      []string // 标签列表
}

WebConfig web服务配置对象