nacos

README

nacos (This is a community driven project)

中文

Nacos as service discovery for Hertz.

How to use?

Server

example/standard/server/main.go

import (
	"context"
	"log"

	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/app/server/registry"
	"github.com/cloudwego/hertz/pkg/common/utils"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
	"github.com/hertz-contrib/registry/nacos"
)

func main() {
	addr := "127.0.0.1:8888"
	r, err := nacos.NewDefaultNacosRegistry()
	if err != nil {
		log.Fatal(err)
		return
	}
	h := server.Default(
		server.WithHostPorts(addr),
		server.WithRegistry(r, &registry.Info{
			ServiceName: "hertz.test.demo",
			Addr:        utils.NewNetAddr("tcp", addr),
			Weight:      10,
			Tags:        nil,
		}),
	)
	h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
		ctx.JSON(consts.StatusOK, utils.H{"ping": "pong"})
	})
	h.Spin()
}

Client

example/standard/client/main.go

import (
	"context"
	"log"

	"github.com/cloudwego/hertz/pkg/app/client"
	"github.com/cloudwego/hertz/pkg/app/middlewares/client/sd"
	"github.com/cloudwego/hertz/pkg/common/config"
	"github.com/cloudwego/hertz/pkg/common/hlog"
	"github.com/hertz-contrib/registry/nacos"
)

func main() {
client, err := client.NewClient()
	if err != nil {
		panic(err)
	}
	r, err := nacos.NewDefaultNacosResolver()
	if err != nil {
		log.Fatal(err)
		return
	}
	client.Use(sd.Discovery(r))
	// ...
}

How to run example?

run docker

• make prepare

make prepare

run server

go run ./examples/standard/server/main.go

run client

go run ./examples/standard/client/main.go

2022/07/26 13:52:47.310617 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311019 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311186 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311318 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311445 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311585 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311728 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311858 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.311977 main.go:46: [Info] code = 200, body ={"ping":"pong"}
2022/07/26 13:52:47.312107 main.go:46: [Info] code = 200, body ={"ping":"pong"}

Custom Nacos Client Configuration

Server

example/custom_config/server/main.go

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/app/server/registry"
	"github.com/cloudwego/hertz/pkg/common/utils"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
	"github.com/hertz-contrib/registry/nacos"
	"github.com/nacos-group/nacos-sdk-go/clients"
	"github.com/nacos-group/nacos-sdk-go/common/constant"
	"github.com/nacos-group/nacos-sdk-go/vo"
)

func main() {
	sc := []constant.ServerConfig{
		*constant.NewServerConfig("127.0.0.1", 8848),
	}
	
	cc := constant.ClientConfig{
		NamespaceId:         "public",
		TimeoutMs:           5000,
		NotLoadCacheAtStart: true,
		LogDir:              "/tmp/nacos/log",
		CacheDir:            "/tmp/nacos/cache",
		LogLevel:            "info",
	}
	
	cli, err := clients.NewNamingClient(
		vo.NacosClientParam{
			ClientConfig:  &cc,
			ServerConfigs: sc,
		},
	)
	if err != nil {
		panic(err)
	}
	
	addr := "127.0.0.1:8888"
	r := nacos.NewNacosRegistry(cli)
	h := server.Default(
		server.WithHostPorts(addr),
		server.WithRegistry(r, &registry.Info{
			ServiceName: "hertz.test.demo",
			Addr:        utils.NewNetAddr("tcp", addr),
			Weight:      10,
			Tags:        nil,
		}),
	)
	// ...
	h.Spin()
}

Client

example/custom_config/client/main.go

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app/client"
	"github.com/cloudwego/hertz/pkg/app/middlewares/client/sd"
	"github.com/cloudwego/hertz/pkg/common/config"
	"github.com/cloudwego/hertz/pkg/common/hlog"
	"github.com/hertz-contrib/registry/nacos"
	"github.com/nacos-group/nacos-sdk-go/clients"
	"github.com/nacos-group/nacos-sdk-go/common/constant"
	"github.com/nacos-group/nacos-sdk-go/vo"
)

func main() {
	cli, err := client.NewClient()
	if err != nil {
		panic(err)
	}
	sc := []constant.ServerConfig{
		*constant.NewServerConfig("127.0.0.1", 8848),
	}
	cc := constant.ClientConfig{
		NamespaceId:         "public",
		TimeoutMs:           5000,
		NotLoadCacheAtStart: true,
		LogDir:              "/tmp/nacos/log",
		CacheDir:            "/tmp/nacos/cache",
		LogLevel:            "info",
	}

	nacosCli, err := clients.NewNamingClient(
		vo.NacosClientParam{
			ClientConfig:  &cc,
			ServerConfigs: sc,
		}
  )
	if err != nil {
		panic(err)
	}
	r := nacos.NewNacosResolver(nacosCli)
	cli.Use(sd.Discovery(r))
	// ...
}

Environment Variable

Environment Variable Name	Environment Variable Default Value	Environment Variable Introduction
serverAddr	127.0.0.1	nacos server address
serverPort	8848	nacos server port
namespace		the namespaceId of nacos

Compatibility

The server of Nacos2.0 is fully compatible with 1.X nacos-sdk-go. see

Documentation

Index

• func NewDefaultNacosRegistry(opts ...RegistryOption) (registry.Registry, error)
• func NewDefaultNacosResolver(opts ...ResolverOption) (discovery.Resolver, error)
• func NewNacosRegistry(client naming_client.INamingClient, opts ...RegistryOption) registry.Registry
• func NewNacosResolver(cli naming_client.INamingClient, opts ...ResolverOption) discovery.Resolver
• type RegistryOption
  • func WithRegistryCluster(cluster string) RegistryOption
  • func WithRegistryGroup(group string) RegistryOption
• type ResolverOption
  • func WithResolverCluster(cluster string) ResolverOption
  • func WithResolverGroup(group string) ResolverOption

Functions

func NewDefaultNacosRegistry

func NewDefaultNacosRegistry(opts ...RegistryOption) (registry.Registry, error)

NewDefaultNacosRegistry create a default service registry using nacos.

func NewDefaultNacosResolver

func NewDefaultNacosResolver(opts ...ResolverOption) (discovery.Resolver, error)

NewDefaultNacosResolver create a default service resolver using nacos.

func NewNacosRegistry

func NewNacosRegistry(client naming_client.INamingClient, opts ...RegistryOption) registry.Registry

NewNacosRegistry create a new registry using nacos.

func NewNacosResolver

func NewNacosResolver(cli naming_client.INamingClient, opts ...ResolverOption) discovery.Resolver

NewNacosResolver create a service resolver using nacos.

Types

type RegistryOption

type RegistryOption func(o *registryOptions)

RegistryOption Option is nacos registry option.

func WithRegistryCluster

func WithRegistryCluster(cluster string) RegistryOption

WithRegistryCluster with cluster option.

func WithRegistryGroup

func WithRegistryGroup(group string) RegistryOption

WithRegistryGroup with group option.

type ResolverOption

type ResolverOption func(o *resolverOptions)

ResolverOption Option is nacos registry option.

func WithResolverCluster

func WithResolverCluster(cluster string) ResolverOption

WithResolverCluster with cluster option.

func WithResolverGroup

func WithResolverGroup(group string) ResolverOption

WithResolverGroup with group option.