首页 > 其他分享 >Flutter 如何将代码显示到界面上

Flutter 如何将代码显示到界面上

时间：2023-05-05 09:15:02浏览次数：42  
标签：文件 界面 代码 flutter build key dart Flutter

前言

如何优雅的将项目中的代码，亦或是你的demo代码展示到界面上？本文对使用简单、便于维护且通用的解决方案，进行相关的对比和探究

为了节省大家的时间，把最终解决方案的相关接入和用法写在前面

预览代码

快速开始

dependencies:
  code_preview: ^0.1.5
  • 用法：CodePreview，提供需要预览的className，可自动匹配该类对应的代码文件
    • 本来想把写法简化成传入对象，但是因为一些原因无奈放弃，改成了className
    • 具体可以参考下面Flutter Web中的问题模块的说明
import 'package:code_preview/code_preview.dart';
import 'package:flutter/material.dart';

class Test extends StatelessWidget {
  const Test({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const CodePreview(className: 'Test');
  }
}

image-20230429215042820

配置代码文件

因为原理是遍历资源文件，所以必须将需要展示的代码文件或者其文件夹路径，定义在assets下，这步操作，为大家提供了一个自动化的插件解决

强烈建议需要展示到界面的代码，都放在统一的文件夹里管理

  • 展示界面的代码需要在pugspec.yaml中的assets定义

image-20230422224011359

如果代码预览的文件夹，分级复杂，每次都需要定义路径实在麻烦

提供一个插件：Flutter Code Helper

  • 安装：Plugins中搜索Flutter Code Helper

image-20230422225244651

  • pugspec.yaml中定义下需要自动生成文件夹的路径，文件夹随便套娃，会自动帮你递归在assets下生成
    • 不需要自动生成，可：不写该配置，或者配置空数组（auto_folder: []）
code_helper:
  auto_folder: [ "assets/", "lib/widgets/" ]

Apr-09-2023 22-33-42

说明下：上面的插件是基于RayC的FlutterAssetsGenerator插件项目改的

  • 看了下RayC的插件代码和相关功能，和我预想的上面功能实现有一定出入，改动起来变动较大
  • 想试下插件项目的各种新配置，直接拉到最新
  • 后期如果想到需要什么功能，方便随时添加

所以没向其插件里面提pr，就单独新开了个插件项目

高级使用

主题

提供俩种代码样式主题

  • 日间模式
CodePreview.config = CodePreviewConfig(codeTheme: CodeTheme.light);

image-20230429215716043

  • 夜间模式
CodePreview.config = CodePreviewConfig(codeTheme: CodeTheme.dark);

image-20230429215545723

注释解析

  • 你可以使用如下的格式，在类上添加注释
    • key的前面必须加@，举例（@title，@xxx）
    • key与value的之间，必须使用分号分割，举例（@xxx: xxx）
    • value如果需要换行，换行的文案前必须加中划线
/// @title:
///  - test title one
///  - test title two
/// @content: test content
/// @description: test description
class OneWidget extends StatelessWidget {
  const OneWidget({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const Placeholder();
  }
}
  • 然后可以从customBuilder的回调获取param参数，param中拥有parseParam参数
    • 获取取得上面注释的数据：param.parseParam['title']或者param.parseParam['***']
    • 获取的value的类型是List，可兼容多行value的类型
  • customBuilder的用法
    • codeWidget内置的代码预览布局，如果你想定义自己预览代码的布局，那就可以不使用codeWidget
    • 一般来说，可以根据注释获取的数据，结合codeWidget嵌套来自定义符合要求的布局
    • param中含有多个有用内容，可自行查看
import 'package:code_preview/code_preview.dart';
import 'package:flutter/material.dart';

class Test extends StatelessWidget {
  const Test({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return CodePreview(
      className: 'OneWidget',
      customBuilder: (Widget codeWidget, CustomParam? param) {
        debugPrint(param?.parseParam['title'].toString());
        debugPrint(param?.parseParam['content'].toString());
        debugPrint(param?.parseParam['description'].toString());
        return codeWidget;
      },
    );
  }
}
  • 目前内部预览的布局，会自动去掉类上的注释，如果想保留注释，可自行匹配下
 CodePreview.config = CodePreviewConfig(removeParseComment: false);

几种代码预览方案

FlutterUnit方案

FlutterUnit项目也是自带代码预览方案，这套方案是比较特殊方案

