postMessage メソッド (DOM)

[2] postMessage メソッドは、 Web におけるプロセス間通信のためのメソッドです。

文脈

[112] Window オブジェクト、 MessagePort オブジェクト、 DedicatedWorkerGlobalScope オブジェクト、 Worker オブジェクト、 BroadcastChannel オブジェクトに存在します。

[159] SharedWorker オブジェクトには存在しませんが、かわりに port IDL属性があって、 MessagePort オブジェクトにアクセスできます。

引数

[160] 第1引数は送信するデータです。 postMessage メソッドではこれを「メッセージ」と呼んでいます。メッセージとしては任意の JavaScript値を指定できます。

[176] ただし、送信されるのは指定された値そのものではなく、構造化クローンです。

[161] 第2引数以後は文脈オブジェクトによって異なります。元は引数をいくつか順に指定する形式でしたが、 2018年の改訂以後省略可能な辞書 PostMessageOptions 形式の引数 >>18 で指定できるようになりました >>22。

`Window` オブジェクトの場合

[25] 第2引数 USVString または辞書引数 WindowPostMessageOptions (PostMessageOptions を継承 >>18) の省略可能な USVString の値 targetOrigin >>18 には、投函先の起源を指定します。投函先が実際には異なる起源なら、メッセージは無視されます (エラーにもなりません)。

[26] 起源は、次のいずれかの値を指定できます。

[20] 絶対URL は、その URL の起源を表します。
[28] / は、送信元の文書と同じ起源を表します。同じ起源同士でも、異なる起源の場合と同じように投函できます。その場合でもやはりメッセージは構造化クローンが引き渡されます。
[27] * は、任意の起源を表します。著者は、機密情報を含むメッセージの場合、対象の起源として * を指定するべきではありません >>18。

[29] 相対URLは指定できません。

[30] 例えば https://hoge.example/foo/bar を指定すると、 https://hoge.example 下の任意の文書などが受信できます。

[31] 第3引数または辞書引数 PostMessageOptions の省略可能な値 transfer >>18 には、 Transferable の配列を指定できます。該当するものがなければ、省略できます。

`MessagePort` と `DedicatedWorkerGlobalScope` と `Worker` の場合

[114] 第2引数または辞書引数 PostMessageOptions の省略可能な値 transfer >>18 には、 Transferable の配列を指定できます。該当するものがなければ、省略できます。

`BroadcastChannel` オブジェクトの場合

[139] 第1引数のみです。

処理

`Window` の場合

[21] Window インターフェイスの postMessage メソッドは、 window post message steps、すなわち次のようにしなければなりません >>18。

[177] 引数群を必須の any、必須の USVString、省略可能な sequence<object> か、必須の any、省略可能な WindowPostMessageOptions のいずれかとして解釈します。
1. [96] メッセージを、第1引数を any として解釈した結果に設定します。
2. [178] 前者の場合、
  1. [97] 対象起源を、第2引数を USVString として解釈した結果に設定します。
  2. [98] transfer を、第3引数を sequence<object> として解釈した結果に設定します。既定値は、空リストとします。
3. [113] 後者の場合、
  1. [179] オプション群を、第2引数を WindowPostMessageOptions と解釈した結果に設定します。
  2. [180] 対象起源を、 オプション群の targetOrigin に設定します。
  3. [181] transferを、 オプション群の transfer に設定します。
