kratos学习(二) kratos配置_kartos

2401_86437020

于 2024-09-11 23:36:30 发布

阅读量556

点赞数 4

文章标签：学习算法

本文链接：https://blog.youkuaiyun.com/2401_86437020/article/details/142153210

版权

可以通过Option注入自定义的组件, WithSource这个是必定会用到,其他一般不怎么会用到。

WithDecoder: 自定义解码器
WithLogger: 注入一个日志组件,该接口已经被废弃,可以使用全局日志组件替代
WithResolver: 自定义占位符处理器
WithSource: 添加配置源

func WithDecoder(d Decoder) Option
func WithLogger(l log.Logger) Option
func WithResolver(r Resolver) Option
func WithSource(s ...Source) Option

Config

type Config interface {
	Load() error 
	Scan(v interface{}) error
	Value(key string) Value
	Watch(key string, o Observer) error
	Close() error
}

Load: 加载配置源
Scan: 将配置反射到结构体中
Value: 获取配置的值
Watch: 监听配置更新
Close: 关闭所有watch

File

完整代码

初始化配置源

	path := "config.yaml"
	// 初始化配置源
	c := config.New(
		config.WithSource(
			file.NewSource(path),
		),
	)

读取配置

读取配置可以使用Scan来反射到结构体也可以使用Value获取指定键值

使用Scan

	var v struct {
		Service struct {
			Name    string `json:"name"`
			Version string `json:"version"`
		} `json:"service"`
	}

	// Unmarshal the config to struct
	if err := c.Scan(&v); err != nil {
		panic(err)
	}

如果通过Scan方法来读取, 修改文件内容后结构体的也会跟着更改

	for {
		version, err := c.Value("service.version").String()
		if err != nil {
			panic(err)
		}
		log.Printf("version: %s", version)
		time.Sleep(time.Second)
	}

// 2023/05/07 11:51:47 version: v1.0.0
// 2023/05/07 11:51:48 version: v1.0.011

使用Value

	name, err := c.Value("service.name").String()
	if err != nil {
		panic(err)
	}
	log.Printf("service: %s", name)

监听配置变更

通过.Watch方法，可以监听配置中某个字段的变更，在本地或远端的配置中心有配置文件变更时，执行回调函数进行自定义的处理

	// watch key
	if err := c.Watch("service.name", func(key string, value config.Value) {
		log.Printf("config changed: %s = %v\n", key, value)
	}); err != nil {
		panic(err)
	}

env

完整代码

如果有配置需要从环境变量读取可以配置env.NewSource

c := config.New(
    config.WithSource(
        // 添加前缀为 KRATOS\_ 的环境变量，不需要的话也可以设为空字符串
        env.NewSource("KRATOS\_"),
        // 添加配置文件
        file.NewSource(path),
    ))
  
// 加载配置源：
if err := c.Load(); err != nil {
    log.Fatal(err)
}

// 获取环境变量 KRATOS\_PORT 的值，这里用去掉前缀的名称进行读取
port, err := c.Value("PORT").String()

除了上面使用Value方法直接读的方式，也可以在配置文件内容里使用占位符来把环境变量中的值渲染进去：

service:
  name: "kratos\_app"
http:
  server:
    # 使用 service.name 的值
    name: "${service.name}"
    # 使用环境变量 PORT 替换，若不存在，使用默认值 8080
    port: "${PORT:8080}"
    # 使用环境变量 TIMEOUT 替换，无默认值
    timeout: "$TIMEOUT"

consul

部署consul

这里我们使用docker-compose部署

version: "3.0"

services:
  consul:
    container_name: consul
    image: consul
    restart: always
    ports:
      - 8500:8500
    command: ["consul","agent","-server","-bootstrap","-data-dir","/consul","-ui","-bind","127.0.0.1","-client","0.0.0.0"]

添加配置

docker exec -it consul consul kv put http/server/port 8000

代码实现

package main

import (
	"github.com/go-kratos/kratos/contrib/config/consul/v2"
	"github.com/go-kratos/kratos/v2/config"
	"github.com/hashicorp/consul/api"
	"log"
)

func main() {
	consulClient, err := api.NewClient(&api.Config{
		Address: "127.0.0.1:8500",
	})
	if err != nil {
		panic(err)
	}
	cs, err := consul.New(consulClient, consul.WithPath("http/server"))
	// consul中需要标注文件后缀，kratos读取配置需要适配文件后缀
	// The file suffix needs to be marked, and kratos needs to adapt the file suffix to read the configuration.
	if err != nil {
		panic(err)
	}
	c := config.New(config.WithSource(cs))
	defer c.Close()

	// load sources before get
	if err := c.Load(); err != nil {
		log.Fatalln(err)
	}

	// acquire config value
	foo, err := c.Value("port").String()
	if err != nil {
		log.Fatalln(err)
	}

	log.Println(foo)
}

etcd

部署etcd

这里我们使用docker-compose部署

version: "3.0"

networks:
  etcd-net:           # 网络
    driver: bridge    # 桥接模式

volumes:
  etcd1_data:         # 挂载到本地的数据卷名
    driver: local
  etcd2_data:
    driver: local
  etcd3_data:
    driver: local
