iOS Flutter共享FlutterEngine页面切换无法点击的问题

30 0 0

问题描述

在混合开发中，如果使用共享 Flutter 引擎的方式降低内存开销，从原生页面跳转到 Flutter 页面，再从 Flutter 页面跳转到原生页面，然后再跳转到 Flutter 页面，虽然这个流程很奇特，但是这个难免没有这个需求。

假如使用 N 代表原生页面，F 代表 Flutter 页面，流程可以如下表示：

N1 -> F1 -> N2 -> F2

假如从 F2 返回到 N2，然后 N2 返回到 F1，则 F1 就可能出现页面中的按钮无法点击。

问题分析

从查看 FlutterViewController 的源码得知，每一个 FlutterViewController 对象都会持有一个 FlutterEngine 对象(弱应用)，然后 FlutterEngine 对象又会持有一个 FlutterViewController 对象（弱应用），属性名字叫 viewController，当 F2 返回之后，F2 的 FlutterViewController 对象就会销毁，所以共享的 FlutterEngine 中的 viewController 属性就为空，返回到 F1 之后，就会执行 F1 的 viewWillAppear(_:) 方法, 源码如下所示:

- (void)viewWillAppear:(BOOL)animated {
  TRACE_EVENT0("flutter", "viewWillAppear");
  if ([_engine.get() viewController] == self) {
    // Send platform settings to Flutter, e.g., platform brightness.
    [self onUserSettingsChanged:nil];

    // Only recreate surface on subsequent appearances when viewport metrics are known.
    // First time surface creation is done on viewDidLayoutSubviews.
    if (_viewportMetrics.physical_width) {
      [self surfaceUpdated:YES];
    }
    [[_engine.get() lifecycleChannel] sendMessage:@"AppLifecycleState.inactive"];
    [[_engine.get() restorationPlugin] markRestorationComplete];
  }

  [super viewWillAppear:animated];
}

通过源码得知，每一次返回到 FlutterViewController 页面中都会执行一些配置代码，比如生命周期调用等等。所以共享的 FlutterEngine 中的 viewController 为空，就无法执行 viewWillAppear 中的一些方法，就会导致页面无法响应，至于具体为什么无法响应事件，需要仔细查看源码来分析。

如何解决

知道了问题原因，解决办法就很简单了，使用运行时的方法替换，替换掉 FlutterViewController 中的 viewWillAppear 方法，在新方法中对共享引擎的 viewController 属性设置正确的值。

extension FlutterViewController {
    
    /// 初始化
    public class func initialization() {
        // 替换系统的 viewWillAppear(_:) 方法
        exchangeInstanceMethod(#selector(viewWillAppear(_:)), swizzled: #selector(flutter_viewWillAppear(_:)), target: self)
    }
    
    @objc func flutter_viewWillAppear(_ animated: Bool) {
        /// 非常重要: 为当前引擎设置当前视图控制器，否则页面无法响应事件
        /// 场景: 共享 Flutter 引擎情况下，多个 FlutterViewController 跳转，返回到上一个 FlutterViewController
        /// 会出现页面中的按钮无法点击或者无法响应事件
        /// 请阅读 FlutterViewController.mm 源码，找到 - (void)viewWillAppear:(BOOL)animated 方法就一目了然了
        if engine?.viewController == nil {
            engine?.viewController = self
        }
        
        // 调用系统的 viewWillAppear 方法
        flutter_viewWillAppear(animated)
    }
}

上述代码需要在 AppDelegate 中初始化一次

FlutterViewController.initialization()

exchangeInstanceMethod 方法的代码

func exchangeInstanceMethod(_ original: Selector, swizzled: Selector, target: AnyClass) {
    let originalSelector = original
    let swizzledSelector = swizzled

    let originalMethod = class_getInstanceMethod(target, originalSelector)
    let swizzledMethod = class_getInstanceMethod(target, swizzledSelector)

    //在进行 Swizzling 的时候,需要用 class_addMethod 先进行判断一下原有类中是否有要替换方法的实现
    let didAddMethod: Bool = class_addMethod(target, originalSelector, method_getImplementation(swizzledMethod!), method_getTypeEncoding(swizzledMethod!))
    //如果 class_addMethod 返回 yes,说明当前类中没有要替换方法的实现,所以需要在父类中查找,这时候就用到 method_getImplemetation 去获取 class_getInstanceMethod 里面的方法实现,然后再进行 class_replaceMethod 来实现 Swizzing
    if didAddMethod {
        class_replaceMethod(target, swizzledSelector, method_getImplementation(originalMethod!), method_getTypeEncoding(originalMethod!))
    } else {
        method_exchangeImplementations(originalMethod!, swizzledMethod!)
    }
}

通过这样设置，每次返回到 FlutterViewController 之后都会正确设置共享引擎中的 viewController 属性的值，系统就会得到响应。

最后附上 FlutterEngine.mm 和 FlutterViewController.mm 的源码链接

https://api.flutter.dev/ios-embedder/_flutter_engine_8mm_source.html
https://api.flutter.dev/ios-embedder/_flutter_view_controller_8mm_source.html

# 随笔