[106] 対象窓を、文脈オブジェクトに設定します。
[108] 対象Realm を、対象窓のRealmに設定します。
[83] 現職設定群を、現職設定群オブジェクトに設定します。
[109] 対象起源により、
*
対象起源はそのまま * とします。
/
対象起源を、現職設定群の起源に設定します。
それ以外
[100] URL を、対象起源にURL構文解析器を適用した結果に設定します。
[101] URL が失敗の場合、
[102] SyntaxError DOMException を投げ、ここで停止します。
[103] 対象起源を、URL の起源に設定します。
[99] 直列化結果を、 メッセージと transfer に StructuredSerializeWithTransfer を適用した結果に設定します。例外が投げられれば、再び投げ、ここで停止します。
[130] タスクをキューに追加します。
タスク源
対象窓の関連エージェントのイベントループの投稿済みメッセージタスク源
処理
[82] 対象起源が * 以外で、 対象窓の文書の起源が対象起源と同じ起源でなければ、
[93] ここで停止します。
[81] 起源を、現職設定群の起源の直列化に設定します。
[104] 始点を、現職設定群の大域オブジェクトの WindowProxy に設定します。
[110] 記録を、直列化結果と対象Realmについて StructuredDeserializeWithTransfer した結果に設定します。例外が投げられた場合、
[131] イベントを発火します。
対象
対象窓
型
messageerror
インターフェイス
MessageEvent
origin
起源
source
始点
[132] ここで停止します。
[91] イベントを発火します。
対象
対象窓
型
message
インターフェイス
MessageEvent
origin
起源
source
始点
data
記録のDeserialized
ports
記録のTransferredValuesの MessagePort をすべて同じ順に含めた凍結配列

[33] 送信したメッセージは、 Window の message イベントとして受信することができます。

message を参照。

`MessagePort` と `DedicatedWorkerGlobalScope` と `Worker` の場合

[115] MessagePort オブジェクトと Worker オブジェクトと DedicatedWorkerGlobalScope オブジェクトの postMessage は、 message port post message options、すなわち次のようにしなければなりません >>111, >>156, >>158。

[157] ポートを、文脈オブジェクトにより、次の値に設定します。
MessagePort
文脈オブジェクト
DedicatedWorkerGlobalScope
文脈オブジェクトの暗示的ポート
Worker
文脈オブジェクトの暗示的ポート
[116] メッセージを、必須の第1引数を any として解釈した結果に設定します。
[117] オプション群を、省略可能な第2引数をオブジェクトの配列または MessagePortOptions として解釈した結果に設定します。
[182] オプション群が MessagePortOptions の場合、
1. [183] transfer を、 オプション群の transfer に設定します。
[184] それ以外の場合、
1. [185] transfer を、 オプション群に設定します。
[120] transfer にポートが含まれる場合、
1. [121] DataCloneError を投げ、ここで停止します。
[118] 対象ポートを、ポートのentangle されているポートに設定します。
[122] 対象ポートが null 以外で、 transfer に対象ポートが含まれるなら、
1. [123] doomed を、真に設定します。
2. [124] 開発者コンソールに、通信路が失われることを報告しても構いません。
[126] それ以外の場合、
1. [119] doomed を、偽に設定します。
[163] 結果を、 StructuredSerializeWithTransfer (メッセージ、transfer) の結果に設定します。例外が投げられたら、再び投げ、ここで停止します。
[133] 対象ポートが null 以外で、 doomed が偽なら、
1. [142] 結果についての処理 (>>125) を対象ポートのポートメッセージキューに追加します。

[125] 結果についての処理は、次のようなものです >>111。ここで、最終対象ポートは、実行側で指定される変数です (ポートメッセージキューに追加参照)。

[85] Realmを、最終対象ポートの関連Realmに設定します。
[165] 記録を、 StructuredDeserializeWithTransfer (結果, Realm) の結果に設定します。例外が投げられた場合、
1. [92] イベントを発火します。
  インターフェイス
  MessageEvent
  対象
  最終対象ポート
  型
  messageerror
2. [105] ここで停止します。
[168] イベントを発火します。
インターフェイス
MessageEvent
対象
最終対象ポート
型
message
data
記録の Deserialized
ports
記録の TransferredValues 内の各 MessagePort を同じ順序で含めた凍結済み配列

`BroadcastChannel` オブジェクトの場合

[140] BroadcastChannel オブジェクトの postMessage は、次のようにしなければなりません >>138。

