插件开发:Android端API实现

本节我们接着上一节”获取电池电量”插件的示例,来完成Android端API的实现。以下步骤是使用Java的示例,如果您更喜欢Kotlin,可以直接跳到后面Kotlin部分。

首先在Android Studio中打开您的Flutter应用的Android部分:

  1. 启动 Android Studio
  2. 选择 File > Open…
  3. 定位到您 Flutter app目录, 然后选择里面的 android文件夹,点击 OK
  4. java目录下打开 MainActivity.java

接下来,在onCreate里创建MethodChannel并设置一个MethodCallHandler。确保使用与在Flutter客户端使用的通道名称相同。

  1. import io.flutter.app.FlutterActivity;
  2. import io.flutter.plugin.common.MethodCall;
  3. import io.flutter.plugin.common.MethodChannel;
  4. import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
  5. import io.flutter.plugin.common.MethodChannel.Result;
  6. public class MainActivity extends FlutterActivity {
  7. private static final String CHANNEL = "samples.flutter.io/battery";
  8. @Override
  9. public void onCreate(Bundle savedInstanceState) {
  10. super.onCreate(savedInstanceState);
  11. new MethodChannel(getFlutterView(), CHANNEL).setMethodCallHandler(
  12. new MethodCallHandler() {
  13. @Override
  14. public void onMethodCall(MethodCall call, Result result) {
  15. // TODO
  16. }
  17. });
  18. }
  19. }

接下来,我们添加Java代码,使用Android电池API来获取电池电量。此代码和在原生Android应用中编写的代码完全相同。

首先,添加需要导入的依赖。

  1. import android.content.ContextWrapper;
  2. import android.content.Intent;
  3. import android.content.IntentFilter;
  4. import android.os.BatteryManager;
  5. import android.os.Build.VERSION;
  6. import android.os.Build.VERSION_CODES;
  7. import android.os.Bundle;

然后,将下面的新方法添加到activity类中的,位于onCreate 方法下方:

  1. private int getBatteryLevel() {
  2. int batteryLevel = -1;
  3. if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
  4. BatteryManager batteryManager = (BatteryManager) getSystemService(BATTERY_SERVICE);
  5. batteryLevel = batteryManager.getIntProperty(BatteryManager.BATTERY_PROPERTY_CAPACITY);
  6. } else {
  7. Intent intent = new ContextWrapper(getApplicationContext()).
  8. registerReceiver(null, new IntentFilter(Intent.ACTION_BATTERY_CHANGED));
  9. batteryLevel = (intent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1) * 100) /
  10. intent.getIntExtra(BatteryManager.EXTRA_SCALE, -1);
  11. }
  12. return batteryLevel;
  13. }

最后,我们完成之前添加的onMethodCall方法。我们需要处理平台方法名为getBatteryLevel的调用消息,所以我们需要先在call参数判断调用的方法是否为getBatteryLevel。 这个平台方法的实现只需调用我们在前一步中编写的Android代码,并通过result参数返回成功或错误情况的响应信息。如果调用了未定义的API,我们也会通知返回:

  1. @Override
  2. public void onMethodCall(MethodCall call, Result result) {
  3. if (call.method.equals("getBatteryLevel")) {
  4. int batteryLevel = getBatteryLevel();
  5. if (batteryLevel != -1) {
  6. result.success(batteryLevel);
  7. } else {
  8. result.error("UNAVAILABLE", "Battery level not available.", null);
  9. }
  10. } else {
  11. result.notImplemented();
  12. }
  13. }

现在就可以在Android上运行该应用程序了,如果使用的是Android模拟器,则可以通过工具栏中的”…”按钮访问Extended Controls面板中的电池电量。

使用Kotlin添加Android平台特定的实现

使用Kotlin和使用Java的步骤类似,首先在Android Studio中打开您的Flutter应用的Android部分:

  1. 启动 Android Studio。
  2. 选择 the menu item “File > Open…”。
  3. 定位到 Flutter app目录, 然后选择里面的 android文件夹,点击 OK。
  4. kotlin目录中打开MainActivity.kt

接下来,在onCreate里创建MethodChannel并设置一个MethodCallHandler。确保使用与在Flutter客户端使用的通道名称相同。

  1. import android.os.Bundle
  2. import io.flutter.app.FlutterActivity
  3. import io.flutter.plugin.common.MethodChannel
  4. import io.flutter.plugins.GeneratedPluginRegistrant
  5. class MainActivity() : FlutterActivity() {
  6. private val CHANNEL = "samples.flutter.io/battery"
  7. override fun onCreate(savedInstanceState: Bundle?) {
  8. super.onCreate(savedInstanceState)
  9. GeneratedPluginRegistrant.registerWith(this)
  10. MethodChannel(flutterView, CHANNEL).setMethodCallHandler { call, result ->
  11. // TODO
  12. }
  13. }
  14. }

接下来,我们添加Kotlin代码,使用Android电池API来获取电池电量,这和原生开发是一样的。

首先,添加需要导入的依赖。

  1. import android.content.Context
  2. import android.content.ContextWrapper
  3. import android.content.Intent
  4. import android.content.IntentFilter
  5. import android.os.BatteryManager
  6. import android.os.Build.VERSION
  7. import android.os.Build.VERSION_CODES

然后,将下面的新方法添加到activity类中的,位于onCreate 方法下方:

  1. private fun getBatteryLevel(): Int {
  2. val batteryLevel: Int
  3. if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
  4. val batteryManager = getSystemService(Context.BATTERY_SERVICE) as BatteryManager
  5. batteryLevel = batteryManager.getIntProperty(BatteryManager.BATTERY_PROPERTY_CAPACITY)
  6. } else {
  7. val intent = ContextWrapper(applicationContext).registerReceiver(null, IntentFilter(Intent.ACTION_BATTERY_CHANGED))
  8. batteryLevel = intent!!.getIntExtra(BatteryManager.EXTRA_LEVEL, -1) * 100 / intent.getIntExtra(BatteryManager.EXTRA_SCALE, -1)
  9. }
  10. return batteryLevel
  11. }

最后,我们完成之前添加的onMethodCall方法。我们需要处理平台方法名为getBatteryLevel的调用消息,所以我们需要先在call参数判断调用的方法是否为getBatteryLevel。 这个平台方法的实现只需调用我们在前一步中编写的Android代码,并通过result参数返回成功或错误情况的响应信息。如果调用了未定义的API,我们也会通知返回:

  1. MethodChannel(flutterView, CHANNEL).setMethodCallHandler { call, result ->
  2. if (call.method == "getBatteryLevel") {
  3. val batteryLevel = getBatteryLevel()
  4. if (batteryLevel != -1) {
  5. result.success(batteryLevel)
  6. } else {
  7. result.error("UNAVAILABLE", "Battery level not available.", null)
  8. }
  9. } else {
  10. result.notImplemented()
  11. }
  12. }

您现就可以在Android上运行该应用程序。如果您使用的是Android模拟器,则可以通过工具栏中的”…”按钮访问Extended Controls面板中的电池电量。