React DnD基础概念和整体架构

React DnD 的英文是 Drag and Drop for React。
React DnD 是 React 和 Redux 的核心作者 Dan Abramov 创造的一组 React 高阶组件,基于数据而不是视图开发的一套拖拽工具,主要使用typescript进行开发。

基础概念和使用示例可以参考://www.greatytc.com/p/8a1e16d5519b官方tutorial
作者基于HTML5提供了一个backend实现,相关api参考:HTML_Drag_and_Drop_API

React DnD 的基本概念

Manager

Manager是DnD中非常重要的角色,内部保存了store、monitor和backend,Manager作为入口,对外暴露三者,会订阅store,并调用Backend的setup(负责注册拖拽相关一系列的事件)或teardown(销毁拖拽事件)。

Backends

React DnD 抽象了后端的概念,我们可以使用 HTML5 拖拽后端,也可以自定义 touch、mouse 事件模拟的后端实现,后端主要用来抹平浏览器差异,处理 DOM 事件,同时把 DOM 事件转换为 React DnD 内部的 redux action。主要注册了拖拽相关的监听器,对外提供了dom(drag、preview和drop)注入方法。

Item

React DnD 基于数据驱动,当拖放发生时,它用一个数据对象来描述当前的元素,比如 { cardId: 25 }。

Type

类型是唯一标识应用程序中整个项目类别的字符串(或符号),类似于 redux 里面的 actions types 枚举常量。

Monitors

拖放操作都是有状态的,React DnD 通过 Monitor 来存储这些状态并且提供查询。

Connectors

Backend 关注 DOM 事件,组件关注拖放状态,connector 可以连接组件和 Backend ,可以让 Backend 获取到 DOM。

useDrag

用于将当前组件用作拖动源的钩子。

import { useDrag } from 'react-dnd'

function DraggableComponent(props) {
 const [collectedProps, drag] = useDrag({
   item: { id, type }
 })
 return <div ref={drag}>...</div>
}

useDrop

使用当前组件作为放置目标的钩子。

 const [collectedProps, drop] = useDrop({
   accept
 })

 return <div ref={drop}>Drop Target</div>
}

架构与源码

概略图
backend: HTML5Backend

详细调度图

上图说明:
一、DndProvider
根据createDragDropManager(backend, context)创建名为dragDropManager的单例,并通过React.createContext共享,包含有store、monitor和backend信息;
二、useDrag
2.1、通过useDragSourceMonitor生成DragSourceMonitorImpl实例monitor
1、通过useDragDropManager方法(本质就是React.useContext)获取dragDropManager单例;
2、通过DragSourceMonitorImpl(dragDropManager)生成实例,内部维护了一些诸如canDrag、isDragging、didDrop等常用操作,本质是通过dragDropManager单例内部的manager实现。
2.2、通过useDragSourceConnector生成SourceConnector实例connector
1、通过useDragDropManager获取manager,再通过manager.getBackend()获取backend;
2、通过SourceConnector(backend)生成connector,然后将DragSourceOptions、dragPreviewOptions分别保存在connector.dragSourceOptions、connector.dragPreviewOptions,并通过connector.reconnect()重连;connector内部维护了dragSourceRef、dragSourceNode、dragPreviewRef和dragPreviewNode等数据,还会通过调用backend.connectDragSource和backend.connectDragPreview方法,将drag和preivew相关信息传入backend。
2.3、通过useRegisteredDragSource(spec, monitor, connector)注册DragSource
1、通过DragSourceImpl(spec, monitor, connector)生成DragSource实例handler,提供了beginDrag、canDrag、isDragging和endDrag方法,四个方法基本是调用spec中配置的相应方法;
2、调用manger的registry将handler注册到manager中(manager.getRegitry().addSource),生成对应的handlerId,通过monitor和connector的receiveHandlerId方法注入到各自里面。
2.4、通过useCollectedProps(spec.collect, monitor, connector)返回collect数据
通过monitor.subscribeToStateChange方法注册监听方法updateCollected,该方法会通过collect(monitor)获取到最新的结果

2.5、dragRef通过useConnectDragSource(connector)返回dragRef
通过执行connector.dragSource方法获取最新的drag ref,并reconnectDragSource。
2.6、通过useConnectDragPreview(connector)返回dragPreview
类似2.5。
三、useDrop
四、Backend(HTML5Backend)

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

推荐阅读更多精彩内容