Higress Wasm 插件开发与实战指南

CarlowZJ

已于 2025-06-15 00:01:33 修改

阅读量721

点赞数 26

CC 4.0 BY-SA版权

文章标签： wasm Higress

于 2025-06-15 00:01:17 首次发布

本文链接：https://blog.youkuaiyun.com/csdn122345/article/details/148605360

Higress Wasm 插件开发与实战指南

摘要

本文深入探讨了 Higress 的 WebAssembly (Wasm) 插件系统，包括插件开发框架、内置插件使用、自定义插件开发等内容。通过详细的代码示例和实战案例，帮助开发者快速掌握 Higress Wasm 插件的开发和使用方法，提升微服务网关的扩展能力。

1. Higress Wasm 插件概述

1.1 什么是 Wasm 插件

WebAssembly (Wasm) 是一种低级的类汇编语言，具有紧凑的二进制格式，可以在现代 Web 浏览器中运行。Higress 利用 Wasm 技术实现了可扩展的插件系统，允许开发者以安全、高效的方式扩展网关功能。

1.2 插件系统架构

1.3 插件类型分布

2. 内置插件详解

2.1 认证类插件

2.1.1 Basic Auth 认证

# Basic Auth 插件配置示例
apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: basic-auth
  namespace: higress-system
spec:
  defaultConfig:
    consumers:
      - credential: admin:123456
        name: consumer1
      - credential: guest:abc
        name: consumer2
    global_auth: false
  matchRules:
    - config:
        allow:
          - consumer1
      ingress:
        - higress-conformance-infra/wasmplugin-basic-auth
  url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/go-basic-auth:1.0.0

2.1.2 JWT 认证

# JWT 认证插件配置示例
apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: jwt-auth
  namespace: higress-system
spec:
  defaultConfig:
    public_key: "your-public-key"
    token_header: "Authorization"
  url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/jwt-auth:1.0.0

2.2 安全类插件

2.2.1 防爬虫插件

# Bot Detect 插件配置示例
apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: bot-detect
  namespace: higress-system
spec:
  defaultConfig:
    blocked_code: 401
    blocked_message: "deny by bot detect"
    allow:
      - "Tailsweep"
    deny:
      - "Go-Client"
  url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/go-bot-detect:1.0.0

2.2.2 请求屏蔽插件

# Request Block 插件配置示例
apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: request-block
  namespace: higress-system
spec:
  defaultConfig:
    block_urls:
      - "swagger.html"
  url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/request-block:1.0.0

2.3 限流类插件

# Key Rate Limit 插件配置示例
apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: key-rate-limit
  namespace: higress-system
spec:
  defaultConfig:
    rate_limit:
      - key: "user_id"
        rate: 100
        period: 60
  url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/key-rate-limit:1.0.0

3. 插件开发指南

3.1 开发环境准备

3.2 Go 插件开发示例

// 示例：自定义响应插件
package main

import (
    "github.com/alibaba/higress/plugins/wasm-go/pkg/proxy"
)

func main() {
    proxy.RegisterPlugin(&CustomResponsePlugin{})
}

type CustomResponsePlugin struct {
    proxy.DefaultPlugin
}

func (p *CustomResponsePlugin) OnResponse(ctx *proxy.Context) {
    // 设置自定义响应头
    ctx.SetResponseHeader("X-Custom-Header", "custom-value")
    
    // 修改响应体
    ctx.SetResponseBody([]byte("Custom Response"))
}

3.3 C++ 插件开发示例

// 示例：自定义认证插件
#include <proxy_wasm_intrinsics.h>

class CustomAuthPlugin : public Context {
public:
    FilterHeadersStatus onRequestHeaders(uint32_t headers, bool end_of_stream) override {
        // 获取认证头
        auto auth_header = getRequestHeader("Authorization");
        
        // 验证认证信息
        if (!validateAuth(auth_header)) {
            sendLocalResponse(401, "Unauthorized", {}, "");
            return FilterHeadersStatus::StopIteration;
        }
        
        return FilterHeadersStatus::Continue;
    }
    
private:
    bool validateAuth(const std::string& auth) {
        // 实现认证逻辑
        return true;
    }
};

4. 插件测试与部署

4.1 测试流程

4.2 测试用例示例

// 插件测试用例示例
func TestCustomResponsePlugin(t *testing.T) {
    // 初始化测试环境
    suite := NewTestSuite()
    
    // 配置测试用例
    testCases := []TestCase{
        {
            Name: "测试自定义响应头",
            Request: Request{
                Headers: map[string]string{
                    "Host": "example.com",
                },
            },
            ExpectedResponse: Response{
                Headers: map[string]string{
                    "X-Custom-Header": "custom-value",
                },
            },
        },
    }
    
    // 执行测试
    for _, tc := range testCases {
        t.Run(tc.Name, func(t *testing.T) {
            response := suite.SendRequest(tc.Request)
            assert.Equal(t, tc.ExpectedResponse.Headers, response.Headers)
        })
    }
}