Une introduction à la classe Java.util.Hashtable

1. Vue d'ensemble

Hashtable est la plus ancienne implémentation d'une structure de données de table de hachage en Java. Le HashMap est la deuxième implémentation, qui a été introduite dans JDK 1.2.

Les deux classes fournissent des fonctionnalités similaires, mais il existe également de petites différences, que nous explorerons dans ce didacticiel.

2. Quand utiliser Hashtable

Disons que nous avons un dictionnaire, où chaque mot a sa définition. En outre, nous devons obtenir, insérer et supprimer rapidement des mots du dictionnaire.

Par conséquent, Hashtable (ou HashMap ) a du sens. Les mots seront les clés de la table de hachage , car ils sont censés être uniques. Les définitions, en revanche, seront les valeurs.

3. Exemple d'utilisation

Continuons avec l'exemple du dictionnaire. Nous modéliserons Word comme une clé:

public class Word { private String name; public Word(String name) { this.name = name; } // ... }

Disons que les valeurs sont des chaînes . Maintenant, nous pouvons créer un Hashtable :

Hashtable table = new Hashtable();

Tout d'abord, ajoutons une entrée:

Word word = new Word("cat"); table.put(word, "an animal");

Aussi, pour obtenir une entrée:

String definition = table.get(word);

Enfin, supprimons une entrée:

definition = table.remove(word);

Il existe de nombreuses autres méthodes dans la classe, et nous en décrirons quelques-unes plus tard.

Mais d'abord, parlons de certaines exigences pour l'objet clé.

4. L'importance de hashCode ()

Pour être utilisé comme clé dans une table de hachage , l'objet ne doit pas violer le contrat hashCode () . En bref, les objets égaux doivent renvoyer le même code. Pour comprendre pourquoi, regardons comment la table de hachage est organisée.

Hashtable utilise un tableau. Chaque position dans le tableau est un «compartiment» qui peut être nul ou contenir une ou plusieurs paires clé-valeur. L'indice de chaque paire est calculé.

Mais pourquoi ne pas stocker les éléments séquentiellement, en ajoutant de nouveaux éléments à la fin du tableau?

Le fait est que trouver un élément par index est beaucoup plus rapide que de parcourir les éléments avec la comparaison séquentielle. Par conséquent, nous avons besoin d'une fonction qui mappe les clés aux index.

4.1. Table d'adresses directes

L'exemple le plus simple d'un tel mappage est la table d'adresses directes. Ici, les clés sont utilisées comme index:

index(k)=k, where k is a key

Les clés sont uniques, c'est-à-dire que chaque compartiment contient une paire clé-valeur. Cette technique fonctionne bien pour les clés entières lorsque leur plage possible est raisonnablement petite.

Mais nous avons ici deux problèmes:

  • Premièrement, nos clés ne sont pas des entiers, mais des objets Word
  • Deuxièmement, s'ils étaient des nombres entiers, personne ne garantirait qu'ils sont petits. Imaginez que les clés soient 1, 2 et 1000000. Nous aurons un grand tableau de taille 1000000 avec seulement trois éléments, et le reste sera un espace perdu

La méthode hashCode () résout le premier problème.

La logique de manipulation des données dans le Hashtable résout le deuxième problème.

Discutons de cela en profondeur.

4.2. hashCode (), méthode

Tout objet Java hérite de la méthode hashCode () qui renvoie une valeur int . Cette valeur est calculée à partir de l'adresse mémoire interne de l'objet. Par défaut, hashCode () renvoie des entiers distincts pour des objets distincts.

Ainsi, tout objet clé peut être converti en un entier en utilisant hashCode () . Mais cet entier peut être grand.

4.3. Réduire la portée

Les méthodes get () , put () et remove () contiennent le code qui résout le deuxième problème - réduire la gamme d'entiers possibles.

La formule calcule un index pour la clé:

int index = (hash & 0x7FFFFFFF) % tab.length;

tab.length est la taille du tableau et hash est un nombre renvoyé par la méthode hashCode () de la clé .

Comme nous pouvons le voir, index est un rappel du hachage de division par la taille du tableau . Notez que les codes de hachage égaux produisent le même index.

4.4. Collisions

De plus, même des codes de hachage différents peuvent produire le même index . Nous appelons cela une collision. Pour résoudre les collisions, Hashtable stocke une LinkedList de paires clé-valeur.

Une telle structure de données est appelée une table de hachage avec chaînage.

4.5. Facteur de charge

It is easy to guess that collisions slow down operations with elements. To get an entry it is not enough to know its index, but we need to go through the list and perform a comparison with each item.

Therefore it's important to reduce the number of collisions. The bigger is an array, the smaller is the chance of a collision. The load factor determines the balance between the array size and the performance. By default, it's 0.75 which means that the array size doubles when 75% of the buckets become not empty. This operation is executed by rehash() method.

But let's return to the keys.

4.6. Overriding equals() and hashCode()

When we put an entry into a Hashtable and get it out of it, we expect that the value can be obtained not only with same the instance of the key but also with an equal key:

Word word = new Word("cat"); table.put(word, "an animal"); String extracted = table.get(new Word("cat"));

To set the rules of equality, we override the key’s equals() method:

public boolean equals(Object o) { if (o == this) return true; if (!(o instanceof Word)) return false; Word word = (Word) o; return word.getName().equals(this.name); }

But if we don’t override hashCode() when overriding equals() then two equal keys may end up in the different buckets because Hashtable calculates the key’s index using its hash code.

Let’s take a close look at the above example. What happens if we don’t override hashCode()?