[141] メッセージを、必須の第1引数を any として解釈した結果に設定します。
[143] 始点を、文脈オブジェクトに設定します。
[145] 始点の閉じ済みフラグが真なら、
1. [146] InvalidStateError を投げ、ここで停止します。
[144] 始点設定群を、始点のBroadcastChannel設定群オブジェクトに設定します。
[147] 始点通信路を、始点の通信路名に設定します。
[149] 複製メッセージを、StructuredSerialize(メッセージ、対象Realm) の結果に設定します。例外が投げられれば、再び投げ、ここで停止します。
[150] 終点群を、始点設定群と始点通信路のBroadcastChannelすべてのリストに設定します。
[151] 終点群から、始点を除去します。
[152] 終点群の各項目終点について、順に、
1. [153] タスクをキューに追加します。
  処理
  [154] 対象Realmを、終点の関連設定群オブジェクトのRealmに設定します。
  [136] 起源を、始点設定群の起源の直列化に設定します。
  [127] データを、 StructuredDeserialize (複製メッセージ, 対象Realm) の結果に設定します。例外が投げられた場合、
  [134] イベントを発火します。
  インターフェイス
  MessageEvent
  型
  messageerror
  対象
  終点
  origin
  起源
  [135] ここで停止します。
  [155] イベントを発火します。
  インターフェイス
  MessageEvent
  型
  message
  対象
  終点
  origin
  起源
  data
  データ
  タスク源
  終点の関連エージェントのイベントループのDOM操作タスク源
  タスクの文書
  終点の関連エージェントのイベントループが窓イベントループの場合、 終点のBoardcastChannel設定群オブジェクトの有責文書

[128] メッセージポート等を送ることはできません。 BroadcastMessage でできないことをするには、共有ワーカーを作って中継する必要があります。

歴史

前史

[198] window.name

[199] 素片識別子

[200] The <module> Tag http://json.org/module.html (名無しさん 2006-10-31 01:57:36 +00:00)
- [201] 消滅確認 2024-09-14T01:49:35.700Z
- [202] The <module> Tag, Douglas Crockford, 2006-10-30, 2024-09-14T01:49:26.000Z, 2006-12-16T06:49:43.157Z https://web.archive.org/web/20061216064835/http://www.json.org/module.html

[204] 他の <module> は <script type=module> 参照。

[203] HTML要素概説

要素名

module

日付

2006-10-30

説明

2006-10-30、 Douglas Crockford は module を提案した。現在の iframe と postMessage メソッドに当たる。

出典

ModuleTag: The <module> Tag, Douglas Crockford, 2006-10-30, 2024-09-14T01:49:26.000Z, 2006-12-16T06:49:43.157Z https://web.archive.org/web/20061216064835/http://www.json.org/module.html

注釈

Douglas Crockford JSON の開発で知られる。

登場

[14] 最初 Web Applications 1.0 に追加された時は Document オブジェクトに属していました。

[15] しかし同一起源ポリシーに関する検査が複雑になるとして、より「外側」である Window オブジェクトへと移動されました。

[16] Opera ははじめに Document オブジェクトに実装しましたが、後に Window オブジェクトに移動しました。他のWebブラウザーははじめから Window オブジェクトに実装しました。

[17] postMessage は HTML5 の新機能の中では最も早期に実装されたものの一つでした。

実装開始

[51] IE 8+ (2009/3) >>52
[54] Gecko 1.9+ / Firefox 3+ (2008/6) >>55
[56] WebKit 2007年末+ >>59
- [57] Chrome 4+ (2010/1) >>58
- [63] Safari 4+ (2009/6) >>64
[60] Opera
- [62] Document (旧仕様): 9+ (2006/6) >>59
- [61] Window: 9.5+ (2008/6) >>59

[1] Cross-document messaging in Opera - Arve Bersvendsen http://virtuelvis.com/archives/2005/12/cross-document-messaging

[50] Opera 8 β にはありませんでしたが、 Opera 8.5 では実装されていました。

[3] The cross-document messaging APIs (Ian Hickson <ian@...> 著, 2007-08-09 00:51:36 +09:00 版) http://permalink.gmane.org/gmane.org.w3c.whatwg.discuss/11634

[4] Index of /specs/dom/messages (2008-02-13 01:58:34 +09:00 版) http://www.hixie.ch/specs/dom/messages/

