XMLHttpRequest brauzer API si

XMLHttpRequest (XMLHTTP, XHR) — API, unga brauzerlarning skript tillari orqali murojaat qilinadi, masalan, JavaScript. U HTTP yoki HTTPS so‘rovlarini bevosita veb-serverga yuboradi (ma’lumotlar istalgan matn formatida, masalan, XML, HTML yoki JSON ko‘rinishida uzatilishi mumkin) va server javobidagi ma’lumotlarni bevosita so‘rov yuborgan skriptga yuklaydi. Sahifani qayta yuklamasdan serverga HTTP so‘rovlarini yuborish imkonini beradi.

XMLHTTP AJAX (Asynchronous JavaScript And XML) texnologiyasining muhim tarkibiy qismi bo‘lib, ko‘plab saytlarda foydalanuvchi so‘rovlariga tez javob beradigan dinamik ilovalarni yaratish uchun ishlatiladi. Masalan, XMLHTTP quyidagi saytlarda qo‘llanadi: Bing Maps, Gmail, Google Maps, Google Suggest, Facebook.

XMLHTTP faqat o‘zi ishlatilayotgan sahifa bilan bir xil domendagi fayllar bilan ishlaydi, ammo bu cheklovni aylanib o‘tish mumkin. JavaScriptda bo‘lgani kabi, cheklovdan o‘tish mexanizmi ham saytlararo skriptlardan himoyalanish talablari inobatga olingan holda ishlab chiqilgan (cross-site scripting).

Nomida XML qisqartmasi bo‘lsa-da, bu texnologiya uzatiladigan ma’lumotlar formatini cheklamaydi. Ma’lumotlarni XML, JSON, HTML shaklida yoki oddiy, tuzilmasiz matn sifatida yuborish mumkin. Dasturchi ma’lumot uzatish uchun o‘z formatini ham yaratishi mumkin. Biroq uzatishda matnli HTTP protokoli ishlatilishini hisobga olish kerak. Shu sababli GET usulidan foydalanilganda ma’lumotlar matn ko‘rinishida yuborilishi lozim (ya’ni ikkilik ma’lumotlar, masalan, base64 yordamida kodlanishi kerak). POST usulidan foydalanilganda esa bunday kodlash talab etilmaydi.

Tarixi

Bu texnologiya ilk bor Microsoft kompaniyasi tomonidan Outlook on the web komponentida, ya’ni Microsoft Exchange Server 2000 dasturiy mahsuloti tarkibida ishlab chiqilgan. U IXMLHTTPRequest deb nomlangan. Keyinchalik ushbu ishlanmalar MSXML 2.0 tarkibiga ActiveX obyekti sifatida kiritilgan va unga JScript, VBScript yoki brauzer qo‘llab-quvvatlaydigan boshqa skript tillari orqali murojaat qilish mumkin bo‘lgan. MSXML 2.0 Internet Explorer 5 brauzeri tarkibiga kiritilgan.

Keyinchalik Mozilla loyihasi dasturchilari Mozilla 0.6 brauzeri uchun nsIXMLHttpRequest deb atalgan mos versiyani ishlab chiqdilar. Komponentga murojaat XMLHttpRequest nomli JavaScript obyekti orqali amalga oshirildi. Biroq to‘liq funksionallikka faqat Mozilla 1.0 versiyasida erishildi. Keyinchalik XMLHttpRequest qo‘llab-quvvatlovi Safari 1.2, Opera 8.01 va boshqa brauzerlarda ham paydo bo‘ldi.

So‘nggi rasmiy spetsifikatsiya — 1.0-versiya (XMLHttpRequest, 19-dekabr 2012-yil) bo‘lib, u amaldagi standart (Living Standard) maqomiga ega; 2.0-versiya esa (XMLHttpRequest Level 2, 17-yanvar 2012-yil) ishchi loyiha maqomiga ega. Ikkinchi versiyada bajarilish jarayonini kuzatuvchi hodisa ishlov beruvchilari, domenlararo so‘rovlarni qo‘llab-quvvatlash hamda ikkilik ma’lumotlar bilan ishlash imkoniyati kiritilgan.

XMLHttpRequest sinfining metodlari

