首页
/ Apache ShenYu WASM 插件开发与使用指南

Apache ShenYu WASM 插件开发与使用指南

2024-08-07 12:23:14作者:咎岭娴Homer

1. 项目介绍

Apache ShenYu WASM 是一个基于 Java 的 WebAssembly (WASM) 运行时 SDK,允许开发者在 ShenYu 网关中集成和执行 WASM 模块,从而扩展网关的功能或实现特定的业务逻辑。该项目旨在提供一个高性能且轻量级的方式来增强 API 网关的能力。

2. 项目快速启动

步骤1:添加依赖

在你的 Maven 或 Gradle 项目中添加 shenyu-wasm-runtime 的依赖:

Maven

<dependency>
    <groupId>org.apache.shenyu</groupId>
    <artifactId>shenyu-wasm-runtime</artifactId>
    <version>[$x.y.z]</version>
</dependency>

Gradle

compile "org.apache.shenyu:shenyu-wasm-runtime:[$x.y.z]"

步骤2:编写 WASM 代码

下面是一个 Rust 编写的简单示例(任何可编译到 WASM 的语言都可使用):

#[no_mangle]
pub extern fn sum(x: i32, y: i32) -> i32 {
    x + y
}

步骤3:编译成 WASM 文件

将 Rust 代码编译为 .wasm 文件。

步骤4:在 Java 中运行 WASM

在 Java 类中加载并执行 WASM:

import org.apache.shenyu.wasm.api.WASMEngine;
import org.apache.shenyu.wasm.api.WASMModule;

public class Example {
    public static void main(String[] args) throws Exception {
        // 加载 WASM 文件
        byte[] wasmBytes = Files.readAllBytes(Path.of("tests/resources/simple.wasm"));
        
        // 创建 WASM 引擎实例
        WASMEngine engine = new WASMEngine();
        
        // 加载 WASM 模块
        WASMModule module = engine.instantiate(wasmBytes);
        
        // 调用 WASM 函数
        int result = module.callExport("sum", 10, 20).getI32Value();
        System.out.println("Sum: " + result);  // 输出: Sum: 30
    }
}

3. 应用案例和最佳实践

  • 安全过滤:使用 WASM 实现自定义的安全策略,如 IP 黑名单检查。
  • 性能监控:在网关层面,通过 WASM 监控请求响应时间,统计接口调用频率。
  • 数据转换:动态修改请求或响应的数据结构,以满足不同的服务间交互需求。
  • 日志记录:创建 WASM 模块来收集和发送详细的请求日志信息。

最佳实践:

  • 尽可能使 WASM 模块保持小型和专注,便于管理和更新。
  • 使用测试确保 WASM 代码的正确性和性能。
  • 注意内存管理,避免在 WASM 中产生内存泄露。

4. 典型生态项目

ShenYu-WASM 可以与其他开源项目结合使用,如:

  • Docker: 配合 Docker 容器化部署,方便 WASM 模块的打包和版本控制。
  • Kubernetes: 利用 Kubernetes 的服务网格能力,集成 WASM 网关进行流量管理。
  • Prometheus: 结合 Prometheus 监控 WASM 执行时的性能指标。
  • ZipkinJaeger: 集成跟踪系统,通过 WASM 模块增强链路追踪。

了解更多详细信息,参考 Apache ShenYu 官方文档和源码仓库。祝你在使用 Apache ShenYu WASM 的过程中一切顺利!

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
119
207
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
531
405
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
396
37
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
251
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.03 K
arkanalyzerarkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
45
40
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
358
342
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
582
41