nacos

package module
v2.0.0-...-8a22033 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 19, 2025 License: Apache-2.0 Imports: 15 Imported by: 5

README

nacos (This is a community driven project)

中文

Nacos as service discovery for Hertz.

How to use?

  • The nacos/v2 version of hertz does not currently support creating multiple port examples in the same group multiple times.
  • Service registration and discovery in nacos/v2 is compatible with previous versions.
  • CustomLogger type in constant.ClientConfig has been removed in nacos-sdk-go v2. Instead, use the (github.com/nacos-group/nacos-sdk-go/v2/common/logger).SetLogger to customize the log.
  • nacos/v2 only supports nacos 2.X version.
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/v2"
)

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/v2"
)

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))
	// ...
}
Custom Logger

examples/logger/main.go

package main

import (
	"github.com/hertz-contrib/registry/nacos/v2/common"
	"github.com/nacos-group/nacos-sdk-go/v2/common/logger"
)

func main() {
	logger.InitLogger(logger.Config{
		Level: "debug",
	})
	logger.SetLogger(common.NewCustomNacosLogger())
	logger.Info("info")
}

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/v2"
	"github.com/nacos-group/nacos-sdk-go/v2/clients"
	"github.com/nacos-group/nacos-sdk-go/v2/common/constant"
	"github.com/nacos-group/nacos-sdk-go/v2/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/v2"
	"github.com/nacos-group/nacos-sdk-go/v2/clients"
	"github.com/nacos-group/nacos-sdk-go/v2/common/constant"
	"github.com/nacos-group/nacos-sdk-go/v2/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

  • This package use Nacos2.x client.

  • Nacos2.x detail see

  • Supported Go version over 1.16

  • Supported Nacos version over 2.x

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAddr 

func GetAddr() string

GetAddr Get Nacos addr from environment variables.

func GetNameSpaceID 

func GetNameSpaceID() string

GetNameSpaceID Get Nacos namespace id from environment variables.

func GetPort 

func GetPort() int64

GetPort Get Nacos port from environment variables.

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.

Source Files

View all Source files

Directories

Path Synopsis
examples
custom_config/client
custom_config/server
custom_config_multiple_server/client
custom_config_multiple_server/server
logger
standard/client
standard/server
standard_multiple_server/client
standard_multiple_server/server

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.