Dart自定义Handler注解能否接收非静态方法作为参数？

Problem Context #

I've defined a custom annotation in Dart like this:

class Handler {
  final Function onListen;
  final Function onPause;
  final Function onResume;
  final Function onCancel;

  const Handler({this.onListen, this.onPause, this.onResume, this.onCancel});
}

And I'm using it with a static method successfully:

abstract class Test implements ViewModel<TestController> {
  static onListen() {
    print('onListen');
  }

  @Handler(onListen: onListen)
  Stream<String> get messages;

  factory Test() = _$Test;
  Test._();
}

Since using static methods as annotation parameters works, I'm wondering: Is it possible to use non-static (instance) methods as parameters for the Handler annotation?

Answer #

Great question! Let's break this down specifically for Dart:

Short answer: No, you cannot use non-static methods as parameters for a Dart annotation.

Here's the key reasoning:

• Dart enforces that all annotation parameters must be compile-time constants. This means the value has to be resolvable when your code is compiled, not when it runs.
• Static methods are tied directly to the class itself, not any specific instance. They exist at compile time, so they qualify as valid constant values to pass to annotations.
• Non-static (instance) methods, by contrast, only exist once you create an instance of the class at runtime. Since they aren't available during compilation, they can't be passed as annotation parameters—you'd hit a compile error immediately.

If you tried to pass an instance method to your Handler annotation, you'd see an error like:

The argument type 'void Function()' can't be assigned to the parameter type 'void Function()?' because an instance method is not a compile-time constant.

Possible Workarounds #

If you need to connect instance-level behavior to your annotation, here are a couple of approaches to consider:

• Use a string method name as the annotation parameter, then use reflection (via dart:mirrors) at runtime to look up and invoke the instance method. Note that dart:mirrors isn't supported in Flutter or AOT-compiled Dart apps.
• Redesign your annotation system to use runtime-resolved callbacks: for example, have the annotation point to a factory class or provider that returns the instance method when your code runs.

内容的提问来源于stack exchange，提问作者Ralph Bergmann