Dio encapsulé pour les requêtes réseau flutter (gestion des cookies, ajout d'intercepteurs, téléchargement de fichiers, gestion des exceptions, annulation des requêtes, etc.)

La raison pour laquelle,Des milliers de mots en une seule phrase：Facile à utiliser.

DioAutres

dioEst un puissantDart HttpBibliothèque des requêtes,SoutienRestful API、FormData、Intercepteur、Demande d'annulation、CookieGestion、Téléchargement de fichiers/Télécharger、Temps mort、Adaptateurs personnalisés, etc...

• Ajouter une dépendance,Attention!3.0.+Est une mise à jour incompatible

dependencies:
 dio: ^3.0.9


• Un exemple minimaliste

import 'package:dio/dio.dart';
void getHttp() async {
 try {
 Response response = await Dio().get("http://www.baidu.com");
 print(response);
 } catch (e) {
 print(e);
 }
}


<br>

Début de l'emballage

• Les demandes de réseau sont souvent utilisées,Donc, juste un exemple,Créer un nouveau nomhttpUtilDocuments

class HttpUtil {
 static HttpUtil instance;
 Dio dio;
 BaseOptions options;

 CancelToken cancelToken = new CancelToken();

 static HttpUtil getInstance() {
 if (null == instance) instance = new HttpUtil();
 return instance;
 }
}


• Configuration et initialisationDio

 /*
 * config it and create
 */
 HttpUtil() {
 //BaseOptions、Options、RequestOptions  Vous pouvez configurer les paramètres , Les niveaux de priorité augmentent successivement , Et peut outrepasser les paramètres en fonction du niveau de priorité
 options = new BaseOptions(
 //Adresse de base demandée,Peut contenir des sous - Chemins
 baseUrl: "http://www.google.com",
 //Délai de connexion au serveur,En millisecondes.
 connectTimeout: 10000,
 // L'intervalle entre la réception des données avant et après le flux de réponse ,En millisecondes.
 receiveTimeout: 5000,
 //HttpEn - tête de la demande.
 headers: {
 //do something
 "version": "1.0.0"
 },
 //DemandeContent-Type,La valeur par défaut est"application/json; charset=utf-8",Headers.formUrlEncodedContentType Le corps de la demande est automatiquement encodé .
 contentType: Headers.formUrlEncodedContentType,
 //Indique les attentes dans ce format(Comment)Accepter les données de réponse.Accepté4Type d'espèce `json`, `stream`, `plain`, `bytes`. La valeur par défaut est `json`,
 responseType: ResponseType.json,
 );

 dio = new Dio(options);
 }


Configuration en un coup d'oeil ,Mais il y a un problème potentiel,Les étudiants attentifs peuvent trouver,baseUrlLes paramètres sont fixes, Il est très possible de demander deux adresses de noms de domaine ou plus dans le développement réel , Alors comment changer dynamiquement baseUrlEt alors?？

La configuration ici est BaseOptions,En fait, il y en a d'autres.Options、RequestOptions,  Vous pouvez configurer les paramètres , Les niveaux de priorité augmentent successivement , Et peut outrepasser les paramètres en fonction du niveau de priorité

BaseOptions  Configuration de la demande de classe de base OptionsConfiguration d'une seule demandeRequestOptions Configuration réelle demandée

Alors..., Nous pouvons créer des RequestOptions, Puis remplacer ou remplacer BaseOptions  Ajouter aux paramètres de la requête

Par exemple,：

RequestOptions requestOptions=new RequestOptions(
 baseUrl: "http://www.google.com/aa/bb/cc/"
 );


<br>

getDemande

 /*
 * getDemande
 */
 get(url, {data, options, cancelToken}) async {
 Response response;
 try {
 response = await dio.get(url, queryParameters: data, options: options, cancelToken: cancelToken);
 print('get success---------${response.statusCode}');
 print('get success---------${response.data}');

// response.data; Corps de réponse
// response.headers; En - tête de réponse
// response.request; Corps demandeur
// response.statusCode; Code d'état

 } on DioError catch (e) {
 print('get error---------$e');
 formatError(e);
 }
 return response.data;
 }


url：Adresse demandéedata：Paramètres de demandeoptions：Demande de configurationcancelToken： Annuler l'identification

<br>

postDemande

 /*
 * postDemande
 */
 post(url, {data, options, cancelToken}) async {
 Response response;
 try {
 response = await dio.post(url, queryParameters: data, options: options, cancelToken: cancelToken);
 print('post success---------${response.data}');
 } on DioError catch (e) {
 print('post error---------$e');
 formatError(e);
 }
 return response.data;
 }


post FormFormulaire

Comme d'habitude.post Les demandes sont similaires ,C'est juste...data C'est juste un changement

FormData formData = FormData.from({
 "name": "wendux",
 "age": 25,
 });
response = await dio.post("/info", data: formData);


CréationFormData, Et au lieu de l'original dataC'est tout.

<br>

Gestion des exceptions

En cas d'exception, Bien sûr, plus il est clair, plus il est prudent, mieux c'est ,Et plus facile à gérer

 /*
 * errorTraitement uniforme
 */
 void formatError(DioError e) {
 if (e.type == DioErrorType.CONNECT_TIMEOUT) {
 // It occurs when url is opened timeout.
 print("Délai de connexion");
 } else if (e.type == DioErrorType.SEND_TIMEOUT) {
 // It occurs when url is sent timeout.
 print("Délai de demande");
 } else if (e.type == DioErrorType.RECEIVE_TIMEOUT) {
 //It occurs when receiving timeout
 print("Délai de réponse");
 } else if (e.type == DioErrorType.RESPONSE) {
 // When the server response, but with a incorrect status, such as 404, 503...
 print("Une exception s'est produite");
 } else if (e.type == DioErrorType.CANCEL) {
 // When the request is cancelled, dio will throw a error with this type.
 print("Demande d'annulation");
 } else {
 //DEFAULT Default error type, Some other Error. In this case, you can read the DioError.error if it is not null.
 print("Erreur inconnue");
 }
 }


<br>

CookieGestion

CookieLa gestion esthttp Un sujet qui ne s'ouvre pas , Pour garder la conversation persistante ,Oui.cookiePersistance

• Dépendance

dependencies:
 dio_cookie_manager: ^1.0.0


• Introduction

import 'package:cookie_jar/cookie_jar.dart';
import 'package:dio/dio.dart';
import 'package:dio_cookie_manager/dio_cookie_manager.dart';


• Utiliser

//CookieGestion
dio.interceptors.add(CookieManager(CookieJar()));


<br>

Ajouter un intercepteur

L'intercepteur peut demander 、Avant de répondre、error Avant de faire quelques prétraitements


 dio = new Dio(options);
 
 //Ajouter un intercepteur
 dio.interceptors.add(InterceptorsWrapper(onRequest: (RequestOptions options) {
 print("Avant la demande");
 // Do something before request is sent
 return options; //continue
 }, onResponse: (Response response) {
 print("Avant de répondre");
 // Do something with response data
 return response; // continue
 }, onError: (DioError e) {
 print("Avant l'erreur");
 // Do something with response error
 return e; //continue
 }));


<br>

Télécharger le fichier

Le téléchargement de fichiers est également souvent utilisé , Comme télécharger des photos , Ou une mise à jour

 /*
 * Télécharger le fichier
 */
 downloadFile(urlPath, savePath) async {
 Response response;
 try {
 response = await dio.download(urlPath, savePath,onReceiveProgress: (int count, int total){
 //Progrès
 print("$count $total");
 });
 print('downloadFile success---------${response.data}');
 } on DioError catch (e) {
 print('downloadFile error---------$e');
 formatError(e);
 }
 return response.data;
 }


<br>

Demande d'annulation

 /*
 * Demande d'annulation
 *
 * Le mêmecancel token Peut être utilisé pour plusieurs demandes,Quand uncancel tokenQuand on annule,Toutes les utilisations de cecancel tokenToutes les demandes seront annulées..
 *  Donc les paramètres sont optionnels
 */
 void cancelRequests(CancelToken token) {
 token.cancel("cancelled");
 }


<br>

HttpsVérification des certificats

Il y a deux façons de vérifier httpsCertificat, Supposons que notre service d'arrière - plan utilise un certificat auto - signé , Le format du certificat est PEMFormat, Nous sauvegardons le contenu du certificat dans une chaîne locale , Donc notre logique de vérification est la suivante ：

String PEM="XXXXX"; // certificate content
(dio.httpClientAdapter as DefaultHttpClientAdapter).onHttpClientCreate = (client) {
 client.badCertificateCallback=(X509Certificate cert, String host, int port){
 if(cert.pem==PEM){ // Verify the certificate
 return true;
 }
 return false;
 };
};


X509Certificate Est le format standard du certificat , Contient toutes les informations du certificat, à l'exception de la clé privée , Le lecteur peut consulter le document lui - même .En plus, L'exemple ci - dessus n'est pas vérifié host, C'est parce que tant que le contenu du certificat retourné par le serveur est compatible avec l'enregistrement local, il peut être prouvé que c'est notre serveur （ Au lieu d'un intermédiaire ）,host La validation est généralement effectuée pour éviter que le certificat et le nom de domaine ne correspondent pas .

Pour les certificats auto - signés , Nous pouvons également l'ajouter à la chaîne de confiance des certificats locaux , De cette façon, la validation du certificat passe automatiquement , Au lieu de marcher jusqu'à badCertificateCallbackDans le rappel：

(dio.httpClientAdapter as DefaultHttpClientAdapter).onHttpClientCreate = (client) {
 SecurityContext sc = new SecurityContext();
 //file is the path of certificate
 sc.setTrustedCertificates(file);
 HttpClient httpClient = new HttpClient(context: sc);
 return httpClient;
};


Attention!,AdoptionsetTrustedCertificates() Le format du certificat doit être PEMOuPKCS12, Si le format du certificat est PKCS12, Pour passer le mot de passe du certificat dans , Ceci expose le mot de passe du certificat dans le Code , La vérification du certificat client n'est donc pas recommandée PKCS12Format du certificat.

<br>

Exemple d'appel

 var response = await HttpUtil().get("http://www.baidu.com");
 print(response.toString());


jsonRésolution de la vue：

Flutter Json Analyse automatique FlutterJsonBeanFactory

<br>

Code complet

github：

https://github.com/yechaoa/wanandroid_flutter

<br>

J'ai trouvé ça utile. ^ _ ^

<br><br>