---
title: "Apache APISIXがWasm機能を実現する方法 - API7.ai"
description: "APISIX 在网关级别支持 Wasm，使开发者能够使用高级编程语言来创建 Wasm 插件。"
url: "https://api7.ai/ja/blog/how-apisix-supports-wasm"
---

[Blog](https://api7.ai/ja/blog)

[Products](https://api7.ai/ja/category/products)[Technology](https://api7.ai/ja/category/technology)[Ecosystem](https://api7.ai/ja/category/ecosystem)[Case Study](https://api7.ai/ja/category/usercase)[Team & Community](https://api7.ai/ja/category/community)

Search

⌘ + K

[Blog](https://api7.ai/blog)

Products

# Apache APISIXがWasm機能を実現する方法

Xinxin Zhu

April 7, 2023

[Products](https://api7.ai/category/products)

> 高性能なアプリケーションをウェブブラウザで実行するために、Apache APISIXはゲートウェイレベルでWasmをサポートしています。Wasmは、ウェブ上でコードを効率的かつ安全に実行するためのバイナリ命令形式です。これにより、開発者はC/C++/Go/Rustなどの高級プログラミング言語を使用し、proxy-wasm仕様に従ってWasmプラグインを作成できます。proxy-wasm仕様は、他のシステムとの互換性と相互運用性を保証します。この記事を通じて、詳細を学びましょう。

## Wasmとは

[WebAssembly](http://webassembly.org/)（略称Wasm）は、スタックベースの仮想マシン向けのバイナリ命令形式です。

Wasmが登場する以前は、ウェブブラウザで実行できるのはJavascriptだけでした。しかし、Wasmの導入により、C/C++/Golangなどの高級言語もウェブブラウザで実行できるようになりました。Chrome、Firefox、Safariなどの主要なブラウザはすべてWasmをサポートしています。さらに、WASI（WebAssembly System Interface）プロジェクトの進展により、サーバーサイド環境でもWasm命令の実行が可能になりました。

現在、Apache APISIXはゲートウェイレベルでWasmをサポートしています。開発者はC/C++/Go/Rustなどの高級プログラミング言語を使用し、[proxy-wasm](https://github.com/proxy-wasm/spec)仕様に従ってWasmプラグインを作成できます。

![wasm](https://static.api7.ai/uploads/2023/03/10/6ZI9czxe_whiteboard_exported_image.jpeg?imageMogr2/format/webp)

## APISIXがWasmプラグインをサポートする理由

ネイティブのLuaプラグインと比較して、Wasmプラグインには以下の利点があります：

- **拡張性**: Wasmをサポートすることで、APISIXはproxy-wasmが提供するSDKを使用して、C++、Golang、Rustなどの高級プログラミング言語でプラグインを開発できます。これらの言語はより豊かなエコシステムを持っているため、開発者はより多くの機能を備えたプラグインを実装できます。
- **セキュリティ**: APISIXとWasmの相互作用はproxy-wasmが提供するApplication Binary Interface（ABI）に依存しているため、このアクセスはより安全です。Wasmプラグインはリクエストに対して特定の変更しか行えないため、悪意のある動作を防ぐことができます。さらに、Wasmプラグインは別のVMで実行されるため、プラグインがクラッシュしてもAPISIXのメインプロセスに影響を与えません。

## APISIXがWasmをサポートする仕組み

Wasmが何かを理解したところで、APISIXがどのようにWasmプラグインをサポートするかをトップダウンで見ていきましょう。

![apisix-wasm](https://static.api7.ai/uploads/2023/03/10/5t9ZpK7P_apisx-wasm.jpeg?imageMogr2/format/webp)

### APISIX Wasmプラグイン

APISIXは、開発者がC/C++、Go、Rustなどの人気のある高級プログラミング言語を使用してプラグインを作成できるようにしています。これらのプラグインは、対応するSDKを使用し、proxy-wasm仕様に従って構築できます。

> proxy-wasmは、Envoyによって導入されたL4/L7プロキシ間のABI仕様です。この仕様は、メモリ管理、L4プロキシ、L7プロキシ拡張を含むABIを定義しています。例えば、HTTP(L7)では、proxy-wasm仕様は`proxy_on_http_request_headers`、`proxy_on_http_request_body`、`proxy_on_http_request_trailers`、`proxy_on_http_response_headers`などのABIを定義し、モジュールがさまざまな段階でリクエスト内容を取得および変更できるようにします。

例えば、Golangと[proxy-wasm-go-sdk](https://github.com/tetratelabs/proxy-wasm-go-sdk)を使用してこのプラグインを開発します：

> proxy-wasm-go-sdkは、proxy-wasm仕様のSDKで、開発者がGolangを使用してproxy-wasmプラグインをより簡単に作成できるようにします。ただし、ネイティブGolangのWASIサポートにいくつかの問題があるため、このSDKはTinyGoに基づいて実装されています。詳細については、[こちら](https://github.com/tetratelabs/proxy-wasm-go-sdk/blob/main/doc/OVERVIEW.md#tinygo-vs-the-official-go-compiler)を参照してください。

このプラグインの主な機能は、HTTPリクエストのレスポンスステータスコードとレスポンスボディを変更することです。これは[APISIXリンク](https://github.com/apache/apisix/blob/master/t/wasm/fault-injection/main.go)から参照されています。

```
...
func (ctx *pluginContext) OnPluginStart(pluginConfigurationSize int) types.OnPluginStartStatus {
        data, err := proxywasm.GetPluginConfiguration()
        if err != nil {
                proxywasm.LogErrorf("error reading plugin configuration: %v", err)
                return types.OnPluginStartStatusFailed
        }

        var p fastjson.Parser
        v, err := p.ParseBytes(data)
        if err != nil {
                proxywasm.LogErrorf("error decoding plugin configuration: %v", err)
                return types.OnPluginStartStatusFailed
        }
        ctx.Body = v.GetStringBytes("body")
        ctx.HttpStatus = uint32(v.GetUint("http_status"))
        if v.Exists("percentage") {
                ctx.Percentage = v.GetInt("percentage")
        } else {
                ctx.Percentage = 100
        }

        // schema check
        if ctx.HttpStatus < 200 {
                proxywasm.LogError("bad http_status")
                return types.OnPluginStartStatusFailed
        }
        if ctx.Percentage < 0 || ctx.Percentage > 100 {
                proxywasm.LogError("bad percentage")
                return types.OnPluginStartStatusFailed
        }

        return types.OnPluginStartStatusOK
}

func (ctx *httpLifecycle) OnHttpRequestHeaders(numHeaders int, endOfStream bool) types.Action {
        plugin := ctx.parent
        if !sampleHit(plugin.Percentage) {
                return types.ActionContinue
        }

        err := proxywasm.SendHttpResponse(plugin.HttpStatus, nil, plugin.Body, -1)
        if err != nil {
                proxywasm.LogErrorf("failed to send local response: %v", err)
                return types.ActionContinue
        }
        return types.ActionPause
}
...
```

その後、TinyGoを使用して上記のGolangコードをコンパイルし、`.wasm`ファイルを生成します。

```
tinygo build -o wasm_fault_injection.go.wasm -scheduler=none -target=wasi ./main.go
```

コンパイルが完了すると、`fault_injection.go.wasm`ファイルが得られます。

> wasmファイルの内容に興味がある場合は、[wasm-tool](https://github.com/bytecodealliance/wasm-tools)を使用してwasmファイルの具体的な内容を確認できます。 `wasm-tools dump hello.go.wasm`

APISIXの`config.yaml`ファイルに`wasm_fault_injection.go.wasm`を設定し、プラグイン名を`wasm_fault_injection`とします。

```
apisix:
        ...
wasm:
  plugins:
    - name: wasm_fault_injection
      priority: 7997
      file: wasm_fault_injection.go.wasm
```

その後、APISIXを起動し、Wasmプラグインを参照するルートを作成します：

```
curl  http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{
    "uri":"/*",
    "upstream":{
        "type":"roundrobin",
        "timeout":{
            "connect":1,
            "read":1,
            "send":1
        },
        "nodes":{
            "httpbin.org:80":1
        }
    },
    "plugins":{
        "wasm_fault_injection":{
            "conf":"{\"http_status\":200, \"body\":\"Hello WebAssembly!\n\"}"
        }
    },
    "name":"wasm_fault_injection"
}'
```

アクセステストを行った後、レスポンスボディが「Hello WebAssembly」に変更されていることが確認でき、Wasmプラグインが有効になっていることがわかります。

```
curl 127.0.0.1:9080/get -v
*   Trying 127.0.0.1:9080...
* Connected to 127.0.0.1 (127.0.0.1) port 9080 (#0)
> GET /get HTTP/1.1
> Host: 127.0.0.1:9080
> User-Agent: curl/7.81.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Date: Thu, 09 Feb 2023 07:46:50 GMT
< Content-Type: text/plain; charset=utf-8
< Transfer-Encoding: chunked
< Connection: keep-alive
< Server: APISIX/3.1.0
<
Hello WebAssembly!
```

### Wasm-nginx-module

Apache APISIXがWasmプラグインを使用する方法を学んだ後、次に「なぜWasmプラグインでリクエスト内容にアクセスして変更できるのか？」について深く掘り下げます。

APISIXはOpenRestyを基盤とするフレームワークを使用しているため、Wasmプラグインでリクエスト内容にアクセスして変更するには、OpenRestyまたはNGINXが提供するAPIとやり取りする必要があります。これが`wasm-nginx-module`の役割です。

> wasm-nginx-moduleは、WasmをサポートするNGINXモジュールで、[API7](https://api7.ai/)によって開発されました。このモジュールは、NGINXに基づいてproxy-wasm-abiを実装し、Lua APIをカプセル化して、Luaレベルでproxy-wasm-abi呼び出しを完了できるようにします。詳細については、[wasm-nginx-module](https://github.com/api7/wasm-nginx-module)を参照してください。

例えば、APISIXが**access**フェーズに到達すると、`wasm-nginx-module`が提供するLuaメソッド`on_http_request_headers`を呼び出します。

```
-- apisix/wasm.lua
...
local ok, err = wasm.on_http_request_headers(plugin_ctx)
   if not ok then
       core.log.error(name, ": failed to run wasm plugin: ", err)
       return 503
   end
end
...
```

その後、このメソッド内で`wasm-nginx-module`が提供する`ngx_http_wasm_on_http`メソッドが呼び出されます。

```
ngx_int_t
ngx_http_wasm_on_http(ngx_http_wasm_plugin_ctx_t *hwp_ctx, ngx_http_request_t *r,
                      ngx_http_wasm_phase_t type, const u_char *body, size_t size,
                      int end_of_body)
{
    ...

    ctx = ngx_http_wasm_get_module_ctx(r);

    if (type == HTTP_REQUEST_HEADERS) {
        cb_name = &proxy_on_request_headers;
    } else if (type == HTTP_REQUEST_BODY) {
        cb_name = &proxy_on_request_body;
    } else if (type == HTTP_RESPONSE_HEADERS) {
        cb_name = &proxy_on_response_headers;
    } else {
        cb_name = &proxy_on_response_body;
    }

    if (type == HTTP_REQUEST_HEADERS || type == HTTP_RESPONSE_HEADERS) {
        if (hwp_ctx->hw_plugin->abi_version == PROXY_WASM_ABI_VER_010) {
            rc = ngx_wasm_vm->call(hwp_ctx->hw_plugin->plugin,
                                   cb_name,
                                   true, NGX_WASM_PARAM_I32_I32, http_ctx->id, 0);
        } else {
            rc = ngx_wasm_vm->call(hwp_ctx->hw_plugin->plugin,
                                   cb_name,
                                   true, NGX_WASM_PARAM_I32_I32_I32, http_ctx->id,
                                   0, 1);
        }

    } else {
        rc = ngx_wasm_vm->call(hwp_ctx->hw_plugin->plugin,
                              cb_name,
                              true, NGX_WASM_PARAM_I32_I32_I32, http_ctx->id,
                              size, end_of_body);
    }
    ...
}
```

`wasm-nginx-module`では、異なる段階に基づいて`cb_name`を設定します。例えば、`HTTP_REQUEST_HEADERS`は`proxy_on_request_headers`に対応し、その後`ngx_wasm_vm->call`を通じてVM内のメソッドを呼び出します。これは、この記事の前半で説明したwasmプラグインの`OnHttpRequestHeaders`メソッドです。

これにより、APISIXがwasmプラグインを呼び出し、Golangを実行するための呼び出しチェーンが完成します。呼び出しチェーンは以下の通りです：

### Wasm VM

Wasm VMは、Wasmコードを実行するための仮想マシンです。`wasm-nginx-module`は、Wasmコードを実行するために「wasmtime」と「wasmedge」の2種類の仮想マシンを実装しています。APISIXでは、デフォルトで「wasmtime」がWasmコードを実行します。

> [Wasmtime](https://github.com/bytecodealliance/wasmtime)は、Bytecode Allianceによってオープンソース化された、WebAssemblyとWASIのための高速で安全なランタイムです。ウェブ環境外でWebAssemblyコードを実行でき、コマンドラインツールとして使用したり、他のプログラムにWebAssemblyランタイムエンジンとしてライブラリとして組み込むことができます。[Wasmedge](https://wasmedge.org/)は、エッジコンピューティング向けに最適化された軽量で高性能なWebAssembly（Wasm）仮想マシンです。クラウドネイティブ、エッジ、分散アプリケーションに使用できます。

まず、Wasm VMでは、`load`メソッドを使用して`.wasm`ファイルをメモリにロードします。その後、VMの`call`メソッドを使用してこれらの関数を呼び出すことができます。VMはWASIインターフェースの実装に基づいており、これによりWasmコードはブラウザ側だけでなくサーバー側でも実行できるようになります。

## まとめ

Wasmが何であるか、そしてAPISIXがどのようにWasmプラグインをサポートするかを理解しました。Wasmプラグインのサポートを提供することで、APISIXはC++、Rust、Golang、AssemblyScriptなどの複数の言語でのプラグイン開発をサポートする能力を強化するだけでなく、WebAssemblyの広範なエコシステムとユースケースの恩恵を受けることができます。これにより、APISIXはAPIゲートウェイ側でより高度な機能を提供し、より広範な使用シナリオに対応できるようになります。

Tags:

[APISIX Basics](https://api7.ai/tags/apisix-basics)

[API Gateway Concept](https://api7.ai/tags/api-gateway-concept)

[WebAssembly](https://api7.ai/tags/webassembly)

Share article link

Share

Related Posts

[![なぜApache APISIXが最適なAPIゲートウェイなのか？](https://static.api7.ai/2022/10/03/633a3d046fa57.webp)](https://api7.ai/blog/why-is-apache-apisix-the-best-api-gateway)

## [なぜApache APISIXが最適なAPIゲートウェイなのか？](https://api7.ai/blog/why-is-apache-apisix-the-best-api-gateway)

[![API7 Enterprise Proxy 在 Kubernetes 集群中的应用方式](https://static.api7.ai/uploads/2024/01/27/BxF6o8n4_PA_Cover_ENG.png)](https://api7.ai/blog/api7-enterprise-proxy-applications)

## [API7 Enterprise Proxy 在 Kubernetes 集群中的应用方式](https://api7.ai/blog/api7-enterprise-proxy-applications)

Table of Contents

- [Wasmとは](#wasm%E3%81%A8%E3%81%AF)

- [APISIXがWasmプラグインをサポートする理由](#apisix%E3%81%8Cwasm%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%E3%82%92%E3%82%B5%E3%83%9D%E3%83%BC%E3%83%88%E3%81%99%E3%82%8B%E7%90%86%E7%94%B1)

- [APISIXがWasmをサポートする仕組み](#apisix%E3%81%8Cwasm%E3%82%92%E3%82%B5%E3%83%9D%E3%83%BC%E3%83%88%E3%81%99%E3%82%8B%E4%BB%95%E7%B5%84%E3%81%BF)

  - [APISIX Wasmプラグイン](#apisix-wasm%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3)
  - [Wasm-nginx-module](#wasm-nginx-module)
  - [Wasm VM](#wasm-vm)

- [まとめ](#%E3%81%BE%E3%81%A8%E3%82%81)

## Related Posts

[![LuaJITとは何か？APISIXがLuaJITを選ぶ理由](https://static.api7.ai/uploads/2024/09/06/n3fzQtjH_LuaJIT.png)](https://api7.ai/ja/blog/apisix-chooses-luajit)

Products

April 14, 2023

#### [LuaJITとは何か？APISIXがLuaJITを選ぶ理由](https://api7.ai/ja/blog/apisix-chooses-luajit)

APISIXは、クラウドネイティブなAPIゲートウェイであり、その高い柔軟性とパフォーマンスからLuaJITを技術スタックとして選択しています。

[APISIX Basics](https://api7.ai/tags/apisix-basics)

[API Gateway Concept](https://api7.ai/tags/api-gateway-concept)

[LuaJIT](https://api7.ai/tags/luajit)

[![开源API网关Apache APISIX的技术探索](https://static.api7.ai/2022/10/19/634f6677742a1.png)](https://api7.ai/ja/blog/technical-explorations-of-open-source-api-gateway)

Products

October 24, 2022

#### [开源API网关Apache APISIX的技术探索](https://api7.ai/ja/blog/technical-explorations-of-open-source-api-gateway)

Apache APISIXの探求と革新を学ぶことで、そのデータセンター、ホットリロード、プラグインの動的オーケストレーションについて理解することができます。

[APISIX Basics](https://api7.ai/tags/apisix-basics)

[API Gateway Concept](https://api7.ai/tags/api-gateway-concept)

[Technical Trends](https://api7.ai/tags/technical-trends)

[![Apache APISIX 3.0: オープンソースAPIゲートウェイの11のハイライト](https://static.api7.ai/2022/10/03/633a3d046fa57.webp)](https://api7.ai/ja/blog/apache-apisix-3-0-11-highlights-of-open-source-api-gateway)

Products

September 22, 2022

#### [Apache APISIX 3.0: オープンソースAPIゲートウェイの11のハイライト](https://api7.ai/ja/blog/apache-apisix-3-0-11-highlights-of-open-source-api-gateway)

オープンソースのAPI GatewayであるApache APISIXのバージョン3.0がリリースされます！今回は、その中から11の重要な機能を選んで簡単にご紹介します。

[APISIX Basics](https://api7.ai/tags/apisix-basics)

[API Gateway Concept](https://api7.ai/tags/api-gateway-concept)

[Core Concept](https://api7.ai/tags/core-concept)
