¿Es mejor devolver un ImmutableMap o un Map?

Digamos que estoy escribiendo un método que debería devolver un mapa . Por ejemplo:

public Map<String, Integer> foo() {
  return new HashMap<String, Integer>();
}

Después de pensarlo un rato, he decidido que no hay razón para modificar este mapa una vez creado. Por lo tanto, me gustaría devolver un ImmutableMap .

public Map<String, Integer> foo() {
  return ImmutableMap.of();
}

¿Debo dejar el tipo de devolución como un mapa genérico o debo especificar que estoy devolviendo un mapa inmutable?

Por un lado, esta es exactamente la razón por la que se crearon las interfaces; para ocultar los detalles de implementación.
Por otro lado, si lo dejo así, otros desarrolladores podrían perder el hecho de que este objeto es inmutable. Por lo tanto, no lograré un objetivo importante de objetos inmutables; para hacer el código más claro minimizando el número de objetos que pueden cambiar. Peor aún, después de un tiempo, alguien podría intentar cambiar este objeto, y esto resultará en un error de tiempo de ejecución (el compilador no lo advertirá).

• Si está escribiendo una API de cara al público y esa inmutabilidad es un aspecto importante de su diseño, definitivamente lo haría explícito si el nombre del método denota claramente que el mapa devuelto será inmutable o devolviendo el tipo concreto de el mapa. En mi opinión, mencionarlo en el javadoc no es suficiente.

  Dado que aparentemente está utilizando la implementación de Guava, miré el documento y es una clase abstracta, por lo que le brinda un poco de flexibilidad en el tipo concreto real.

• Si está escribiendo una herramienta / biblioteca interna, es mucho más aceptable devolver un archivo Map. Las personas conocerán los aspectos internos del código al que están llamando o, al menos, tendrán fácil acceso a él.

Mi conclusión sería que lo explícito es bueno, no dejes las cosas al azar.

Debería tener ImmutableMapcomo tipo de devolución. Mapcontiene métodos que no son compatibles con la implementación de ImmutableMap(eg put) y están marcados @deprecateden ImmutableMap.

El uso de métodos obsoletos dará como resultado una advertencia del compilador y la mayoría de los IDE advertirán cuando las personas intenten utilizar los métodos obsoletos.

Esta advertencia avanzada es preferible a tener excepciones en tiempo de ejecución como primer indicio de que algo anda mal.

Por otro lado, si lo dejo así, otros desarrolladores podrían perder el hecho de que este objeto es inmutable.

Deberías mencionar eso en los javadocs. Los desarrolladores los leen, ya sabes.

Por lo tanto, no lograré un objetivo importante de objetos inmutables; para hacer el código más claro minimizando el número de objetos que pueden cambiar. Peor aún, después de un tiempo, alguien podría intentar cambiar este objeto, y esto resultará en un error de tiempo de ejecución (el compilador no lo advertirá).

Ningún desarrollador publica su código sin probarlo. Y cuando lo prueba, recibe una excepción en la que no solo ve el motivo, sino también el archivo y la línea donde intentó escribir en un mapa inmutable.

Sin embargo, tenga en cuenta que solo el Mapmismo será inmutable, no los objetos que contiene.

si lo dejo así, otros desarrolladores podrían perder el hecho de que este objeto es inmutable

Eso es cierto, pero otros desarrolladores deberían probar su código y asegurarse de que esté cubierto.

Sin embargo, tienes 2 opciones más para solucionar esto:

• Utilice Javadoc

  @return a immutable map

• Elija un nombre de método descriptivo

  public Map<String, Integer> getImmutableMap()
  public Map<String, Integer> getUnmodifiableEntries()

  Para un caso de uso concreto, incluso puede nombrar mejor los métodos. P.ej

  public Map<String, Integer> getUnmodifiableCountByWords()

¡¿Qué más puedes hacer?!

Puede devolver un

• Copiar

  private Map<String, Integer> myMap;
  
  public Map<String, Integer> foo() {
    return new HashMap<String, Integer>(myMap);
  }

  Este enfoque debe usarse si espera que muchos clientes modifiquen el mapa y siempre que el mapa solo contenga algunas entradas.

