Java - Comment savoir si un nom de fichier est valide?

Question

Dans mon application Java, je renomme les fichiers en un nom de fichier fourni dans un paramètre String. Il existe une méthode

boolean OKtoRename(String oldName, String newName) 

qui vérifie essentiellement si le newName est pas déjà pris par un autre fichier, comme je ne voudrais pas enterrer ceux qui existent déjà.

Il m'est maintenant apparu que peut-être le nouveau nom Chaîne ne dénotera pas un nom de fichier valide. Donc je pensais que d'ajouter ce chèque à la méthode:

if (new File(newName).isFile()) { 
    return false; 
} 

Ce qui est évidemment pas la bonne façon de le faire, puisque dans la plupart des cas, le newFile n'existe pas encore et donc bien qu'il est OKtoRename, la La fonction renvoie false.

Je me demandais, est-il une méthode (je sais qu'il n'y a pas pour les objets java.io.File) comme canExist()? Ou devrais-je utiliser regex pour m'assurer que la chaîne newFile ne contient pas de caractères invalides (par exemple?, *, ", :)? Je me demande s'il y a peut-être une fonction cachée quelque part dans le JDK pourrait éventuellement indiquer un nom de fichier valide.

Answer 1

Utilisez createNewFile(), qui va créer atomiquement le fichier que si elle n'existe pas encore.

Si le fichier est créé, le nom est valide et il n'est pas en train d'écraser une fichier existant.Vous pouvez ensuite ouvrir les fichiers et copier efficacement les données de l'un à l'autre avec FileChannel.transferXXX opérations

Une chose importante à garder à l'esprit que, en général, le contrôle et le la création devrait être atomique. Si vous vérifiez d'abord si une opération est sûre, effectuez l'opération comme une étape distincte, les conditions peuvent avoir changé entre-temps, rendant l'opération dangereuse.

nourriture supplémentaire pour la pensée est disponible à ce poste connexe: "Move/Copy operations in Java."

---

Mise à jour:

Depuis cette réponse, les API NIO.2 ont été introduites, qui ajoutent une plus grande interaction avec les système de fichiers. Supposons que vous ayez un programme interactif et que vous souhaitiez valider après chaque frappe si le fichier est potentiellement valide. Par exemple, vous pouvez activer un bouton "Enregistrer" uniquement lorsque l'entrée est valide au lieu d'ouvrir une boîte de dialogue d'erreur après avoir appuyé sur "Enregistrer". Créer et assurer la suppression de beaucoup de fichiers inutiles que ma suggestion ci-dessus exigerait semble être un gâchis. Avec NIO.2, vous ne pouvez pas créer une instance Path contenant des caractères qui sont illégaux pour le système de fichiers. Un InvalidPathException est déclenché dès que vous essayez de créer le Path.

Cependant, il n'y a pas d'API pour valider les noms illégaux composés de caractères valides, comme "PRN" sous Windows. Comme solution de contournement, l'expérimentation a montré que l'utilisation d'un nom de fichier illégal soulèverait une exception distincte lors de la tentative d'accès aux attributs (en utilisant Files.getLastModifiedTime(), par exemple).

Si vous spécifiez un nom légal pour un fichier qui existe, vous n'obtenez aucune exception.

Si vous spécifiez un nom légal pour un fichier qui n'existe pas, il lève NoSuchFileException.

Si vous spécifiez un nom non autorisé, FileSystemException est déclenché.

Cependant, cela semble très kludgey et pourrait ne pas être fiable sur d'autres systèmes d'exploitation.

Answer 2

J'ai assemblé une liste de caractères de noms de fichiers illégaux (en considérant les systèmes UNIX, Mac OS X et Windows) sur la base d'une recherche en ligne il y a quelques mois. Si le nouveau nom de fichier contient l'un de ces éléments, il existe un risque qu'il ne soit pas valide sur toutes les plates-formes.

private static final char[] ILLEGAL_CHARACTERS = { '/', '\n', '\r', '\t', '\0', '\f', '`', '?', '*', '\\', '<', '>', '|', '\"', ':' }; 

EDIT: Je voudrais souligner que c'est pas une solution complète: comme commentateur a fait remarquer, même si elle passe ce test votre nom de fichier peut encore être un mot-clé spécifique à Windows COM, PRN, etc. Cependant, si votre nom de fichier contient l'un de ces caractères, il causera certainement des problèmes dans un environnement multi-plateforme.

Answer 3

Pour moi, il semble être un problème dépendant du système d'exploitation. Vous pouvez simplement vouloir vérifier un caractère non valide dans le nom du fichier. Windows le fait lorsque vous essayez de renommer le fichier, il affiche un message indiquant qu'un fichier ne peut contenir aucun des caractères suivants: \ /: *? <> | Je ne suis pas sûr si votre question est "est là une bibliothèque faisant le travail pour moi?" dans ce cas je n'en connais pas.

