Un guide de Java HashMap

1. Vue d'ensemble

Dans cet article, nous verrons comment utiliser HashMap en Java, et nous verrons comment cela fonctionne en interne.

Une classe très similaire à HashMap est Hashtable . Veuillez vous référer à quelques autres articles pour en savoir plus sur la classe java.util.Hashtable elle-même et les différences entre HashMap et Hashtable .

2. Utilisation de base

Voyons d'abord ce que cela signifie que HashMap est une carte. Une carte est un mappage clé-valeur, ce qui signifie que chaque clé est mappée à exactement une valeur et que nous pouvons utiliser la clé pour récupérer la valeur correspondante d'une carte.

On pourrait se demander pourquoi ne pas simplement ajouter la valeur à une liste. Pourquoi avons-nous besoin d'un HashMap ? La raison simple est la performance. Si nous voulons trouver un élément spécifique dans une liste, la complexité temporelle est O (n) et si la liste est triée, ce sera O (log n) en utilisant, par exemple, une recherche binaire.

L'avantage d'un HashMap est que la complexité en temps pour insérer et récupérer une valeur est en moyenne O (1) . Nous verrons comment cela peut être réalisé plus tard. Voyons d'abord comment utiliser HashMap .

2.1. Installer

Créons une classe simple que nous utiliserons tout au long de l'article:

