nacoscli

README

nacoscli

Get the configuration from the nacos configuration center.

Example of use

	import "github.com/18721889353/sunshine/pkg/nacoscli"

	// Way 1: setting parameters
	a := &config{}
	params := &nacoscli.Params{
		IpAddr:      "192.168.3.37",
		Port:        8848,
		NamespaceId: "de7b176e-91cd-49a3-ac83-beb725979775",
		Group:       "dev",
		DataId:      "user-srv.yml",
		Format:      "yaml",
	}
	_, _, err = nacoscli.GetConfig(params)

	// --- or ---

	// Way 2: setting up ClientConfig and ServerConfig
	a = &config{}
	params = &nacoscli.Params{
		Group:  "dev",
		DataId: "user-srv.yml",
		Format: "yaml",
	}
	clientConfig := &constant.ClientConfig{
		NamespaceId:         "de7b176e-91cd-49a3-ac83-beb725979775",
		TimeoutMs:           5000,
		NotLoadCacheAtStart: true,
		LogDir:              os.TempDir() + "/nacos/log",
		CacheDir:            os.TempDir() + "/nacos/cache",
	}
	serverConfigs := []constant.ServerConfig{
		{
			IpAddr: "192.168.3.37",
			Port:   8848,
		},
	}
	_, _, err = nacoscli.GetConfig(params,
		nacoscli.WithClientConfig(clientConfig),
		nacoscli.WithServerConfigs(serverConfigs),
	)

Documentation

Index

• func GetConfig(params *Params, opts ...Option) (string, []byte, error)
• func Init(_ interface{}, _ *Params, _ ...Option) error
• func NewNamingClient(nacosIPAddr string, nacosPort int, nacosNamespaceID string, opts ...Option) (naming_client.INamingClient, error)
• type Option
  • func WithAuth(username string, password string) Option
  • func WithClientConfig(clientConfig *constant.ClientConfig) Option
  • func WithServerConfigs(serverConfigs []constant.ServerConfig) Option
• type Params

Functions

func GetConfig

func GetConfig(params *Params, opts ...Option) (string, []byte, error)

GetConfig 从 Nacos 获取配置并返回配置内容。

func Init

func Init(_ interface{}, _ *Params, _ ...Option) error

Init 从 Nacos 获取配置并解析为结构体，用于配置中心。

已弃用：请使用 GetConfig 替代。

func NewNamingClient

func NewNamingClient(nacosIPAddr string, nacosPort int, nacosNamespaceID string, opts ...Option) (naming_client.INamingClient, error)

NewNamingClient 创建一个 Nacos 服务注册与发现客户端。 注意：如果设置了参数 WithClientConfig，nacosNamespaceID 将无效， 如果设置了参数 WithServerConfigs，nacosIPAddr 和 nacosPort 将无效。

Types

type Option

type Option func(*options)

Option 是一个函数类型，用于设置 Nacos 客户端的选项。

func WithAuth

func WithAuth(username string, password string) Option

WithAuth 设置 Nacos 客户端的身份验证信息。

func WithClientConfig

func WithClientConfig(clientConfig *constant.ClientConfig) Option

WithClientConfig 设置 Nacos 客户端的配置。

func WithServerConfigs

func WithServerConfigs(serverConfigs []constant.ServerConfig) Option

WithServerConfigs 设置 Nacos 服务器的配置。

type Params

type Params struct {
	IPAddr      string // 服务器地址
	Port        uint64 // 端口
	Scheme      string // 协议，http 或 grpc
	ContextPath string // 路径

	NamespaceID string // 命名空间 ID

	Group  string // 分组，例如：dev, prod, test
	DataID string // 配置文件 ID
	Format string // 配置文件类型：json, yaml, toml
	// contains filtered or unexported fields
}

Params 包含 Nacos 的配置参数。