  • 大概看了下，整个FlutterUnit的数据都是基于flutter.db，该文件里面就有相关demo的文本信息
  • 所有的demo也是单独存在一个叫widgets的项目中
  • 所以大概可以猜测出
    • 应该会有个db的辅助工具，会去扫描widgets的项目中的demo代码
    • 将他们的文本信息都扫描出来，然后解析上面的注释等相关信息，分类存储到数据库中，最后生成db文件

image-20230429172832212

  • 映射表，宿主可以通过db中的组件类名，从这里拿到demo效果实例

image-20230429175714400

总结

整套流程看下来，实现起来的工作量还是有点大的

  • db辅助工具的编写
  • 文本注释相关解析规则
  • 如何便捷的维护db文件（辅助工具是否支持，生成后自动覆盖宿主db文件）
  • 不同平台db文件的读取和相关适配

优点

  • 因为扫描工具不依赖Flutter相关库，预览方案可以快速的移植到其它编程语言（compose，SwiftUI等）
  • 具备高度自定义，因为是完全独立的第三方扫描工具，可以随性所欲的定制化

缺点

  • 最明显的缺点，应该就是稍微改下demo代码，就需要三方工具重新生成db文件（如果三方工具实现的是cli工具，可以将扫描生成命令和push等命令集成一起，应该可以比较好的避免该问题）

build_runner方案

build_runner是个强大代码自动生成工具，根据ast语法树+自定义注解信息，可以生成很多强大的附属代码信息，例如 json_serializable等库

所以，也能利用这点自定义类注解，获取到对应的整个类的代码信息，在对应附属的xx.g.dart文件中，将获取的代码内容转换成字符串，然后直接将xx.g.dart文件的代码字符串信息，展示到界面就行了

优点

  • 可以通过生成命令，全自动的生成代码，甚至将整个预览demo的映射表都可以自动配置完成
  • 可以规范的通过注解配置多个参数

缺点

  • 因为build_runner需要解析整个ast语法树，一旦项目很大之后，解析生成的时间会非常非常的长！
  • 因为现在很多的这类库都是依赖build_runner，所以跑自动生成命令，会导致巨多xx.g.dart文件被改动，极大的增加cr工作量

资源文件方案

这应该最常用的一种方案

  • 在pubspec.yaml中的assets中定义下我们代码文件路径
flutter:
  assets:
    - lib/widgets/show/
  • 然后用loadString获取文件内容
final code = await rootBundle.loadString('lib/widgets/show/custome_dialog_animation.dart');

image-20230429205530817

优点

  • 侵入性非常低，不会像build_runnner方案那样影响到其它模块
  • 便于维护，如果demo预览代码被改变了，打包的时候，资源文件也会生成对应改变后的代码文件

缺点

  • 使用麻烦，使用的时候需要传入具体的文件路径，才能找到想要的代码资源文件
  • 需要反复的在pubspec.yaml中的assets里面定义文件路径

资源文件方案优化

上面的三种方案各有优缺点，明确当前的诉求

  • 目前是想写个简单的，通用的，仅在Flutter中实现代码预览方案

  • 要求使用简单，高效

  • 维护简单，多人开发的时候不会有很大成本

FlutterUnit方案：实现起来成本较大，且多人开发对单个db文件的维护很可能会有点问题，例如：更新代码的时候，db文件忘记更新

build_runner方案：生成时间是个问题，还有很对其他类型xx.g.dart文件产生影响也比较麻烦

资源文件方案：整体是符合预期的，但是使用时候，需要传入路径和pubspec.yaml中反复定义文件路径，这是俩个很大痛点

结合实现成本和诉求，选择资源文件方案，下面对其痛点进行优化

使用优化

Flutter的编译产物中，有个相当有用的文件：AssetManifest.json

AssetManifest.json文件里面，有所有的资源文件的路径，然后就简单了，我们只需要读取该文件内容

final manifestContent = await rootBundle.loadString('AssetManifest.json');

获取到所有的路径之后，再结合传入的类名，读取所有路径的文件内容，然后和传入的类名做正则匹配就行了

稍微优化

