Add Flutter functionality as a dependency in android library

Question

Why do I need this?

I'm creating a Flutter package (for android) and I want to create the MethodCallHandler's code in a separate AAR file that can be added in my plugin's code

So I'll have:

pluginNativeCode/android/MyPlugin.kt

import ir.malv.android.flutter.MySeparateMethodCallHandler

class MyFlutterPlugin: FlutterPlugin {
   override fun onAttachedToEngine(...) {
      // Here's the source of the problem
      channel.setMethodCallHandler(MySeparateMethodCallHandler()) 
   }
}

The MySeparateMethodCallHandler is not in the plugin/android part and it's imported as a gradle dependency

However in that library I don't have access to flutter's codes like MethodCallHandler class.

Similar behaviour in unity and react native

In react-native there is com.facebook.react:react-native:+ that can be added as compileOnly to get the needed react-native codes

In unity we have unity.jar file which contains unity native codes and can be added as compileOnly as well to provide engine's native APIs

What do we have in Flutter for this?

Is there a dependency that I can include as compileOnly and use it to get the needed classes and create my aar file in a separate project?

Mahdi-Malv · Accepted Answer · 2021-06-16 11:33:08Z

3

Here's a solution:

Add this remote to repositories of build.gradle

allprojects {
  repositories {
    // .. rest of remote urls

    maven { url("http://download.flutter.io/")}
  }
}

Add this dependency to module's build.gradle

dependencies {
  
  compileOnly("io.flutter:flutter_embedding_debug:1.0.0-0fdb562ac8068ce3dda6b69aca3f355f4d1d2718")

  // rest
}

Notice the compileOnly. This will avoid the class duplication. Plugin just requires it. The flutter app will provide it itself.

What is 0fdb562ac8068ce3dda6b69aca3f355f4d1d2718?
It's the engine version that is good to match the version you are developing the plugin with.

in your code you will have access to needed classes such as MethodChannel, MethodChannel.Result and ...

Bonus: How do I know what engine I'm making the plugin with?

I think it should not matter if you just need a class like MethodChannel to invoke a method, but here's a way to get it using Android Studio

Open the project/example/android of your plugin using Android studio (that has Flutter plugin activated)
run gradle plugin_name:dependencies task and look for flutter_embedding_ phrase.

answered Jun 16, 2021 at 11:33

Mahdi-Malv

19.6k16 gold badges83 silver badges129 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

sunderee Over a year ago

Gosh, thank you so much for that one. Just one more addition: remember to set allowInsecureProtocol = true if Gradle complains that it doesn't allow HTTP over HTTPS.

Mahdi-Malv Over a year ago

@sunderee Good point. Feel free to edit the answer

Rahul Kushwaha Over a year ago

@Mahdi-Malv I want to integrate flutter package into native android project . How can i do that?

parkgrrr · Accepted Answer · 2024-11-15 19:25:03Z

0

I do not recommend the accepted answer, as it caused io.flutter.BuildConfig.DEBUG to return as "true" in a release build of my Flutter app. If you go that route, consider at least using debugCompileOnly.

The Flutter recommended way of handling this, is to have the example project setup inside of the plugin, and building the example project first.

Flutter recommendation here.

answered Nov 15, 2024 at 19:25

parkgrrr

7487 silver badges12 bronze badges

Collectives™ on Stack Overflow

Add Flutter functionality as a dependency in android library

Why do I need this?

Similar behaviour in unity and react native

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Why do I need this?

Similar behaviour in unity and react native

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related