メソッドを呼び出す

Durable Object のメソッドを呼び出す

新規プロジェクトと、互換性日付が 2024-04-03 以降の既存プロジェクトでは、Durable Object クラスに定義した Remote Procedure Call（RPC）メソッドの呼び出しを優先してください。

HTTP のリクエスト／レスポンスフローが必要なプロジェクトや、レガシープロジェクトでは、引き続き Durable Object クラスの fetch() ハンドラーを呼び出せます。

RPC メソッドを呼び出す

組み込み型 DurableObject を継承した Durable Object クラスを書くと、そのクラスの public メソッドが RPC メソッドとして公開されます。Worker から DurableObjectStub を使って呼び出せます。

RPC 呼び出しはすべて非同期です。受け渡しできるのはシリアライズ可能な型で、例外はスタックトレースなしで呼び出し元へ伝播します。詳細は Workers RPC を参照してください。

import { DurableObject } from "cloudflare:workers";

// Durable Object
export class MyDurableObject extends DurableObject {
	constructor(ctx, env) {
		super(ctx, env);
	}

	async sayHello() {
		return "Hello, World!";
	}
}

// Worker
export default {
	async fetch(request, env) {
		// スタブは、Durable Object のメソッドを呼び出すためのクライアントです
		const stub = env.MY_DURABLE_OBJECT.getByName("foo");

		// Durable Object のメソッドはスタブ経由で呼び出します
		const rpcResponse = await stub.sayHello();

		return new Response(rpcResponse);
	},
};

import { DurableObject } from "cloudflare:workers";

export interface Env {
	MY_DURABLE_OBJECT: DurableObjectNamespace<MyDurableObject>;
}

// Durable Object
export class MyDurableObject extends DurableObject {
	constructor(ctx: DurableObjectState, env: Env) {
		super(ctx, env);
	}

	async sayHello(): Promise<string> {
		return "Hello, World!";
	}
}

// Worker
export default {
	async fetch(request, env) {
		// スタブは、Durable Object のメソッドを呼び出すためのクライアントです
		const stub = env.MY_DURABLE_OBJECT.getByName("foo");

		// Durable Object のメソッドはスタブ経由で呼び出します
		const rpcResponse = await stub.sayHello();

		return new Response(rpcResponse);
	},
} satisfies ExportedHandler<Env>;

完全な例はカウンターを作るを参照してください。

`fetch` ハンドラーを呼び出す

互換性日付が 2024-04-03 より前で固定されているプロジェクトや、Request オブジェクトを送って Response オブジェクトを返す必要がある場合は、fetch ハンドラー経由で Durable Object へリクエストを送ります。

import { DurableObject } from "cloudflare:workers";

// Durable Object
export class MyDurableObject extends DurableObject {
	constructor(ctx, env) {
		super(ctx, env);
	}

	async fetch(request) {
		return new Response("Hello, World!");
	}
}

// Worker
export default {
	async fetch(request, env) {
		// A stub is a client used to invoke methods on the Durable Object
		const stub = env.MY_DURABLE_OBJECT.getByName("foo");

		// Methods on the Durable Object are invoked via the stub
		const response = await stub.fetch(request);

		return response;
	},
};

import { DurableObject } from "cloudflare:workers";

export interface Env {
	MY_DURABLE_OBJECT: DurableObjectNamespace<MyDurableObject>;
}

// Durable Object
export class MyDurableObject extends DurableObject {
	constructor(ctx: DurableObjectState, env: Env) {
		super(ctx, env);
	}

	async fetch(request: Request): Promise<Response> {
		return new Response("Hello, World!");
	}
}

// Worker
export default {
	async fetch(request, env) {
		// A stub is a client used to invoke methods on the Durable Object
		const stub = env.MY_DURABLE_OBJECT.getByName("foo");

		// Methods on the Durable Object are invoked via the stub
		const response = await stub.fetch(request);

		return response;
	},
} satisfies ExportedHandler<Env>;

fetch() ハンドラーに渡す Request オブジェクトの URL は、正しい形式の URL である必要があります。公開解決可能なホスト名である必要はありません。

RPC がない場合、お客様は Durable Object の private メソッドに対応するリクエストを組み立て、fetch ハンドラーから振り分けることが多くありました。この例では、RPC のほうが明らかに扱いやすいです。

import { DurableObject } from "cloudflare:workers";

// Durable Object
export class MyDurableObject extends DurableObject {
	constructor(ctx: DurableObjectState, env: Env) {
		super(ctx, env);
	}

	private hello(name) {
		return new Response(`Hello, ${name}!`);
	}

	private goodbye(name) {
		return new Response(`Goodbye, ${name}!`);
	}

	async fetch(request) {
		const url = new URL(request.url);
		let name = url.searchParams.get("name");
		if (!name) {
			name = "World";
		}

		switch (url.pathname) {
			case "/hello":
				return this.hello(name);
			case "/goodbye":
				return this.goodbye(name);
			default:
				return new Response("Bad Request", { status: 400 });
		}
	}
}

// Worker
export default {
	async fetch(_request, env, _ctx) {
		// A stub is a client used to invoke methods on the Durable Object
		const stub = env.MY_DURABLE_OBJECT.getByName("foo");

		// Invoke the fetch handler on the Durable Object stub
		let response = await stub.fetch("http://do/hello?name=World");

		return response;
	},
};

import { DurableObject } from "cloudflare:workers";

export interface Env {
	MY_DURABLE_OBJECT: DurableObjectNamespace<MyDurableObject>;
}

// Durable Object
export class MyDurableObject extends DurableObject {
	constructor(ctx: DurableObjectState, env: Env) {
		super(ctx, env);
	}

	private hello(name: string) {
		return new Response(`Hello, ${name}!`);
	}

	private goodbye(name: string) {
		return new Response(`Goodbye, ${name}!`);
	}

	async fetch(request: Request): Promise<Response> {
		const url = new URL(request.url);
		let name = url.searchParams.get("name");
		if (!name) {
			name = "World";
		}

		switch (url.pathname) {
			case "/hello":
				return this.hello(name);
			case "/goodbye":
				return this.goodbye(name);
			default:
				return new Response("Bad Request", { status: 400 });
		}
	}
}

// Worker
export default {
	async fetch(_request, env, _ctx) {
		// A stub is a client used to invoke methods on the Durable Object
		const stub = env.MY_DURABLE_OBJECT.getByName("foo");

		// Invoke the fetch handler on the Durable Object stub
		let response = await stub.fetch("http://do/hello?name=World");

		return response;
	},
} satisfies ExportedHandler<Env>;