jQuery функция $.ajaxSetup()

jQuery AJAX

Определение и применение

jQuery функция $.ajaxSetup() позволяет установить значения по умолчанию для будущих запросов AJAX.


Обращаю Ваше внимание, что все последующие AJAX запросы с использованием любой функции будут использовать указанные в этой функции настройки, если они не переопределены отдельными вызовами, до тех пор пока функция $.ajaxSetup() не будет вызвана с новыми настройками. Это может вызвать нежелательное поведение, поскольку другие вызывающие методы (например, плагины) могут ожидать нормальные настройки по умолчанию. По этой причине настоятельно рекомендуется не использовать этот API и вместо этой функции задавать параметры явно в вызове, или определить простой плагин для этого.

Глобальные функции обратного вызова должны быть установлены с соответствующими глобальными методами — обработчиками AJAX событий .ajaxComplete(), .ajaxError(), .ajaxSend(), .ajaxSuccess(), а не устанавливаться внутри функции $.ajaxSetup().


jQuery синтаксис:

Синтаксис 1.1:
$.ajaxSetup( { options } );

options - PlainObject

Добавлен в версии jQuery

1.1

Значения параметров

ПараметрОписание
optionsСтрока, содержащая URL адрес, на который отправляется AJAX запрос. Набор пар ключ/значение, которые настраивают запрос AJAX по умолчанию. Все параметры являются необязательными.
Функция .ajaxSetup() поддерживает следующие параметры:
  • accepts (по умолчанию: зависит от dataType).

    Тип: PlainObject.
    Набор пар ключ/значение, которые отправляется в Accept заголовка запроса. Этот заголовок сообщает серверу, какой ответ запрос будет принимать в ответ. Обратите внимание, что значение параметра, указанного в dataType (тип данных, которые мы ожидаем от сервера) сопоставляется с указанным в параметре. Кроме того, для корректной обработки ответа от сервера необходимо в параметре converters указать функцию, которая возвращает преобразованное значение ответа. Например:
    	$.ajaxSetup({
    	  accepts: {
    		mycustomtype: "application/x-some-custom-type"
    	  },
    		 
    	  // указываем как обрабатывать ответ
    	  converters: {
    		"text mycustomtype": function( result ) {
    		  
    		// возвращаем преобразованное значение ответа
    		  return newresult;
    		  }
    	  },
    		 
    	   // Ожидаемый тип данных ("mycustomtype")
    	  dataType: "mycustomtype"
    	});
  • async (по умолчанию: true).

    Тип: Boolean.
    По умолчанию, все запросы отправляются асинхронно, если вам необходимо организовать синхронные запросы, то установите этот параметр в false. Обратите внимание, что кроссдоменные запросы и элемент, параметр dataType которого имеет значение "jsonp" не поддерживают запросы в синхронном режиме. Учтите, что используя синхронные запросы вы можете временно заблокировать браузер отключив какие-либо действия пока запрос будет активен.
  • cache (по умолчанию: true, для dataType "script" и "jsonp" false).

    Тип: Boolean.
    Если задано значение false, то это заставит запрашиваемые страницы не кэшироваться браузером. Обратите внимание, что значение false будет правильно работать только с HEAD и GET запросами.
  • contents.

    Тип: PlainObject.
    Объект состоящий из пар строка/регулярное выражение, определяющих, как jQuery будет обрабатывать (парсить) ответ в зависимости от типа содержимого. Добавлен в версии jQuery 1.5.
  • contentType (по умолчанию: "application/x-www-form-urlencoded; charset=UTF-8").

    Тип: Boolean, или String.
    Определяет тип содержимого, которое указывается в запросе при передаче данных на сервер. С версии с jQuery 1.6 допускается указать значение false, в этом случае jQuery не передает в заголовке поле Content-Type совсем.
  • context.

    Тип: PlainObject.
    При выполнении AJAX функций обратного вызова контекстом их выполнения является объект window. Параметр context позволяет настроить контекст исполнения функции таким образом, что $( this ) будет ссылаться на определенный DOM элемент, или объект. Например:
    $.ajaxSetup({
      url: "test.html", // адрес, на который будет отправлен запрос
      context: $( ".myClass" ), // новый контекст исполнения функции
      success: function(){ // если запрос успешен вызываем функцию
        $( this ).html( "Всё ок" ); // добавлем текстовое содержимое в элемент с классом .myClass
       }
    });
    
  • converters

    Значения по умолчанию:
    {
    "* text": window.String, // любой тип в текст
    "text html": true, // текст в html
    "text json": jQuery.parseJSON, // текст в JSON
    "text xml": jQuery.parseXML // текст в XML
    }
    
    Тип: PlainObject.
    Объект, содержащий тип данных для конвертации и способ его преобразования. Значение каждого преобразователя является функцией, которая возвращает преобразованное значение ответа. Добавлен в версии jQuery 1.5.
  • crossDomain (по умолчанию: false для запросов внутри того же домена, true для кроссдоменных запросов).

    Тип: Boolean.
    Если вы хотите сделать кроссдоменный запрос находясь на том же домене (например jsonp-запрос), то установите этот параметр в true. Это позволит, к примеру, сделать перенаправление запроса на другой домен с вашего сервера. Добавлен в версии jQuery 1.5.
  • data.

    Тип: PlainObject, или String, или Array.
    Данные, которые будут отправлены на сервер. Если они не является строкой, то преобразуются в строку запроса. Для GET запросов строка будет добавлена к URL. Для того, чтобы предотвратить автоматическую обработку вы можете воспользоваться параметром processData со значением false. Если данные передаются в составе объекта, то он должен состоять из пар ключ/значение. Если значение является массивом, то jQuery сериализует несколько значений с одним и тем же ключом (в зависимости от значения параметра traditional, который позволяет задействовать традиционный тип сериализации основанный на методе $.param).
  • dataFilter.

    Тип: Function( String data, String type ) => Anything.
    Функция вызывается после успешного выполнения AJAX запроса и позволяет обработать "сырые" данные, полученные из ответа сервера. Возврат данных должен происходить сразу после их обработки. Функция принимает два аргумента: data - данные полученные от сервера в виде строки и type - тип этих данных (значение параметра dataType).
  • dataType (по умолчанию: xml, json, script, или html ).

    Тип: String.
    Определяет тип данных, который вы ожидаете получить от сервера. Если тип данных не указан, то jQuery будет пытаться определить его на основе типа MIME из ответа (XML тип MIME приведет к получению XML, с версии jQuery 1.4 json будет давать объект JavaScript, script будет выполнять скрипт, а все остальное будет возвращено в виде строки).

    Доступные типы (результат передается в качестве первого аргумента в функцию обратного вызова success):

    • "xml" - возвращает XML документ, который может быть обработан с помощью jQuery.
    • "html" - возвращает HTML как обычный текст, теги <script> будут обработаны и выполнены после вставки в объектную модель документа (DOM).
    • "script" - расценивает ответ как JavaScript и возвращает его как обычный текст. Отключает кэширование с помощью добавления параметра к строке запроса _=[TIMESTAMP], даже если парамета cache имеет значение true. Это превратит метод POST в GET для кроссдоменных запросов.
    • "json" - расценивает ответ как JSON и возвращает объект JavaScript. Кроссдоменные "json" запросы преобразуются в "jsonp", если в параметрах запроса не указано jsonp: false. Данные JSON парсятся в строгом порядке и должны соответствовать общепринятому формату, любой некорректный JSON отвергается и выдается ошибка. С версии jQuery 1.9, пустой ответ не принимается, сервер должен вернуть в качестве ответа NULL, или {}.
    • "jsonp" - загружает данные в формате JSON, используя при этом формат загрузки JSONP. Добавляет дополнительный параметр "?callback=?" в конец URL адреса для указания имени функции обработчика. Отключает кэширование путем добавления параметра _=[TIMESTAMP] к URL адресу,даже если парамета cache имеет значение true.
    • "text" - обычная текстовая строка.
    • несколько значений - значения разделяются пробелом. Начиная с версии 1.5, jQuery может преобразовать тип данных, который получен в Content-Type заголовка, в тип данных, который вам требуется. Например, если вы хотите, чтобы текстовый ответ был расценен как XML, используйте "text XML" для этого типа данных. Вы также можете сделать JSONP запрос, получить его в виде текста и интерпретировать его в формате XML: "jsonp text XML". Следующая строка позволит сделать тоже самое: "jsonp XML", jQuery будет пытаться конвертировать из JSONP в XML, после неудачной попытки попытается преобразовать JSONP в текст, а затем из текста уже в XML.
  • global (по умолчанию: true).

    Тип: Boolean.
    Логический параметр, который определяет допускается ли вызвать глобальные обработчики событий AJAX для этого запроса. Значением по умолчанию является true. Если Вам необходимо предотвратить вызов глобальных обработчиков событий, таких как .ajaxStart(), или .ajaxStop(), то используйте значение false.
  • headers (по умолчанию: { }).

    Тип: PlainObject.
    Объект, который содержит пары ключ/значение дополнительных заголовков запроса, предназначенные для отправки вместе с запросом с использованием объекта XMLHttpRequest. Обращаю Ваше внимание, что заголовок X-Requested-With: XMLHttpRequest добавляется всегда, но значение XMLHttpRequest по умоланию допускается изменить с использованием этого параметра. Значения headers также могут быть переопределены параметром beforeSend. Добавлен в версии jQuery 1.5.
  • ifModified (по умолчанию: false).

    Тип: Boolean.
    По умолчанию значение false, игнорирует поля заголовка HTTP запроса, а при значении true AJAX запрос переводится в статус успешно (success), только в том случае, если ответ от сервера изменился с момента последнего запроса. Проверка производится путем проверки поля заголовка Last-Modified. Начиная с версии jQuery 1.4, помимо заголовка Last-Modified производится проверка и "etag" (entity tag) - это закрытый идентификатор, присвоенный веб-сервером на определенную версию ресурса, найденного на URL. Если содержание ресурса для этого адреса меняется на новое, назначается и новый etag.
  • isLocal (по умолчанию: зависит от текущего местоположения).

    Тип: Boolean.
    Используйте значение true для определения текущего окружения как "локального" (например, file:///url), даже если jQuery не распознает его таким по умоланию. Следующие протоколы в настоящее время признаются как локальные: file, *-extension и widget. Если Вам необходимо изменить параметр isLocal, то рекомендуется сделать это один раз при помощи метода $.ajaxSetup(). Добавлен в версии jQuery 1.5.1.
  • jsonp

    Тип: Boolean, или String.
    Переопределяет имя функции обратного вызова в JSONP запросе. Это значение будет использоваться вместо "callback" ("http://basicweb.ru/test.php?callback=?") в составе части строки запроса в URL адресе. Например, значение {jsonp: "onLoad"} передастся на сервер в виде следующей строки запроса "http://basicweb.ru/test.php?onLoad=?".
    Начиная с версии jQuery 1.5 при установке значения параметра jsonp в значение false предотвращает добавление строки "?callback" к URL адресу, или попытки использовать "=?" для преобразования ответа. В этом случае Вы дополнительно должны указать значение параметра jsonpCallback, например:
    {
      jsonp: false,
      jsonpCallback: "callbackName"
    }
    
    По соображениям безопасности, если Вы не доверяете цели ваших AJAX запросов, то рекомендуется установить значение параметра jsonp в значение false.
  • jsonpCallback.

    Тип: String, или Function.
    Задает имя функции обратного вызова для JSONP запроса. Это значение будет использоваться вместо случайного имени, которое автоматически генерируется и присваивается библиотекой jQuery. Рекомендуется, чтобы jQuery самостоятелно генерировало уникальное имя, это позволит легче управлять запросами и обрабатывать возможные ошибки. В некоторых случаях установка собственного имени функции позволит улучшить браузерное кеширование GET запросов.
    Начиная с версии jQuery 1.5, вы можете в качестве значения параметра jsonpCallback указать функцию. В этом случае, в значение параметра jsonpCallback должно быть установлено возвращаемое значение этой функцией.
  • method (по умолчанию: "GET").

    Тип: String.
    Метод HTTP, используемый для запроса (например, "POST", "GET", "PUT"). Добавлен в версии jQuery 1.9.0.
  • mimeType.

    Тип: String.
    MIME тип, который переопределяет MIME тип, указанынй в объекте XHR по умолчанию. Добавлен в версии jQuery 1.5.1.
  • password.

    Тип: String.
    Пароль, который будет использован с XMLHttpRequest в ответе на запрос проверки подлинности доступа HTTP.
  • processData (по умолчанию: true).

    Тип: Boolean.
    По умолчанию данные, передаваемые в параметр data в качестве объекта будут обработаны и преобразованы в строку запроса, подходящую для типа данных по умолчанию "application/x-www-form-urlencoded". Если Вам необходимо отправить DOMDocument, или другие не обработанные данные, то установите значение этого параметра в false.
  • scriptCharset.

    Тип: String.
    Устанавливает атрибут charset (кодировка символов) на HTML тег <script>, используемый в запросе. Используется, когда кодировка на странице отличается от кодировки удаленного скрипта. Обратите внимание, что параметр scriptCharset применяется только в кроссдоменных запросах с параметром type со значением "GET" (по умолчанию) и параметром dataType со значением "jsonp", или "script".
  • statusCode (по умолчанию: { }).

    Тип: PlainObject.
    Объект числовых кодов HTTP и функции, которые будут вызываться, когда код ответа сервера имеет соотвествующее значение (определенный код HTTP). Например, следующая функция будет вызвана, если от сервера получен код ответа 404, или "Not found" (стандартный код ответа HTTP о том, что клиент был в состоянии общаться с сервером, но сервер не может найти данные согласно запросу.):
    $.ajaxSetup({
      statusCode: { 
        404: function(){ // выполнить функцию если код ответа HTTP 404
          alert( "страница не найдена" );
        },
        403: function(){ // выполнить функцию если код ответа HTTP 403
          alert( "доступ запрещен" );
        } 
      }
    });
    
  • timeout.

    Тип: Number.
    Устанавливает в миллисекундах таймаут для запроса. Значение 0 означает, что таймаут не установлен. Обращаю Ваше внимание, что этот параметр переопределяет значение таймаута, установленного с помощью метода .ajaxSetup(). Таймаут ожидания начинается в момент вызова метода $.ajax().
  • traditional.

    Тип: Boolean.
    Если вы планируете использовать традиционные параметры сериализации (подходит для использования в строке URL запроса или запроса AJAX), то установите значение этого параметра в true.
  • type (по умолчанию: "GET").

    Тип: String.
    Псевдоним (алиас) для параметра method. Вы должны использовать type, если вы используете версии jQuery до 1.9.0.
  • url (по умолчанию: текущая страница).

    Тип: String.
    Строка, содержащая URL адрес, на который отправляется запрос.
  • username.

    Тип: String.
    Имя пользователя, которое будет использовано с XMLHttpRequest в ответе на запрос проверки подлинности доступа HTTP.
  • xhr (по умолчанию: ActiveXObject, когда доступен (Internet Explorer), в других случаях XMLHttpRequest.

    Тип: Function().
    Обратный вызов для создания объекта XMLHttpRequest. С помощью этого параметра Вы можете переопределить объект XMLHttpRequest, чтобы обеспечить свою собственную реализацию.
  • xhrFields.

    Тип: PlainObject.
    Объект, содержащий пары имя_поля: значение_поля, которые будут установлены на объект XHR. Например, вы можете определить, должны ли создаваться кроссдоменные запросы с использованием таких идентификационных данных как cookie, авторизационные заголовки или TLS сертификаты:
    $.ajaxSetup({
      url: "cross_domain_url", // адрес, на который будет отправлен запрос
      xhrFields: { 
        withCredentials: true // поддерживается в jQuery 1.5.1 +
      }
    });
    

Пример использования

<!DOCTYPE html>
<html>
	<head>
		<title>Использование функции $.ajaxSetup()</title>
		<script src = "https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
		<script>
	$( document ).ready(function() {
	  $.ajaxSetup({
	    url: "ajax_script.js", // строка, содержащая URL адрес, на который отправляется запрос
	    dataType: "script" // расценивает ответ как JavaScript и возвращает его как обычный текст
	  });		
	  $( "button" ).click(function() { // задаем функцию при нажатиии на элемент <button>
	    $.ajax(); // выполняем асинхронный AJAX запрос без параметров 
	  })
	});
		</script>
	</head>
	<body>
		<button>Клик</button>
		<br><br>
		<div></div>
	</body>
</html>

В этом примере с использованием jQuery функции $.ajaxSetup() мы устанавливаем значения по умолчанию для будущих запросов AJAX. Будующий запрос будет иметь следующие параметры:

С помощью jQuery функции $.ajax() мы при нажатии на элемент <button> (кнопка) выполняем асинхронный AJAX запрос, который загружает скрипт JavaScript и выполняет его. Обратите внимание, что функция $.ajax() используется без параметров, настройка AJAX запроса происходит как раз за счёт функции $.ajaxSetup().

Результат нашего примера:

Пример использования jQuery функции $.ajaxSetup().
Пример использования jQuery функции $.ajaxSetup()
jQuery AJAX