Flutter 解决Navigator跳转导致Rebuild的一种方案

Flutter开发者都知道,页面每次push和pop 时都会build当前页,滑动位置等数据因此被销毁,这或许是Flutter团队的一种调优策略,但在实际业务中反而造成了一些困扰,github关于此问题也争论了很久,相关issue,个人认为rebuild问题还是需要解决下的(或许是没有完全适应Flutter的UI模式,至少目前需要解决)

/// !解决rebuild问题 !
///
/// 相关issue:https://github.com/flutter/flutter/issues/11655?tdsourcetag=s_pcqq_aiomsg
///
/// 所有State类请继承[XCState],勿继承[State]
///
/// 所有State类请重写[XCState.shouldBuild],勿重写[State.build];
///
/// 刷新请使用[XCState.reload],勿使用[State.setState]

源码

XCShouldBuild.dart

import 'package:flutter/widgets.dart';

typedef XCShouldBuildFunction<T> = bool Function(
    T oldSubstance, T newSubstance);

class XCShouldBuild<T> extends StatefulWidget {
  final T substance; // substance
  final XCShouldBuildFunction<T> shouldBuildFunction;
  final WidgetBuilder builder;
  XCShouldBuild(
      {this.substance, this.shouldBuildFunction, @required this.builder})
      : assert(() {
          if (builder == null) {
            throw FlutterError.fromParts(<DiagnosticsNode>[
              ErrorSummary('error in XCShouldBuild: builder must exist')
            ]);
          }
          return true;
        }());
  @override
  _XCShouldBuildState createState() => _XCShouldBuildState<T>();
}

class _XCShouldBuildState<T> extends State<XCShouldBuild> {
  Widget oldWidget;
  T oldSubstance;

  bool _isInit = true;

  @override
  Widget build(BuildContext context) {
    final newSubstance = widget.substance;

    if (_isInit ||
        (widget.shouldBuildFunction == null
            ? true
            : widget.shouldBuildFunction(oldSubstance, newSubstance))) {
      _isInit = false;
      oldSubstance = newSubstance;
      oldWidget = widget.builder(context);
    }
    return oldWidget;
  }

  @override
  void dispose() {
    super.dispose();
    debugPrint("_XCShouldBuildState dispose");
  }
}

XCState.dart

import 'package:flutter/widgets.dart';
import 'XCShouldBuild.dart';

/// ## Sumarry

/// - this is a way of resolving the issue of rebuilding stateful widget when a navigator is pushing or popping

/// - associated issue:https://github.com/flutter/flutter/issues/11655?tdsourcetag=s_pcqq_aiomsg

///  ## Usage

/// 1. import XCShouldBuild.dart and XCState.dart

/// 2. make all classes of State inherit from [XCState],do not inherit from [State]

/// 3. override [XCState.shouldBuild],do not override [State.build]

/// 4. use [XCState.reload] to reload,do not use [State.setState] to reload
abstract class XCState<T> extends State {
  bool _isShouldBuild = false;

  @override
  Widget build(BuildContext context) {
    bool willUseSubstance = useSubstance();

    return XCShouldBuild<T>(
        substance: willUseSubstance ? substance() : null,
        shouldBuildFunction: (oldSubstance, newSubstance) {
          bool willReload;
          if (_isShouldBuild) {
            willReload = true;
          } else {
            if (willUseSubstance) {
              willReload = oldSubstance != newSubstance;
            } else {
              willReload = false;
            }
          }
          return willReload;
        },
        builder: (BuildContext context) {
          _isShouldBuild = false;
          return shouldBuild(context);
        });
  }

  Widget shouldBuild(BuildContext context);

  bool useSubstance() => false;

  T substance() => null;

  void reload([VoidCallback fn]) {
    if (!mounted) return;
    setState(() {
      _isShouldBuild = true;
      if (fn != null) {
        fn();
      }
    });
  }

  @override
  void dispose() {
    super.dispose();
    debugPrint("XCState dispose");
  }
}

场景1:

在Push或Pop时不rebuild(默认)


class _XCTestViewState extends XCState {

  @override
  Widget shouldBuild(BuildContext context) {
    return Center(
        child: Text(
            "_XCTestView, if you use `shouldBuild`, it can avoid rebuilding when pushing or popping"));
  }
    
  void aFunc() {
    reload()
  }

}

场景2:

也可以重写参照物方法,决定Push或Pop时是否rebuild

class _XCUseSubstanceTestViewState extends XCState {

  var _aCountAsSubstance = 0;

  @override
  Widget shouldBuild(BuildContext context) {
    return Center(
        child: Text(
            "_XCUseSubstanceTestView, if you use `shouldBuild`, it can avoid rebuilding when pushing or popping, _aCountAsSubstance = $_aCountAsSubstance "));
  }

  /// only effect to pushing or poping, no effect to [XCState.reload]
  @override
  bool useSubstance() {
    return true;
  }

  /// only effect to pushing or poping, no effect to [XCState.reload]
  @override
  substance() {
    return _aCountAsSubstance;
  }

  void aFunc() {
    reload();
  }
}

附GitHubDemo

2021.04.16 updated

Flutter官方已改进了跳转时的rebuild方案:
详情见:
flutter release-notes-1.17.0中的这几个pr489004936649376

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351