如何使用js或jQuery向ajax请求添加自定义HTTP标头?


Answers:


584

有几种解决方案取决于您的需求...

如果要向单个请求添加自定义标头(或标头集),则只需添加headers属性:

// Request with custom header
$.ajax({
    url: 'foo/bar',
    headers: { 'x-my-custom-header': 'some value' }
});

如果要向每个请求添加默认标头(或标头集),请使用$.ajaxSetup()

$.ajaxSetup({
    headers: { 'x-my-custom-header': 'some value' }
});

// Sends your custom header
$.ajax({ url: 'foo/bar' });

// Overwrites the default header with a new header
$.ajax({ url: 'foo/bar', headers: { 'x-some-other-header': 'some value' } });

如果要向每个请求添加标头(或标头集), 则将beforeSend钩子与一起使用$.ajaxSetup()

$.ajaxSetup({
    beforeSend: function(xhr) {
        xhr.setRequestHeader('x-my-custom-header', 'some value');
    }
});

// Sends your custom header
$.ajax({ url: 'foo/bar' });

// Sends both custom headers
$.ajax({ url: 'foo/bar', headers: { 'x-some-other-header': 'some value' } });

编辑(更多信息):要注意的一件事情是,ajaxSetup您只能定义一组默认标题,而您只能定义一个beforeSend。如果您ajaxSetup多次调用,将仅发送最后一组头,并且仅执行最后一个发送前回调。


如果beforeSend在执行操作时定义一个新值会$.ajax怎样?
Kostas 2013年

3
您只能定义一个beforeSend回调。如果调用$.ajaxSetup({ beforeSend: func... })两次,则第二个回调将是唯一触发的回调。
Prestaul

1
更新了我的答案以添加有关的更多详细信息ajaxSetup
Prestaul

2
似乎不适用于CORS Request(每个浏览器)。有没有解决的办法?
svassr 2015年

1
@ Si8,对我来说,这似乎是一个跨域问题。您不能从一个域向另一个域发出请求。尝试调查CORS,看看是否有帮助。
Prestaul

54

或者,如果要为以后的每个请求发送自定义标头,则可以使用以下命令:

$.ajaxSetup({
    headers: { "CustomHeader": "myValue" }
});

这样,每个将来的ajax请求都将包含自定义标头,除非被请求的选项明确覆盖。您可以在这里找到更多信息ajaxSetup


1
在我真正想要完成此操作的地方,这似乎并没有实际起作用。
2013年

1
那么,您应该确保在实际ajax调用之前先调用ajaxSetup。我不知道这为什么行不通的其他原因:)
Szilard Muzsi 2013年

20

假设使用JQuery ajax,则可以添加自定义标头,例如-

$.ajax({
  url: url,
  beforeSend: function(xhr) {
    xhr.setRequestHeader("custom_header", "value");
  },
  success: function(data) {
  }
});

19

这是使用XHR2的示例:

function xhrToSend(){
    // Attempt to creat the XHR2 object
    var xhr;
    try{
        xhr = new XMLHttpRequest();
    }catch (e){
        try{
            xhr = new XDomainRequest();
        } catch (e){
            try{
                xhr = new ActiveXObject('Msxml2.XMLHTTP');
            }catch (e){
                try{
                    xhr = new ActiveXObject('Microsoft.XMLHTTP');
                }catch (e){
                    statusField('\nYour browser is not' + 
                        ' compatible with XHR2');                           
                }
            }
        }
    }
    xhr.open('POST', 'startStopResume.aspx', true);
    xhr.setRequestHeader("chunk", numberOfBLObsSent + 1);
    xhr.onreadystatechange = function (e) {
        if (xhr.readyState == 4 && xhr.status == 200) {
            receivedChunks++;
        }
    };
    xhr.send(chunk);
    numberOfBLObsSent++;
}; 

希望能有所帮助。

如果创建对象,则可以在发送请求之前使用setRequestHeader函数分配名称和值。


2
尽管这在2011年可能是正确的,但通常最好不要重蹈覆辙,而应使用Zepto或jQuery之类的AJAX库。
Dan Dascalescu 2014年

4
除非您试图将标头添加到现有的XHR2调用中,并且不想开始全部重写以使用jQuery来实现此目的,否则@gryzzly才是唯一可行的答案。
roryhewitt 2014年

@AliGajani问题是某些应用程序或库(例如THREE.js)不使用$.ajax*b / c函数,它们不依赖jQuery,而是使用XHR,因此这是在这些情况下唯一有效的选项。
科本

1
@AliGajani此外,它不仅是网络加载时间,还包括库的解析时间。另外,如果您不小心添加了哪些依赖项,则可以很快获得一个依赖项过多的项目
Oztaco-Reinstate Monica C.17.08.17

19

您也可以不使用jQuery来执行此操作。重写XMLHttpRequest的send方法并在其中添加标头:

XMLHttpRequest.prototype.realSend = XMLHttpRequest.prototype.send;
var newSend = function(vData) {
    this.setRequestHeader('x-my-custom-header', 'some value');
    this.realSend(vData);
};
XMLHttpRequest.prototype.send = newSend;

12

您应该避免$.ajaxSetup()docs中所述使用。请改用以下内容:

$(document).ajaxSend(function(event, jqXHR, ajaxOptions) {
    jqXHR.setRequestHeader('my-custom-header', 'my-value');
});

6

假设您的意思是“使用ajax时”和“ HTTP 请求标头”,然后headers在传递给的对象中使用该属性ajax()

标头(增加1.5)

默认: {}

要与请求一起发送的其他标头键/值对的映射。此设置在调用beforeSend函数之前设置;因此,标头设置中的任何值都可以从beforeSend函数中覆盖。

http://api.jquery.com/jQuery.ajax/



1

您可以使用js 提取

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.