Answer 4

En utilisant

String validName = URLEncoder.encode(fileName , "UTF-8"); 

File newFile = new File(validName); 

Est-ce que le travail.

Je viens de trouver aujourd'hui. Je ne suis pas sûr que cela fonctionne à 100% du temps, mais jusqu'à présent, j'ai pu créer des noms de fichiers valides.

Answer 5

Voilà comment je mis en œuvre ceci: manière spécifique

public boolean isValidFileName(final String aFileName) { 
    final File aFile = new File(aFileName); 
    boolean isValid = true; 
    try { 
     if (aFile.createNewFile()) { 
      aFile.delete(); 
     } 
    } catch (IOException e) { 
     isValid = false; 
    } 
    return isValid; 
} 

Answer 6

système Here est suggéré.

public static boolean isFilenameValid(String file) { 
    File f = new File(file); 
    try { 
    f.getCanonicalPath(); 
    return true; 
    } catch (IOException e) { 
    return false; 
    } 
} 

Answer 7

Si le développement d'Eclipse, consultez org.eclipse.core.internal.resources.OS

public abstract class OS { 
    private static final String INSTALLED_PLATFORM; 

    public static final char[] INVALID_RESOURCE_CHARACTERS; 
    private static final String[] INVALID_RESOURCE_BASENAMES; 
    private static final String[] INVALID_RESOURCE_FULLNAMES; 

    static { 
     //find out the OS being used 
     //setup the invalid names 
     INSTALLED_PLATFORM = Platform.getOS(); 
     if (INSTALLED_PLATFORM.equals(Platform.OS_WIN32)) { 
     //valid names and characters taken from http://msdn.microsoft.com/library/default.asp?url=/library/en-us/fileio/fs/naming_a_file.asp 
     INVALID_RESOURCE_CHARACTERS = new char[] {'\\', '/', ':', '*', '?', '"', '<', '>', '|'}; 
     INVALID_RESOURCE_BASENAMES = new String[] {"aux", "com1", "com2", "com3", "com4", //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ 
       "com5", "com6", "com7", "com8", "com9", "con", "lpt1", "lpt2", //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ 
       "lpt3", "lpt4", "lpt5", "lpt6", "lpt7", "lpt8", "lpt9", "nul", "prn"}; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$ 
     Arrays.sort(INVALID_RESOURCE_BASENAMES); 
     //CLOCK$ may be used if an extension is provided 
     INVALID_RESOURCE_FULLNAMES = new String[] {"clock$"}; //$NON-NLS-1$ 
     } else { 
     //only front slash and null char are invalid on UNIXes 
     //taken from http://www.faqs.org/faqs/unix-faq/faq/part2/section-2.html 
     INVALID_RESOURCE_CHARACTERS = new char[] {'/', '\0',}; 
     INVALID_RESOURCE_BASENAMES = null; 
     INVALID_RESOURCE_FULLNAMES = null; 
     } 
    } 

    /** 
    * Returns true if the given name is a valid resource name on this operating system, 
    * and false otherwise. 
    */ 
    public static boolean isNameValid(String name) { 
     //. and .. have special meaning on all platforms 
     if (name.equals(".") || name.equals("..")) //$NON-NLS-1$ //$NON-NLS-2$ 
     return false; 
     if (INSTALLED_PLATFORM.equals(Platform.OS_WIN32)) { 
     //empty names are not valid 
     final int length = name.length(); 
     if (length == 0) 
      return false; 
     final char lastChar = name.charAt(length-1); 
     // filenames ending in dot are not valid 
     if (lastChar == '.') 
      return false; 
     // file names ending with whitespace are truncated (bug 118997) 
     if (Character.isWhitespace(lastChar)) 
      return false; 
     int dot = name.indexOf('.'); 
     //on windows, filename suffixes are not relevant to name validity 
     String basename = dot == -1 ? name : name.substring(0, dot); 
     if (Arrays.binarySearch(INVALID_RESOURCE_BASENAMES, basename.toLowerCase()) >= 0) 
      return false; 
     return Arrays.binarySearch(INVALID_RESOURCE_FULLNAMES, name.toLowerCase()) < 0; 
     } 
     return true; 
    } 
} 

Answer 8

quelque chose que je trouve, en Java 7 et plus tard, il y a une classe appelée Paths qui a une méthode appelée get qui prend un ou plusieurs String s et jette

InvalidPathException - si la chaîne de chemin ne peut pas être converti en un chemin