用Kotlin擼一個圖片壓縮插件-實戰篇(三)

時間 2019-11-06

標籤 kotlin 一個圖片壓縮插件實戰简体版

原文原文鏈接

簡述: 因爲我的緣由，已經有很長一段時間沒有寫過文章，有句話是那麼說的只要開始就不會太晚，因此咱們開始《用Kotlin擼一個圖片壓縮插件》系列文章最後一篇實戰篇。實際上我已經把源碼發佈到了GitHub，代碼很簡單。有了前兩篇文章的基礎，這篇文章將會使用Kotlin從零開始帶你擼個圖片壓縮插件。java

1、開發前期準備工做

一、訪問TinyPng官網註冊TinyPng開發者帳號，拿到TinyPng ApiKey,整個過程只需簡單註冊驗證便可。

二、因爲本項目圖片壓縮框架是基於TinyPng的圖片壓縮API來實現的，因此須要在TinyPng官網提供了develop開發庫，能夠找到相應Java的jar，爲了方便下載這裏就直接貼出地址了:TinyPng依賴包下載

三、因爲圖片插件使用到GUI，插件GUI採用的是Java中的Swing框架搭建，具體能夠去複習相關Swing的知識點，固然只須要大概瞭解便可，畢竟這個不是重點。git
四、須要去掌握插件開發的基礎知識，因爲本篇文章是實戰篇就不去細講插件基礎知識，具體詳情可參照該系列的第二篇文章用Kotlin擼一個圖片壓縮插件-插件基礎篇(二)github
五、須要有Kotlin的基本開發知識，好比Kotlin中擴展函數的封裝，Lambda表達式，函數式API，IO流API的使用api

2、圖片壓縮插件基本功能點

圖片壓縮插件主要支持以下兩大功能:瀏覽器

一、支持指定圖片源輸入目錄批量壓縮到一個指定的輸出目錄。

二、支持在AndroidStudio項目中直接選中指定的一個或多個圖片，右鍵點擊直接壓縮。

3、實現思路分析

實現的總體思路：首先咱們須要找到實現關鍵點，而後從關鍵點一步步向外擴展延伸，那麼實現圖片壓縮的插件的關鍵點在哪裏，確定毫無疑問是圖片壓縮API，也就是TinyPng API函數調用實現。網絡

Tinify.fromFile(inputFile).toFile(inputFile)
複製代碼

經過以上的TinyPng API就能夠找到關鍵點，一個是輸入文件另外一個則是輸出文件，那麼咱們這個圖片壓縮插件的全部實現都是圍繞着如何經過一個簡單的方式指定一個輸入文件或目錄和一個輸出文件或目錄。app

沒錯就是這麼簡單，那麼咱們一塊兒來分析下上面兩大功能實現思路其實也很簡單：框架

功能點一: 就是經過Swing框架中的JFileChooser組件，打開並指定一個圖片輸入文件或目錄和一個圖片壓縮後的輸出文件或目錄便可。異步
功能點二: 經過Intellij Idea open api中的 DataKeys.VIRTUAL_FILE_ARRAY.getData(this)拿到當前選中的Virtual Files,也就是當前選中的文件把選中的文件當作輸入文件，而後圖片壓縮後文件直接輸出到源文件中便可。async

注意: 因爲Tiny.fromFile().toFile()內部源碼實際上經過OkHttp發送圖片壓縮的網絡請求，並且內部採用的方式是同步請求的，可是在IDEA Plugin開發中主線程是不能執行耗時任務的，因此須要將該API方法調用放在異步任務中

4、代碼結構和實現

action包:主要定義插件中的兩個action，咱們都知道在插件開發中Action是功能執行的入口，ImageSlimmingAction是前面說到第一個功能點批量壓縮指定輸入和輸出目錄的，RightSelectedAction是前面說過的第二個功能點在項目選中圖中文件直接右鍵壓縮的, 最後這兩個Action都須要在plugin.xml中註冊。

<actions>
        <action class="com.mikyou.plugins.image.slimming.action.ImageSlimmingAction" text="ImageSlimming" id="com.mikyou.plugins.image.slimming.action.ImageSlimmingAction" description="compress picture plugin" icon="/img/icon_image_slimming.png">
            <add-to-group group-id="MainToolBar" anchor="after" relative-to-action="Android.MainToolBarSdkGroup"/>
        </action>

        <action id="com.mikyou.plugins.image.action.rightselectedaction" class="com.mikyou.plugins.image.slimming.action.RightSelectedAction" text="Quick Slim Images" description="Quick Slim Images">
            <add-to-group group-id="ProjectViewPopupMenu" anchor="after" relative-to-action="ReplaceInPath"/>
        </action>
    </actions>
複製代碼

extension包: 主要是定義了Kotlin中的擴展函數，一個是Boolean的擴展能夠相似鏈式調用來替代if-else判斷，另外一個則是Dialog使用的擴展

//Boolean 擴展
sealed class BooleanExt<out T>