Metod Tavsif
abort() Joriy so‘rovni bekor qiladi, barcha sarlavhalarni o‘chiradi va server javobi matnini null qiymatiga o‘rnatadi.
getAllResponseHeaders() Barcha HTTP sarlavhalarining to‘liq ro‘yxatini satr ko‘rinishida qaytaradi. Sarlavhalar qator ko‘chirish belgilari (CR+LF) bilan ajratiladi.
Xatolik bayrog‘i true bo‘lsa, bo‘sh satr qaytaradi.
Holat 0 yoki 1 bo‘lsa, INVALID_STATE_ERR xatoligini keltirib chiqaradi.
getResponseHeader(headerName) Ko‘rsatilgan sarlavhaning qiymatini qaytaradi.
Xatolik bayrog‘i true bo‘lsa, null qaytaradi.
Sarlavha topilmasa, null qaytaradi.
Holat 0 yoki 1 bo‘lsa, INVALID_STATE_ERR xatoligini keltirib chiqaradi.
open(method, URL, async, userName, password) So‘rovning metodi, URL manzili va boshqa ixtiyoriy parametrlarini belgilaydi;
async parametri jarayon asinxron rejimda bajarilishini belgilaydi.
Oxirgi ikkita parametr majburiy emas.
send(content) So‘rovni serverga yuboradi.
setRequestHeader(label, value) So‘rovga HTTP sarlavhasini qo‘shadi.
overrideMimeType(mimeType) Server hujjatning MIME turini ko‘rsatmagan yoki noto‘g‘ri ko‘rsatgan bo‘lsa, uni belgilash imkonini beradi.
Diqqat: bu metod Internet Explorer brauzerida mavjud emas!

XMLHttpRequest sinfining xususiyatlari

Xususiyat Tur Tavsif
onreadystatechange EventListener Obyektning holati har safar o‘zgarganda yuz beradigan hodisa uchun ishlov beruvchi. Nomi kichik harflar bilan yozilishi kerak.
readyState unsigned short Obyektning joriy holati (0 — ishga tayyorlanmagan, 1 — ochilgan, 2 — ma’lumot yuborilmoqda, 3 — ma’lumot olinmoqda, 4 — ma’lumot yuklangan)
responseText DOMString So‘rovga berilgan javob matni.
Holat 3 yoki 4 bo‘lmasa, bo‘sh satr qaytaradi.
responseXML Document XML formatidagi so‘rov javobini keyinchalik quyidagi vosita orqali qayta ishlash mumkin: DOM.
Holat 4 bo‘lmasa, null qaytaradi.
status unsigned short HTTP holat kodi son ko‘rinishida (404 — «Not Found», 200 — «OK» va hokazo)
statusText DOMString Holatning matn ko‘rinishi («Not Found», «OK» va hokazo).
Holat aniqlanmasa, foydalanuvchi brauzeri INVALID_STATE_ERR xatoligini yuzaga keltirishi kerak.

XMLHttpRequest sinfi keltirib chiqaradigan xatoliklar

Nomi Kodi Tavsif
SECURITY_ERR 18 Foydalanuvchi brauzerining xavfsizlik sozlamalari taqiqlagan so‘rovni yuborishga urinishda yuzaga keladi.
NETWORK_ERR 101 Tarmoq xatoligi yuz berganda (sinxron so‘rov vaqtida) sodir bo‘ladi.
ABORT_ERR 102 Foydalanuvchi so‘rovni to‘xtatganda (sinxron so‘rov vaqtida) yuzaga keladi.

Foydalanishga misol

XMLHttpRequest obyekti bilan ishlash tartibini quyidagicha ifodalash mumkin:

  1. XMLHttpRequest obyektining nusxasini yaratish
  2. Ulanishni ochish
  3. Hodisa ishlov beruvchisini o‘rnatish (IE brauzerida buni ulanishni ochgandan keyin, so‘rovni yuborishdan oldin bajarish kerak)
  4. So‘rovni yuborish.

XMLHttpRequest obyektining nusxasini yaratish.

Bu bosqichda turli brauzerlar uchun alohida yondashuv talab qilinadi. Obyektni yaratish usuli farq qiladi: IE 5 — IE 6 brauzerlarida u ActiveXObject orqali, boshqa brauzerlarda (IE 7 va undan keyingi versiyalar, Mozilla, Opera, Chrome, Netscape va Safari) esa ichki XMLHttpRequest turidagi obyekt sifatida yaratiladi.

Internet Explorer brauzerining eski versiyalarida chaqiruv quyidagicha bo‘ladi:

var req = new ActiveXObject("Microsoft.XMLHTTP");

Boshqa brauzerlarda esa:

var req = new XMLHttpRequest();

Demak, kodning turli brauzerlarda ishlashini ta’minlash uchun window.XMLHttpRequest va window.ActiveXObject obyektlari mavjudligini tekshirish va qaysi biri mavjud bo‘lsa, o‘shandan foydalanish kifoya.

