paramsSerializer — Query parametrlarni maxsus formatda serialize qilish
Axios'da paramsSerializer yordamida massiv va murakkab obyekt parametrlarini moslash, URLSearchParams va qs kutubxonasi yordamida maxsus query string yasash.
15-dars
paramsSerializer — Query parametrlarni maxsus formatda serialize qilish
Muammo nimada?
Tasavvur qiling, siz serverga bir nechta ID'larni massiv ko'rinishida yubormoqchisiz: ids: [1, 2, 3].
Standart holatda Axios buni quyidagi ko'rinishga o'tkazadi (brackets notation):
- Axios standarti:
?ids[]=1&ids[]=2&ids[]=3
Lekin sizning backend'ingiz (masalan, eskiroq REST API yoki boshqa texnologiyada yozilgan server) bu ma'lumotni boshqacha talab qilishi mumkin:
- Variant A (Vergul bilan ajratilgan):
?ids=1,2,3 - Variant B (Qavslarsiz takrorlanish):
?ids=1&ids=2&ids=3 - Variant C (Chuqur obyektlar):
?filter[user][status]=active
Ana shunday holatlarda URL qanday yasalishini o'zimiz to'liq boshqarishimiz uchun paramsSerializer funksiyasidan foydalanamiz.
1. Real misol: Massivni vergul bilan ajratib yuborish (?ids=1,2,3)
Ko'plab zamonaviy API'lar massiv parametrlarni qavslarsiz, vergul yordamida qabul qilishni afzal ko'radi. Buni paramsSerializer yordamida juda oson hal qilamiz:
import { apiClient } from '../api/axios';
interface FilterParams {
status: string;
categoryIds: number[];
}
export const getFilteredProducts = async (filters: FilterParams) => {
const response = await apiClient.get('/products', {
params: {
status: filters.status,
ids: filters.categoryIds, // [1, 2, 3]
},
// paramsSerializer funksiyasi params obyektini olib, tayyor query string qaytarishi kerak
paramsSerializer: (params) => {
const searchParams = new URLSearchParams();
// Har bir parametrni tekshirib chiqamiz
Object.entries(params).forEach(([key, value]) => {
if (value !== undefined && value !== null) {
// Agar qiymat massiv bo'lsa, ularni vergul bilan birlashtiramiz (1,2,3)
if (Array.isArray(value)) {
searchParams.append(key, value.join(','));
} else {
searchParams.append(key, String(value));
}
}
});
return searchParams.toString();
},
});
return response.data;
};
Natijada yaratiladigan URL: /products?status=active&ids=1%2C2%2C3 (bu yerda %2C vergulning URL kodlangan ko'rinishi hisoblanadi).
2. qs kutubxonasi yordamida murakkab obyektlarni serialize qilish
Agar sizning loyihangizda juda murakkab, ichma-ich joylashgan obyektlar (nested objects va arrays of objects) ko'p bo'lsa, ularni qo'lda yozish qiyin. Buning uchun JavaScript olamida mashhur bo'lgan qs nomli yordamchi kutubxonadan foydalanishadi.
1-qadam: qs ni o'rnatish
npm install qs
npm install --save-dev @types/qs
2-qadam: Axios'da qs.stringify ishlatish
import { apiClient } from '../api/axios';
import qs from 'qs';
interface ComplexSearchQuery {
search: string;
filters: {
priceRange: [number, number];
brands: string[];
};
}
export const searchWithComplexParams = async (queryData: ComplexSearchQuery) => {
const response = await apiClient.get('/search', {
params: queryData,
// qs kutubxonasi barcha murakkab obyektlarni mukammal serialize qiladi
paramsSerializer: (params) => {
return qs.stringify(params, {
arrayFormat: 'brackets', // Massivlarni qanday formatda yozishni belgilaydi
});
},
});
return response.data;
};
3. Global baseURL instansiyasida paramsSerializer'ni sozlash
Agar siz butun loyiha bo'ylab barcha so'rovlarda bitta maxsus serialize qoidasi amal qilishini istasangiz, uni to'g'ridan-to'g'ri axios.create() ichiga yozib qo'yishingiz mumkin:
import axios, { AxiosInstance } from 'axios';
import qs from 'qs';
export const globalApiClient: AxiosInstance = axios.create({
baseURL: 'https://api.example.com/v1',
// Global miqyosda barcha params obyektlari qs orqali tarjima qilinadi
paramsSerializer: (params) => {
return qs.stringify(params, { encode: false }); // encode: false maxsus belgilarni saqlab qoladi
},
});
Xulosa
- Default: Axios o'zi massivlarni
ids[]=1&ids[]=2qilib yuboradi. paramsSerializer: Agar backend boshqa formatni talab qilsa (ids=1,2,3yoki murakkab ichma-ich obyektlar), query string'ni o'zingiz istagan ko'rinishda yig'ish imkonini beradi.