file_drag_and_drop一個Flutter桌面版拖動復(fù)制文件插件開源啦

前言

我的上一篇文章手把手教你實戰(zhàn)Flutter 桌面版-Tinypng(熊貓圖片壓縮)GUI工具基于Flutter Deskstop 實現(xiàn)初版的圖片壓縮功能是尔,可以支持macOS合愈、以及windows。但是美中不足的是栖榨,macOS下依然要點擊選擇文件去壓縮,而不是像Finder一樣隨意拖動文件闸天。在文末我也是立了Flag要支持侥钳,經(jīng)過一周時間的調(diào)研呈枉,順利實現(xiàn)并且開源了此插件file_drag_and_drop刹勃。目前僅支持macOS堪侯,由于此功能非常依賴原生桌面,我對Windows Visual Studio編程是在是不熟荔仁,F(xiàn)lutter接口已經(jīng)寫好伍宦,期待有緣人可以貢獻。話不多說乏梁,基于此插件雹拄,我也對我的圖片壓縮工具macOS版本做了版本更新,效果如下掌呜。

c126edd73491463a81c8fa8c941c94e4~tplv-k3u1fbpfcp-watermark.image.gif

插件實現(xiàn)的代碼過程解析

第一步等待初始化window

由于macOS桌面不像iOS原生可以使用PlatforView. 實際拖動接受文件和iOS差不多,要實現(xiàn)NSView的一個drag協(xié)議坪哄。 這里用了個取巧的方法质蕉,先在flutter端main函數(shù) await一個 initializedMainView初始化方法。我們直接蓋一個drop view到 NSWindow上即可翩肌。由于用戶可能放大縮小窗口模暗,布局就不用frame了,直接用原生約束念祭,也不要SnapKit了兑宇,還要導(dǎo)入庫,很簡單的約束而已粱坤。

Flutter代碼


void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await dragAndDropChannel.initializedMainView();
  runApp(GetMaterialApp(
    navigatorKey: Get.key,
    home: OKToast(
      child: MyApp(),
    ),
  ));
}


macOS 原生 Swift代碼

private var mainWindow: NSWindow {
        get {
            return (self.registrar.view?.window)!;
        }
    }

private var mainView: NSView {
        get {
            return self.registrar.view!
        }
    }
    
private func _initializedMainView() {
        if (!_initialized) {
            _initialized = true
            mainView.addSubview(mainDropView)
            mainDropView.frame = mainView.bounds
            mainDropView.translatesAutoresizingMaskIntoConstraints = false
            mainView.addConstraints(
                [
                    NSLayoutConstraint(item: mainDropView, attribute: .leading, relatedBy: .equal, toItem: mainView, attribute: .leading, multiplier: 1, constant: 0),
                    NSLayoutConstraint(item: mainDropView, attribute: .trailing, relatedBy: .equal, toItem: mainView, attribute: .trailing, multiplier: 1, constant: 0),
                    NSLayoutConstraint(item: mainDropView, attribute: .top, relatedBy: .equal, toItem: mainView, attribute: .top, multiplier: 1, constant: 0),
                    NSLayoutConstraint(item: mainDropView, attribute: .bottom, relatedBy: .equal, toItem: mainView, attribute: .bottom, multiplier: 1, constant: 0)
              ]
            )
        }
    }

第二步實現(xiàn)協(xié)議


Swift

protocol FlutterDragContainerDelegate {
    func draggingFileEntered()
    func draggingFileExit()
    func prepareForDragFileOperation()
    func performDragFileOperation(_ results : [FileResult])
}

Flutter 添加監(jiān)聽

abstract class DragContainerListener {
    void draggingFileEntered() {}
    void draggingFileExit() {}
    void prepareForDragFileOperation() {}
    void performDragFileOperation(List<DragFileResult> fileResults) {}
}
   

原生幾個重要協(xié)議方法隶糕,通過Channel 轉(zhuǎn)為Flutter的監(jiān)聽

Swift


override func draggingEntered(_ sender: NSDraggingInfo) -> NSDragOperation {
        if let delegate = self.delegate {
            delegate.draggingFileEntered();
        }
        return NSDragOperation.generic
    }
    
    override func draggingExited(_ sender: NSDraggingInfo?) {
        if let delegate = self.delegate {
            delegate.draggingFileExit();
        }
    }
    
    override func prepareForDragOperation(_ sender: NSDraggingInfo) -> Bool {
        if self.delegate != nil {
            self.delegate?.prepareForDragFileOperation()
        }
        return true
    }
    
    override func performDragOperation(_ sender: NSDraggingInfo) -> Bool {
        var files = Array<FileResult>()
        if let board = sender.draggingPasteboard.propertyList(forType: NSFilenamesPboardType) as? NSArray {
            for path in board {
                print(path)
                if let p = path as? String {
                    let isDirectory = FlutterFileUtil.isDirectory(p)
                    let fileExtension = FlutterFileUtil.fileExtension(p)
                    files.append((path: p,isDirectory: isDirectory, fileExtension: fileExtension))
                }
            }
        }
        if self.delegate != nil {
            self.delegate?.performDragFileOperation(files)
        }
        return true
    }

Flutter端


