Gestion des packages et bibliothèques Dart

Lorsque l'échelle du projet augmente, il est essentiel de diviser le code en plusieurs fichiers et modules.

Ce chapitre présente le système de gestion de paquets pub de Dart, le fichier de configuration des dépendances pubspec.yaml, la syntaxe import/export, et comment créer des bibliothèques personnalisées.


Configuration de pubspec.yaml

pubspec.yaml est le fichier de configuration central de chaque projet Dart, déclarant les métadonnées et les dépendances du projet.

Une structure typique de fichier pubspec.yaml est la suivante :

Exemple

# Chemin du fichier : pubspec.yaml
name
: my_dart_app              # Nom du projet (obligatoire, en minuscules et avec des underscores)
description
: Un projet Dart d'exemple# Description du projet
version
: 1.0.0                 # Numéro de version
# publish_to: none # Si vous ne voulez pas publier sur pub.dev, décommentez cette ligne

environment
:
  sdk
: '>=3.0.0 <4.0.0'      # Plage de versions du SDK Dart

dependencies
:
 # Paquets tiers dont le projet dépend à l'exécution
  http
: ^1.1.0                # Client HTTP
  path
: ^1.8.0                # Utilitaires de chemin

dev_dependencies
:
 # Dépendances nécessaires uniquement pendant le développement (tests, lint, etc.)
  test
: ^1.24.0               # Framework de test
  lints
: ^2.0.0               # Règles de lint officielles

# Facultatif : point d'entrée exécutable
# exécutables :
# my_app: main

Explication de la syntaxe des numéros de version :

SyntaxeSignificationExemple
^1.1.0Compatible avec 1.1.0 à 2.0.0 (exclu)Le plus couramment utilisé, recommandé
1.1.0Version exactePas très flexible
>=1.1.0 <1.5.0Plage de versionsÀ utiliser lorsqu'un contrôle précis est nécessaire
anyToute versionNon recommandé

Le symbole caret (^) est la méthode de contrainte de version par défaut de Dart. ^1.1.0 est équivalent à >=1.1.0 <2.0.0. Cela signifie que les versions mineures et correctives peuvent être mises à niveau automatiquement, mais les versions majeures ne peuvent pas être mises à niveau (les mises à niveau de version majeure peuvent inclure des changements incompatibles).

Installer les dépendances

$ dart pub get           # 安装依赖
$ dart pub upgrade       # 升级依赖到最新兼容版本
$ dart pub outdated      # 查看哪些依赖有更新

Trouver des dépendances sur pub.dev

pub.dev est le dépôt officiel de paquets pour Dart et Flutter, semblable à npm (JavaScript) ou PyPI (Python).

Vous pouvezhttps://pub.devrechercher et parcourir des dizaines de milliers de paquets Dart.

Exemples de paquets tiers courants :

Nom du packageObjectifDescription
httpRequête HTTPClient HTTP officiellement maintenu
pathOpérations sur les cheminsOutil de traitement de chemins multiplateforme
testTests unitairesFramework de test officiel
json_serializableSérialisation JSONGénérer automatiquement le code de conversion JSON
dioClient HTTPUne bibliothèque HTTP tierce plus puissante que http.
riverpodGestion d'étatSolution de gestion d'état populaire pour les projets Flutter

Exemple

Ajoutez le package http et utilisez-le :

// D'abord, ajoutez aux dépendances dans pubspec.yaml :
// http: ^1.1.0
// Ensuite, exécutez : dart pub get

import 'package:http/http.dart' as http;

void main() async {
  // Envoyer une requête GET
  var url = Uri.parse('https://www.example.com');
  var response = await http.get(url);

  print('Code de statut : ${response.statusCode}');
  print('Longueur du corps de la réponse : ${response.body.length} caractères');
}

syntaxe d'import

import est utilisé pour importer du code d'autres bibliothèques dans un fichier Dart.

