非同期HTTP通信を実現する。元々は名前の通りXMLデータ通信のためのAPIである。Firefox、Safari、Opera、IE7ではスクリプト実行環境のネイティブオブジェクトとして使用できる。IE6以前ではJScriptのActiveX呼び出しとして使用する。
各ブラウザで共通に使用できるXMLHttpRequestオブジェクトのメンバです。
- onreadystatechange
- オブジェクトの状態が変化したときに実行されるイベントハンドラ。関数オブジェクトをセットして通信状態(readyStateプロパティ)が変化したときにコールバックされる関数を指定。
- readyState
- オブジェクトの状態を示す値。
0 = uninitialized、1 = loading、2 = loaded、3 = interactive、4 = complete
readyStateが4のとき、以下に示すプロパティからレスポンスを取得できるようになる。
- responseText
- HTTPレスポンスボディを文字列として取得するプロパティ。
- responseXML
- HTTPレスポンスボディをDOMドキュメントオブジェクトとして取得できるプロパティ。レスポンスはXML文書でなくてはならない。
- status
- HTTPレスポンスステータスコード、200、404等。
- statusText
- ステータスコードに対応するメッセージ、200ならOK、404ならNot Found。
- abort()
- 通信を中断します。同一のXMLHttpRequestオブジェクトに対して連続でsendする場合、現在の通信をキャンセルする。
- getAllResponseHeaders()
- HTTPレスポンスヘッダを全て文字列として取得。
- getResponseHeader(headerLabel)
- headerLabelで指定したレスポンスヘッダの内容を取得。
- open(method, URL, asyncFlag, userName, password)
- 指定したURLに接続する。methodにはPOSTまたはGETを指定する。ブラウザによってはDELETEやPUTを発行することも可能。asyncFlagは、通信を非同期とするかどうかのフラグ。falseを指定するとsendメソッド実行時、通信完了まで処理がブロックされる。userNameとpasswordはBASIC認証のユーザ名、パスワードを指定。asyncFlag, userName, passwordは省略可能。
- send(content)
- HTTPリクエストを送信する。contentはレスポンスボディ。レスポンスボディが無い場合はnullを渡すが、Operaではnullを渡すとエラーになるため空文字列を渡す。
- setRequestHeader(label, value)
- labelで指定したHTTPリクエストヘッダにvalueをセットする。
Dynamic HTML and XML: The XMLHttpRequest Object
sendメソッドにnullを渡せない。(Opera 8)→空文字を渡す。
ステータス204の場合、statusが1223になる(IE6)
setRequestHeaderが存在するのに、動作しない(Opera 8)
ステータス200で、レスポンスボディが空の場合、statusがundefined(Safari 2)
リダイレクトレスポンス時に、Locationヘッダが付いていない場合、statusが0(IE6)
responseTextで日本語が文字化け(Safari 2)→
回避法