Quel est le répertoire des documents (NSDocumentDirectory) ?

Question

Quelqu'un peut-il m'expliquer ce qu'est le répertoire des documents dans une application iOS et quand l'utiliser ?

Voici ce que je crois pour le moment :

Pour moi, il semble s'agir d'un dossier central où l'utilisateur peut stocker tous les fichiers nécessaires à l'application.

Cela serait un emplacement différent de celui où Core Data stocke ses données ?

Il semble que chaque application possède son propre répertoire des documents.

Je suis libre de créer un sous-répertoire du répertoire des documents, comme répertoire des documents/images, ou répertoire des documents/vidéos ?

Answer 1

En plus du dossier Documents, iOS vous permet également de sauvegarder des fichiers dans les dossiers temp et Library.

Pour plus d'informations sur lequel utiliser, consultez ce lien de la documentation:

• "Où Doit-on Mettre les Fichiers de Votre Application."

Answer 2

Vous pouvez accéder au répertoire des documents en utilisant ce code, il est généralement utilisé pour stocker des fichiers au format plist :

NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
NSString *documentsDirectory = [paths firstObject];
return documentsDirectory;

Answer 3

Voici une petite fonction utile qui rend l'utilisation/création de dossiers iOS un peu plus facile.

Vous lui passez le nom d'un sous-dossier, il vous renverra le chemin complet et s'assurera que le répertoire existe.

(Personnellement, je place cette fonction statique dans ma classe AppDelete, mais peut-être n'est-ce pas l'endroit le plus judicieux pour la mettre.)

Voici comment vous l'appelleriez pour obtenir le "chemin complet" d'un sous-répertoire MySavedImages :

NSString* fullPath = [AppDelegate getFullPath:@"MySavedImages"];

Et voici la fonction complète :

+(NSString*)getFullPath:(NSString*)folderName
{
    // Vérifie si un sous-répertoire existe dans notre répertoire Documents sandboxé.
    // Renvoie le chemin complet du répertoire.
    //
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
    if (paths.count < 1)
        return nil;

    NSString *rootFolder = [paths firstObject];
    NSString* fullFolderPath = [rootFolder stringByAppendingPathComponent:folderName];

    BOOL isDirectory;
    NSFileManager* manager = [NSFileManager defaultManager];

    if (![manager fileExistsAtPath:fullFolderPath isDirectory:&isDirectory] || !isDirectory) {
        NSError *error = nil;
        NSDictionary *attr = [NSDictionary dictionaryWithObject:NSFileProtectionComplete
                                                         forKey:NSFileProtectionKey];
        [manager createDirectoryAtPath:fullFolderPath
           withIntermediateDirectories:YES
                            attributes:attr
                                 error:&error];
        if (error) {
            NSLog(@"Erreur lors de la création du chemin du répertoire : %@", [error localizedDescription]);
            return nil;
        }
    }
    return fullFolderPath;
}

En utilisant cette petite fonction, il est facile de créer un répertoire dans le répertoire Documents de votre application (s'il n'existe pas déjà) et d'y écrire un fichier.

Voici comment je créerais le répertoire et écrirais le contenu d'un de mes fichiers image :

// Créons un sous-répertoire "MySavedImages" (s'il n'existe pas déjà)
NSString* fullPath = [AppDelegate getFullPath:@"MySavedImages"];

// Par exemple, chargeons les données d'un de mes fichiers image
NSString* imageFilename = @"icnCross.png";

UIImage* image = [UIImage imageNamed:imageFilename];
NSData *imageData = UIImagePNGRepresentation(image);

// Obtenons le chemin complet + nom de fichier où nous pouvons écrire ce .png, dans notre nouveau répertoire MySavedImages
NSString* imageFilePathname = [fullPath stringByAppendingPathComponent:imageFilename];

// Écrivons les données
[imageData writeToFile:imageFilePathname atomically:YES];

J'espère que cela vous aidera !

Answer 4

Comme d'autres l'ont mentionné, votre application s'exécute dans un environnement sandbox et vous pouvez utiliser le répertoire des documents pour stocker des images ou d'autres ressources que votre application peut utiliser, par exemple en téléchargeant des fichiers hors ligne selon les préférences de l'utilisateur - Bases du système de fichiers - Documentation Apple - Quel répertoire utiliser pour stocker des fichiers spécifiques à l'application

Mis à jour pour Swift 5, vous pouvez utiliser l'une de ces fonctions, selon les besoins -

func getDocumentsDirectory() -> URL {
    let paths = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)
    return paths[0]
}

func getCacheDirectory() -> URL {
        let paths = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask)
        return paths[0]
    }

func getApplicationSupportDirectory() -> URL {
        let paths = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask)
        return paths[0]
    }

Utilisation :

let urlPath = "https://jumpcloud.com/wp-content/uploads/2017/06/SSH-Keys.png" //Ou un chemin de chaîne vers une URL d'image valide, par exemple.

if let url = URL(string: urlPath){
    let destination = getDocumentsDirectory().appendingPathComponent(url.lastPathComponent)
    do {
        let data = try Data(contentsOf: url) //Appel synchrone, juste à titre d'exemple
        try data.write(to: destination)
    } catch _ {
        //Faites quelque chose pour gérer l'erreur
    }
}