Redéfinition de noSuchMethod

Fait partie de la section Programmation Orientée Objet du Journey Dart de Coddy — leçon 74 sur 110.

Lorsque vous appelez une méthode qui n'existe pas sur un objet, Dart lève normalement une NoSuchMethodError. Cependant, vous pouvez surcharger la méthode spéciale noSuchMethod() pour intercepter ces appels et les gérer de manière appropriée.

Pour utiliser noSuchMethod(), votre classe doit également implémenter une interface ou utiliser le typage dynamic.

La méthode reçoit un objet Invocation contenant des détails sur l'appel tenté :

class Flexible {
  @override
  dynamic noSuchMethod(Invocation invocation) {
    var methodName = invocation.memberName.toString();
    print('Called: $methodName');
    return null;
  }
}

void main() {
  dynamic obj = Flexible();
  obj.anyMethod();      // Appelé : Symbol("anyMethod")
  obj.anotherOne(42);   // Appelé : Symbol("anotherOne")
}

L'objet Invocation fournit des informations utiles sur l'appel - memberName vous donne le nom de la méthode sous forme de Symbol, positionalArguments contient les arguments transmis, et isMethod vous indique s'il s'agissait d'un appel de méthode par opposition à un getter ou un setter.

class Logger {
  @override
  dynamic noSuchMethod(Invocation invocation) {
    print('Method: ${invocation.memberName}');
    print('Args: ${invocation.positionalArguments}');
    return 'handled';
  }
}

void main() {
  dynamic log = Logger();
  var result = log.save('data', 123);
  print(result);  // handled
}

Cette technique est utile pour créer des objets proxy, des classes fictives (mock) pour les tests, ou pour construire des API flexibles qui répondent à des appels de méthodes arbitraires. Cependant, utilisez-la avec parcimonie car elle contourne la vérification des types à la compilation.

Défi

Facile

Construisons un enregistreur de méthodes qui intercepte et enregistre tous les appels de méthodes effectués sur un objet ! Vous allez créer une classe qui utilise noSuchMethod() pour capturer des informations sur les appels de méthodes non définies et répondre intelligemment en fonction du nom de la méthode.

Vous organiserez votre code en deux fichiers :

method_logger.dart : Créez une classe MethodLogger qui intercepte les appels aux méthodes non définies. Votre enregistreur doit surcharger noSuchMethod() pour :
- Extraire le nom de la méthode à partir de l'invocation (ce sera un Symbol comme Symbol("methodName") - vous devrez le convertir en chaîne de caractères et extraire juste le nom)
- Afficher le nom de la méthode et tous les arguments positionnels dans ce format : Called: [methodName] with args: [arguments]
- Retourner une réponse spéciale basée sur le nom de la méthode :
  - Si le nom de la méthode contient get, retournez la chaîne 'data retrieved'
  - Si le nom de la méthode contient save, retournez la chaîne 'data saved'
  - Sinon, retournez la chaîne 'unknown action'
main.dart : Importez votre enregistreur et démontrez comment il gère divers appels de méthodes non définies. N'oubliez pas d'utiliser le typage dynamic pour que Dart autorise l'appel de méthodes qui n'existent pas :
- Créez une instance de MethodLogger en utilisant une variable dynamique
- Appelez getUserData('Alice', 42) sur celle-ci et affichez le résultat retourné
- Appelez saveRecord('important') sur celle-ci et affichez le résultat retourné
- Appelez processItem() sur celle-ci (sans arguments) et affichez le résultat retourné

Pour extraire le nom de la méthode d'un Symbol, vous pouvez le convertir en chaîne de caractères, puis extraire le nom entre les guillemets. Par exemple, Symbol("myMethod").toString() vous donne 'Symbol("myMethod")'.

Sortie attendue :

Called: getUserData with args: [Alice, 42]
data retrieved
Called: saveRecord with args: [important]
data saved
Called: processItem with args: []
unknown action

Aide-mémoire

La méthode noSuchMethod() vous permet d'intercepter les appels à des méthodes qui n'existent pas sur un objet. Pour l'utiliser, votre classe doit utiliser le typage dynamic ou implémenter une interface.

Surchargez noSuchMethod() pour gérer les appels de méthodes non définies :

class Flexible {
  @override
  dynamic noSuchMethod(Invocation invocation) {
    var methodName = invocation.memberName.toString();
    print('Called: $methodName');
    return null;
  }
}

void main() {
  dynamic obj = Flexible();
  obj.anyMethod();      // Called: Symbol("anyMethod")
  obj.anotherOne(42);   // Called: Symbol("anotherOne")
}

L'objet Invocation fournit des informations sur l'appel :

memberName - le nom de la méthode sous forme de Symbol
positionalArguments - les arguments passés à la méthode
isMethod - indique s'il s'agissait d'un appel de méthode par opposition à un getter ou un setter

class Logger {
  @override
  dynamic noSuchMethod(Invocation invocation) {
    print('Method: ${invocation.memberName}');
    print('Args: ${invocation.positionalArguments}');
    return 'handled';
  }
}

void main() {
  dynamic log = Logger();
  var result = log.save('data', 123);
  print(result);  // handled
}

Cette technique est utile pour créer des objets proxy, des classes fictives (mocks) pour les tests ou des API flexibles, mais elle doit être utilisée avec parcimonie car elle contourne la vérification de type à la compilation.

Essayez vous-même

import 'method_logger.dart';

void main() {
  // TODO: Créer une instance de MethodLogger en utilisant le typage dynamique
  // L'utilisation de dynamic permet d'appeler des méthodes qui n'existent pas au moment de la compilation
  dynamic logger;
  
  // TODO: Appeler getUserData('Alice', 42) et afficher le résultat
  
  // TODO: Appeler saveRecord('important') et afficher le résultat
  
  // TODO: Appeler processItem() sans argument et afficher le résultat
  
}