  • Two instances of Word are involved here – the first is for putting the entry and the second is for getting the entry. Although these instances are equal, their hashCode() method return different numbers
  • The index for each key is calculated by the formula from section 4.3. According to this formula, different hash codes may produce different indexes
  • This means that we put the entry into one bucket and then try to get it out from the other bucket. Such logic breaks Hashtable

Equal keys must return equal hash codes, that’s why we override the hashCode() method:

public int hashCode() { return name.hashCode(); }

Note that it's also recommended to make not equal keys return different hash codes, otherwise they end up in the same bucket. This will hit the performance, hence, losing some of the advantages of a Hashtable.

Also, note that we don’t care about the keys of String, Integer, Long or another wrapper type. Both equal() and hashCode() methods are already overridden in wrapper classes.

5. Iterating Hashtables

There are a few ways to iterate Hashtables. In this section well talk about them and explain some of the implications.

5.1. Fail Fast: Iteration

Fail-fast iteration means that if a Hashtable is modified after its Iterator is created, then the ConcurrentModificationException will be thrown. Let's demonstrate this.

First, we'll create a Hashtable and add entries to it:

Hashtable table = new Hashtable(); table.put(new Word("cat"), "an animal"); table.put(new Word("dog"), "another animal");

Second, we'll create an Iterator:

Iterator it = table.keySet().iterator();

And third, we'll modify the table:

table.remove(new Word("dog"));

Now if we try to iterate through the table, we'll get a ConcurrentModificationException:

while (it.hasNext()) { Word key = it.next(); }
java.util.ConcurrentModificationException at java.util.Hashtable$Enumerator.next(Hashtable.java:1378)

ConcurrentModificationException helps to find bugs and thus avoid unpredictable behavior, when, for example, one thread is iterating through the table, and another one is trying to modify it at the same time.

5.2. Not Fail Fast: Enumeration

Enumeration in a Hashtable is not fail-fast. Let's look at an example.

First, let's create a Hashtable and add entries to it:

Hashtable table = new Hashtable(); table.put(new Word("1"), "one"); table.put(new Word("2"), "two");

Second, let's create an Enumeration:

Enumeration enumKey = table.keys();

Third, let's modify the table:

table.remove(new Word("1"));

Now if we iterate through the table it won't throw an exception:

while (enumKey.hasMoreElements()) { Word key = enumKey.nextElement(); }

5.3. Unpredictable Iteration Order

Also, note that iteration order in a Hashtable is unpredictable and does not match the order in which the entries were added.

This is understandable as it calculates each index using the key's hash code. Moreover, rehashing takes place from time to time, rearranging the order of the data structure.

Hence, let's add some entries and check the output:

Hashtable table = new Hashtable(); table.put(new Word("1"), "one"); table.put(new Word("2"), "two"); // ... table.put(new Word("8"), "eight"); Iterator
    