object Otherwise : BooleanExt<Nothing>()//Nothing是全部類的子類，協變的類繼承關係和泛型參數類型繼承關係一致

class TransferData<T>(val data: T) : BooleanExt<T>()

inline fun <T> Boolean.yes(block: () -> T): BooleanExt<T> = when {
    this -> TransferData(block.invoke())
    else -> Otherwise
}

inline fun <T> Boolean.no(block: () -> T): BooleanExt<T> = when {
    this -> Otherwise
    else -> TransferData(block.invoke())
}

inline fun <T> BooleanExt<T>.otherwise(block: () -> T): T = when (this) {
    is Otherwise ->
        block()
    is TransferData ->
        this.data
}


//Dialog擴展
fun Dialog.showDialog(width: Int = 550, height: Int = 400, isInCenter: Boolean = true, isResizable: Boolean = false) {
    pack()
    this.isResizable = isResizable
    setSize(width, height)
    if (isInCenter) {
        setLocation(Toolkit.getDefaultToolkit().screenSize.width / 2 - width / 2, Toolkit.getDefaultToolkit().screenSize.height / 2 - height / 2)
    }
    isVisible = true
}

fun Project.showWarnDialog(icon: Icon = UIUtil.getWarningIcon(), title: String, msg: String, positiveText: String = "肯定", negativeText: String = "取消", positiveAction: (() -> Unit)? = null, negativeAction: (() -> Unit)? = null) {
    Messages.showDialog(this, msg, title, arrayOf(positiveText, negativeText), 0, icon, object : DialogWrapper.DoNotAskOption.Adapter() {
        override fun rememberChoice(p0: Boolean, p1: Int) {
            if (p1 == 0) {
                positiveAction?.invoke()
            } else if (p1 == 1) {
                negativeAction?.invoke()
            }
        }
    })
}
複製代碼

helper包主要是用文件IO操做，因爲兩個Action都存在圖片壓縮操做，爲了複用就直接把圖片壓縮API調用的實現操做抽出封裝在ImageSlimmingHelper中。
ui包主要就是Swing框架中一些界面GUI的實現和交互。

4、實現的關鍵技術點

關鍵點一: 插件開發中如何執行一個異步任務

IDEA Plugin開發和Android開發很相似，一些耗時的任務是不能直接在主線程執行的，須要在特定後臺線程執行，不然會阻塞主線程。在intellij open api中有個Task.Backgroundable抽象類就是處理異步任務的。Backgroundable繼承了Task類以及實現了PerformInBackgroundOption接口。具體使用很簡單傳入兩個參數一個是Project對象和一個執行異步中hint提示文本，有四個回調函數分別爲run(progress: ProgressIndicator)、onSuccess、onThrowable、onFinished.最後經過queue方法加入到異步任務隊列中。爲了方便調用將其封裝成一個擴展函數來使用。

//建立後臺異步任務的Project的擴展函數asyncTask
private fun Project.asyncTask( hintText: String, runAction: (ProgressIndicator) -> Unit,
        successAction: (() -> Unit)? = null,
        failAction: ((Throwable) -> Unit)? = null,
        finishAction: (() -> Unit)? = null
) {
    object : Task.Backgroundable(this, hintText) {
        override fun run(p0: ProgressIndicator) {
            runAction.invoke(p0)
        }

        override fun onSuccess() {
            successAction?.invoke()
        }

        override fun onThrowable(error: Throwable) {
            failAction?.invoke(error)
        }

        override fun onFinished() {
            finishAction?.invoke()
        }
    }.queue()
}
//asyncTask的使用

  project?.asyncTask(hintText = "正在壓縮", runAction = {
        //執行圖片壓縮操做
        outputSameFile.yes {
            //針對右鍵選定圖片狀況，直接壓縮當前目錄選中圖片，輸出目錄包括文件也是原來的
            inputFiles.forEach { inputFile -> Tinify.fromFile(inputFile.absolutePath).toFile(inputFile.absolutePath) }
        }.otherwise {
            inputFiles.forEach { inputFile -> Tinify.fromFile(inputFile.absolutePath).toFile(getDestFilePath(model, inputFile.name)) }
        }
    }, successAction = {
        successAction?.invoke()
    }, failAction = {
        failAction?.invoke("TinyPng key存在異常，請從新輸入")
    })
複製代碼

關鍵點二: 插件開發中如何獲取當前選中的文件或目錄

在插件開發中如何得到當前選中文件，實際上open api提供了相似DataContext數據上下文環境，咱們須要去拿到文件集合對象就須要先找到文件管理的窗口對象，還記得上篇博客中說到的AnActionEvent對象是插件與IDEA交互通訊的一個媒介，經過AnActionEvent內部的dataContext的getData方法，傳入對應的DataKey對象得到相應的窗口對象。在CommonDataKey中有一個DataKey<VirtualFile[]>，經過傳入當前event中的dataContext對象便可得到當前選中的文件對象集合。