[23] Fixed a security problem with postMessage() (Ian Hickson <ian@...> 著, 2008-02-12 20:03:46 +09:00 版) http://permalink.gmane.org/gmane.org.w3c.whatwg.discuss/13237 (名無しさん)

[24] IE Team Feedback on HTML 5.0 Cross Document Messaging (Sunava Dutta <sunavad@...> 著, 2008-02-22 03:18:40 +09:00 版) http://permalink.gmane.org/gmane.org.w3c.whatwg.discuss/13320

[32] postMessage() issues (Ian Hickson <ian@...> 著, 2008-04-16 00:10:07 +09:00 版) http://permalink.gmane.org/gmane.org.w3c.whatwg.discuss/13716

[38] postMessage feedback (Ian Hickson <ian@...> 著, 2008-04-24 23:49:56 +09:00 版) http://permalink.gmane.org/gmane.org.w3c.whatwg.discuss/13867

[39] (X)HTML5 Tracking (2010-01-09 14:12:17 +09:00 版) http://html5.org/tools/web-apps-tracker?from=4547&to=4548

[40] HTML5 Communications (2010-01-09 10:10:53 +09:00 版) http://dev.w3.org/html5/postmsg/Overview.html

[41] IRC logs: freenode / #whatwg / 20100212 (2010-02-14 11:17:32 +09:00 版) http://krijnhoetmer.nl/irc-logs/whatwg/20100212#l-271

[42] David Baron's weblog: setTimeout with a shorter delay (2010-03-16 08:44:54 +09:00 版) http://dbaron.org/log/20100309-faster-timeouts

[43] [whatwg] postMessage's target origin argument can be a full URL in some implementations (2010-08-11 10:18:42 +09:00 版) http://lists.whatwg.org/pipermail/whatwg-whatwg.org/2010-August/027848.html

[44] HTML5 Revision Tracker (2010-08-11 23:17:32 +09:00 版) http://html5.org/tools/web-apps-tracker?from=5276&to=5277

[45] [whatwg] postMessage's target origin argument can be a full URL in some implementations ( (2010-11-16 08:52:44 +09:00 版)) http://lists.whatwg.org/htdig.cgi/whatwg-whatwg.org/2010-November/029037.html

[46] Web Applications 1.0 r5682 Revert r5277's removal of '/' as a magic value to postMessage(), since it has useful use cases. Paths in absolute URLs are still ignored without raising an exception. ( (2010-11-16 08:25:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=5681&to=5682

[47] HTML5 Web Messaging ( (2010-11-19 05:40:25 +09:00 版)) http://www.w3.org/TR/2010/WD-webmessaging-20101118/

[48] IE で postMessage 的実装をちゃんとやる - 冬通りに消え行く制服ガールは、夢物語にリアルを求めない。 - subtech ( (2010-12-07 22:02:13 +09:00 版)) http://subtech.g.hatena.ne.jp/cho45/20101207/1291719344

[49] HTML5 Web Messaging ( (2011-03-17 23:58:26 +09:00 版)) http://www.w3.org/TR/2011/WD-webmessaging-20110317/

