SYNCERのロゴ
アイキャッチ画像

XMLHttpRequest.setRequestHeader() - リクエストヘッダーを追加する

setRequestHeader()は、XMLHttpRequestのメソッドです。ajax通信で任意のリクエストヘッダーを追加します。

概要

名前
setRequestHeader
所属
XMLHttpRequest
IDL
void setRequestHeader(ByteString name, ByteString value);
仕様書
https://xhr.spec.whatwg.org/#dom-xmlhttprequest-setrequestheader

説明

第1引数(name)には、ヘッダー名を指定します。

第2引数(value)には、ヘッダーの値を指定します。

このメソッドは、readyStateの値がOPENED(1)の時、具体的にはopen()send()の間で実行しなければいけません。

既存のヘッダーを指定した場合、値が上書きされます。

Host、Cookie、User-agentなど、セキュリティに関わるヘッダーは変更できません。

クロスオリジンのajax通信でカスタムヘッダーの送信を許可するには、サーバー側でAccess-Control-Allow-Headers: X-SYNCER1,X-SYNCER2というように、許可するヘッダー名を返す必要があります。ワイルドカードは使用できません。

デモ

ボタンをクリックすると、あるテキストファイルにアクセスします。このテキストファイルは動的に、受け取ったリクエストヘッダーの内容をそのまま出力します。また、"X-SYNCER"というカスタムヘッダーのみ受け付けています。セットしたヘッダーがリクエストヘッダーに含まれているか確認して下さい。

<!-- このコードは編集できます。 -->

<!DOCTYPE html>
<html>
<head>
<style>
body { word-break: break-all ; tab-size: 2 ; }
div#result { white-space: pre-wrap ; }
textarea#hoge { box-sizing: border-box ; width: 100% ; font-size: 16px ; }
</style>
</head>
<body>
<p><button id="send">通信 [send()]</button></p>
<hr>
<textarea rows="15" id="hoge"></textarea>
<hr>
<div id="result"></div>
<script>
var xhr = new XMLHttpRequest() ;
xhr.open( "GET", "https://syncer.ch/requestHeader" ) ;
xhr.setRequestHeader( "X-SYNCER", "hello!!" ) ;

xhr.onloadstart = function ( event ) {
	appendText( "[loadstart] ダウンロードを開始しました!!" + "\n" ) ;
}

xhr.onprogress = function ( event ) {
	appendText( "[progress] ダウンロード中…" + "\n" ) ;
}

xhr.onload = function ( event ) {
	appendText( "[load] ダウンロードが正常に完了しました!!" + "\n" ) ;
}

xhr.onloadend = function ( event ) {
	appendText( "[loadend] ダウンロードを終了しました!!" + "\n" ) ;
}

xhr.addEventListener( "load", function ( event ) {
	document.getElementById( "hoge" ).value = xhr.response ;
} ) ;

document.getElementById( "send" ).onclick = function () {
	xhr.send() ;
}

function appendText ( text ) {
	document.getElementById( "result" ).appendChild( document.createTextNode( text ) ) ;
}
</script>
</body>
</html>

サポート状況

ChromeFirefoxSafariEdgeIEOperaiOS SafariAndroid
  • Twitterでシェア
  • Facebookでシェア
  • Google+でシェア
  • はてなブックマークでシェア
  • pocketに保存
  • LINEでシェア
更新履歴
2017年10月23日 (月)
コンテンツを公開しました。