Universal yechim sifatida quyidagi funksiyadan foydalanish taklif etiladi:

function createRequestObject() {
  if (typeof XMLHttpRequest === 'undefined') {
    XMLHttpRequest = function() {
      try { return new ActiveXObject("Msxml2.XMLHTTP.6.0"); }
        catch(e) {}
      try { return new ActiveXObject("Msxml2.XMLHTTP.3.0"); }
        catch(e) {}
      try { return new ActiveXObject("Msxml2.XMLHTTP"); }
        catch(e) {}
      try { return new ActiveXObject("Microsoft.XMLHTTP"); }
        catch(e) {}
      throw new Error("This browser does not support XMLHttpRequest.");
    };
  }
  return new XMLHttpRequest();
}

Hodisa ishlov beruvchisini o‘rnatish, ulanishni ochish va so‘rovlarni yuborish

Bu chaqiruvlar quyidagicha ko‘rinadi:

req.open(<"GET"|"POST"|...>, <url>[, <asyncFlag>[, <user>, <password>]]);
req.onreadystatechange = processReqChange;

Bu yerda:

  • <"GET"|«POST»|…> — so‘rov metodi. Quyidagi metodlardan foydalanish mumkin: DELETE, GET, HEAD, OPTIONS, POST, PUT.
  • <url> — so‘rov manzili.
  • <asyncFlag> — asinxron so‘rovdan foydalanish yoki foydalanmaslikni belgilovchi bayroq. Odatiy qiymati true.
  • <user>, <password> — mos ravishda foydalanuvchi nomi va parol. Zarurat bo‘lganda ko‘rsatiladi.

So‘rovning barcha parametrlari belgilab olingach, uni yuborish qoladi. Buning uchun send() metodidan foydalaniladi. ActiveX ishlatilmaydigan versiyada GET so‘rovi yuborilganda null parametrini ko‘rsatish kerak, boshqa hollarda esa hech qanday parametr bermaslik mumkin. GET so‘rovida har doim null ko‘rsatilsa ham, bu xato hisoblanmaydi:

req.send(null);

Shundan so‘ng yuqorida ko‘rsatilgan hodisa ishlov beruvchisi ishga tushadi. U amalda dasturning asosiy qismi hisoblanadi. Odatda ishlov beruvchi so‘rov holatining barcha mumkin bo‘lgan kodlarini aniqlab, tegishli amallarni bajaradi, shuningdek, yuzaga kelishi mumkin bo‘lgan xatoliklarni qayta ishlaydi. Ushbu ikkita funksiyadan foydalanilgan kod namunasi:

var req;

function loadXMLDoc(url)
{
    req = null;
    if (window.XMLHttpRequest) {
        try {
            req = new XMLHttpRequest();
        } catch (e){}
    } else if (window.ActiveXObject) {
        try {
            req = new ActiveXObject('Msxml2.XMLHTTP');
        } catch (e){
            try {
                req = new ActiveXObject('Microsoft.XMLHTTP');
            } catch (e){}
        }
    }

    if (req) {       
        req.open("GET", url, true);
        req.onreadystatechange = processReqChange;
        req.send(null);
    }
}

function processReqChange()
{
  try { // Важно!
    // только при состоянии "complete"
    if (req.readyState == 4) {
        // для статуса "OK"
        if (req.status == 200) {
            // обработка ответа
        } else {
            alert("Не удалось получить данные:\n" +
                req.statusText);
        }
    }
  }
  catch( e ) {
      // alert('Ошибка: ' + e.description);
      // В связи с багом XMLHttpRequest в Firefox приходится отлавливать ошибку
      // Bugzilla Bug 238559 XMLHttpRequest needs a way to report networking errors
      // https://bugzilla.mozilla.org/show_bug.cgi?id=238559
  }
}

Ma’lum muammolar

Yuklanayotgan video uchun bufer hajmining kichikligi.

Adabiyotlar

  • Deyv Kreyn, Erik Paskarello, Darren Jeyms. AJAX amalda: Asynchronous JavaScript and XML texnologiyasi = Ajax in Action. — M.: «Vilyams», 2006. — B. 640. — ISBN 1-932394-61-3.
  • Dari K., Brinzare B., Cherchez-Toza F., Busika M. AJAX va PHP: dinamik veb-ilovalarni ishlab chiqish. — SPb.: Simvol Plyus, 2006. — B. 336. — ISBN 5-93286-077-4.

Havolalar

Brauzerlardagi amalga oshirilishi: