Comment puis-je empêcher la modification d'un champ privé dans une classe?

Imaginer que j'ai de cette classe:

public class Test
{
  private String[] arr = new String[]{"1","2"};    

  public String[] getArr() 
  {
    return arr;
  }
}

Maintenant, j'ai une autre classe qui utilise la classe ci-dessus:

Test test = new Test();
test.getArr()[0] ="some value!"; //!!!

Donc, c'est le problème: j'ai consulté un domaine privé d'une classe à partir de l'extérieur!
Comment puis-je éviter cela? Je veux dire, comment puis-je faire de ce tableau immuable? Est-ce à dire que chaque méthode de lecture vous pouvez travailler votre chemin jusqu'à accéder à la zone privée? (Je ne veux pas de bibliothèques comme la Goyave. J'ai juste besoin de connaître la bonne façon de le faire).

faire final
En fait, le rendant final empêche la modification du champ. Toutefois, la prévention de la modification de la Object visé par un champ est plus compliqué.
Il y a un problème avec votre modèle mental si vous pensez être en mesure de modifier un tableau pour lequel vous avez une référence stockée dans un champ privé est la même chose que d'être en mesure de modifier un champ privé.
Si c'est le privé, pourquoi l'exposer en premier lieu?
Les deux OldCurmudgeon et sp00m anwsers sont à droite. À utiliser dépend de la situation. Je vous recommande de lire Efficace Java - Item 13: Minimiser l'accessibilité des classes et des membres.
Il m'a fallu un certain temps pour comprendre cela, mais il améliore toujours mon code quand j's'assurer que toutes les structures de données sont entièrement encapsulés à l'intérieur de leur objet-à-dire il n'existe aucun moyen pour "Obtenir" votre "arr", au lieu de faire qu', vous devez à l'intérieur de la classe ou de fournir un itérateur.
Je propose l'édition du titre de Prevent modification to a private array field?.
Je vois que personne n'a mentionné Josh Bloch Effectif de Java - Item 39: Make defensive copies when needed
Est ce que quelqu'un d'autre aussi surpris de voir pourquoi cette question a eu tellement d'attention?
Je n'ai pas l'upvotes pour Erik Reppen commentaire. L'encapsulation de données ne signifie pas que vous ne pouvez pas exposer l'état interne, mais il doit s'assurer que l'instance de contrôle de l'état interne (par exemple en renvoyant uniquement en lecture seule des valeurs ou des copies des valeurs stockées).

InformationsquelleAutor Hossein | 2013-02-11

161

Vous devez renvoyer un copie de votre tableau.
```
public String[] getArr() {
  return arr == null ? null : Arrays.copyOf(arr, arr.length);
}
```
- Je tiens à rappeler aux gens que, bien que cela a été voté la réponse correcte à la question, le meilleure solution pour le problème est effectivement comme sp00m, dit - retour d'un Unmodifiable List.
- Pas si vous avez réellement besoin de retourner un tableau.
- En fait, le meilleure solution pour le problème est discuté souvent que @MikhailVladimirov dit: - fournir ou de rendre un affichage de la matrice ou de la collection.
- Et combien de fois est-ce? Retourner un tableau est presque certainement pas nécessaire.
- mais assurez-vous que c'est une copie en profondeur, pas d'une copie des données. Pour les Chaînes, il ne fait aucune différence, pour d'autres catégories comme la Date où le contenu de l'instance peut être modifié, il peut faire une différence.
- N'a pas d'importance combien de fois il est. Parfois, il est, et depuis que la question concernait une je trouve qu'il est approprié que la réponse ne trop 🙂
- J'aurais été plus drastique: si vous retournez un tableau à partir d'une fonction de l'API que vous le faites mal. En privé, des fonctions à l'intérieur d'une bibliothèque à être à droite. Dans une API (où la protection contre le caractère modifiable joue un rôle), il jamais est.
- Je leur dis aussi que c'est une mauvaise solution - voir ma réponse pour plus de clarification.
- C'est le même que sp00m de la solution. Malgré ce que le nom unmodifiableList peut sembler, il retourne en fait un inmodifiable vue d'une éventuellement modifiables liste.
- C'est vrai, mais j'ai pensé que la solution était trop spécifique. Vous n'avez pas à retourner un inmodifiable voir si vous pouvez fournir un moyen d'autres méthodes.
- le inmodifiable vue peut effectivement être modifiable grâce à la réflexion, si il n'y a pas une bonne SecurityManager.
- Et alors? Même java.lang.String peut être gâché par l'intermédiaire de la réflexion. Rappelez-vous: l'encapsulation est de protéger les code de code, et non pas sur la protection de la code de des codeurs.
- Lecture conseillée: Eric Lippert l'article de Tableaux Considéré comme un Peu Nocifs.
- Je dirais michael_s réponse la plus logique.
InformationsquelleAutor OldCurmudgeon
375

