Dubbo-go-pixiu 示例

CI

dubbo-go-pixiu 的示例

English

包含内容

  • dubbogo/simple：此目录包含 dubbogo 和 pixiu 的一些简单示例

    • dubbogo/simple/bestdo：包含 jaeger 和 http 到 dubbo
    • dubbogo/simple/body：http 到 dubbo，使用 api_config.yaml
    • dubbogo/simple/csrf：CSRF 保护
    • dubbogo/simple/direct：http 到 dubbo 的直接泛化调用
    • dubbogo/simple/nacos_farconf：pixiu 使用 nacos 作为远端配置中心
    • dubbogo/simple/jaeger：pixiu 集成 jaeger
    • dubbogo/simple/jwt：JWT 认证
    • dubbogo/simple/nacos：http 到 dubbo，使用 nacos 作为注册中心
    • dubbogo/simple/prometheus：pixiu 集成 prometheus
    • dubbogo/simple/dubboproxy：dubbo 到 http 转换和 http 到 dubbo 转换
    • dubbogo/simple/resolve：将 http 请求转换为 dubbo 请求，按照默认http to dubbo转换规则
    • dubbogo/simple/traffic：流量切分和金丝雀发布
    • dubbogo/simple/triple：http 到 triple
    • dubbogo/simple/zookeeper：pixiu 集成 dubbo，使用 zookeeper 作为注册中心

  • dubbohttpproxy：dubbo 到 http 转换和 http 到 dubbo 转换

  • dubbotripleproxy：dubbo2 协议和 triple 协议请求相互转换的案例

  • grpc/simple: 演示了如何使用 Pixiu 作为标准 gRPC 服务的网关，支持一元调用、客户端流、服务端流和双向流通信。

  • http/grpc：将http请求转换为 grpc 请求，支持配置 proto 文件或动态从开启反射功能的 grpc server中获取 proto 信息

  • http/simple：此目录包含常见的 Http 请求代理功能，作为常见的 API 网关

  • llm：pixiu 调用 LLM 的简单示例

  • mcp: 演示了如何使用 Dubbo-go-pixiu 的 MCP (Model Context Protocol) 过滤器，将后端 HTTP API 服务暴露为 MCP 工具，供大型语言模型 (LLM) 调用。

  • plugins：此目录包含 pixiu 的一些插件

    • plugins/ratelimit：pixiu 的 ratelimit 插件

  • seata：演示了如何配置 Seata filter 与 Seata TC 交互对分布式事务进行协调

  • shutdown：此目录演示优雅关闭

    • shutdown/dubbo：演示如何优雅关闭带有 dubbo listener 的 Pixiu 服务。
    • shutdown/http：演示如何优雅关闭带有 http listener 的 Pixiu 服务。
    • shutdown/http2：演示如何优雅关闭带有 http2 listener 的 Pixiu 服务。
    • shutdown/triple：演示如何优雅关闭带有 triple listener 的 Pixiu 服务。

  • springcloud：http代理功能，从 spring cloud 服务注册中心中获取集群信息，动态管理 cluster 和 route 功能

  • xds：pixiu 集成 xds

如何运行

请参考 如何运行 获取相关说明。

Dubbo-go-pixiu 生态系统的其他项目

  • pixiu-admin Dubbo-go-pixiu Admin 是 dubbo-go-pixiu 网关的综合管理平台。它提供了一个集中的控制面板，用于通过基于 Web 的用户界面和 RESTful API 来配置、监控和管理网关资源。
  • pixiu-api Dubbo-go-pixiu API 是 dubbo-go-pixiu 生态系统的 API 配置模型。它提供了一组 API 和配置模型，用于构建、配置和扩展微服务的 API 网关功能，尤其侧重于与 Dubbo 服务的集成。
  • benchmark 该基准测试系统允许用户在各种负载条件下测量和分析关键性能指标，如延迟、吞吐量和每秒查询数 (QPS)，以评估协议转换过程的效率。

如何贡献

如果您希望增加新的用例，请继续阅读:

  1. 为您的示例起合适的名字并创建子目录。如果您不太确定如何做，请参考现有示例摆放目录结构
  2. 提交 PR 之前请确保在本地运行通过，提交 PR 之后请确保 GitHub 上的集成测试通过。请参考现有示例增加对应的测试
  3. 请提供示例相关的 README.md 的中英文版本