###
### etcd 其他环境配置见：https://doczhcn.gitbook.io/etcd/index/index-1/configuration
###
services:
  etcd1:
    image: bitnami/etcd:latest  # 镜像
    container_name: etcd1       # 容器名 --name
    restart: always             # 总是重启
    networks:
      - etcd-net                # 使用的网络 --network
    ports:                      # 端口映射 -p
      - "20000:2379"
      - "20001:2380"
    environment:                # 环境变量 --env
      - ALLOW_NONE_AUTHENTICATION=yes                       # 允许不用密码登录
      - ETCD_NAME=etcd1                                     # etcd 的名字
      - ETCD_INITIAL_ADVERTISE_PEER_URLS=http://etcd1:2380  # 列出这个成员的伙伴 URL 以便通告给集群的其他成员
      - ETCD_LISTEN_PEER_URLS=http://0.0.0.0:2380           # 用于监听伙伴通讯的URL列表
      - ETCD_LISTEN_CLIENT_URLS=http://0.0.0.0:2379         # 用于监听客户端通讯的URL列表
      - ETCD_ADVERTISE_CLIENT_URLS=http://etcd1:2379        # 列出这个成员的客户端URL，通告给集群中的其他成员
      - ETCD_INITIAL_CLUSTER_TOKEN=etcd-cluster             # 在启动期间用于 etcd 集群的初始化集群记号
      - ETCD_INITIAL_CLUSTER=etcd1=http://etcd1:2380,etcd2=http://etcd2:2380,etcd3=http://etcd3:2380 # 为启动初始化集群配置
      - ETCD_INITIAL_CLUSTER_STATE=new                      # 初始化集群状态
    volumes:
      - etcd1_data:/bitnami/etcd                            # 挂载的数据卷

  etcd2:
    image: bitnami/etcd:latest
    container_name: etcd2
    restart: always
    networks:
      - etcd-net
    ports:
      - "20002:2379"
      - "20003:2380"
    environment:
      - ALLOW_NONE_AUTHENTICATION=yes
      - ETCD_NAME=etcd2
      - ETCD_INITIAL_ADVERTISE_PEER_URLS=http://etcd2:2380
      - ETCD_LISTEN_PEER_URLS=http://0.0.0.0:2380
      - ETCD_LISTEN_CLIENT_URLS=http://0.0.0.0:2379
      - ETCD_ADVERTISE_CLIENT_URLS=http://etcd2:2379
      - ETCD_INITIAL_CLUSTER_TOKEN=etcd-cluster
      - ETCD_INITIAL_CLUSTER=etcd1=http://etcd1:2380,etcd2=http://etcd2:2380,etcd3=http://etcd3:2380
      - ETCD_INITIAL_CLUSTER_STATE=new
    volumes:
      - etcd2_data:/bitnami/etcd

  etcd3:
    image: bitnami/etcd:latest
    container_name: etcd3
    restart: always
    networks:
      - etcd-net
    ports:
      - "20004:2379"
      - "20005:2380"
    environment:
      - ALLOW_NONE_AUTHENTICATION=yes
      - ETCD_NAME=etcd3
      - ETCD_INITIAL_ADVERTISE_PEER_URLS=http://etcd3:2380
      - ETCD_LISTEN_PEER_URLS=http://0.0.0.0:2380
      - ETCD_LISTEN_CLIENT_URLS=http://0.0.0.0:2379
      - ETCD_ADVERTISE_CLIENT_URLS=http://etcd3:2379
      - ETCD_INITIAL_CLUSTER_TOKEN=etcd-cluster
      - ETCD_INITIAL_CLUSTER=etcd1=http://etcd1:2380,etcd2=http://etcd2:2380,etcd3=http://etcd3:2380
      - ETCD_INITIAL_CLUSTER_STATE=new
    volumes:
      - etcd3_data:/bitnami/etcd

然后添加一个配置

docker exec -it etcd1 etcdctl put /app-config hello

代码实现读取配置

package main

import (
	"log"
	"time"

	clientv3 "go.etcd.io/etcd/client/v3"
	"google.golang.org/grpc"

	cfg "github.com/go-kratos/kratos/contrib/config/etcd/v2"
	"github.com/go-kratos/kratos/v2/config"
)

func main() {
	// create an etcd client
	client, err := clientv3.New(clientv3.Config{
		Endpoints:   []string{"127.0.0.1:20000", "127.0.0.1:20002", "127.0.0.1:20004"},
		DialTimeout: time.Second,
		DialOptions: []grpc.DialOption{grpc.WithBlock()},
	})
	if err != nil {
		log.Fatal(err)
	}

	// configure the source, "path" is required
	source, err := cfg.New(client, cfg.WithPath("/app-config"), cfg.WithPrefix(true))
	if err != nil {
		log.Fatalln(err)
	}

	// create a config instance with source
	c := config.New(config.WithSource(source))
	defer c.Close()

	// load sources before get
	if err := c.Load(); err != nil {
		log.Fatalln(err)
	}

	// acquire config value
	foo, err := c.Value("/app-config").String()
	if err != nil {
		log.Fatalln(err)
	}

	log.Println(foo)

}