Si vous pouvez utiliser une Liste au lieu d'un tableau, Collections fournit une liste inmodifiable:
```
public List<String> getList() {
    return Collections.unmodifiableList(list);
}
```
- Ajout d'une réponse qui utilise Collections.unmodifiableList(list) comme la cession du terrain, assurez-vous que la liste n'est pas modifiée par la classe elle-même.
- Je me demandais, Si vous décompiler cette méthode, vous obtenez beaucoup de nouveaux mots clés. N'est-ce pas blesser les performances lors de la getList() obtenir l'accès à un grand nombre. Par exemple, dans le rendu de code.
- Notez que cela fonctionne si les éléments des tableaux sont immuables, comme les String est bien, mais si ils sont mutables quelque chose pourrait être fait pour empêcher l'appelant de les modifier.
InformationsquelleAutor sp00m
45

Modificateur private ne protège que le champ lui-même d'être accessible à partir d'autres classes, mais pas l'objet de références en ce domaine. Si vous avez besoin de protéger l'objet référencé, il suffit de ne pas le donner. Changement
```
public String [] getArr ()
{
    return arr;
}
```
à:
```
public String [] getArr ()
{
    return arr.clone ();
}
```
ou à
```
public int getArrLength ()
{
    return arr.length;
}

public String getArrElementAt (int index)
{
    return arr [index];
}
```
- quel est le problème avec clone()?
- Cet article ne donne pas d'arguments contre l'utilisation de clone sur les tableaux, seulement sur les objets qui peuvent être sous-classé.
InformationsquelleAutor Mikhail Vladimirov
28

La Collections.unmodifiableList a déjà été mentionné - la Arrays.asList() étrangement pas! Ma solution serait également utiliser la liste de l'extérieur et envelopper le tableau comme suit:
```
String[] arr = new String[]{"1", "2"}; 
public List<String> getList() {
    return Collections.unmodifiableList(Arrays.asList(arr));
}
```
Le problème avec la copie du tableau est: si vous le faites à chaque fois que vous accédez le code et le tableau est grand, vous allez créer beaucoup de travail pour le garbage collector pour vous. Si la copie est un simple, mais c'est une mauvaise approche, je dirais, "bon marché", mais de mémoire-cher! Surtout quand vous êtes en avoir plus que juste 2 éléments.

Si vous regardez le code source de Arrays.asList et Collections.unmodifiableList il n'y a effectivement pas beaucoup créé des. Le premier juste enveloppe le tableau sans le copier, le deuxième, juste encapsule la liste, faire des changements indisponible.
- Vous faire l'hypothèse ici que le tableau y compris les chaînes de caractères est copié à chaque fois. Il n'est pas, uniquement les références à l'immuable les chaînes de caractères sont copiés. Tant que votre tableau n'est pas énorme, la charge est négligeable. Si le tableau est énorme, aller pour les listes et les immutableList tout le chemin!
- Non, je n'avais pas fait cette hypothèse - où? C'est sur les références qui sont copiés - n'a pas d'importance si c'est une Chaîne ou de tout autre objet. Juste dire que pour les grands tableaux que je ne recommande pas de copier le tableau et que la Arrays.asList et Collections.unmodifiableList opérations sont probablement moins cher pour les plus grands tableaux. Peut-être que quelqu'un peut calculer combien d'éléments sont nécessaires, mais j'ai déjà vu code de boucles avec des tableaux contenant des milliers d'éléments copiés pour empêcher toute modification. - c'est de la folie!
InformationsquelleAutor michael_s
6

Vous pouvez également utiliser ImmutableList qui devrait être mieux que la norme unmodifiableList. La classe fait partie de Goyave bibliothèques qui a été créer par Google.

