nacos

Documentation

Index

• Constants
• func GetUniqueID() int64
• func NacosAddr() string
• func NacosNameSpaceId() string
• func NacosPort() uint64
• func NewCustomNacosLogger() logger.Logger
• type Client
  • func NewClient(opts Options) (Client, error)
• type ConfigParamConfig
• type ConfigParser
• type CustomFunction
• type Options

Constants

const (
	NacosAliServerAddrEnv = "serverAddr"
	NacosAliPortEnv       = "serverPort"
	NacosAliNamespaceEnv  = "namespace"
)

keep consistent with the env with alicloud

const (
	NacosDefaultServerAddr   = "127.0.0.1"
	NacosDefaultPort         = 8848
	NacosDefaultConfigGroup  = "DEFAULT_GROUP"
	NacosDefaultClientDataID = "{{.ClientServiceName}}.{{.ServerServiceName}}.{{.Category}}"
	NacosDefaultServerDataID = "{{.ServerServiceName}}.{{.Category}}"
)

Functions

func GetUniqueID

func GetUniqueID() int64

GetUniqueID get the unique id

func NacosAddr

func NacosAddr() string

NacosAddr Get Nacos addr from environment variables

func NacosNameSpaceId

func NacosNameSpaceId() string

NacosNameSpaceId Get Nacos namespace id from environment variables

func NacosPort

func NacosPort() uint64

NacosPort Get Nacos port from environment variables

func NewCustomNacosLogger

func NewCustomNacosLogger() logger.Logger

Types

type Client

type Client interface {
	SetParser(ConfigParser)
	ClientConfigParam(cpc *ConfigParamConfig) (vo.ConfigParam, error)
	ServerConfigParam(cpc *ConfigParamConfig) (vo.ConfigParam, error)
	RegisterConfigCallback(vo.ConfigParam, func(string, ConfigParser), int64)
	DeregisterConfig(vo.ConfigParam, int64) error
}

Client the wrapper of nacos client.

func NewClient

func NewClient(opts Options) (Client, error)

NewClient Create a default Nacos client

type ConfigParamConfig

type ConfigParamConfig struct {
	Category          string
	ClientServiceName string
	ServerServiceName string
}

ConfigParamConfig use for render the dataId or group info by go template, ref: https://pkg.go.dev/text/template The fixed key shows as below.

type ConfigParser

type ConfigParser interface {
	Decode(kind vo.ConfigType, data string, config interface{}) error
}

ConfigParser the parser for nacos config.

type CustomFunction

type CustomFunction func(*vo.ConfigParam)

CustomFunction use for customize the config parameters.

type Options

type Options struct {
	Address            string
	Port               uint64
	NamespaceID        string
	RegionID           string
	Group              string
	ServerDataIDFormat string
	ClientDataIDFormat string
	CustomLogger       logger.Logger
	Password           string
	Username           string
	ConfigParser       ConfigParser
}

Options nacos config options. All the fields have default value.