IDEA插件:多线程文件下载插件开发

摘要

上周使用Java开发了大文件多线程下载工具类,自己平时的文件下载也在使用这个工具,下载速度确实提升不少,但是每次下载都要去打开项目运行代码,觉得实在不是很方便;考虑到每天我们都会使用到IDEA开发工具,所以就决定把这个下载工具做成IDEA的插件,文章末尾附上插件下载地址。

Java实现大文件多线程下载

IDEA多线程文件下载插件

不要忘记star哟

IDEA插件介绍

IntelliJ IDEA是目前最好用的JAVA开发IDE,它本身的功能已经非常强大了,但是可能我们会遇到一些定制的需求,比如说:自定义代码生成器;这时候就需要我们自己动手来写一个插件,如果只是想要开发简单的功能其实只要掌握了Java Swing,那么开发IDEA的插件是很容易的,如果想学习更多的原理和设计理念可以看IntelliJ Platform SDK的官方文档。

IDEA插件开发步骤

1. 创建Gradle的插件工程

image

创建完成项目之后,我们可以看一下resource/META-INF/plugin.xml

<idea-plugin>
    <id>cn.silently9527.fast-download-idea-plugin</id>   <!-- 插件的ID -->
    <name>FastDownloadPlugin</name> <!-- 插件的名字,会在插件中心展示 -->
    <vendor email="380303318@qq.com" url="https://silently9527">Silently9527</vendor>
    <!--插件说明-->
    <description><![CDATA[
    多线程文件下载器
    ]]></description>

    <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
         on how to target different products -->
    <!-- uncomment to enable plugin in all products
    <depends>com.intellij.modules.lang</depends>
    -->

    <extensions defaultExtensionNs="com.intellij">
        <!-- Add your extensions here -->
    </extensions>

    <actions>
        <!-- Add your actions here -->
    </actions>
</idea-plugin>

2. 创建一个Action

在IDEA的插件开发中,基本都会使用到Action,Action其实就是事件的处理器,就好比JS中的onClick方法。在IDEA中创建一个Action十分简单,通过图形化界面就可以完成

image
image

创建完成后就可以看到Action类

public class FastDownloadAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent e) {

}
}

plugin.xml中可以看到生成的Action信息

<action id="fast.download" class="cn.silently9527.FastDownloadAction" text="FastDownload" description="文件多线程下载">
    <add-to-group group-id="ToolsMenu" anchor="last"/>
    <keyboard-shortcut keymap="$default" first-keystroke="shift D"/>
</action>

3. 创建输入下载信息的弹窗

IDEA插件的SDK已经对弹窗进行的封装,只需要继承DialogWrapper即可,界面上的绘制工作都在createCenterPanel方法中,组件的布局与JavaSwing类似

@Nullable
@Override
protected JComponent createCenterPanel() {
    Box verticalBox = Box.createVerticalBox();
    verticalBox.add(createUrlBox());
    verticalBox.add(Box.createVerticalStrut(10));
    verticalBox.add(createFileDirJPanel());
    verticalBox.add(Box.createVerticalStrut(10));
    verticalBox.add(createThreadNumJPanel());
    return verticalBox;
}

我们需要对输入的下载地址和存放的路径的参数进行校验,判断输入是否正确,可以实现方法doValidate,校验通过返回null,校验不通过返回ValidationInfo对象

@Nullable
@Override
protected ValidationInfo doValidate() {
    if (StringUtils.isBlank(downloadUrlField.getText())) {
        return new ValidationInfo("文件下载地址必填");
    }
    if (StringUtils.isBlank(fileDirField.getText())) {
        return new ValidationInfo("文件保存目录必填");
    }
    if (StringUtils.isBlank(threadNumField.getText())) {
        return new ValidationInfo("下载线程数必填");
    }
    return null;
}

最终界面完成后的效果

image

4. 在FastDownloadAction中获取弹窗输入的下载信息

DownloadDialog downloadDialog = new DownloadDialog();
if (downloadDialog.showAndGet()) {
    // 用户点击OK之后进入到这里
}

当用户点击了OK,输入信息检验通过后我们就可以开始下载文件了,由于之前做的下载组件是同步调用,为了不阻塞界面操作,需要使用线程异步下载

CompletableFuture.runAsync(() -> {
    try {
        Downloader downloader = new MultiThreadFileDownloader(threadNum, downloadProgressPrinter);
        downloader.download(downloadURL, downloadDir);
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
})

在下载的过程中,需要给用户反馈,让用户知道当前下载的进度是多少,以及当前下载的速度是多少

//使用SDK开启一个后台任务线程
ProgressManager.getInstance().run(new Task.Backgroundable(project, "File Downloading") {
    private long tmpAlreadyDownloadLength; //当前已下载字节数
    private long speed; //每秒下载速度

    public void run(@NotNull ProgressIndicator progressIndicator) {
        // start your process
        while (true) {
            long alreadyDownloadLength = downloadProgressPrinter.getAlreadyDownloadLength();
            long contentLength = downloadProgressPrinter.getContentLength();
            if (alreadyDownloadLength != 0 && alreadyDownloadLength >= contentLength) {
                // 下载已完成,进度条显示100%
                progressIndicator.setFraction(1.0);
                progressIndicator.setText("finished");
                break;
            }
            setProgressIndicator(progressIndicator, contentLength, alreadyDownloadLength);
            sleep();
        }
    }

    private void setProgressIndicator(ProgressIndicator progressIndicator, long contentLength,
                                      long alreadyDownloadLength) {
        if (alreadyDownloadLength == 0 || contentLength == 0) {
            return;
        }
        speed = alreadyDownloadLength - tmpAlreadyDownloadLength;
        tmpAlreadyDownloadLength = alreadyDownloadLength;

        double value = (double) alreadyDownloadLength / (double) contentLength;

        double fraction = Double.parseDouble(String.format("%.2f", value));
        progressIndicator.setFraction(fraction);
        String text = "already download " + fraction * 100 + "% ,speed: " + (speed / 1000) + "KB";
        progressIndicator.setText(text); //进度条显示已下载百分比,下载速度
    }
});
image

插件安装

下载插件之后,选择本地安装

image

总结

  • IDEA插件介绍
  • IDEA插件开发的基本步骤
  • 实现了多线程文件下载插件

目前测试过程中发现文件下载速度计算不太准确,个别线程的下载速度未能统计在内,后期继续优化。

插件下载链接: https://pan.baidu.com/s/1cmzKgmu8JwUa-liWmNl5jw 提取码: 3f4t

写到最后 点关注,不迷路

文中或许会存在或多或少的不足、错误之处,有建议或者意见也非常欢迎大家在评论交流。

最后,创作不易,请不要白嫖,希望朋友们可以点赞评论关注三连,因为这些就是我分享的全部动力来源🙏

微信公众号:贝塔学JAVA

原文地址:https://silently9527.cn/archives/93

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

推荐阅读更多精彩内容