Voici la description:

A La Différence Des Collections.unmodifiableList(java.util.Liste), qui est une vue d'une collecte séparée qui peut encore changer, une instance de ImmutableList contient ses propres données privées et ne changera jamais

Voici un exemple simple de la façon de l'utiliser:
```
public class Test
{
  private String[] arr = new String[]{"1","2"};    

  public ImmutableList<String> getArr() 
  {
    return ImmutableList.copyOf(arr);
  }
}
```
- L'utilisation de cette solution si vous ne peut pas faire confiance à la Test classe de quitter la liste retournée intacte. Vous devez vous assurer que ImmutableList est retourné, et que les éléments de la liste sont immuables ainsi. Sinon, ma solution devrait être à l'abri ainsi.
InformationsquelleAutor iTech

à ce point de vue, vous devez utiliser le système de tableau de copie:

public String[] getArr() {
   if (arr != null) {
      String[] arrcpy = new String[arr.length];
      System.arraycopy(arr, 0, arrcpy, 0, arr.length);
      return arrcpy;
   } else
      return null;
   }
}

-1 car il n'a rien fait de plus appel clone, et n'est pas aussi concis.

InformationsquelleAutor G M Ramesh

Vous pouviez retourner une copie des données. Le visiteur qui choisit de changer les données seront seulement la modification de la copie

public class Test {
    private static String[] arr = new String[] { "1", "2" };

    public String[] getArr() {

        String[] b = new String[arr.length];

        System.arraycopy(arr, 0, b, 0, arr.length);

        return b;
    }
}

InformationsquelleAutor artfullyContrived

2

Là le cœur du problème, c'est que vous êtes de retour d'un pointeur vers un objet mutable. Oups. Soit vous effectuez le rendu de l'objet immuable (le inmodifiable liste de solution) ou vous retourner une copie de l'objet.

D'une manière générale, la finalité des objets ne permet pas de protéger les objets d'être modifiées si elles sont mutables. Ces deux problèmes sont "kissing cousins."
- Bien Java a des références, alors que C est des pointeurs. J'en ai assez dit. En outre, la "finale" modificateur peut avoir plusieurs impacts selon l'endroit où il est appliqué. L'application sur un membre du groupe va appliquer pour attribuer de la valeur à la membre exactement une fois avec le "=" (affectation) de l'opérateur. Cela n'a rien à voir avec l'immutabilité. Si vous remplacez la référence d'un membre à un nouveau (un autre exemple de la même classe), l'instance précédente restera inchangée (mais peut-être GCed si pas d'autres références sont les tenir).
InformationsquelleAutor ncmathsadist
1

Retour d'un inmodifiable liste est une bonne idée. Mais une liste qui est faite inmodifiable lors de l'appel à la méthode de lecture peut toujours être modifié par la classe ou à des classes dérivées de la classe.

Au lieu de cela, vous devriez faire comprendre à quelqu'un qui étend la classe que la liste ne doit pas être modifié.

Donc dans votre exemple, il pourrait conduire à la suite du code:
```
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class Test {
    public static final List<String> STRINGS =
        Collections.unmodifiableList(
            Arrays.asList("1", "2"));

    public final List<String> getStrings() {
        return STRINGS;
    }
}
```
Dans l'exemple ci-dessus, j'ai fait le STRINGS domaine public, en principe, on pourrait faire disparaître avec l'appel de la méthode, ainsi que les valeurs sont déjà connus.

Vous pouvez également affecter les cordes pour un private final List<String> field inmodifiable lors de la construction de l'instance de classe. À l'aide d'une constante ou d'instanciation des arguments (du constructeur) dépend de la conception de la classe.
```
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class Test {
    private final List<String> strings;

    public Test(final String ... strings) {
        this.strings = Collections.unmodifiableList(Arrays
                .asList(strings));
    }

    public final List<String> getStrings() {
        return strings;
    }
}
```
InformationsquelleAutor Maarten Bodewes
0

Oui, vous devez nous retourner une copie de la matrice:
```
 public String[] getArr()
 {
    return Arrays.copyOf(arr);
 }
```
- -1 comme ce seul argument de la méthode n'existe pas.
InformationsquelleAutor kofemann

Vous devez vous connecter pour publier un commentaire.