ObserverList<DragContainerListener>? _listeners =
      ObserverList<DragContainerListener>();

  Future<void> _methodCallHandler(MethodCall call) async {
    if (_listeners == null) return;

    for (final DragContainerListener listener in listeners) {
      if (!_listeners!.contains(listener)) {
        return;
      }

      if (call.method != 'onEvent') throw UnimplementedError();

      String eventName = call.arguments['eventName'];
      Map<String, Function> funcMap = {
        kFileDragAndDropEventEntered: listener.draggingFileEntered,
        kFileDragAndDropEventExit: listener.draggingFileExit,
        kFileDragAndDropEventPrepareDragTask:
            listener.prepareForDragFileOperation,
        kFileDragAndDropEventPerformDragTask: listener.performDragFileOperation,
      };
      if (eventName == kFileDragAndDropEventPerformDragTask) {
        List fileResult = call.arguments['fileResult'];
        var resultList = <DragFileResult>[];
        fileResult.forEach((element) { 
          var result = DragFileResult.fromJson(element);
          resultList.add(result);
        });
        funcMap[eventName]!(resultList);
      } else {
        funcMap[eventName]!();
      }
    }
  }

第三步Window Home Page添加監(jiān)聽及處理

@override
  void initState() {
    super.initState();
    dragAndDropChannel.addListener(this);
  }

  @override
  void dispose() {
    dragAndDropChannel.removeListener(this);
    super.dispose();
  }

flutter監(jiān)聽的處理(相當(dāng)于觸發(fā)了原生的協(xié)議),這里簡單做了個遮罩站玄,拖進去顯示枚驻,退出隱藏。

[圖片上傳失敗...(image-b3e241-1659196308997)]


@override
  void draggingFileEntered() {
    print("flutter: draggingFileEntered");
    setState(() {
      visibilityTips = true;
    });
  }

  @override
  void draggingFileExit() {
    print("flutter: draggingFileExit");
    setState(() {
      visibilityTips = false;
    });
  }

  @override
  void prepareForDragFileOperation() {
    print("flutter: prepareForDragFileOperation");
    setState(() {
      visibilityTips = false;
    });
  }

  @override
  void performDragFileOperation(List<DragFileResult> fileResults) {
    print("flutter: performDragFileOperation");
    checkCanPicker().then((canPicker) {
      if (canPicker) {
        var collectionFiles = <File>[];
        fileResults.forEach((element) {
          if (element.isDirectory == false) {
            collectionFiles.add(File(element.path));
          }
          //TODO Also can collect the image file in Directory
        });
        var chooseFiles = chooseImageFiles(collectionFiles);
        if (chooseFiles.isNotEmpty) {
          controller.refreshWithFileList(chooseFiles);
        }
      }
    });
  }

源碼地址

未來研究

此次插件僅實現(xiàn)了macOS從外部拖文件到應(yīng)用內(nèi)部株旷,如何從應(yīng)用內(nèi)部拖文件去其他地方再登?由于deskstop版不支持Platform View。這感覺像是變成了一個死循環(huán),還有待研究锉矢。另外寫作不易梯嗽,每次寫作都耗費了不少時間,如果此文對你有幫助沽损,希望點贊三連灯节,Github也是Star頂起來,感謝??缠俺。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末显晶,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子壹士,更是在濱河造成了極大的恐慌磷雇,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,682評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件躏救,死亡現(xiàn)場離奇詭異唯笙,居然都是意外死亡,警方通過查閱死者的電腦和手機盒使,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,277評論 3 395
  • 文/潘曉璐 我一進店門崩掘,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人少办,你說我怎么就攤上這事苞慢。” “怎么了英妓?”我有些...
    開封第一講書人閱讀 165,083評論 0 355
  • 文/不壞的土叔 我叫張陵挽放,是天一觀的道長。 經(jīng)常有香客問我蔓纠,道長辑畦,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,763評論 1 295
  • 正文 為了忘掉前任腿倚,我火速辦了婚禮纯出,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘敷燎。我一直安慰自己暂筝,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,785評論 6 392
  • 文/花漫 我一把揭開白布硬贯。 她就那樣靜靜地躺著乖杠,像睡著了一般。 火紅的嫁衣襯著肌膚如雪澄成。 梳的紋絲不亂的頭發(fā)上胧洒,一...
    開封第一講書人閱讀 51,624評論 1 305
  • 那天畏吓,我揣著相機與錄音,去河邊找鬼卫漫。 笑死菲饼,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的列赎。 我是一名探鬼主播宏悦,決...
    沈念sama閱讀 40,358評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼包吝!你這毒婦竟也來了饼煞?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,261評論 0 276
  • 序言:老撾萬榮一對情侶失蹤诗越,失蹤者是張志新(化名)和其女友劉穎砖瞧,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體嚷狞,經(jīng)...
    沈念sama閱讀 45,722評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡块促,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了床未。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片竭翠。...
    茶點故事閱讀 40,030評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖薇搁,靈堂內(nèi)的尸體忽然破棺而出斋扰,到底是詐尸還是另有隱情,我是刑警寧澤啃洋,帶...
    沈念sama閱讀 35,737評論 5 346
  • 正文 年R本政府宣布褥实,位于F島的核電站,受9級特大地震影響裂允,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜哥艇,卻給世界環(huán)境...
    茶點故事閱讀 41,360評論 3 330
  • 文/蒙蒙 一绝编、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧貌踏,春花似錦十饥、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,941評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至眷昆,卻和暖如春蜒秤,著一層夾襖步出監(jiān)牢的瞬間汁咏,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,057評論 1 270
  • 我被黑心中介騙來泰國打工作媚, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留攘滩,地道東北人。 一個月前我還...
    沈念sama閱讀 48,237評論 3 371
  • 正文 我出身青樓纸泡,卻偏偏與公主長得像漂问,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子女揭,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,976評論 2 355

推薦閱讀更多精彩內(nèi)容