flutter:打卡 `repaintBoundary`, widget 渲染转图像

背景

最近遇到一个项目中的需求: 接入native三方打印SDK,将flutter绘制的页面进行打印。打印SDK支持打印bitmap图片数据。整体的思路是将flutter页面进行渲染,转换成图片数据,将图片数据通过methodChannel以字节数组的形式传递到原生层进行打印。

下面我们来重点说说视图转图片的部分

RepaintBoundary

  • 防止重绘

在自定义绘制时,我们常常使用 RepaintBoundary 做性能优化,来避免重复绘制。RepaintBoundary 内部的 widget 拥有独立画布,可以不被干扰,官方很多组件外层也包了层 RepaintBoundary。

SingleChildScrollView(
    Column(
        children:[
            WidgetA,
            WidgetB,
            RepaintBoundary( -> 外层嵌套 RepaintBoundary ,当页面进行滚动时,CustomPaint 不会进行重绘。
              child: CustomPaint(),
            ),
        ]
    )
)
  • 生成截图

今天,我们用到 RepaintBoundary 的第二个常用能力:生成截图

final _boundaryKey = GlobalKey();

@override
void initState() {
  super.initState();
  SchedulerBinding.instance?.addPostFrameCallback((_) { -> 监听页面绘制,绘制完成开始生成截图
    _captureWidget();
  });
}

/// 通过 RenderRepaintBoundary 生成图片
void _captureWidget() async {
  final boundary = _boundaryKey.currentContext?.findRenderObject();
  if (boundary != null && boundary is RenderRepaintBoundary) {
    final image = await boundary.toImage();
    ByteData? byteData = await image.toByteData(format: ImageByteFormat.png);
    if (byteData != null) {
      // 图片数据生成成功,用法在下面
    }
  }
}

@override
Widget build(BuildContext context) {
  return SingleChildScrollView( -> 外层嵌套支持滚动,可生成长屏截图
    child: RepaintBoundary(
      key: _boundaryKey,
      child: widgetA, —> widgetA 为截图的视图层
    )
  );
}

方法_captureWidgetByteData 即为生成的图片数据,具体用法如下:

//Unit8List 就是一个 byte[]
Unit8List imageData = byteData.buffer.asUnit8List();
  • 直接展示为 Image
...
child: Image.memory(imageData),
  • 转换为base64
...
String bs64 = base64Encode(imageData);
  • 保存为本地文件file
//tempPath 文件功能可通过官方插件 `path_provider` 来获取,如:
//Directory tempDir = await getTemporaryDirectory()
...
File(tempPath).writeAsBytes(imageData);
附注
  • image.toByteData(format: format) 可以自定义存储格式,一般图片为png格式,但是要注意,如果你的RepaintBoundary包裹的部分没有设置背景色,那么存储出来的图片可能会有背景色缺失的问题。
  • toImage({double pixelRatio = 1.0})中的pixelRatio参数是生成图片像素倍数。例如,屏幕基础宽高为360px*480px, 默认输出也是360px*480px的图片文件;如果将pixelRatio设置为10,那么你输出的图片文件大小将是3600px*4800px

Native 层如何接收 字节数组

我们知道截图生成的Unit8List,其数据结构为字节数组byte[]。下面我们用小篇幅来演示一下如何通过methodChannel接收传递字节数组。

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

推荐阅读更多精彩内容