Python配置Nacos，并实现服务的注册与配置的读取

概要

本文将介绍如何使用Python配置Nacos，并实现服务的注册与配置的读取。我们将基于nacos_config.py、nacos_client.py和main.py三个文件，详细解析如何集成Nacos到FastAPI应用中。

整体架构流程

1. 启动服务

• 应用启动时，通过ServiceRegistry类注册服务到Nacos。
• 从Nacos获取配置信息，并将其应用到应用中。

2. 服务注册

• 使用NacosClient提供的API进行服务实例的注册和注销。
• 注册的服务信息包括服务名称、IP地址、端口等。

3. 读取配置
4. 关闭服务同步注销服务注册

技术名词解释

• FastAPI: 一个现代、快速（高性能）的Web框架，用于构建API，基于Python类型提示。
• Nacos: 一个用于动态服务发现、配置管理和服务管理的平台。

关键代码解析

环境：

你需要安装 Nacos 的 Python 客户端库。可以使用 nacos-sdk-python 来与 Nacos 进行交互。

pip install nacos-sdk-python

1. 该文件定义了连接Nacos服务器所需的配置项。

# nacos_config.py
NACOS_SERVER_ADDRESSES = "http://localhost:8848"
NACOS_NAMESPACE = "public"
NACOS_GROUP = "DEFAULT_GROUP"
NACOS_DATA_ID = "auth_service"

2. 该文件实现了与Nacos交互的客户端逻辑，包括服务注册和配置读取。

# nacos_client.py
from nacos import NacosClient
from nacos_config.nacos_config import NACOS_SERVER_ADDRESSES, NACOS_NAMESPACE, NACOS_GROUP
import yaml

class NacosService:
    def __init__(self, service_name):
        self.client = NacosClient(NACOS_SERVER_ADDRESSES, namespace=NACOS_NAMESPACE)
        self.data_id = f"{service_name}.yaml"

    def add_naming_instance(self, service_name, ip, port, weight=1.0, enable=True, healthy=True, metadata=None, cluster_name=None):
        self.client.add_naming_instance(
            service_name=service_name,
            ip=ip,
            port=port,
            weight=weight,
            enable=enable,
            healthy=healthy,
            metadata=metadata,
            cluster_name=cluster_name
        )

    def remove_naming_instance(self, service_name, ip, port, cluster_name=None):
        self.client.remove_naming_instance(
            service_name=service_name,
            ip=ip,
            port=port,
            cluster_name=cluster_name
        )

    def get_config(self):
        config = self.client.get_config(self.data_id, NACOS_GROUP)
        if config:
            return yaml.safe_load(config)
        return None

# service_registry.py
from nacos_config.nacos_config import NACOS_GROUP, NACOS_DATA_ID
from nacos_client import NacosService


class ServiceRegistry:
    def __init__(self):
        self.ip = "0.0.0.0"
        self.port = 8001
        self.group = NACOS_GROUP
        self.nacos_service = NacosService(service_name=NACOS_DATA_ID)

    def register_service(self):
        self.nacos_service.add_naming_instance(
            service_name=NACOS_DATA_ID,
            ip=self.ip,
            port=self.port,
            metadata={"group": self.group}  # 使用metadata传递group信息
        )
        print(f"Service {NACOS_DATA_ID} registered to Nacos")

    def deregister_service(self):
        self.nacos_service.remove_naming_instance(
            ip=self.ip,
            port=self.port
        )
        print(f"Service {NACOS_DATA_ID} removed from Nacos")

    def get_config(self):
        config = self.nacos_service.get_config()
        return config

4. 该文件是FastAPI应用的入口，负责初始化应用、添加中间件、注册路由以及处理服务的注册和注销。

import uvicorn
from fastapi import FastAPI
from service_registry import ServiceRegistry

app = FastAPI()

# 初始化服务注册
service_registry = ServiceRegistry()

@app.on_event("startup")
async def startup_event():
    # 注册服务到Nacos
    service_registry.register_service()

    # 从Nacos获取配置
    config = service_registry.get_config()
    if config:
        print(f"Config from Nacos: {config}")
        app.config = config
    else:
        print("No config found in Nacos")

@app.on_event("shutdown")
async def shutdown_event():
    # 注销服务从Nacos
    service_registry.deregister_service()

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8001)

nacos读取配置成功

小结

本文介绍了如何在Python项目中配置Nacos，并实现服务的注册与配置的读取。通过上述代码示例，我们可以看到如何利用Nacos进行服务发现和配置管理，从而简化微服务架构下的开发和运维工作。