Dart prend en charge plusieurs styles d'import, chacun adapté à différents scénarios.

Importer les bibliothèques intégrées de Dart

Exemple

// Le préfixe dart: indique les bibliothèques de base intégrées de Dart
import 'dart:math';    // Bibliothèque mathématique (nombres aléatoires, fonctions trigonométriques, etc.)
import 'dart:convert'; // Bibliothèque de conversion d'encodage (JSON, Base64, etc.)
import 'dart:io';      // Bibliothèque d'E/S (fichiers, réseau, etc.)

void main() {
  // Utilisation des fonctions de dart:math
  print('Pi: $pi');
  print('2 à la puissance 10 : ${pow(2, 10)}');

  // Utilisation des fonctions de dart:convert
  var jsonStr = '{"name": "example", "age": 10}';
  var decoded = jsonDecode(jsonStr);
  print('JSON analysé : $decoded');
  print('Nom d’utilisateur : ${decoded['name']}');
}
圆周率: 3.141592653589793
2 的 10 次方: 1024
解析后的 JSON: {name: example, age: 10}
用户名: example

Importer des paquets tiers

Exemple

// Le préfixe package: indique des paquets tiers sur pub.dev
import 'package:http/http.dart';
import 'package:path/path.dart' as p;

Importer des fichiers locaux

Exemple

// Import par chemin relatif : importer d’autres fichiers Dart dans le même projet
import 'src/utils.dart';          // Sous-répertoire dans le même répertoire
import '../models/user.dart';    // Fichier dans le répertoire parent
import 'constants.dart';         // Fichier dans le même répertoire

Modificateurs d'import

ModificateursSyntaxeObjectif
Préfixe (as)import 'lib.dart' as myLib;Donner un alias à la bibliothèque pour éviter les conflits de noms
Importer uniquement une partie (show)import 'lib.dart' show foo, bar;Importer uniquement les noms spécifiés
Exclure une partie (hide)import 'lib.dart' hide foo;Importer tout sauf les noms spécifiés
Chargement différé (deferred as)import 'lib.dart' deferred as lib;Charger à la demande pour réduire le temps de démarrage

Exemple

Utilisation pratique de divers modificateurs d'import :

import 'dart:math';              // Import standard
import 'dart:math' as math;      // Import avec préfixe : utiliser math.pow() au lieu de pow()
import 'dart:math' show pi, sqrt;  // Importer uniquement pi et sqrt
import 'dart:math' hide Random;    // Importer tout sauf Random

void main() {
  // Import standard
  print('sin(0) = ${sin(0)}');

  // Import avec préfixe : doit être accessible via le préfixe
  print('cos(0) = ${math.cos(0)}');

  // import show : seuls pi et sqrt peuvent être utilisés
  print('π = $pi');
  print('sqrt(16) = ${sqrt(16)}');
  // print(sin(0)); // Erreur : sin n'est pas importé

  // import avec hide : Random est indisponible, tout le reste est disponible
  print('max(3, 7) = ${max(3, 7)}');
  // Random(); // Erreur : Random est exclu
}
sin(0) = 0.0
cos(0) = 1.0
π = 3.141592653589793
sqrt(16) = 4.0
max(3, 7) = 7

show et hide ne sont pas seulement pratiques—ce sont aussi des outils pour la qualité du code. Utiliser show rend les dépendances plus claires : vous pouvez voir d'un coup d'œil quels symboles de la bibliothèque ce fichier utilise.


syntaxe export

export est utilisé pour réexposer les API publiques d'autres bibliothèques, principalement pour créer des bibliothèques agrégées.

Supposons que vous ayez la structure de fichiers suivante :

lib/
├── my_package.dart          # 入口文件(聚合导出)
├── src/
│   ├── models/
│   │   └── user.dart        # User 类
│   ├── services/
│   │   └── api_service.dart # API 服务
│   └── utils/
│       └── helpers.dart     # 工具函数

Exemple

