diff --git a/README.md b/README.md index 33772383..ffb4190e 100644 --- a/README.md +++ b/README.md @@ -27,38 +27,42 @@ $ go get -u github.com/nacos-group/nacos-sdk-go/v2 * ClientConfig ```go -constant.ClientConfig{ -TimeoutMs uint64 // timeout for requesting Nacos server, default value is 10000ms -NamespaceId string // the namespaceId of Nacos -Endpoint string // the endpoint for ACM. https://help.aliyun.com/document_detail/130146.html -RegionId string // the regionId for ACM & KMS -AccessKey string // the AccessKey for ACM & KMS -SecretKey string // the SecretKey for ACM & KMS -OpenKMS bool // it's to open KMS, default is false. https://help.aliyun.com/product/28933.html -// , to enable encrypt/decrypt, DataId should be start with "cipher-" -CacheDir string // the directory for persist nacos service info,default value is current path -UpdateThreadNum int // the number of goroutine for update nacos service info,default value is 20 -NotLoadCacheAtStart bool // not to load persistent nacos service info in CacheDir at start time -UpdateCacheWhenEmpty bool // update cache when get empty service instance from server -Username string // the username for nacos auth -Password string // the password for nacos auth -LogDir string // the directory for log, default is current path -RotateTime string // the rotate time for log, eg: 30m, 1h, 24h, default is 24h -MaxAge int64 // the max age of a log file, default value is 3 -LogLevel string // the level of log, it's must be debug,info,warn,error, default value is info + +constant.ClientConfig { + TimeoutMs uint64 // timeout for requesting Nacos server, default value is 10000ms + NamespaceId string // the namespaceId of Nacos + Endpoint string // the endpoint for ACM. https://help.aliyun.com/document_detail/130146.html + RegionId string // the regionId for ACM & KMS + AccessKey string // the AccessKey for ACM & KMS + SecretKey string // the SecretKey for ACM & KMS + OpenKMS bool // it's to open KMS, default is false. https://help.aliyun.com/product/28933.html + // , to enable encrypt/decrypt, DataId should be start with "cipher-" + CacheDir string // the directory for persist nacos service info,default value is current path + UpdateThreadNum int // the number of goroutine for update nacos service info,default value is 20 + NotLoadCacheAtStart bool // not to load persistent nacos service info in CacheDir at start time + UpdateCacheWhenEmpty bool // update cache when get empty service instance from server + Username string // the username for nacos auth + Password string // the password for nacos auth + LogDir string // the directory for log, default is current path + RotateTime string // the rotate time for log, eg: 30m, 1h, 24h, default is 24h + MaxAge int64 // the max age of a log file, default value is 3 + LogLevel string // the level of log, it's must be debug,info,warn,error, default value is info } + ``` * ServerConfig ```go + constant.ServerConfig{ -Scheme string // the nacos server scheme,defaut=http,this is not required in 2.0 -ContextPath string // the nacos server contextpath,defaut=/nacos,this is not required in 2.0 -IpAddr string // the nacos server address -Port uint64 // nacos server port -GrpcPort uint64 // nacos server grpc port, default=server port + 1000, this is not required + Scheme string // the nacos server scheme,defaut=http,this is not required in 2.0 + ContextPath string // the nacos server contextpath,defaut=/nacos,this is not required in 2.0 + IpAddr string // the nacos server address + Port uint64 // nacos server port + GrpcPort uint64 // nacos server grpc port, default=server port + 1000, this is not required } + ``` Note：We can config multiple ServerConfig,the client will rotate request the servers @@ -66,83 +70,83 @@ GrpcPort uint64 // nacos server grpc port, default=server port + 1000, this i ### Create client ```go -//create clientConfig -clientConfig := constant.ClientConfig{ -NamespaceId: "e525eafa-f7d7-4029-83d9-008937f9d468", //we can create multiple clients with different namespaceId to support multiple namespace.When namespace is public, fill in the blank string here. -TimeoutMs: 5000, -NotLoadCacheAtStart: true, -LogDir: "/tmp/nacos/log", -CacheDir: "/tmp/nacos/cache", -LogLevel: "debug", -} -//Another way of create clientConfig -clientConfig := *constant.NewClientConfig( -constant.WithNamespaceId("e525eafa-f7d7-4029-83d9-008937f9d468"), //When namespace is public, fill in the blank string here. -constant.WithTimeoutMs(5000), -constant.WithNotLoadCacheAtStart(true), -constant.WithLogDir("/tmp/nacos/log"), -constant.WithCacheDir("/tmp/nacos/cache"), -constant.WithLogLevel("debug"), -) - -// At least one ServerConfig -serverConfigs := []constant.ServerConfig{ -{ -IpAddr: "console1.nacos.io", -ContextPath: "/nacos", -Port: 80, -Scheme: "http", -}, -{ -IpAddr: "console2.nacos.io", -ContextPath: "/nacos", -Port: 80, -Scheme: "http", -}, -} -//Another way of create serverConfigs -serverConfigs := []constant.ServerConfig{ -*constant.NewServerConfig( -"console1.nacos.io", -80, -constant.WithScheme("http"), -constant.WithContextPath("/nacos") -), -*constant.NewServerConfig( -"console2.nacos.io", -80, -constant.WithScheme("http"), -constant.WithContextPath("/nacos") -), -} -// Create naming client for service discovery -_, _ := clients.CreateNamingClient(map[string]interface{}{ -"serverConfigs": serverConfigs, -"clientConfig": clientConfig, -}) - -// Create config client for dynamic configuration -_, _ := clients.CreateConfigClient(map[string]interface{}{ -"serverConfigs": serverConfigs, -"clientConfig": clientConfig, -}) - -// Another way of create naming client for service discovery (recommend) -namingClient, err := clients.NewNamingClient( -vo.NacosClientParam{ -ClientConfig: &clientConfig, -ServerConfigs: serverConfigs, -}, -) - -// Another way of create config client for dynamic configuration (recommend) -configClient, err := clients.NewConfigClient( -vo.NacosClientParam{ -ClientConfig: &clientConfig, -ServerConfigs: serverConfigs, -}, -) + //create clientConfig + clientConfig := constant.ClientConfig{ + NamespaceId: "e525eafa-f7d7-4029-83d9-008937f9d468", //we can create multiple clients with different namespaceId to support multiple namespace.When namespace is public, fill in the blank string here. + TimeoutMs: 5000, + NotLoadCacheAtStart: true, + LogDir: "/tmp/nacos/log", + CacheDir: "/tmp/nacos/cache", + LogLevel: "debug", + } + //Another way of create clientConfig + clientConfig := *constant.NewClientConfig( + constant.WithNamespaceId("e525eafa-f7d7-4029-83d9-008937f9d468"), //When namespace is public, fill in the blank string here. + constant.WithTimeoutMs(5000), + constant.WithNotLoadCacheAtStart(true), + constant.WithLogDir("/tmp/nacos/log"), + constant.WithCacheDir("/tmp/nacos/cache"), + constant.WithLogLevel("debug"), + ) + // At least one ServerConfig + serverConfigs := []constant.ServerConfig{ + { + IpAddr: "console1.nacos.io", + ContextPath: "/nacos", + Port: 80, + Scheme: "http", + }, + { + IpAddr: "console2.nacos.io", + ContextPath: "/nacos", + Port: 80, + Scheme: "http", + }, + } + //Another way of create serverConfigs + serverConfigs := []constant.ServerConfig{ + *constant.NewServerConfig( + "console1.nacos.io", + 80, + constant.WithScheme("http"), + constant.WithContextPath("/nacos") + ), + *constant.NewServerConfig( + "console2.nacos.io", + 80, + constant.WithScheme("http"), + constant.WithContextPath("/nacos") + ), + } + + // Create naming client for service discovery + _, _ := clients.CreateNamingClient(map[string]interface{}{ + "serverConfigs": serverConfigs, + "clientConfig": clientConfig, + }) + + // Create config client for dynamic configuration + _, _ := clients.CreateConfigClient(map[string]interface{}{ + "serverConfigs": serverConfigs, + "clientConfig": clientConfig, + }) + + // Another way of create naming client for service discovery (recommend) + namingClient, err := clients.NewNamingClient( + vo.NacosClientParam{ + ClientConfig: &clientConfig, + ServerConfigs: serverConfigs, + }, + ) + + // Another way of create config client for dynamic configuration (recommend) + configClient, err := clients.NewConfigClient( + vo.NacosClientParam{ + ClientConfig: &clientConfig, + ServerConfigs: serverConfigs, + }, + ) ``` @@ -151,23 +155,25 @@ ServerConfigs: serverConfigs, https://help.aliyun.com/document_detail/130146.html ```go -cc := constant.ClientConfig{ -Endpoint: "acm.aliyun.com:8080", -NamespaceId: "e525eafa-f7d7-4029-83d9-008937f9d468", -RegionId: "cn-shanghai", -AccessKey: "LTAI4G8KxxxxxxxxxxxxxbwZLBr", -SecretKey: "n5jTL9YxxxxxxxxxxxxaxmPLZV9", -OpenKMS: true, -TimeoutMs: 5000, -LogLevel: "debug", -} -// a more graceful way to create config client -client, err := clients.NewConfigClient( -vo.NacosClientParam{ -ClientConfig: &cc, -}, -) +cc := constant.ClientConfig{ + Endpoint: "acm.aliyun.com:8080", + NamespaceId: "e525eafa-f7d7-4029-83d9-008937f9d468", + RegionId: "cn-shanghai", + AccessKey: "LTAI4G8KxxxxxxxxxxxxxbwZLBr", + SecretKey: "n5jTL9YxxxxxxxxxxxxaxmPLZV9", + OpenKMS: true, + TimeoutMs: 5000, + LogLevel: "debug", + } + + // a more graceful way to create config client + client, err := clients.NewConfigClient( + vo.NacosClientParam{ + ClientConfig: &cc, + }, + ) + ``` ### Service Discovery @@ -177,18 +183,18 @@ ClientConfig: &cc, ```go success, err := namingClient.RegisterInstance(vo.RegisterInstanceParam{ -Ip: "10.0.0.11", -Port: 8848, -ServiceName: "demo.go", -Weight: 10, -Enable: true, -Healthy: true, -Ephemeral: true, -Metadata: map[string]string{"idc":"shanghai"}, -ClusterName: "cluster-a", // default value is DEFAULT -GroupName: "group-a", // default value is DEFAULT_GROUP -}) - + Ip: "10.0.0.11", + Port: 8848, + ServiceName: "demo.go", + Weight: 10, + Enable: true, + Healthy: true, + Ephemeral: true, + Metadata: map[string]string{"idc":"shanghai"}, + ClusterName: "cluster-a", // default value is DEFAULT + GroupName: "group-a", // default value is DEFAULT_GROUP + }) + ``` * Deregister instance：DeregisterInstance @@ -196,13 +202,13 @@ GroupName: "group-a", // default value is DEFAULT_GROUP ```go success, err := namingClient.DeregisterInstance(vo.DeregisterInstanceParam{ -Ip: "10.0.0.11", -Port: 8848, -ServiceName: "demo.go", -Ephemeral: true, -Cluster: "cluster-a", // default value is DEFAULT -GroupName: "group-a", // default value is DEFAULT_GROUP -}) + Ip: "10.0.0.11", + Port: 8848, + ServiceName: "demo.go", + Ephemeral: true, + Cluster: "cluster-a", // default value is DEFAULT + GroupName: "group-a", // default value is DEFAULT_GROUP + }) ``` @@ -211,35 +217,37 @@ GroupName: "group-a", // default value is DEFAULT_GROUP ```go services, err := namingClient.GetService(vo.GetServiceParam{ -ServiceName: "demo.go", -Clusters: []string{"cluster-a"}, // default value is DEFAULT -GroupName: "group-a", // default value is DEFAULT_GROUP -}) + ServiceName: "demo.go", + Clusters: []string{"cluster-a"}, // default value is DEFAULT + GroupName: "group-a", // default value is DEFAULT_GROUP + }) ``` * Get all instances：SelectAllInstances ```go + // SelectAllInstance return all instances,include healthy=false,enable=false,weight<=0 -instances, err := namingClient.SelectAllInstances(vo.SelectAllInstancesParam{ -ServiceName: "demo.go", -GroupName: "group-a", // default value is DEFAULT_GROUP -Clusters: []string{"cluster-a"}, // default value is DEFAULT -}) + instances, err := namingClient.SelectAllInstances(vo.SelectAllInstancesParam{ + ServiceName: "demo.go", + GroupName: "group-a", // default value is DEFAULT_GROUP + Clusters: []string{"cluster-a"}, // default value is DEFAULT + }) ``` * Get instances ：SelectInstances ```go + // SelectInstances only return the instances of healthy=${HealthyOnly},enable=true and weight>0 -instances, err := namingClient.SelectInstances(vo.SelectInstancesParam{ -ServiceName: "demo.go", -GroupName: "group-a", // default value is DEFAULT_GROUP -Clusters: []string{"cluster-a"}, // default value is DEFAULT -HealthyOnly: true, -}) + instances, err := namingClient.SelectInstances(vo.SelectInstancesParam{ + ServiceName: "demo.go", + GroupName: "group-a", // default value is DEFAULT_GROUP + Clusters: []string{"cluster-a"}, // default value is DEFAULT + HealthyOnly: true, + }) ``` @@ -247,12 +255,12 @@ HealthyOnly: true, ```go // SelectOneHealthyInstance return one instance by WRR strategy for load balance -// And the instance should be health=true,enable=true and weight>0 -instance, err := namingClient.SelectOneHealthyInstance(vo.SelectOneHealthInstanceParam{ -ServiceName: "demo.go", -GroupName: "group-a", // default value is DEFAULT_GROUP -Clusters: []string{"cluster-a"}, // default value is DEFAULT -}) + // And the instance should be health=true,enable=true and weight>0 + instance, err := namingClient.SelectOneHealthyInstance(vo.SelectOneHealthInstanceParam{ + ServiceName: "demo.go", + GroupName: "group-a", // default value is DEFAULT_GROUP + Clusters: []string{"cluster-a"}, // default value is DEFAULT + }) ``` @@ -261,15 +269,15 @@ Clusters: []string{"cluster-a"}, // default value is DEFAULT ```go // Subscribe key = serviceName+groupName+cluster -// Note: We call add multiple SubscribeCallback with the same key. -err := namingClient.Subscribe(vo.SubscribeParam{ -ServiceName: "demo.go", -GroupName: "group-a", // default value is DEFAULT_GROUP -Clusters: []string{"cluster-a"}, // default value is DEFAULT -SubscribeCallback: func (services []model.Instance, err error) { -log.Printf("\n\n callback return services:%s \n\n", utils.ToJsonString(services)) -}, -}) + // Note: We call add multiple SubscribeCallback with the same key. + err := namingClient.Subscribe(vo.SubscribeParam{ + ServiceName: "demo.go", + GroupName: "group-a", // default value is DEFAULT_GROUP + Clusters: []string{"cluster-a"}, // default value is DEFAULT + SubscribeCallback: func (services []model.Instance, err error) { + log.Printf("\n\n callback return services:%s \n\n", utils.ToJsonString(services)) + }, + }) ``` @@ -278,13 +286,13 @@ log.Printf("\n\n callback return services:%s \n\n", utils.ToJsonString(services) ```go err := namingClient.Unsubscribe(vo.SubscribeParam{ -ServiceName: "demo.go", -GroupName: "group-a", // default value is DEFAULT_GROUP -Clusters: []string{"cluster-a"}, // default value is DEFAULT -SubscribeCallback: func (services []model.Instance, err error) { -log.Printf("\n\n callback return services:%s \n\n", utils.ToJsonString(services)) -}, -}) + ServiceName: "demo.go", + GroupName: "group-a", // default value is DEFAULT_GROUP + Clusters: []string{"cluster-a"}, // default value is DEFAULT + SubscribeCallback: func (services []model.Instance, err error) { + log.Printf("\n\n callback return services:%s \n\n", utils.ToJsonString(services)) + }, + }) ``` @@ -293,10 +301,10 @@ log.Printf("\n\n callback return services:%s \n\n", utils.ToJsonString(services) ```go serviceInfos, err := namingClient.GetAllServicesInfo(vo.GetAllServiceInfoParam{ -NameSpace: "0e83cc81-9d8c-4bb8-a28a-ff703187543f", -PageNo: 1, -PageSize: 10, -}), + NameSpace: "0e83cc81-9d8c-4bb8-a28a-ff703187543f", + PageNo: 1, + PageSize: 10, + }), ``` @@ -307,9 +315,9 @@ PageSize: 10, ```go success, err := configClient.PublishConfig(vo.ConfigParam{ -DataId: "dataId", -Group: "group", -Content: "hello world!222222"}) + DataId: "dataId", + Group: "group", + Content: "hello world!222222"}) ``` @@ -318,8 +326,8 @@ Content: "hello world!222222"}) ```go success, err = configClient.DeleteConfig(vo.ConfigParam{ -DataId: "dataId", -Group: "group"}) + DataId: "dataId", + Group: "group"}) ``` @@ -328,8 +336,9 @@ Group: "group"}) ```go content, err := configClient.GetConfig(vo.ConfigParam{ -DataId: "dataId", -Group: "group"}) + DataId: "dataId", + Group: "group"}) + ``` @@ -338,12 +347,12 @@ Group: "group"}) ```go err := configClient.ListenConfig(vo.ConfigParam{ -DataId: "dataId", -Group: "group", -OnChange: func (namespace, group, dataId, data string) { -fmt.Println("group:" + group + ", dataId:" + dataId + ", data:" + data) -}, -}) + DataId: "dataId", + Group: "group", + OnChange: func (namespace, group, dataId, data string) { + fmt.Println("group:" + group + ", dataId:" + dataId + ", data:" + data) + }, + }) ``` @@ -352,9 +361,9 @@ fmt.Println("group:" + group + ", dataId:" + dataId + ", data:" + data) ```go err := configClient.CancelListenConfig(vo.ConfigParam{ -DataId: "dataId", -Group: "group", -}) + DataId: "dataId", + Group: "group", + }) ``` @@ -362,12 +371,12 @@ Group: "group", ```go configPage, err := configClient.SearchConfig(vo.SearchConfigParam{ -Search: "blur", -DataId: "", -Group: "", -PageNo: 1, -PageSize: 10, -}) + Search: "blur", + DataId: "", + Group: "", + PageNo: 1, + PageSize: 10, + }) ``` ## Example