Flutter中安全获取Activity上下文的方法

本文旨在解决Flutter插件开发中，因`Activity`上下文获取不当导致的`BadTokenException`及`getActivity()`返回`null`的问题。我们将深入探讨`ActivityAware`接口的生命周期管理，并提出一种基于`WeakReference`的健壮解决方案，以确保在需要时能安全、有效地访问`Activity`上下文，同时避免潜在的内存泄漏。

Flutter插件中Activity上下文管理挑战

在Flutter插件开发中，当我们需要执行一些依赖于Android Activity上下文的操作时，例如显示AlertDialog、启动新的Activity或访问某些UI相关的系统服务，直接获取Activity上下文是必不可少的。然而，常见的错误做法是直接存储Activity对象的强引用，或者在Activity生命周期结束后尝试访问它，这通常会导致以下问题：

1. android.view.WindowManager$BadTokenException: Unable to add window -- token null is not valid; is your activity running?: 当尝试在无效或已销毁的Activity上下文中创建UI元素（如AlertDialog）时，系统会抛出此异常。这通常意味着你持有的Activity引用已经失效。
2. getActivity()返回null: 即使插件实现了ActivityAware接口，并在onAttachedToActivity中获取了ActivityPluginBinding，但如果后续在不恰当的时机调用getActivity()，仍可能返回null。这通常发生在Activity被销毁或重建（如配置变更）而插件没有正确更新其引用时。

这些问题根源于Android Activity的生命周期特性。Activity可以被销毁和重建，而插件可能在更长的生命周期中运行。直接持有Activity的强引用不仅可能导致null引用问题，更严重的是会造成内存泄漏，因为插件会阻止Activity被垃圾回收。

解决方案：使用WeakReference安全管理上下文

为了解决上述问题，推荐使用WeakReference（弱引用）来持有Activity和Application上下文。WeakReference是一种特殊的引用类型，它不会阻止垃圾回收器回收其引用的对象。当一个对象只被WeakReference引用时，它可以在任何时候被垃圾回收器回收。这使得WeakReference成为管理生命周期不确定对象的理想选择，尤其适用于Android组件，如Activity和Context。

核心优势

• 避免内存泄漏: WeakReference不会阻止被引用对象的垃圾回收，从而有效防止因插件持有Activity强引用而导致的内存泄漏。
• 生命周期感知: 结合ActivityAware接口，可以在Activity附加和分离时更新WeakReference，确保引用始终指向当前有效的Activity。
• 健壮性: 在访问上下文时，通过WeakReference.get()方法进行判空，可以安全地处理Activity可能已被回收的情况。

实现步骤

以下是一个完整的Flutter插件实现，演示了如何使用WeakReference安全地管理Application上下文和Activity上下文。

