Apache ShenYu Python客户端SDK使用教程

Apache ShenYu Python客户端SDK使用教程

shenyu-client-pythonApache ShenYu Client SDK for python.项目地址:https://gitcode.com/gh_mirrors/sh/shenyu-client-python

1. 项目的目录结构及介绍

Apache ShenYu Python客户端SDK的目录结构如下：

shenyu-client-python/
├── github/
│   └── workflows/
├── client/
│   └── example/
├── asf.yaml
├── .gitignore
├── .licenserc.yaml
├── DISCLAIMER
├── LICENSE
├── NOTICE
├── README.md
├── deploy.md

目录结构介绍

• github/workflows/: 包含GitHub Actions的工作流配置文件。
• client/example/: 包含客户端的示例代码。
• asf.yaml: Apache软件基金会相关的配置文件。
• .gitignore: Git忽略文件配置。
• .licenserc.yaml: 许可证相关配置。
• DISCLAIMER: 免责声明。
• LICENSE: 许可证文件。
• NOTICE: 通知文件。
• README.md: 项目说明文档。
• deploy.md: 部署说明文档。

2. 项目的启动文件介绍

在client/example/目录下，可以找到示例代码，其中包含了项目的启动文件。以下是一个简单的启动示例：

from apache_shenyu_client.config import GatewayConfig
from apache_shenyu_client.api import GatewayProxy

# 配置网关
GatewayConfig.uri = [
    {
        "app_name": "app2",  # 应用名称
        "host": "172.24.43.28",  # 服务主机
        "port": 8000,  # 服务端口
        "context_path": "/flask_test",  # 上下文路径
        "environment": "test",  # 环境
        "rpc_type": "http"  # RPC类型
    }
]

# 创建网关代理
gt = GatewayProxy()

# 注册URI
gt.register_uri()

# 注册元数据
gt.register_metadata("/helloqq2")

启动文件介绍

• GatewayConfig: 配置网关的参数，包括应用名称、服务主机、服务端口、上下文路径、环境和RPC类型。
• GatewayProxy: 创建网关代理实例，并注册URI和元数据。

3. 项目的配置文件介绍

项目的配置文件主要包括GatewayConfig的配置。以下是配置文件的示例：

from apache_shenyu_client.config import GatewayConfig

GatewayConfig.uri = [
    {
        "app_name": "app2",  # 应用名称
        "host": "172.24.43.28",  # 服务主机
        "port": 8000,  # 服务端口
        "context_path": "/flask_test",  # 上下文路径
        "environment": "test",  # 环境
        "rpc_type": "http"  # RPC类型
    }
]

配置文件介绍

• app_name: 应用名称，用于标识服务。
• host: 服务主机，指定服务的IP地址。
• port: 服务端口，指定服务的端口号。
• context_path: 上下文路径，指定服务的上下文路径。
• environment: 环境，指定服务的环境（如测试环境、生产环境等）。
• rpc_type: RPC类型，指定服务的RPC类型（如HTTP、RPC等）。

通过以上配置，可以灵活地配置和管理Apache ShenYu Python客户端SDK。

shenyu-client-pythonApache ShenYu Client SDK for python.项目地址:https://gitcode.com/gh_mirrors/sh/shenyu-client-python