L'interface fmt.Stringer

Fait partie de la section Programmation Orientée Objet du Journey GO de Coddy — leçon 75 sur 107.

L'interface fmt.Stringer contrôle la manière dont vos types s'affichent lorsqu'ils sont imprimés. C'est l'une des interfaces les plus couramment implémentées en Go, définie dans le package fmt :

type Stringer interface {
    String() string
}

Lorsque vous passez une valeur à fmt.Println, fmt.Printf avec %v, ou des fonctions similaires, Go vérifie si le type implémente Stringer. Si c'est le cas, Go appelle la méthode String() pour obtenir la représentation textuelle.

type Temperature struct {
    Celsius float64
}

func (t Temperature) String() string {
    return fmt.Sprintf("%.1f°C", t.Celsius)
}

func main() {
    temp := Temperature{Celsius: 23.5}
    fmt.Println(temp)  // 23.5°C
}

Sans la méthode String(), l'affichage montrerait le format de structure par défaut : {23.5}. En implémentant Stringer, vous contrôlez exactement la façon dont votre type se présente.

Ceci est particulièrement utile pour les types où les valeurs brutes des champs n'expriment pas clairement leur signification. Un type Duration pourrait s'afficher sous la forme "2h 30m" au lieu d'afficher des nanosecondes brutes, ou un type User pourrait afficher un nom formaté au lieu de l'ensemble de ses champs.

Défi

Facile

Construisons un système de suivi du temps qui affiche les durées dans un format convivial ! Vous allez implémenter l'interface fmt.Stringer pour contrôler la façon dont vos types personnalisés apparaissent lorsqu'ils sont affichés.

Vous organiserez votre code sur deux fichiers :

duration.go : Définissez vos types liés au temps avec des représentations sous forme de chaînes personnalisées.
Créez une structure Duration qui stocke un nombre total de minutes sous forme d'entier. Implémentez la méthode String() de sorte que, lorsqu'elle est affichée, elle apparaisse dans un format lisible comme 2h 30m pour 150 minutes, ou 0h 45m pour 45 minutes. Les heures et les minutes doivent toujours être affichées.

Créez une structure Task avec des champs pour Name (string) et Time (Duration). Implémentez String() sur Task pour l'afficher au format [Name]: [duration], où la durée utilise sa propre méthode String.
main.go : Construisez et affichez les tâches avec leurs durées.
Lisez un nombre de tâches, puis pour chaque tâche, lisez son nom et sa durée en minutes. Créez des instances de Task et affichez chacune d'elles directement en utilisant fmt.Println—l'interface Stringer gérera automatiquement le formatage.

Après avoir affiché toutes les tâches, calculez et affichez le temps total de toutes les tâches au format :
```
Total: [duration]
```

Les entrées suivantes seront fournies :

Ligne 1 : Nombre de tâches
Lignes suivantes : Nom de la tâche et minutes (deux lignes par tâche)

Par exemple, étant donné :

3
Code Review
90
Meeting
45
Documentation
120

Votre sortie devrait être :

Code Review: 1h 30m
Meeting: 0h 45m
Documentation: 2h 0m
Total: 4h 15m

Et étant donné :

2
Design
180
Testing
65

Votre sortie devrait être :

Design: 3h 0m
Testing: 1h 5m
Total: 4h 5m

En implémentant Stringer, vos types s'intègrent parfaitement aux fonctions d'affichage de Go. Au lieu de voir des champs de structure bruts comme {90}, vous obtenez une sortie significative qui a du sens pour les utilisateurs.

Aide-mémoire

L'interface fmt.Stringer contrôle la manière dont les types s'affichent lorsqu'ils sont imprimés :

type Stringer interface {
    String() string
}

Lorsque vous passez une valeur à fmt.Println ou fmt.Printf avec %v, Go vérifie si le type implémente Stringer. Si c'est le cas, Go appelle la méthode String() pour obtenir la représentation textuelle.

Exemple d'implémentation :

type Temperature struct {
    Celsius float64
}

func (t Temperature) String() string {
    return fmt.Sprintf("%.1f°C", t.Celsius)
}

func main() {
    temp := Temperature{Celsius: 23.5}
    fmt.Println(temp)  // 23.5°C
}

Sans la méthode String(), l'affichage montre le format de structure par défaut : {23.5}. En implémentant Stringer, vous contrôlez exactement comment votre type se présente, rendant la sortie plus significative et conviviale.

Essayez vous-même

package main

import (
	"bufio"
	"fmt"
	"os"
	"strconv"
	"strings"
)

func main() {
	reader := bufio.NewReader(os.Stdin)

	// Lire le nombre de tâches
	line, _ := reader.ReadString('\n')
	numTasks, _ := strconv.Atoi(strings.TrimSpace(line))

	// TODO: Créer un slice pour stocker les tâches
	// TODO: Suivre le nombre total de minutes

	for i := 0; i < numTasks; i++ {
		// Lire le nom de la tâche
		name, _ := reader.ReadString('\n')
		name = strings.TrimSpace(name)

		// Lire la durée de la tâche en minutes
		minutesLine, _ := reader.ReadString('\n')
		minutes, _ := strconv.Atoi(strings.TrimSpace(minutesLine))

		// TODO: Créer une Task avec le name et Duration
		// TODO: Afficher la tâche (fmt.Println utilisera l'interface Stringer)
		// TODO: Ajouter les minutes au total
		_ = name
		_ = minutes
	}

	// TODO: Afficher la durée totale au format "Total: Xh Ym"
}