  • 将传入的类名，转换为下划线名称和所有路径名称做匹配，如果能匹配上，再进行内容匹配，匹配成功后就返回该文件的代码内容
  • 如果上述匹配失败，就进行兜底的全量匹配

优化前

import 'package:code_preview/code_preview.dart';
import 'package:flutter/material.dart';

class Test extends StatelessWidget {
  const Test({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const CodePreview(path: 'lib/widgets/show/custome_dialog_animation.dart');
  }
}

优化后

import 'package:code_preview/code_preview.dart';
import 'package:flutter/material.dart';

class Test extends StatelessWidget {
  const Test({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const CodePreview(className: 'CustomDialogAnimation');
  }
}
  • 一般来说，我是统一配置预览demo和className，这样比较好对照

image-20230429170007279

路径定义优化

本来是想在pubspec.yaml的assets里面直接写通配符定义全路径，然后悲剧了，它不支持这种写法

flutter:
  assets:
    - lib/widgets/**/*.dart

GG，只能想其他办法了，想了很多方法都不行，只能从外部入手，用idea插件的形式，实现自动化扫描生成路径

  • 安装：Plugins中搜索Flutter Code Helper

image-20230422225244651

  • pugspec.yaml中定义下需要自动生成文件夹的目录，文件夹随便套娃，会自动帮你递归在assets下生成
    • 不需要自动生成，可：不写该配置，或者配置空数组（auto_folder: []）
code_helper:
  auto_folder: [ "assets/", "lib/widgets/" ]

Apr-09-2023 22-33-42

Flutter Web中的问题

魔幻的runtimeType

flutter web的release模式中

  • dart2js 会压缩 JS，这样会使得类型名被改变
  • 例如：dart中的TestWidgetFunction类的runtimeType，可能会变成minified:Ah，而不是TestWidgetFunction！

为啥需要压缩呢？压缩名称可以使得编译器将 JavaScript体积缩小 3 倍+；精确等效语义和性能/代码大小之间的权衡，Dart明显是选择了后者

这种情况只会在Flutter Web的release模式下发生，其他平台和Flutter web的Debug | Profile模式都不会有这种问题；所以说Xxx.runtimeType.toString，并不一定会得到预期内的数据。。。

具体讨论可参考

解决思路

  • 将压缩类型minified:Ah 恢复成 Test
  • 将获取的Test字符串使用相同算法压缩成minified:Ah

如有知道如何实现的，务必告诉鄙人

下面从压缩级别调整的角度，探究是否可解决该问题

dart2js压缩说明

注：flutter build web默认的是O4优化级别

  • O0: 禁用许多优化。
  • O1: 启用默认优化(仅是dart2js该命令的默认级别)
  • O2: 在O1优化基础上,尊重语言语义且对所有程序安全的其他优化（例如缩小）
    • 备注：使用-O2,使用开发JavaScript编译器编译时,类型的字符串表示不再与Dart VM中的字符串表示相同
  • O3: 在O2优化基础上,并省略隐式类型检查。
    • 注意：省略类型检查可能会导致应用程序因类型错误而崩溃
  • O4: 在O3优化基础上,启用更积极的优化
    • 注意：O4优化容易受到输入数据变化的影响,在依赖O4之前,需测试用户输入中的边缘情况

下面是flutter新建项目，未做任何改动，不同压缩级别的js产物体积

# main.dart.js: 7.379MB
flutter build web --dart2js-optimization O0 
# main.dart.js: 5.073MB
flutter build web --dart2js-optimization O1
# main.dart.js: 1.776MB
flutter build web --dart2js-optimization O2
# main.dart.js: 1.716MB
flutter build web --dart2js-optimization O3
# main.dart.js: 1.687MB
flutter build web --dart2js-optimization O4

总结

  • 预期用法
    • 为什么想使用对象？因为当对象名称改变时，对应使用的地方，可以便捷观察到需要改变
    • 可以使用传入的对象实例，在内部使用runtimeType获取类型名，再进行相关匹配
CodePreview(code: Test());

但是

综上可知，使用flutter build web --dart2js-optimization O1编译的flutter web release产物，能够使得runtimeType的语义和Dart VM中字符串保持一致

但是该压缩级别下的，js体积过于夸张，务必会对加载速度产生极大影响，可想而知，在复杂项目中的体积增涨肯定更加离谱

对于想要用法更加简单，使用低级别压缩命令打包的想法需要舍弃

  • 用法不得已做妥协
CodePreview(className: "Test");

这是个让我非常纠结的思路历程

最后

到这里也结束了，自我感觉，对大家应该能有一些帮助

一般来说，大部分团队，都会有个自己的内部组件库，因为Flutter强大的跨平台特性，所以就能很轻松的发布到web平台，可以方便的体验各种组件的效果，结合文章中的代码预览方案，就可以更加快速的上手各种组件用法了~

好了，下次再见了，靓仔们！

标签：文件,界面,代码,flutter,build,key,dart,Flutter
From： https://www.cnblogs.com/xdd666/p/17373084.html

相关文章