[65] Web Applications 1.0 r6690 Make postMessage() accept the second and third arguments in either order. Compat with WebKit and hopefully solves the difficulty people have about remembering which goes first. ( (2011-10-18 06:47:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=6689&to=6690

[66] Web Applications 1.0 r6691 Revert last checkin. My testing was bogus. ( (2011-10-18 07:09:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=6690&to=6691

[67] HTML5 Web Messaging ( (2011-10-19 02:36:24 +09:00 版)) http://www.w3.org/TR/2011/WD-webmessaging-20111020/

[68] IE 6/7 で文書間通信を実現するための一案: Days on the Moon ( (2011-12-10 00:17:35 +09:00 版)) http://nanto.asablo.jp/blog/2011/12/08/6237308

[69] HTML5 Web Messaging ( (2012-03-12 22:06:22 +09:00 版)) http://www.w3.org/TR/2012/WD-webmessaging-20120313/

[70] HTML5 Web Messaging ( (2012-05-01 21:47:11 +09:00 版)) http://www.w3.org/TR/2012/CR-webmessaging-20120501/

[71] Securing Frame Communication in Browsers ( (2008-05-15 01:03:44 +09:00 版)) http://seclab.stanford.edu/websec/frames/post-message.pdf

[72] Compound Document by Reference Framework 1.0 ( (2010-08-17 16:50:04 +09:00 版)) http://www.w3.org/TR/CDR/#event-propagation

[73] Interview with Ian Hickson, HTML editor | HTML5 Doctor ( (2013-01-13 18:27:28 +09:00 版)) http://html5doctor.com/interview-with-ian-hickson-html-editor/

[74] RemoteDocumentMessaging - WHATWG Wiki ( (2013-06-24 05:31:29 +09:00 版)) http://wiki.whatwg.org/wiki/RemoteDocumentMessaging

[75] IRC logs: freenode / #whatwg / 20130621 ( (2013-06-24 19:18:13 +09:00 版)) http://krijnhoetmer.nl/irc-logs/whatwg/20130621#l-585

[76] [whatwg] web messaging - postMessage ( (2013-09-13 00:52:56 +09:00 版)) http://lists.whatwg.org/pipermail/whatwg-whatwg.org/2013-September/040800.html

[77] Web Applications 1.0 r8247 The bulk of this is editorial: refactoring how scripts are defined so that all the common stuff is in a shared 'settings object' rather than being duplicated per script. But this also cleans up how postMessage() interacts with the event loop and a few other things I've since forgotten. ( (2013-10-31 08:18:00 +09:00 版)) http://html5.org/tools/web-apps-tracker?from=8246&to=8247

[78] Web Applications 1.0 r8741 Try to explain why postMessage()'s privacy implications aren't actually anything new ( (2014-09-04 08:43:00 +09:00 版)) http://html5.org/r/8741

[79] JavaScript - WebWorkersで巨大データ転送の不思議 - Qiita ( (2014-09-05 02:14:11 +09:00 版)) http://qiita.com/Quramy/items/8c12e6c3ad208c97c99a

[5] CfC: publish Proposed Recommendation of Web Messaging; deadline March 28 (Arthur Barstow 著, 2015-03-21 21:52:25 +09:00 版) https://lists.w3.org/Archives/Public/public-webapps/2015JanMar/0848.html

[6] Part2 - browsersec - Browser Security Handbook, part 2 - Browser Security Handbook - Google Project Hosting (2015-03-31 16:38:48 +09:00 版) https://code.google.com/p/browsersec/wiki/Part2#Gaps_in_DOM_access_control

[7] YuzuJS/setImmediate (2015-04-01 12:18:25 +09:00 版) https://github.com/YuzuJS/setImmediate

Note that Internet Explorer 8 includes a synchronous version of postMessage. We detect this, or any other such synchronous implementation, and fall back to another trick.

[8] HTML5 Web Messaging ( (2015-04-07 00:52:40 +09:00 版)) http://www.w3.org/TR/2015/PR-webmessaging-20150407/

[9] HTML5 Web Messaging ( (2015-05-18 22:30:14 +09:00 版)) http://www.w3.org/TR/2015/REC-webmessaging-20150519/

[10] Errata/WebMessaging - WEBAPPS (2015-05-11 23:07:22 +09:00 版) https://www.w3.org/2008/webapps/wiki/Errata/WebMessaging

[11] All Results (2015-05-19 23:43:52 +09:00 版) https://w3c.github.io/test-results/webmessaging/all

[12] HTML5 Web Messaging (2015-05-18 22:30:14 +09:00 版) http://www.w3.org/TR/2015/REC-webmessaging-20150519/

Open Bugs 27128

[13] HTML5 Web Messaging (2015-05-18 22:30:14 +09:00 版) http://www.w3.org/TR/2015/REC-webmessaging-20150519/

Open Bugs 18242

[34] PSA: Change the Latest Editor's Drafts of WebStorage, WebWorkers, WebMessaging, Server-Sent Events and WebSockets (Xiaoqian Wu 著, 2015-10-20 02:52:22 +09:00 版) https://lists.w3.org/Archives/Public/public-webapps/2015OctDec/0099.html

[35] Safari 4.0 (2015-11-04 22:53:48 +09:00 版) https://developer.apple.com/library/safari/releasenotes/General/WhatsNewInSafari/Articles/Safari_4_0.html#//apple_ref/doc/uid/TP40014305-CH4-SW13

WebKit now supports the HTML5 cross-document messaging standard, allowing documents served from different domains to communicate with each other directly without the need for server relaying.

[36] High-performance Web Worker messages | Read the Tea Leaves (2016-03-02 09:24:25 +09:00 版) http://nolanlawson.com/2016/02/29/high-performance-web-worker-messages/

My tests confirmed that stringifying is indeed faster than sending raw objects, and that the message size has a dramatic impact on the speed of worker communication.
Furthermore, the only real benefit comes if you stringify the entire message. Even a small object that wraps the stringified message (e.g. {msg: JSON.stringify(message)}) performs worse than the fully-stringified case. (These results differ between Chrome, Firefox, and Safari, but keep reading for the full analysis.)

[37] Write structured clone algorithm in terms of ECMAScript · whatwg/html@bfb960c (2016-03-02 16:38:38 +09:00 版) https://github.com/whatwg/html/commit/bfb960c938580c95e77365e614218b952f96375b

[80] Make window.postMessage grab settings objects before going async · whatwg/html@26f5645 (2016-03-24 21:26:11 +09:00 版) https://github.com/whatwg/html/commit/26f5645b0c161c60903e945adace86165d56c03c

[84] Use FrozenArray for Navigator#languages and MessageEvent#ports · whatwg/html@e4df68a (2016-03-25 13:52:53 +09:00 版) https://github.com/whatwg/html/commit/e4df68a41b86753c7fcdd0d8ea4615f63ffc87e9

[86] Clarify settings object, realm, and global relationships · whatwg/html@0866f1b (2016-03-28 00:37:35 +09:00 版) https://github.com/whatwg/html/commit/0866f1b3f4b4ea5a99a30909e9bbe557dea0b460

[87] Editorial: else -> false in postMessage() algorithm · whatwg/html@60e5fc3 (2016-04-05 14:05:10 +09:00 版) https://github.com/whatwg/html/commit/60e5fc361572c8d0ef576dc78542ec4b845aef5b

[88] postMessage should always be flexible; HT @NAndreasson · w3c/webappsec-cowl@7ec257b (2016-04-07 11:06:22 +09:00 版) https://github.com/w3c/webappsec-cowl/commit/7ec257b9951bff0fb8f81253b94124eb1afe64e4

[89] Use USVString for all URLs ( (domenic著, 2016-05-20 22:02:29 +09:00)) https://github.com/whatwg/html/commit/018b983b77b2cd908f6d00100e7e0abe893dd2c3

[90] Use only the incumbent global in postMessage (domenic著, 2016-07-20 22:41:29 +09:00) https://github.com/whatwg/html/commit/8259a69aab7538b772beebad1ff69dca44b159ab

[95] Parse postMessage()'s targetOrigin argument (annevk著, 2016-07-22 01:32:19 +09:00) https://github.com/whatwg/html/commit/8282fc8dd47891160859375d0eacfcd08f9bdec4

[107] Tidy up the various postMessage algorithms (domenic著, 2016-07-28 02:42:32 +09:00) https://github.com/whatwg/html/commit/ee103bbdba81bdbb8eb8e1bf77e9565f6158c5be

[19] javascript - postMessage still broken on IE11? - Stack Overflow ( (2016-10-03 16:49:38 +09:00)) http://stackoverflow.com/questions/21070553/postmessage-still-broken-on-ie11

[94] Set some MessageEvent's isTrusted attributes to true (domenic著, 2016-10-26 02:33:24 +09:00) https://github.com/whatwg/html/commit/eecea4bf565a442e98c2ec98bf298d082d196282