tree: 721efb5d03a8addb99640844d3c5460abcb621ac [path history] [tgz]
  1. bin/
  2. ci/
  3. doc/
  4. example/
  5. lib/
  6. mock_handler_tester/
  7. pigeons/
  8. platform_tests/
  9. test/
  10. tool/
  11. .gitignore
  12. AUTHORS
  13. CHANGELOG.md
  14. CONTRIBUTING.md
  15. copyright_header.txt
  16. diff_tool.sh
  17. LICENSE
  18. pubspec.yaml
  19. README.md
packages/pigeon/README.md

Pigeon

Pigeon is a code generator tool to make communication between Flutter and the host platform type-safe, easier and faster.

Supported Platforms

Currently Pigeon supports generating:

  • Kotlin and Java code for Android,
  • Swift and Objective-C code for iOS
  • Swift code for macOS
  • C++ code for Windows

Runtime Requirements

Pigeon generates all the code that is needed to communicate between Flutter and the host platform, there is no extra runtime requirement. A plugin author doesn't need to worry about conflicting versions of Pigeon.

Usage

  1. Add Pigeon as a dev_dependency.
  2. Make a “.dart” file outside of your “lib” directory for defining the communication interface.
  3. Run pigeon on your “.dart” file to generate the required Dart and host-language code: flutter pub get then flutter pub run pigeon with suitable arguments (see example).
  4. Add the generated Dart code to ./lib for compilation.
  5. Implement the host-language code and add it to your build (see below).
  6. Call the generated Dart methods.

Flutter calling into iOS steps

  1. Add the generated Objective-C or Swift code to your Xcode project for compilation (e.g. ios/Runner.xcworkspace or .podspec).
  2. Implement the generated protocol for handling the calls on iOS, set it up as the handler for the messages.

Flutter calling into Android Steps

  1. Add the generated Java or Kotlin code to your ./android/app/src/main/java directory for compilation.
  2. Implement the generated Java or Kotlin interface for handling the calls on Android, set it up as the handler for the messages.

Flutter calling into Windows Steps

  1. Add the generated C++ code to your ./windows directory for compilation, and to your windows/CMakeLists.txt file.
  2. Implement the generated C++ abstract class for handling the calls on Windows, set it up as the handler for the messages.

Flutter calling into macOS steps

  1. Add the generated Objective-C or Swift code to your Xcode project for compilation (e.g. macos/Runner.xcworkspace or .podspec).
  2. Implement the generated protocol for handling the calls on macOS, set it up as the handler for the messages.

Calling into Flutter from the host platform

Flutter also supports calling in the opposite direction. The steps are similar but reversed. For more information look at the annotation @FlutterApi() which denotes APIs that live in Flutter but are invoked from the host platform.

Rules for defining your communication interface

  1. The file should contain no method or function definitions, only declarations.
  2. Custom classes used by APIs are defined as classes with fields of the supported datatypes (see the supported Datatypes section).
  3. APIs should be defined as an abstract class with either HostApi() or FlutterApi() as metadata. The former being for procedures that are defined on the host platform and the latter for procedures that are defined in Dart.
  4. Method declarations on the API classes should have arguments and a return value whose types are defined in the file, are supported datatypes, or are void.
  5. Generics are supported, but can currently only be used with nullable types (example: List<int?>).

Supported Datatypes

Pigeon uses the StandardMessageCodec so it supports any datatype Platform Channels supports [documentation]. Nested datatypes are supported, too.

Features

Asynchronous Handlers

By default Pigeon will generate synchronous handlers for messages and asynchronous methods. If you want a handler to be able to respond to a message asynchronously you can use the @async annotation as of version 0.1.20.

Example:

class Value {
  int? number;
}

@HostApi()
abstract class Api2Host {
  @async
  Value calculate(Value value);
}

Generates:

// Objective-C
@protocol Api2Host
-(void)calculate:(nullable Value *)input
      completion:(void(^)(Value *_Nullable, FlutterError *_Nullable))completion;
@end
// Swift

/** Generated interface from Pigeon that represents a handler of messages from Flutter.*/
protocol Api2Host {
  func calculate(value: Value, completion: @escaping (Value) -> Void)
}
// Java
public interface Result<T> {
   void success(T result);
}

/** Generated interface from Pigeon that represents a handler of messages from Flutter.*/
public interface Api2Host {
   void calculate(Value arg, Result<Value> result);
}
// Kotlin

/** Generated interface from Pigeon that represents a handler of messages from Flutter.*/
interface Api2Host {
   fun calculate(value: Value, callback: (Result<Value>) -> Unit)
}
// C++

/** Generated class from Pigeon that represents a handler of messages from Flutter.*/
class Api2Host {
public:
    virtual void calculate(Value value, flutter::MessageReply<Value> result) = 0;
}

Null Safety (NNBD)

Pigeon supports generating null-safe code, but it doesn't yet support:

  1. Nullable generics type arguments
  2. Nullable enum arguments to methods

Enums

Pigeon supports enum generation in class fields. For example:

enum State {
  pending,
  success,
  error,
}

class StateResult {
  String? errorMessage;
  State? state;
}

@HostApi()
abstract class Api {
  StateResult queryState();
}

Primitive Data-types

Prior to version 1.0 all arguments to API methods had to be wrapped in a class, now they can be used directly. For example:

@HostApi()
abstract class Api {
   Map<String?, int?> makeMap(List<String?> keys, List<String?> values);
}

TaskQueues

When targeting a Flutter version that supports the TaskQueue API the threading model for handling HostApi methods can be selected with the TaskQueue annotation:

@HostApi()
abstract class Api2Host {
  @TaskQueue(type: TaskQueueType.serialBackgroundThread)
  int add(int x, int y);
}

Error Handling

Kotlin, Java and Swift

All Host API exceptions are translated into Flutter PlatformException.

  • For synchronous methods, thrown exceptions will be caught and translated.
  • For asynchronous methods, there is no default exception handling; errors should be returned via the provided callback.

To pass custom details into PlatformException for error handling, use FlutterError in your Host API. For example:

// Kotlin
class MyApi : GeneratedApi {
  // For synchronous methods
  override fun doSomething() {
    throw FlutterError('error_code', 'message', 'details')
  }

  // For async methods
  override fun doSomethingAsync(callback: (Result<Unit>) -> Unit) {
    callback(Result.failure(FlutterError('error_code', 'message', 'details'))
  }
}

Objective-C and C++

Likewise, Host API errors can be sent using the provided FlutterError class (translated into PlatformException).

For synchronous methods:

  • Objective-C - Assign the error argument to a FlutterError reference.
  • C++ - Return a FlutterError directly (for void methods) or within an ErrorOr instance.

For async methods:

  • Both - Return a FlutterError through the provided callback.

Handling the errors

Then you can implement error handling on the Flutter side:

// Dart
void doSomething() {
  try {
    myApi.doSomething()
  } catch (PlatformException e) {
    if (e.code == 'error_code') {
      // Perform custom error handling
      assert(e.message == 'message')
      assert(e.details == 'details')
    }
  }
}

Feedback

File an issue in flutter/flutter with the word “pigeon” in the title.