  • [vscode] 代码提示不能默认选中第一项问题
    [vscode]代码提示不能默认选中第一项问题码代码时发现一个问题，有些代码提示无法选中第一项。如果是所有代码提示都无法选中第一项，直接百度。这里说的是另一种，部分代码无法默认选中。在输入类似class=“”这类代码的代码自动补全回车后，输入代码触发代码提示后不会默认选中第......
  • Django笔记三十五之admin后台界面介绍
    本文首发于公众号：Hunter后端原文链接：Django笔记三十五之admin后台界面介绍这一篇介绍一下Django的后台界面使用。Django自带了一套后台管理界面，可用于我们直接操作数据库数据，本篇笔记目录如下：创建后台账号以及登录操作注册后台显示的数据表列表字段的显示操作字段值......
  • 命令行编译和执行java代码
    虽然现在IDE很强大又很智能，但是平常随意写点练手的代码的时候，直接在命令行中使用vim和java命令更为方便快捷，可以做到无鼠标纯键盘的操作。首先保证将java相关指令添加到了环境变量中；1.编译class文件：javac-d./Test.java编译好的class文件会放置到环境当前目录(./)中。-d......
  • 基于深度学习的水果检测与识别系统（Python界面版，YOLOv5实现）
    摘要：本博文介绍了一种基于深度学习的水果检测与识别系统，使用YOLOv5算法对常见水果进行检测和识别，实现对图片、视频和实时视频中的水果进行准确识别。博文详细阐述了算法原理，同时提供Python实现代码、训练数据集，以及基于PyQt的UI界面。通过YOLOv5实现对图像中存在的多个水果目标......
  • 从代码上解析Meta-learning
    文章目录1.背景2.Meta-learning理解2.1Meta-learning到底做什么2.2MAML算法2.3MAML算法步骤2.4MAML代码分析和实现3.参考文章1.背景meta-learning区别于pretraining，它主要通过多个task来学习不同任务之间的内在联系，通俗点说，也即是通过多个任务来学习共同的参数。举个例子，人类在......
  • 代码自动生成：Github Copilot
    2021年，Github和OpenAI合作，基于GPT-3模型推出了可以代码自动编码的插件：githubcopilot。1.安装在vscode软件中，找到githubcopilot进行安装：因为目前copilot还是在测试阶段，需要进行测试人员申请才能够真正使用：https://copilot.github.com/2.代码生成例子自动生成在python代码自动生......
  • 基于深度神经网络的图像分类与训练系统（MATLAB GUI版，代码+图文详解）
    摘要：本博客详细介绍了基于深度神经网络的图像分类与训练系统的MATLAB实现代码，包括GUI界面和数据集，可选择模型进行图片分类，支持一键训练神经网络。首先介绍了基于GoogleNet、ResNet进行图像分类的背景、意义，系统研究现状及相关算法。然后展示了系统的界面演示效果，包括选择图片分......
  • 基于YOLOv4的目标检测系统（附MATLAB代码+GUI实现）
    摘要：本文介绍了一种MATLAB实现的目标检测系统代码，采用YOLOv4检测网络作为核心模型，用于训练和检测各种任务下的目标，并在GUI界面中对各种目标检测结果可视化。文章详细介绍了YOLOv4的实现过程，包括算法原理、MATLAB实现代码、训练数据集、训练过程和图形用户界面。在GUI界面中，用户......
  • 5分钟教你配置命令行界面的163邮箱客户端
    网易163免费邮箱相关服务器信息：mutt是命令行下的邮件客户端，它仅是管理邮件的组织编辑，邮件的发送和接收需要调用对应的程序。这里用的分别是getmail和msmtp.步骤如下=====1.安装mutt,getmail,msmtp======================$sudoyum-yinstallmuttgetmailmsmtp2.Bui......
  • vscode使用git推送代码
    下载vscodehttps://code.visualstudio.com/点击应用管理搜素Chinese(Simplified)LanguagePackforVisualStudioCode点击安装后记得全屏安装，好了后会有提示点击蓝色的按钮vscode会自动重新启动命令如下桌面新建一个文件夹-随便起一个名字把你需要的代码......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99