Un didacticiel sur l'utilisation du stockage côté client dans les applications Web

Lors de la création d'applications Web modernes, en particulier d'applications Web progressives (PWA), il est crucial de disposer d'un moyen de stocker les données hors ligne. IndexedDB est une puissante base de données côté client qui permet aux applications Web de stocker et de récupérer des données, même lorsque l'utilisateur est hors ligne. Ce guide vous guidera à travers les bases d'IndexedDB, vous montrant comment créer, lire, mettre à jour et supprimer des données (opérations CRUD) dans votre application Web.

Qu’est-ce qu’IndexedDB ?

IndexedDB est une API de bas niveau pour le stockage côté client de grandes quantités de données structurées, notamment des fichiers et des blobs. Contrairement à localStorage, IndexedDB vous permet de stocker des types de données complexes, pas seulement des chaînes. Il utilise un modèle de base de données transactionnelle asynchrone, ce qui le rend puissant pour les applications devant gérer de grands ensembles de données ou une synchronisation de données hors ligne.

Pourquoi utiliser IndexedDB ?

• Capacités hors ligne : Idéal pour les applications Web progressives (PWA) et les applications hors ligne.
• Capacité de stockage : IndexedDB peut stocker beaucoup plus de données que localStorage (qui est limité à environ 5 à 10 Mo).
• Flexibilité : Stockez des objets complexes tels que des tableaux, des objets et même des blobs.
• Asynchrone : Les opérations ne bloquent pas le thread de l'interface utilisateur, ce qui signifie que votre application reste réactive.

Mise en route : configuration d'IndexedDB

Plongeons dans les étapes principales pour travailler avec IndexedDB. Nous couvrirons :

• Créer ou ouvrir une base de données
• Création de magasins d'objets (tables)
• Ajout de données
• Lecture des données
• Mise à jour des données
• Suppression de données

Étape 1 : ouvrir une base de données

Pour interagir avec IndexedDB, vous devez d'abord ouvrir une connexion à la base de données. Si la base de données n'existe pas, elle sera créée.

const request = indexedDB.open('MyCustomersDatabase', 1);

request.onerror = (event) => {
    console.error('Database error:', event.target.errorCode);
};

request.onsuccess = (event) => {
    const db = event.target.result;
    console.log('Database opened successfully', db);
};

request.onupgradeneeded = (event) => {
    const db = event.target.result;
    if (!db.objectStoreNames.contains('customers')) {
        const objectStore = db.createObjectStore('customers', { keyPath: 'id' });
        objectStore.createIndex('name', 'name', { unique: false });
        objectStore.createIndex('email', 'email', { unique: true });
        console.log('Object store created.');
    }
};

Voici ce qui se passe :

• indexedDB.open ouvre ou crée la base de données.
• onerror gère toutes les erreurs lors de l'ouverture de la base de données.
• onsuccess est déclenché lorsque la connexion à la base de données est ouverte avec succès.
• onupgradeneeded est déclenché lorsque la base de données doit être mise à niveau (par exemple, si c'est la première fois que vous ouvrez la base de données ou si la version change). C'est là que vous définissez vos magasins d'objets (considérez-les comme des tables en SQL).

Étape 2 : ajout de données à IndexedDB

Maintenant que notre base de données et notre magasin d'objets sont configurés, ajoutons-y quelques données.

const addCustomer = (db, customer) => {
    const transaction = db.transaction(['customers'], 'readwrite');
    const objectStore = transaction.objectStore('customers');
    const request = objectStore.add(customer);

    request.onsuccess = () => {
        console.log('Customer added:', customer);
    };

    request.onerror = (event) => {
        console.error('Error adding customer:', event.target.errorCode);
    };
}

const customer = { id: 1, name: 'John Doe', email: '[email protected]' };

request.onsuccess = (event) => {
    const db = event.target.result;
    addCustomer(db, customer);
};

Voici ce qui se passe :

• Nous créons une transaction avec un accès « lecture-écriture » pour permettre les modifications.
• La méthode add() est utilisée pour insérer des données dans le magasin d'objets.
• Nous écoutons les événements de réussite et d'erreur pour confirmer si les données ont été ajoutées avec succès.

Étape 3 : Lire les données d'IndexedDB

La lecture des données d'IndexedDB est également simple. Récupérons le client que nous venons d'ajouter en utilisant la méthode get().

const getCustomer = (db, id) => {
    const transaction = db.transaction(['customers'], 'readonly');
    const objectStore = transaction.objectStore('customers');
    const request = objectStore.get(id);

    request.onsuccess = (event) => {
        const customer = event.target.result;
        if (customer) {
            console.log('Customer found:', customer);
        } else {
            console.log('Customer not found.');
        }
    };

    request.onerror = (event) => {
        console.error('Error fetching customer:', event.target.errorCode);
    };
}

request.onsuccess = (event) => {
    const db = event.target.result;
    getCustomer(db, 1); // Fetch customer with ID 1
};

Étape 4 : mise à jour des données dans IndexedDB

Pour mettre à jour un enregistrement existant, nous pouvons utiliser la méthode put(), qui fonctionne de la même manière que add() mais remplace l'enregistrement si la clé existe déjà.

const updateCustomer = (db, customer) => {
    const transaction = db.transaction(['customers'], 'readwrite');
    const objectStore = transaction.objectStore('customers');
    const request = objectStore.put(customer);

    request.onsuccess = () => {
        console.log('Customer updated:', customer);
    };

    request.onerror = (event) => {
        console.error('Error updating customer:', event.target.errorCode);
    };
}

const updatedCustomer = { id: 1, name: 'Jane Doe', email: '[email protected]' };

request.onsuccess = (event) => {
    const db = event.target.result;
    updateCustomer(db, updatedCustomer);
};

Étape 5 : Suppression des données d'IndexedDB

Enfin, pour supprimer un enregistrement, utilisez la méthode delete().

const deleteCustomer = (db, id) => {
    const transaction = db.transaction(['customers'], 'readwrite');
    const objectStore = transaction.objectStore('customers');
    const request = objectStore.delete(id);

    request.onsuccess = () => {
        console.log('Customer deleted.');
    };

    request.onerror = (event) => {
        console.error('Error deleting customer:', event.target.errorCode);
    };
}

request.onsuccess = (event) => {
    const db = event.target.result;
    deleteCustomer(db, 1); // Delete customer with ID 1
};

Conclusion

IndexedDB est une solution robuste pour gérer le stockage de données côté client, en particulier dans les applications Web hors ligne. En suivant ce guide, vous avez appris à :

• Ouvrir et créer une base de données
• Créer des magasins d'objets
• Ajouter, lire, mettre à jour et supprimer des données

Avec IndexedDB, vous pouvez créer des applications Web plus résilientes qui stockent les données localement et fonctionnent même sans connexion Internet.

Références :

1. MDN Web Docs - API IndexedDB
   
   Un guide complet sur le fonctionnement d'IndexedDB, ses méthodes API et ses cas d'utilisation.
   
   Guide MDN IndexedDB

2. Développeurs Google - IndexedDB
   
   Un article détaillé couvrant les meilleures pratiques et l'utilisation d'IndexedDB pour créer des applications Web compatibles hors ligne.
   
   Développeurs Google - IndexedDB

3. API de base de données indexée W3C
   
   La spécification officielle du W3C décrivant la mise en œuvre technique et la structure d'IndexedDB.
   
   Spécification de base de données indexée du W3C

Ces ressources fourniront une profondeur et un contexte supplémentaires si vous souhaitez en savoir plus sur IndexedDB au-delà de ce didacticiel !

Bon codage !