• CopyOnWriteMap

  Las colecciones de copia en escritura se utilizan generalmente cuando tienes que lidiar con
  concurrencia. Pero el concepto también le ayudará en su situación, ya que CopyOnWriteMap crea una copia de la estructura de datos interna en una operación mutativa (por ejemplo, agregar, eliminar).

  En este caso, necesita un envoltorio delgado alrededor de su mapa que delegue todas las invocaciones de métodos al mapa subyacente, excepto las operaciones mutativas. Si se invoca una operación mutativa, se crea una copia del mapa subyacente y todas las invocaciones posteriores se delegarán en esta copia.

  Este enfoque debe utilizarse si espera que algunos clientes modifiquen el mapa.

  Lamentablemente, Java no tiene tal CopyOnWriteMap. Pero puede encontrar un tercero o implementarlo usted mismo.

Por último, debe tener en cuenta que los elementos de su mapa aún pueden ser mutables.

Definitivamente devuelve un ImmutableMap, la justificación es:

• La firma del método (incluido el tipo de retorno) debe ser autodocumentada. Los comentarios son como el servicio al cliente: si sus clientes necesitan confiar en ellos, entonces su producto principal es defectuoso.
• Si algo es una interfaz o una clase, solo es relevante cuando se extiende o se implementa. Dada una instancia (objeto), el 99% de las veces el código del cliente no sabrá o no le importará si algo es una interfaz o una clase. Al principio asumí que ImmutableMap era una interfaz. Solo después de hacer clic en el enlace me di cuenta de que es una clase.

Depende de la clase en sí. Guava's ImmutableMapno pretende ser una vista inmutable en una clase mutable. Si su clase es inmutable y tiene una estructura que es básicamente an ImmutableMap, entonces haga el tipo de retorno ImmutableMap. Sin embargo, si tu clase es mutable, no lo hagas. Si tienes esto:

public ImmutableMap<String, Integer> foo() {
    return ImmutableMap.copyOf(internalMap);
}

Guava copiará el mapa cada vez. Eso es lento. Pero si internalMapya era un ImmutableMap, entonces está totalmente bien.

Si no restringe su clase para que regrese ImmutableMap, entonces podría regresar Collections.unmodifiableMapasí:

public Map<String, Integer> foo() {
    return Collections.unmodifiableMap(internalMap);
}

Tenga en cuenta que esta es una vista inmutable del mapa. Si internalMapcambia, también lo hará una copia en caché de Collections.unmodifiableMap(internalMap). Sin embargo, todavía lo prefiero para los getters.

Esto no responde a la pregunta exacta, pero vale la pena considerar si se debe devolver un mapa. Si el mapa es inmutable, entonces el método principal que se proporcionará se basa en get (clave):

public Integer fooOf(String key) {
    return map.get(key);
}

Esto hace que la API sea mucho más estricta. Si realmente se requiere un mapa, esto podría dejarse en manos del cliente de la API proporcionando un flujo de entradas:

public Stream<Map.Entry<String, Integer>> foos() {
    map.entrySet().stream()
}

Luego, el cliente puede hacer su propio mapa inmutable o mutable según lo necesite, o agregar las entradas a su propio mapa. Si el cliente necesita saber si el valor existe, se puede devolver opcional en su lugar:

public Optional<Integer> fooOf(String key) {
    return Optional.ofNullable(map.get(key));
}

Immutable Map es un tipo de mapa. Entonces, dejar el tipo de retorno de Map está bien.

Para asegurarse de que los usuarios no modifiquen el objeto devuelto, la documentación del método puede describir las características del objeto devuelto.

Podría decirse que esto es una cuestión de opinión, pero la mejor idea aquí es usar una interfaz para la clase de mapa. Esta interfaz no necesita decir explícitamente que es inmutable, pero el mensaje será el mismo si no expone ninguno de los métodos de establecimiento de la clase principal en la interfaz.

Eche un vistazo al siguiente artículo:

Andy Gibson