FlutterAssetsGenerator,一款Flutter资源索引插件

FlutterAssetsGenerator,一款Flutter资源索引插件

引言

​ 在Flutter中,资源的引用一般都需要现在根目录下定义一个目录,例如assets,然后在pubspec.yaml中配置目录,最后引用,写法一般如下:

Image.asset(
  'assets/images/add.png',
  width: 40,
  height: 40,
),

​ 这样引入资源总感觉很容易写错,目录和文件名都得写完整,手滑了一下就容易写错。因而又有了下面一种简化的方法:

///获取资源目录
String assetsPath(String name,
    {String rootPath = 'assets/images/',
    String dir = '',
    String fileType = '.png'}) {
  return '$rootPath$dir$name$fileType';
}

​ 先定义一个类似于上面的方法,方法中对路径进行一下封装,因而使用资源文件的方式变成了下面这种:

Image.asset(
  assetsPath('add'),
  width: 40,
  height: 40,
)

​ 看起来是减少了不少要手写的地方,然而还是要手写一下文件名,文件后缀不同也需要再额外多写一点内容。而且还要再包一个方法,看起来也不是很好看。

FlutterAssetsGenerator就是为了解决Flutter中资源引用这一个蛋疼的方式而来的。

介绍

​ 如果有做过Android开发的朋友应该都知道,在Android中,资源的索引会有一个R文件,这是一个自动生成的文件。放进资源drawable目录里的资源,一般引用就用R.drawable.xx方式引用,这样找资源首先很方便,再来也不会出现什么差错。

​ 本插件想要实现的效果就是这样的,首先插件会遍历项目下的assets目录,然后整理出文件索引,最后生成一个assets.dart

文件,如:

///This file is automatically generated. DO NOT EDIT, all your changes would be lost.
class Assets {
  Assets._();

  static const String imagesAdd = 'assets/images/add.png';
  static const String imagesArrowDown = 'assets/images/arrow_down.png';
  static const String imagesBack = 'assets/images/back.png';
  static const String imagesBackWhite = 'assets/images/back_white.png';
  static const String imagesBounds = 'assets/images/bounds.png';
  static const String imagesCloseWhite = 'assets/images/close_white.png';

}

​ 最后引用资源就可以如下了:

Image.asset(
  Assets.imagesAdd,
  width: 40,
  height: 40,
)

​ 这样有什么好处呢?首先资源整理到一起,方便查看,再来引用的时候都是直接引用常量,有代码提醒,也不怕写错了。插件实现的功能其实都是很简单的,也可以自己手写成这样,但是程序员能不手写肯定不会手写的啦。

使用

1、安装

image-20201124105737198

插件已上传插件市场,因而打开Preferences->Plugins,在Marketplace可以直接搜索安装。

2、配置assets目录

​ 插件会从pubspec.yaml文件下下读取assets目录,因此要使用本插件,你需要在pubspec.yaml下配置资源目录:

flutter:

  # The following line ensures that the Material Icons font is
  # included with your application, so that you can use the icons in
  # the material Icons class.
  uses-material-design: true

  # To add assets to your application, add an assets section, like this:
  assets:
    - assets/images/

3、使用

配置完成目录后,即可生成资源索引文件了:

image-20201124110013734

插件默认的快捷键是Alt/Opt + G。

2020-11-24 10.50.35

​ 插件也会自动检测assets目录下的文件变动,如果发生变动会自动生成新的内容。如果你不需要这个,你也可以关掉。
2020-11-24 11.05.32

资源左侧的icon是可以点击的,点击可以定位到文件处。如果资源是svg,还会显示预览。(至于图片预览为啥还没显示,目前调试有点问题,所以还没展示)

4、设置

image-20201124110127634

​ 插件默认生成的文件目录在lib/generated目录下,如果你不喜欢,你可以自己更改,目录支持多级,以/分割。索引文件的类名默认是Assets,如果你希望Android一点,你也可以改为R

​ 插件默认打开了自动检测功能,如果不需要的时候可以关掉。

​ 资源索引默认命名是小驼峰式,更符合dart语言规范。开启Named with parent会为资源索引加上一级文件夹名,如果有重名的会再多取一级,如果想要索引短一点,可以关掉此选项。

最后附上github地址,欢迎star,使用插件有什么问题或者建议,欢迎提出!

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

推荐阅读更多精彩内容