1. 声明弱引用字段: 在插件类中，声明WeakReference类型的字段来持有Context和Activity。

   import android.app.Activity;
   import android.content.Context;
   import androidx.annotation.NonNull;
   import io.flutter.embedding.engine.plugins.FlutterPlugin;
   import io.flutter.embedding.engine.plugins.activity.ActivityAware;
   import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
   import io.flutter.plugin.common.MethodCall;
   import io.flutter.plugin.common.MethodChannel;
   import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
   import io.flutter.plugin.common.MethodChannel.Result;
   
   import java.lang.ref.WeakReference;
   
   public class MyPlugin implements FlutterPlugin, MethodCallHandler, ActivityAware {
   
     private MethodChannel channel;
     private WeakReference weakApplicationContext;
     private WeakReference weakActivity;
   
     @Override
     public void onAttachedToEngine(@NonNull FlutterPluginBinding flutterPluginBinding) {
       channel = new MethodChannel(flutterPluginBinding.getBinaryMessenger(), "my_plugin");
       channel.setMethodCallHandler(this);
       // 存储Application Context的弱引用
       weakApplicationContext = new WeakReference<>(flutterPluginBinding.getApplicationContext());
     }
   
     @Override
     public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
       // ... 处理方法调用 ...
     }
   
     @Override
     public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
       channel.setMethodCallHandler(null);
       channel = null;
       weakApplicationContext.clear(); // 清除弱引用
       weakApplicationContext = null;
     }
   
     @Override
     public void onAttachedToActivity(@NonNull ActivityPluginBinding binding) {
       // 存储Activity的弱引用
       weakActivity = new WeakReference<>(binding.getActivity());
     }
   
     @Override
     public void onDetachedFromActivityForConfigChanges() {
       weakActivity.clear(); // 配置变更时清除旧的Activity引用
       weakActivity = null;
     }
   
     @Override
     public void onReattachedToActivityForConfigChanges(@NonNull ActivityPluginBinding binding) {
       // 重新附加到新的Activity时更新引用
       weakActivity = new WeakReference<>(binding.getActivity());
     }
   
     @Override
     public void onDetachedFromActivity() {
       weakActivity.clear(); // Activity被完全销毁时清除引用
       weakActivity = null;
     }
   
     /**
      * 获取当前的Application Context。
      * @return 如果可用，返回Application Context，否则返回null。
      */
     public Context getApplicationContext() {
       return (weakApplicationContext != null) ? weakApplicationContext.get() : null;
     }
   
     /**
      * 获取当前的Activity实例。
      * @return 如果可用，返回Activity实例，否则返回null。
      */
     public Activity getActivity() {
       return (weakActivity != null) ? weakActivity.get() : null;
     }
   
     // 示例：在Activity上下文中使用AlertDialog
     public void showExampleAlertDialog(String title, String message) {
       Activity currentActivity = getActivity();
       if (currentActivity != null) {
         currentActivity.runOnUiThread(() -> {
           new android.app.AlertDialog.Builder(currentActivity)
                   .setTitle(title)
                   .setMessage(message)
                   .setPositiveButton("OK", (dialog, which) -> dialog.dismiss())
                   .show();
         });
       } else {
         System.err.println("Error: Activity is not available to show AlertDialog.");
       }
     }
   }

注意事项和最佳实践

1. 始终进行null检查: 在通过weakReference.get()获取对象时，务必检查返回结果是否为null。因为弱引用所指向的对象可能已被垃圾回收。

   Activity currentActivity = getActivity();
   if (currentActivity != null) {
       // 安全地使用Activity
   } else {
       // 处理Activity不可用的情况
   }

2. 生命周期管理:

   • 在onAttachedToActivity和onReattachedToActivityForConfigChanges中更新weakActivity。
   • 在onDetachedFromActivityForConfigChanges和onDetachedFromActivity中清除（clear()）并置null weakActivity。这有助于及时释放资源，并避免持有过期的Activity引用。
   • 对于ApplicationContext，虽然其生命周期通常与应用进程相同，但使用WeakReference仍是良好的实践，并在onDetachedFromEngine时清除。

3. 区分Application Context和Activity Context:

   • Application Context: 适用于不涉及UI的全局操作，如访问文件系统、数据库、全局服务等。它的生命周期与整个应用程序进程绑定。
   • Activity Context: 必须用于与UI相关的操作，如显示AlertDialog、启动其他Activity、访问布局或视图。它的生命周期与特定的Activity实例绑定。
   • 混淆使用会导致BadTokenException（用Application Context显示AlertDialog）或其他UI相关错误。

4. UI操作在主线程: 任何涉及更新UI的操作都必须在Android的主线程（UI线程）上执行。在插件中，可以通过Activity.runOnUiThread()方法来实现。

   currentActivity.runOnUiThread(() -> {
       // 在这里执行UI操作
   });

总结

通过采用WeakReference来管理Flutter插件中的Activity和Application上下文，我们能够有效地解决getActivity()返回null和BadTokenException等常见问题，同时避免了内存泄漏。这种方法使得插件能够更健壮地与Android原生UI和系统服务交互，确保了应用的稳定性和性能。遵循上述指南和最佳实践，可以显著提升Flutter插件的开发质量和用户体验。