      it = table.entrySet().iterator(); while (it.hasNext()) { Map.Entry entry = it.next(); // ... } }
    
five four three two one eight seven

6. Hashtable vs. HashMap

Hashtable and HashMap provide very similar functionality.

Both of them provide:

  • Fail-fast iteration
  • Unpredictable iteration order

But there are some differences too:

  • HashMap doesn't provide any Enumeration, while Hashtable provides not fail-fast Enumeration
  • Hashtable doesn't allow null keys and null values, while HashMap do allow one null key and any number of null values
  • Hashtable‘s methods are synchronized while HashMaps‘s methods are not

7. Hashtable API in Java 8

Java 8 has introduced new methods which help make our code cleaner. In particular, we can get rid of some if blocks. Let's demonstrate this.

7.1. getOrDefault()

Let's say we need to get the definition of the word “dogand assign it to the variable if it is on the table. Otherwise, assign “not found” to the variable.

Before Java 8:

Word key = new Word("dog"); String definition; if (table.containsKey(key)) { definition = table.get(key); } else { definition = "not found"; }

After Java 8:

definition = table.getOrDefault(key, "not found");

7.2. putIfAbsent()

Let's say we need to put a word “cat only if it's not in the dictionary yet.

Before Java 8:

if (!table.containsKey(new Word("cat"))) { table.put(new Word("cat"), definition); }

After Java 8:

table.putIfAbsent(new Word("cat"), definition);

7.3. boolean remove()

Let's say we need to remove the word “cat” but only if it's definition is “an animal”.

Before Java 8:

if (table.get(new Word("cat")).equals("an animal")) { table.remove(new Word("cat")); }

After Java 8:

boolean result = table.remove(new Word("cat"), "an animal");

Finally, while old remove() method returns the value, the new method returns boolean.

7.4. replace()

Let's say we need to replace a definition of “cat”, but only if its old definition is “a small domesticated carnivorous mammal”.

Before Java 8:

if (table.containsKey(new Word("cat")) && table.get(new Word("cat")).equals("a small domesticated carnivorous mammal")) { table.put(new Word("cat"), definition); }

After Java 8:

table.replace(new Word("cat"), "a small domesticated carnivorous mammal", definition);

7.5. computeIfAbsent()

This method is similar to putIfabsent(). But putIfabsent() takes the value directly, and computeIfAbsent() takes a mapping function. It calculates the value only after it checks the key, and this is more efficient, especially if the value is difficult to obtain.

table.computeIfAbsent(new Word("cat"), key -> "an animal");

Hence, the above line is equivalent to:

if (!table.containsKey(cat)) { String definition = "an animal"; // note that calculations take place inside if block table.put(new Word("cat"), definition); }

7.6. computeIfPresent()

This method is similar to the replace() method. But, again, replace() takes the value directly, and computeIfPresent() takes a mapping function. It calculates the value inside of the if block, that's why it's more efficient.

Let's say we need to change the definition:

table.computeIfPresent(cat, (key, value) -> key.getName() + " - " + value);

Hence, the above line is equivalent to:

if (table.containsKey(cat)) { String concatination=cat.getName() + " - " + table.get(cat); table.put(cat, concatination); }

7.7. compute()

Now we'll solve another task. Let's say we have an array of String, where the elements are not unique. Also, let's calculate how many occurrences of a String we can get in the array. Here is the array:

String[] animals = { "cat", "dog", "dog", "cat", "bird", "mouse", "mouse" };

Also, we want to create a Hashtable which contains an animal as a key and the number of its occurrences as a value.

Here is a solution:

Hashtable table = new Hashtable(); for (String animal : animals) { table.compute(animal, (key, value) -> (value == null ? 1 : value + 1)); }

Finally, let's make sure, that the table contains two cats, two dogs, one bird and two mouses:

assertThat(table.values(), hasItems(2, 2, 2, 1));

7.8. merge()

There is another way to solve the above task:

for (String animal : animals) { table.merge(animal, 1, (oldValue, value) -> (oldValue + value)); }

The second argument, 1, is the value which is mapped to the key if the key is not yet on the table. If the key is already in the table, then we calculate it as oldValue+1.

7.9. foreach()

This is a new way to iterate through the entries. Let's print all the entries:

table.forEach((k, v) -> System.out.println(k.getName() + " - " + v)

7.10. replaceAll()

Additionally, we can replace all the values without iteration:

table.replaceAll((k, v) -> k.getName() + " - " + v);

8. Conclusion

In this article, we've described the purpose of the hash table structure and showed how to complicate a direct-address table structure to get it.

De plus, nous avons couvert ce que sont les collisions et quel est le facteur de charge dans une table de hachage. De plus, nous avons appris pourquoi remplacer equals () et hashCode () pour les objets clés.

Enfin, nous avons parlé des propriétés de Hashtable et de l'API spécifique à Java 8.

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