Proxy-Wasm Rust SDK 使用教程

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

proxy-wasm-rust-sdk/
├── examples/
│   ├── hello_world/
│   ├── http_auth_random/
│   ├── http_headers/
│   ├── http_response_body/
│   ├── http_configuration/
│   └── grpc_auth_random/
├── src/
│   ├── lib.rs
│   ├── context.rs
│   ├── dispatcher.rs
│   ├── imports.rs
│   ├── exports.rs
│   └── utils.rs
├── bazel/
│   ├── cargo/
│   └── BUILD
├── github/
│   └── workflows/
├── .bazelrc
├── .bazelversion
├── .gitignore
├── BUILD
├── CHANGELOG.md
├── CODEOWNERS
├── CONTRIBUTING.md
├── Cargo.toml
├── LICENSE
├── README.md
└── WORKSPACE

目录结构介绍

• examples/: 包含多个示例项目，展示了如何使用 Proxy-Wasm Rust SDK 编写不同的代理插件。

  • hello_world/: 最简单的示例，展示了如何编写一个基本的 Wasm 插件。
  • http_auth_random/: 展示如何实现一个随机认证的 HTTP 插件。
  • http_headers/: 展示如何操作 HTTP 请求和响应头。
  • http_response_body/: 展示如何操作 HTTP 响应体。
  • http_configuration/: 展示如何处理配置文件。
  • grpc_auth_random/: 展示如何实现一个随机认证的 gRPC 插件。

• src/: 包含 SDK 的核心代码。

  • lib.rs: 主库文件，定义了 SDK 的主要功能。
  • context.rs: 定义了上下文相关的结构和方法。
  • dispatcher.rs: 定义了调度器相关的结构和方法。
  • imports.rs: 定义了导入的函数和常量。
  • exports.rs: 定义了导出的函数和常量。
  • utils.rs: 包含一些实用工具函数。

• bazel/: 包含 Bazel 构建系统的相关文件。

  • cargo/: 包含与 Cargo 相关的 Bazel 规则。
  • BUILD: Bazel 构建文件。

• github/: 包含 GitHub Actions 的工作流配置文件。

  • workflows/: 包含 CI/CD 的工作流配置。

• 其他文件:

  • .bazelrc: Bazel 配置文件。
  • .bazelversion: 指定 Bazel 的版本。
  • .gitignore: Git 忽略文件配置。
  • BUILD: Bazel 构建文件。
  • CHANGELOG.md: 项目变更日志。
  • CODEOWNERS: 代码所有者配置。
  • CONTRIBUTING.md: 贡献指南。
  • Cargo.toml: Rust 项目的依赖和元数据配置。
  • LICENSE: 项目许可证。
  • README.md: 项目介绍和使用说明。
  • WORKSPACE: Bazel 工作区文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/lib.rs，它是整个 SDK 的核心入口文件。在这个文件中，定义了 SDK 的主要功能和结构。开发者可以通过这个文件了解 SDK 的基本架构和主要功能模块。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• Cargo.toml: Rust 项目的依赖和元数据配置文件。开发者可以通过这个文件了解项目的依赖库、版本信息、作者信息等。

• .bazelrc: Bazel 配置文件，定义了 Bazel 构建系统的配置选项。

• .bazelversion: 指定 Bazel 的版本，确保构建环境的一致性。

• WORKSPACE: Bazel 工作区文件，定义了项目的工作区配置和依赖。

这些配置文件共同确保了项目的构建和运行环境的一致性和可重复性。