【Flutter】Widget 转 Image

【环境】Flutter (Channel stable, 1.22.2, on Mac OS X 10.15.7 19H2, locale zh-Hans-CN)

不知道各位小伙伴有没有遇到过需要将 Widget 转成图片保存下来的需求,今天就来介绍一下这个功能具体是怎么实现的。
大家都知道,写一个新的 Widget 需要继承 StatelessWidget 或者 StatefulWidget 类,然后需要重写 build 方法,build 方法会传入 BuildContext 对象,从字面意思可以判断出,这个应该是与 Widget 的显示有关的东西,进入到源码中看一下

abstract class BuildContext

这是一个抽象类,通过查看源码,可以找到这个东西


截屏2020-11-05 上午10.28.45.png

RenderObject,应该就是和渲染相关的东西了,阅读说明,第二段很重要,大意是,在 build 过程完成后,才可以获取到这个renderObject,后面将要用到的。

关键方法
  Future<Uint8List> widgetToImage(Widget widget) async {
    GlobalKey key = GlobalKey(); // 1.通过 key 来获取 BuildContext 从而获取 RenderObject
    Completer completer = Completer<Uint8List>(); // 2.因为要等待回调之后才能返回,所以需要使用到 Completer

    setState(() {
      widgetToConvert = RepaintBoundary(key: key, child: widget); // 3.将需要转换为图片的 widget 显示出来,才能获取到 BuildContext
    });

    WidgetsBinding.instance.addPostFrameCallback((timeStamp) async {
      // 4.此时如果立刻执行下面的代码,是获取不到 BuildContext,因为 widget 还没有完成绘制
      // 所以需要等待这一帧绘制完成后,才能开始转换图片
      if (key.currentContext?.findRenderObject() != null) {
        RenderRepaintBoundary render = key.currentContext.findRenderObject();
        ui.Image image = await render.toImage();
        ByteData byteData = await image.toByteData(format: ui.ImageByteFormat.png);
        completer.complete(byteData.buffer.asUint8List());
      }

      setState(() {
        widgetToConvert = null; // 5.图片已经绘制完成,不需要显示该 widget 了
      });
    });

    // 6.返回数据,使用 Completer 可以实现返回和回调数据相关的 Future
    return completer.future;
  }

Page 的 build 方法需要处理一下,因为只有将 widget 显示出来,才能转换为图片

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Stack(
        children: [
          child ?? Container(),
          Positioned.fill(
            child: yourPage(),
          ),
        ],
      ),
    );
  }

至此已经完成了基本转换功能了
但是,如果 Widget 里面包含了图片,会发现图片在第一次转换的时候,图片显示不出来的。
这个是因为,widget 的绘制和图片的绘制不是同步的。所以当 widget 绘制完成时,图片并没有加载完毕所以不显示。第二次因为图片已经缓存,所以转换成图片是正常的。
所以如果包含了图片,需要先将图片手动缓存,以 AssetImage 为例子,代码如下

AssetImage provider = AssetImage('assets/images/1.png');
await precacheImage(provider, context);

完整代码地址
https://github.com/huangrrui/Widget-to-Image

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