IconFontPreview——一款预览IconFont的插件

背景

使用过IconFont的应该都深有体会,每次使用IconFont的时候,由于不知道Unicode和Icon的对应关系,每次都要到对应的文件夹下找到默认生成的html文件,打开后才能寻找到我们需要的IconFont。而每次找文件这个过程真的很麻烦,而且当公司IconFont的版本更新的时候,这个路径也会相应改变,那就更痛苦了。
为了解决这个问题,我就考虑能不能做一款预览IconFont的插件,避免这种痛苦的寻找文件过程,提高开发效率。

功能特性

  • 支持已定义的IconFont的预览
  • 支持缓存避免每次查找
  • 使用方便

源码地址

IconFontPreview

欢迎Star👏~
欢迎提issue和PR~
这里再推荐一下我的另一个开源项目EasyTextView,一款高效利用IconFont的TextView,功能丰富,用过的人都说好~

jar包地址

我已经发布到Intellij的官网上了,不知道为啥搜不到

IconFontPreview.zip

使用步骤

1.安装完插件后,在操作面板会生成一个草帽的Icon,点击操作面版的草帽icon(ONE PIECE)
step1
2.第一次需要设置工程下ttf字体文件路径和定义iconfont的string.xml路径
step2.jpg

这一步只会在第一次才会使用,因为本地会有缓存,后面的会读取缓存的目录(根目录下的PlugCache)

3.点击确定后或者以后在点击草帽就会在浏览器中打开预览定义的IconFont图标了
ONE PIECE
4.后面再使用就可以直接点击操作面板的草帽Icon就会直接弹出预览页面了

实现原理

1.IntelliJ插件开发

这个网上博客很多,这里就不专门讲解了

2.XML解析

这里本来一开始是准备直接读取ttf文件,然后直接生成ttf文件中所有定义的IconFont的,但是我好像没有找到实现方式(大家有好的实现方式可以告诉我~,或者提PR)
我们一般定义IconFont的都会在String.xml定义unicode类似于下面

<resources>
    <!--后退-->
    <string name="icon_font_606">\ue606</string>
    <!--评论-->
    <string name="icon_font_comment">\ue68f</string>
    <!--收藏-->
    <string name="icon_font_collection">\ue68e</string>
    <!--赞-->
    <string name="icon_font_like">\ue695</string>
</resources>

所以这里就需要我们遍历XML了,这里我选择了SAX解析的方式,取出了定义的Key,和对应的Unicode,并保存起来

3.Jsoup动态渲染HTML

拿到我们的数据集后,我们就需要生成我们最终的预览页面了,这里直接利用IconFont固定的HTMl模版,下载下来,利用Jsoup这个HTMl解析库,遍历我们生成的数据集,并对应在固定位置插入HTML代码,最后利用File保存到PluginCache文件夹下
这里有几个问题:

3.1 jar包中HTML读取css文件路径问题

由于插件最终生成的是jar文件,所有html中的css文件,由于路径无法读取,需要将css文件拷贝到html中

3.2 缓存文件需要利用文件流保存,这里涉及到插件的数据持久化。

因为用户设置的ttf文件路径和string.xml文件路径不能每次点击都要重新设置,哪还要这个插件干啥...,所以我就想将用户设置的这两个路径缓存起来,所以这里就涉及到插件的数据持久化。
网上提供的插件持久化的两种方式我都试了一下,发现没法真正意义上的持久化,当你idea关闭后,这些数据都会被对应清理掉,对应于
1.使用PersistentStateComponent
2.使用PersistentStateComponent
所以最后我是用了文件流的方式缓存目录路径(大家如果有更好的方式可以告诉我~)

/**
     * 创建li
     */
public static final String ICON_ITEM = "<li>\n" +
            "                <i class=\"icon iconfont\">%s</i>\n" +
            "                    <div class=\"name\">%s</div>\n" +
            "                    <div class=\"code\">%s</div>\n" +
            "                </li>";
public void printer(String ttfPath) {
        InputStream html = this.getClass().getResourceAsStream(Common.HTML_PATH);
        try {
            Document doc = Jsoup.parse(html, "UTF-8", "");
            if (data != null) {
                Elements style = doc.select("style");
                style.prepend(String.format(Common.STYLE_DF, ttfPath));
                Elements container = doc.getElementsByClass("icon_lists clear");
                if (Common.MODE_ALL) {
                    //全量模式,从16进制最小值到16进制最大值
                    printerAll(container);
                } else {
                    //自定义模式,只输出定义的资源文件
                    printerDefine(container);
                }
            }
            File result = CreateFileUtil.createFile(RESULT_PATH);
            if (result == null) {
                return;
            }
            FileOutputStream outStream = new FileOutputStream(result);    //文件输出流用于将数据写入文件
            outStream.write(doc.toString().getBytes(StandardCharsets.UTF_8));
            outStream.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private void printerDefine(Elements container) {
        for (Map.Entry<String, XmlIconFontModel> entry : data.getFonts().entrySet()) {
            String code = entry.getValue().getFontValue();
            if (code.startsWith(Common.ICON_START)) {
                String value = "&#xe" + code.substring(3) + ";";
                container.append(String.format(Common.ICON_ITEM, value,
                        entry.getValue().getFontKey(), code));
            } else if (code.startsWith(Common.ICON_START_SUB)) {
                container.append(String.format(Common.ICON_ITEM, code,
                        entry.getValue().getFontKey(), code));
            }
        }
    }

4.利用exec执行命令,打开生成的html文件

/**
         * 执行展示
         */
        try {
            if (OSinfo.isWindows()) {
                Runtime.getRuntime().exec("cmd.exe /c start " + RESULT_PATH);
            } else {
                Runtime.getRuntime().exec("open " + RESULT_PATH);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

相关推荐

【干货】基于iconfont拓展的EasyTextView(高度自定义,丰富Api,支持左右设置Text,设置Shape,设置span等)

EMvp-基于AOP的一种RecyclerView多楼层开发模式,支持组件化,全局楼层打通,MVP等高拓展性功能

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容