Sonar Violación: Seguridad - matriz se almacena directamente

Question

Hay una Violación Sonar:

Sonar Violación: Seguridad - matriz se almacena directamente

public void setMyArray(String[] myArray) { 
    this.myArray = myArray; 
} 

Solución:

public void setMyArray(String[] newMyArray) { 
    if(newMyArray == null) { 
    this.myArray = new String[0]; 
    } else { 
    this.myArray = Arrays.copyOf(newMyArray, newMyArray.length); 
    } 
} 

Pero me pregunto por qué?

Answer 1

Se queja de que la matriz que está almacenando es la misma que tiene la persona que llama. Es decir, si la persona que llama posteriormente modifica esta matriz, la matriz almacenada en el objeto (y, por lo tanto, el objeto mismo) cambiará.

La solución es hacer una copia dentro del objeto cuando se pasa. Esto se llama copiando a la defensiva. Una modificación posterior de la colección no afectará a la matriz almacenada dentro del objeto.

También es una buena práctica hacerlo normalmente al devolver una colección (por ejemplo, en una llamada correspondiente getMyArray()). De lo contrario, el receptor podría realizar una modificación y afectar la instancia almacenada.

Tenga en cuenta que esto obviamente se aplica a todas las colecciones mutables (y, de hecho, a todos los objetos mutables), no solo a las matrices. Tenga en cuenta también que esto tiene un impacto en el rendimiento que debe evaluarse junto con otras preocupaciones.

Answer 2

Se llama copiado defensivo. Un buen artículo sobre el tema es "Whose object is it, anyway?" de Brian Goetz, que analiza la diferencia entre el valor y la semántica de referencia para getters y setters.

Básicamente, el riesgo con la semántica de referencia (sin una copia) es que piensas erróneamente que eres el propietario de la matriz, y cuando la modificas, también modificas otras estructuras que tienen alias para la matriz. Puede encontrar mucha información sobre copias defensivas y problemas relacionados con el alias de objetos en línea.

Answer 3

Ir a la implementación de forma defensiva puede ahorrarle mucho tiempo. En guayaba le da otra buena solución para alcanzar la meta: ImmutableCollections

http://code.google.com/p/guava-libraries/wiki/ImmutableCollectionsExplained

Answer 4

que tenía el mismo problema:

Seguridad - matriz se almacena directamente La matriz proporcionada por el usuario 'palomitas' se almacena directamente.

mi método original:

public void setCheck(boolean[] palomitas) { 
     this.check=palomitas; 
    } 

fijo se volvieron a:

public void setCheck(boolean[] palomitas) { 
     if(palomitas == null) { 
     this.check = new boolean[0]; 
     } else { 
     this.check = Arrays.copyOf(palomitas, palomitas.length); 
     } 
} 

Otro Ejemplo:

Seguridad - matriz se almacena directamente La matriz proporcionada por el usuario

private String[] arrString; 

    public ListaJorgeAdapter(String[] stringArg) {  
     arrString = stringArg; 
    } 

fijo:

public ListaJorgeAdapter(String[] stringArg) { 
    if(stringArg == null) { 
     this.arrString = new String[0]; 
    } else { 
     this.arrString = Arrays.copyOf(stringArg, stringArg.length); 
    } 
} 

Answer 5

Para eliminarlos hay que clonar la matriz antes de guardar/devolverlo como se muestra en la siguiente implementación de la clase, por lo que nadie puede modificar u obtener los datos originales de su clase, pero solo una copia de ellos.

public byte[] getarrString() { 
    return arrString.clone(); 
} 
/** 
* @param arrStringthe arrString to set 
*/ 
public void arrString(byte[] arrString) { 
    this.arrString= arrString.clone(); 
} 

lo utilicé como esto y ahora no estoy recibiendo ninguna violación SONAR ...

Answer 6

Hay ciertos casos en los que es una decisión de diseño y no perdido. En estos casos, debe modificar las reglas de Sonar para excluirlo, de modo que no muestre dichos problemas en el informe.

Answer 7

Es más fácil que todo esto. Solo necesita cambiar el nombre del parámetro de método a cualquier otra cosa para evitar violaciones de Sonar.

http://osdir.com/ml/java-sonar-general/2012-01/msg00223.html

public void setInventoryClassId(String[] newInventoryClassId) 
    {     
      if(newInventoryClassId == null) 
      { 
        this.inventoryClassId = new String[0]; 
      } 
      else 
      { 
        this.inventoryClassId = Arrays.copyOf(newInventoryClassId, newInventoryClassId.length); 
      } 

    }