public class Product { private String name; private String description; private List tags; // standard getters/setters/constructors public Product addTagsOfOtherProdcut(Product product) { this.tags.addAll(product.getTags()); return this; } }

2.2. Mettre

Nous pouvons maintenant créer un HashMap avec la clé de type String et des éléments de type Product :

Map productsByName = new HashMap(); 

Et ajoutez des produits à notre HashMap :

Product eBike = new Product("E-Bike", "A bike with a battery"); Product roadBike = new Product("Road bike", "A bike for competition"); productsByName.put(eBike.getName(), eBike); productsByName.put(roadBike.getName(), roadBike); 

2.3. Avoir

Nous pouvons récupérer une valeur de la carte par sa clé:

Product nextPurchase = productsByName.get("E-Bike"); assertEquals("A bike with a battery", nextPurchase.getDescription());

Si nous essayons de trouver une valeur pour une clé qui n'existe pas dans la carte, nous obtiendrons une valeur nulle :

Product nextPurchase = productsByName.get("Car"); assertNull(nextPurchase);

Et si nous insérons une deuxième valeur avec la même clé, nous n'obtiendrons que la dernière valeur insérée pour cette clé:

Product newEBike = new Product("E-Bike", "A bike with a better battery"); productsByName.put(newEBike.getName(), newEBike); assertEquals("A bike with a better battery", productsByName.get("E-Bike").getDescription());

2.4. Null comme clé

HashMap nous permet également d'avoir null comme clé:

Product defaultProduct = new Product("Chocolate", "At least buy chocolate"); productsByName.put(null, defaultProduct); Product nextPurchase = productsByName.get(null); assertEquals("At least buy chocolate", nextPurchase.getDescription());

2.5. Valeurs avec la même clé

De plus, nous pouvons insérer le même objet deux fois avec une clé différente:

productsByName.put(defaultProduct.getName(), defaultProduct); assertSame(productsByName.get(null), productsByName.get("Chocolate"));

2.6. Supprimer une valeur

Nous pouvons supprimer un mappage clé-valeur du HashMap :

productsByName.remove("E-Bike"); assertNull(productsByName.get("E-Bike"));

2.7. Vérifier si une clé ou une valeur existe dans la carte

Pour vérifier si une clé est présente dans la carte, nous pouvons utiliser la méthode containsKey () :

productsByName.containsKey("E-Bike");

Ou, pour vérifier si une valeur est présente dans la carte, nous pouvons utiliser la méthode containsValue () :

productsByName.containsValue(eBike);

Les deux appels de méthode renverront true dans notre exemple. Bien qu'ils semblent très similaires, il existe une différence de performances importante entre ces deux appels de méthode. La complexité pour vérifier si une clé existe est O (1) , tandis que la complexité pour vérifier un élément est O (n), car il est nécessaire de boucler sur tous les éléments de la carte.

2.8. Itérer sur un HashMap

Il existe trois méthodes de base pour parcourir toutes les paires clé-valeur dans un HashMap .

Nous pouvons itérer sur l'ensemble de toutes les clés:

for(String key : productsByName.keySet()) { Product product = productsByName.get(key); }

Ou nous pouvons parcourir l'ensemble de toutes les entrées:

for(Map.Entry entry : productsByName.entrySet()) { Product product = entry.getValue(); String key = entry.getKey(); //do something with the key and value }

Enfin, nous pouvons itérer sur toutes les valeurs:

List products = new ArrayList(productsByName.values());

3. La clé

Nous pouvons utiliser n'importe quelle classe comme clé dans notre HashMap . Cependant, pour que la carte fonctionne correctement, nous devons fournir une implémentation pour equals () et hashCode (). Disons que nous voulons avoir une carte avec le produit comme clé et le prix comme valeur:

HashMap priceByProduct = new HashMap(); priceByProduct.put(eBike, 900);

Implémentons les égaux () et hashCode () méthodes:

@Override public boolean equals(Object o) { if (this == o) { return true; } if (o == null || getClass() != o.getClass()) { return false; } Product product = (Product) o; return Objects.equals(name, product.name) && Objects.equals(description, product.description); } @Override public int hashCode() { return Objects.hash(name, description); }

Notez que hashCode () et equals () doivent être remplacés uniquement pour les classes que nous voulons utiliser comme clés de mappage, pas pour les classes qui ne sont utilisées que comme valeurs dans une mappe. Nous verrons pourquoi cela est nécessaire dans la section 5 de cet article.

4. Additional Methods as of Java 8

Java 8 added several functional-style methods to HashMap. In this section, we'll look at some of these methods.

For each method, we'll look at two examples. The first example shows how to use the new method, and the second example shows how to achieve the same in earlier versions of Java.

As these methods are quite straightforward, we won't look at more detailed examples.

4.1. forEach()

The forEach method is the functional-style way to iterate over all elements in the map:

productsByName.forEach( (key, product) -> { System.out.println("Key: " + key + " Product:" + product.getDescription()); //do something with the key and value }); 

Prior to Java 8:

for(Map.Entry entry : productsByName.entrySet()) { Product product = entry.getValue(); String key = entry.getKey(); //do something with the key and value }

Our article Guide to the Java 8 forEach covers the forEach loop in greater detail.

4.2. getOrDefault()

Using the getOrDefault() method, we can get a value from the map or return a default element in case there is no mapping for the given key:

Product chocolate = new Product("chocolate", "something sweet"); Product defaultProduct = productsByName.getOrDefault("horse carriage", chocolate); Product bike = productsByName.getOrDefault("E-Bike", chocolate);

Prior to Java 8:

Product bike2 = productsByName.containsKey("E-Bike") ? productsByName.get("E-Bike") : chocolate; Product defaultProduct2 = productsByName.containsKey("horse carriage") ? productsByName.get("horse carriage") : chocolate; 

4.3. putIfAbsent()

With this method, we can add a new mapping, but only if there is not yet a mapping for the given key:

productsByName.putIfAbsent("E-Bike", chocolate); 

Prior to Java 8:

if(productsByName.containsKey("E-Bike")) { productsByName.put("E-Bike", chocolate); }

Our article Merging Two Maps with Java 8 takes a closer look at this method.

4.4. merge()

And with merge(), we can modify the value for a given key if a mapping exists, or add a new value otherwise:

Product eBike2 = new Product("E-Bike", "A bike with a battery"); eBike2.getTags().add("sport"); productsByName.merge("E-Bike", eBike2, Product::addTagsOfOtherProdcut);

Prior to Java 8:

if(productsByName.containsKey("E-Bike")) { productsByName.get("E-Bike").addTagsOfOtherProdcut(eBike2); } else { productsByName.put("E-Bike", eBike2); } 

4.5. compute()

With the compute() method, we can compute the value for a given key:

productsByName.compute("E-Bike", (k,v) -> { if(v != null) { return v.addTagsOfOtherProdcut(eBike2); } else { return eBike2; } });

Prior to Java 8:

if(productsByName.containsKey("E-Bike")) { productsByName.get("E-Bike").addTagsOfOtherProdcut(eBike2); } else { productsByName.put("E-Bike", eBike2); } 

It's worth noting that the methods merge() and compute() are quite similar. The compute() method accepts two arguments: the key and a BiFunction for the remapping. And merge() accepts three parameters: the key, a default value to add to the map if the key doesn't exist yet, and a BiFunction for the remapping.

5. HashMap Internals

In this section, we'll look at how HashMap works internally and what are the benefits of using HashMap instead of a simple list, for example.

As we've seen, we can retrieve an element from a HashMap by its key. One approach would be to use a list, iterate over all elements, and return when we find an element for which the key matches. Both the time and space complexity of this approach would be O(n).

With HashMap, we can achieve an average time complexity of O(1) for the put and get operations and space complexity of O(n). Let's see how that works.

5.1. The Hash Code and Equals

Instead of iterating over all its elements, HashMap attempts to calculate the position of a value based on its key.

The naive approach would be to have a list that can contain as many elements as there are keys possible. As an example, let's say our key is a lower-case character. Then it's sufficient to have a list of size 26, and if we want to access the element with key ‘c', we'd know that it's the one at position 3, and we can retrieve it directly.

However, this approach would not be very effective if we have a much bigger keyspace. For example, let's say our key was an integer. In this case, the size of the list would have to be 2,147,483,647. In most cases, we would also have far fewer elements, so a big part of the allocated memory would remain unused.

HashMap stores elements in so-called buckets and the number of buckets is called capacity.

When we put a value in the map, the key's hashCode() method is used to determine the bucket in which the value will be stored.

To retrieve the value, HashMap calculates the bucket in the same way – using hashCode(). Then it iterates through the objects found in that bucket and use key's equals() method to find the exact match.

5.2. Keys' Immutability

In most cases, we should use immutable keys. Or at least, we must be aware of the consequences of using mutable keys.

Let's see what happens when our key changes after we used it to store a value in a map.

For this example, we'll create the MutableKey:

public class MutableKey { private String name; // standard constructor, getter and setter @Override public boolean equals(Object o) { if (this == o) { return true; } if (o == null || getClass() != o.getClass()) { return false; } MutableKey that = (MutableKey) o; return Objects.equals(name, that.name); } @Override public int hashCode() { return Objects.hash(name); } }

And here goes the test:

MutableKey key = new MutableKey("initial"); Map items = new HashMap(); items.put(key, "success"); key.setName("changed"); assertNull(items.get(key));

As we can see, we're no longer able to get the corresponding value once the key has changed, instead, null is returned. This is because HashMap is searching in the wrong bucket.

The above test case may be surprising if we don't have a good understanding of how HashMap works internally.

5.3. Collisions

For this to work correctly, equal keys must have the same hash, however, different keys can have the same hash. If two different keys have the same hash, the two values belonging to them will be stored in the same bucket. Inside a bucket, values are stored in a list and retrieved by looping over all elements. The cost of this is O(n).

As of Java 8 (see JEP 180), the data structure in which the values inside one bucket are stored is changed from a list to a balanced tree if a bucket contains 8 or more values, and it's changed back to a list if, at some point, only 6 values are left in the bucket. This improves the performance to be O(log n).

5.4. Capacity and Load Factor

To avoid having many buckets with multiple values, the capacity is doubled if 75% (the load factor) of the buckets become non-empty. The default value for the load factor is 75%, and the default initial capacity is 16. Both can be set in the constructor.

5.5. Summary of put and get Operations

Let's summarize how the put and get operations work.

When we add an element to the map,HashMap calculates the bucket. If the bucket already contains a value, the value is added to the list (or tree) belonging to that bucket. If the load factor becomes bigger than the maximum load factor of the map, the capacity is doubled.

When we want to get a value from the map,HashMap calculates the bucket and gets the value with the same key from the list (or tree).

6. Conclusion

Dans cet article, nous avons vu comment utiliser un HashMap et comment il fonctionne en interne. Avec ArrayList , HashMap est l'une des structures de données les plus fréquemment utilisées en Java, il est donc très pratique d'avoir une bonne connaissance de son utilisation et de son fonctionnement sous le capot. Notre article The Java HashMap Under the Hood couvre les éléments internes de HashMap plus en détail.

Comme d'habitude, le code source complet est disponible sur Github.