private fun DataContext.getSelectedFiles(): Array<VirtualFile>? {
        return DataKeys.VIRTUAL_FILE_ARRAY.getData(this)//右鍵獲取選中多個文件,擴展函數
    }
複製代碼

關鍵點三: Swing中JFileChooser組件的使用

關於JFileChooser組件的使用就比較簡單了，這裏就不去詳細介紹，代碼也很簡單

private void openFileAndSetPath(JComboBox<String> cBoxPath, int selectedMode, Boolean isSupportMultiSelect) {
        JFileChooser fileChooser = new JFileChooser();
        fileChooser.setFileSelectionMode(selectedMode);
        fileChooser.setMultiSelectionEnabled(isSupportMultiSelect);
        //設置文件擴展過濾器
        if (selectedMode != JFileChooser.DIRECTORIES_ONLY) {
            fileChooser.addChoosableFileFilter(new FileNameExtensionFilter(".png", "png"));
            fileChooser.addChoosableFileFilter(new FileNameExtensionFilter(".jpg", "jpg"));
            fileChooser.addChoosableFileFilter(new FileNameExtensionFilter(".jpeg", "jpeg"));
        }

        fileChooser.showOpenDialog(null);


        if (selectedMode == JFileChooser.DIRECTORIES_ONLY) {//僅僅選擇目錄狀況，不存在多文件選中
            File selectedDir = fileChooser.getSelectedFile();
            if (selectedDir != null) {
                cBoxPath.insertItemAt(selectedDir.getAbsolutePath(), 0);
                cBoxPath.setSelectedIndex(0);
            }
        } else {//選擇含有文件狀況，包括僅僅 選擇文件 和 同時選擇文件和目錄，
            File[] selectedFiles = fileChooser.getSelectedFiles();
            if (selectedFiles != null && selectedFiles.length > 0) {
                cBoxPath.insertItemAt(getSelectedFilePath(selectedFiles), 0);
                cBoxPath.setSelectedIndex(0);
            }
        }

    }
複製代碼

關鍵點四: api key的驗證和圖片壓縮的實現

在進行圖片壓縮前就是須要去驗證一下TingPng ApiKey的合法性，若是第一次驗證合法就須要把該ApiKey存儲在本地，下次壓縮就直接使用本地的key進行壓縮，一旦本地key失效後，須要從新彈出TinyPng apikey 的驗證提示框，進行從新認證。固然須要注意的是驗證api key的合法性也是進行一次同步的網絡請求因此它也要放在異步任務執行。

fun checkApiKeyValid( project: Project?, apiKey: String, validAction: (() -> Unit)? = null,
        invalidAction: ((String) -> Unit)? = null
) {
    if (apiKey.isBlank()) {
        invalidAction?.invoke("TinyPng key爲空，請從新輸入")
    }
    project?.asyncTask(hintText = "正在檢查key是否合法", runAction = {
        try {
            Tinify.setKey(apiKey)
            Tinify.validate()
        } catch (exception: Exception) {
            throw exception
        }
    }, successAction = {
        validAction?.invoke()
    }, failAction = {
        println("驗證Key失敗!!${it.message}")
        invalidAction?.invoke("TinyPng key驗證失敗，請從新輸入")
    })
}
複製代碼

而後就是利用異步任務進行圖片壓縮操做。

fun slimImage( project: Project?, inputFiles: List<File>, model: ImageSlimmingModel = ImageSlimmingModel("", "", "", ""),
        successAction: (() -> Unit)? = null,
        outputSameFile: Boolean = false,
        failAction: ((String) -> Unit)? = null
) {
    project?.asyncTask(hintText = "正在壓縮", runAction = {
        //執行圖片壓縮操做
        outputSameFile.yes {
            //針對右鍵選定圖片狀況，直接壓縮當前目錄選中圖片，輸出目錄包括文件也是原來的
            inputFiles.forEach { inputFile -> Tinify.fromFile(inputFile.absolutePath).toFile(inputFile.absolutePath) }
        }.otherwise {
            inputFiles.forEach { inputFile -> Tinify.fromFile(inputFile.absolutePath).toFile(getDestFilePath(model, inputFile.name)) }
        }
    }, successAction = {
        successAction?.invoke()
    }, failAction = {
        failAction?.invoke("TinyPng key存在異常，請從新輸入")
    })
}
複製代碼

5、總結

到這裏《用Kotlin擼一個圖片壓縮插件》系列文章就結束了，其實實現起來挺簡單的，其中主要的關鍵點就是須要更加熟悉使用Intellij open api, 而後其餘就是運用好Kotlin的一些語法特性，其他的都很簡單。並且我的以爲把圖片壓縮作成一個插件會變得很高效，否則傳統的模式得須要把圖片拖到瀏覽器中而後一個一個下載下來，還有的人問我不就是一個腳本能解決的嗎？腳本我的以爲不夠靈活不能像插件同樣任意在項目中選中一張或多張圖片直接右鍵壓縮。若有什麼問題歡迎下方留言，謝謝。

插件項目源碼地址