# Understanding Reflection and Annotations in Dart

In this tutorial we will explore the topic of Reflection and how that can be used to write cleaner software. Reflection allows us to examine and modify the structure and behaviour of a program at runtime. We will be working with the **dart:mirrors** library which contains helper classes and functions for achieving this. We will end by looking at a common use case with **Annotations**.

## Full video tutorial

%[https://youtu.be/_2yjPLVEGs4] 

## **Basic example with Reflection**

Create a `main.dart` file and start by importing our **dart:mirrors** dependency. Before we implement our reflection logic, let’s also define a class with a method we wish to invoke:

```dart
import 'dart:mirrors';

main() {
  // TODO: Implement Reflection logic
}

// Our example class to reflect on
class Endpoint {
  handle() => print('Request received');
}
```

To reflect on types and objects we have three methods to work with:

1. `reflect()`: Reflects on an instance of a class
    
2. `reflectClass()`: Reflects on a class declaration
    
3. `reflectType()` Reflects on the type passed in as the argument
    

In our use case we will use `reflect()`. Let’s instantiate `Endpoint` and invoke the handle method via reflection:

```dart
main() {
  var reflectedClass = reflect(Endpoint());

  // Invoke the handle() method
  reflectedClass.invoke(Symbol('handle'), []);
}
```

And then let’s run this file:

```bash
$ dart /path/to/main.dart
```

Reflecting an instance provides us with an `InstanceMirror` that exposes the `invoke()` method. The members of our instance are depicted as `Symbol` types. The example above invokes the handle method by passing its `Symbol`ic name along with an array of positional arguments if any are specified.

To pass arguments across, let’s modify the signature of the `handle()` method:

```dart
handle(String a) => print('Request received $a');
```

And pass this to the invocation:

```dart
reflectedClass.invoke(Symbol('handle'), ['argument 1']);
// => Request received argument 1
```

You can also use the literal form of the `handle()` symbol:

```dart
reflectedClass.invoke(#handle, ['argument 1']);
```

You can use the `Symbol('methodName')` approach if the method name is received as a value from an operation or provided as user input. Ideally when you **don’t** know beforehand the method to invoke.

[Watch full video tutorial](https://youtu.be/_2yjPLVEGs4)

[Get the source code](https://gist.github.com/graphicbeacon/9fb6c6a951168d6a31d9b2cc442bcbe2)

## **Further reading**

* [**dart:mirrors** library documentation](https://api.dart.dev/stable/2.4.0/dart-mirrors/dart-mirrors-library.html)
    
* [Dart and MongoDB Tutorial #1: Using the mongo\_dart package](https://creativebracket.com/dart-and-mongodb-tutorial-1/)