Utiliser export pour créer un point d'entrée de bibliothèque agrégée :

// Fichier : lib/my_package.dart
// Export agrégé : expose uniformément toutes les API publiques

export 'src/models/user.dart';
export 'src/services/api_service.dart';
// N'exporter qu'une partie du contenu de helpers
export 'src/utils/helpers.dart' show formatDate, validateEmail;

Ainsi, les utilisateurs n'ont besoin d'importer qu'un seul fichier :

Exemple

// Les utilisateurs n'ont besoin d'importer que le fichier d'entrée
import 'package:my_package/my_package.dart';

void main() {
  // On peut directement utiliser toutes les classes exportées
  var user = User('example');
  var api = ApiService();
}

Création de bibliothèques personnalisées

La création d’une bibliothèque personnalisée ne nécessite aucune syntaxe spéciale — chaque fichier Dart est une bibliothèque.

Cependant, vous pouvez utiliser le mot-clé library pour déclarer explicitement un nom de bibliothèque, et utiliser part/part of pour scinder les bibliothèques volumineuses.

Utilisation de library pour déclarer un nom de bibliothèque

Exemple

// Fichier : lib/calculator.dart
// library déclare le nom de la bibliothèque (facultatif, mais utile pour la documentation)
library calculator;

/// Opération d’addition
int add(int a, int b) => a + b;

/// Opération de soustraction
int subtract(int a, int b) => a - b;

/// Opération de multiplication
int multiply(int a, int b) => a * b;

/// Opération de division, lève une exception lorsque le diviseur est 0
double divide(int a, int b) {
  if (b == 0) {
    throw ArgumentError(Le diviseur ne peut pas être 0);
  }
  return a / b;
}

Utilisez part pour diviser les grandes bibliothèques

Lorsque le code d'une bibliothèque est trop long, vous pouvez utiliser part pour le diviser en plusieurs fichiers physiques, mais ils appartiennent toujours logiquement à la même bibliothèque.

Exemple

Le fichier principal déclare part :

// Fichier : lib/user_system.dart
// Fichier principal de la bibliothèque
library user_system;

// Déclarer les autres fichiers qui composent cette bibliothèque
part 'src/user_model.dart';
part 'src/user_service.dart';
part 'src/user_validator.dart';

// API publique au niveau de la bibliothèque
String libraryVersion = '1.0.0';

Exemple

le fichier part déclare faire partie de :

// Fichier : lib/src/user_model.dart
// part of déclare à quelle bibliothèque ce fichier appartient
part of '../user_system.dart';

// On peut accéder à libraryVersion dans la bibliothèque principale
class User {
  String name;
  User(this.name);

  void printVersion() {
    print('EXEMPLE Version du module User : $libraryVersion');
  }
}

part/part of n'est pas couramment utilisé dans le développement Dart moderne ; la plupart des équipes préfèrent import/export pour organiser le code. L'inconvénient de part est que les fichiers part partagent tous les membres privés, ce qui casse l'encapsulation. À moins d'un besoin clair, import/export est recommandé.


Aperçu de la bibliothèque de base Dart

Nom de la bibliothèqueMéthode d'importFonctionnalités principales
dart:coreImport automatiqueTypes de base, collections, exceptions, etc.
dart:mathimport 'dart:math';Constantes et fonctions mathématiques
dart:convertimport 'dart:convert';Encodage/décodage JSON, UTF-8, Base64
dart:ioimport 'dart:io';Opérations sur les fichiers, le réseau et les processus
dart:asyncimport 'dart:async';Outils asynchrones tels que Future, Stream, etc.
dart:collectionimport 'dart:collection';Autres types de collections (Queue, etc.)
dart:developerimport 'dart:developer';Outils de débogage et d'analyse de performances

dart:core est importé automatiquement, donc vous n'avez pas besoin d'écrire import 'dart:core' pour utiliser des types de base comme int, String, List, Map, etc.

autres extensions