又一个前端框架 - dagger.js

JavaScript/前端
445
0
0
2022-12-17

推荐一个轻量完备的开源前端框架:dagger.js:https://daggerjs.org

img

什么是 dagger.js

dagger.js 是一个基于 html 的描述式单页应用开发框架,通过在页面 DOM 元素上添加语义化的指令来驱动业务逻辑。从语法特性的角度来说,dagger.js 模板 + 指令的工作方式与 Angular/Vue 比较接近。

dagger.js 采用去组件去 api 设计,没有对第三方代码或工具的依赖,模型简单,易于理解。与当前的主流前端框架相比,使用者的整体学习和使用成本更低。

使用 dagger.js,开发者将无须依赖于:

项目构建过程

dagger.js 工作在浏览器运行时当中。只需要通过 script 标签引入框架源码(release 版本 gzip 压缩后约 20KB)即可轻松创建单页应用程序。dagger.js 对项目代码结构是非侵入式的,您可以以极小成本对历史项目(即使是非单页应用程序)进行渐进升级。

包管理工具

dagger.js 内部实现了一个运行时模块管理器,根据路由配置按需动态加载和解析各类模块,为您的应用程序进行极限瘦身。

第三方路由管理工具

dagger.js 内置了基于 hash 的路由管理器。开发者无需引入额外的路由管理类库。

数据状态管理工具

dagger.js 倡导数据即状态的技术理念。有别于 React/Vue 等框架单向数据流模型中对于 state/prop 对象的区分,dagger.js 的作用域数据由框架本身进行维护,并具有全域视图响应性,开发者不必为不同组件间的数据状态同步而劳心费神。

开发范式

不同于 React Hooks 和 Vue 的组合式 API 方案,dagger.js 提供了更加接近原生 javaScript 开发体验的心智模型。dagger.js 没有设计任何框架相关的 “语法糖”,开发者编写的脚本代码只是普通的原生 javaScript 函数。函数定义本身是上下文无关的,其触发时机、调用参数以及副作用完全由调用者(指令)所决定。

dagger.js 中不存在组件(Component)实体的概念,指令是串接作用域数据(Model)和页面视图(View)的桥梁。换句话说,在 dagger.js 中,一切业务逻辑都以指令作为调用入口。某些特定指令可以在执行上下文创建作用域数据,而所有指令都可以作为作用域数据的消费者。指令读取或者修改作用域数据,进而触发依赖收集或者页面视图的响应式更新。

下文中我们将通过示例代码来体验 dagger.js 的工作模式。

创建作用域

在 dagger.js 中,我们可以通过生命周期指令 +loading 来创建作用域数据:

 <div +loading="{ message: 'Hello dagger!' }"> 
     <!-- 可以在其他指令中访问或者修改message -->
     ...
 </div>

+loading 指令在宿主元素(div)初始化时由框架触发调用。它的副作用是,当表达式的执行结果是一个平凡对象时,框架将依据此对象在当前上下文创建出新的作用域数据。技术上说,这个作用域数据是指令返回平凡对象的代理对象。

作用域数据在宿主元素被销毁时由框架自动移除,无需开发者手动管理。

指令

在 dagger.js 中,除去生命周期指令之外,还有两种重要的指令类型:控制指令和事件处理指令。

两种指令都可以自由读写在其声明位置可见的作用域数据,但是行为有所不同。

控制指令

控制指令在执行过程中会收集参与计算的作用域变量字段,并在指令的依赖项发生变化时动态触发指令重新执行。我们来看一个例子:

 <div dg-cloak     +loading="{ a: 1, b: 2, c: 0, d: 0 }" 
     $watch#1="c = a + b" 
     $watch#2="d = 2 * c"
 >

     <button +click="a = 1, b = 2">reset</button>
     <input type="number" $value#input="a">
     <input type="number" $value#input="b">
     <br>
     span>${ c } = ${ a } + ${ b }</span>
     <br>
     <span>${ d } = 2 * (${ c })</span>
 </div>

img

示例链接:https://codepen.io/dagger8224/pen/JjpJxzq

上例中,我们在 div 元素上声明了控制指令 watch 的两个实例。其中编号为#1” 的指令依赖于作用域变量下字段 a 和字段 b,编号为#2 的指令依赖于作用域变量下字段 c。当用户修改 a 或 b 的值时,将首先触发指令 watch#1 重新计算,更新字段 c 的值。c 值发生变化后再触发指令

除去 $watch 指令之外,dagger.js 还提供了更多语义化的控制指令,我们简单列举下这些控制指令的使用方法:

 <input type="checkbox" $checked="checked">

$checked 指令用于绑定宿主元素的选中状态,适用于类型为 radiocheckboxinput 元素,以及 option 元素。

 <div $class="className">...</div>

$class 指令用于将表达式的内容绑定到宿主元素的 class 属性上。

 <div $each="array">...</div>

$each 指令用于循环渲染具有相同视图模板的数组,对象,或者其他可迭代变量。

 <div $exist="exist">...</div>

$exist 指令用于切换宿主元素及其子级元素的存在状态。

 <div $html="content"></div>

$html 指令用于在宿主元素下动态创建子级元素。

 <input type="file" $file="file">
 <input type="file" multiple $file="files">

$file 指令用于绑定用户选择的本地文件信息。

 <select $selected="selected"> 
     <option value="1">1</option>
     ...
 </select>

$selected 指令用于绑定宿主元素的选中值,适用于类型为 radiocheckboxinput 元素,以及 select 元素。

 <div $style="style">...</div>

$style 指令用于绑定宿主元素的 style 属性。

 <span $text="text"></span>
 <span>${ text }</span>

$text 指令用于在宿主元素下动态创建文本内容。大多数情况下,我们也可以使用原地模板字符串(上例第二种方式)来创建动态文本节点,这样更加简单灵活。

 <input type="text" $value="message">

$value 指令用于将表达式的内容与 input 元素的 value 建立双向数据绑定。

事件处理指令

与控制指令相比,事件处理指令的用法更加简单。事件处理指令由用户操作或系统事件触发调用,在执行过程中不会对作用域数据进行依赖收集。我们来看一个例子:

 <button +click="alert(message)">click</button>

上例中,button 元素上的 +click 指令声明了一个鼠标点击事件处理函数。类似地,您也可以声明其他的原生事件处理指令(+keyup,+mouseenter 等等),或者自定义事件处理指令(例如:+custom_event)。

接下来我们来看几个指令的综合示例:

指令综合示例 1

下面的示例代码演示了生命周期指令 +loading+loaded+unloading+unloaded,控制指令 $exist 以及事件处理指令 + click` 的使用:

 <div dg-cloak +loading="{ status: '', exist: true }"> 
     <button +click="exist = !exist">toggle exist</button> 
     <span class="status-span">The status of dynamic span: ${ status }</span> 
     <span class="dynamic-span"
         $exist="exist"
         +loaded="status = 'existing'"
         +unloading="status = 'removing'"
         +unloaded="status = 'removed'">
         Some content
     </span> 
 </div>

点击按钮将切换作用域字段 exist 的值,进而触发声明了 $exist 指令的 span 元素加载或移除。

img

示例链接:https://codepen.io/dagger8224/pen/wvmgRyj

指令综合示例 2

下面的示例代码演示了控制指令 each 和 checked 的使用:

 <label $each="[1, 2, 3]">
     <input type="checkbox" name="checkbox1" $checked="checked[index]">checkbox${ item }
 </label>

切换复选框的勾选状态,作用域变量 checked 字段的内容将随之发生变化,这是双向数据绑定指令的典型用法。

img

示例链接:https://codepen.io/dagger8224/pen/PoRpROq

各种指令更详细的定义和使用方法参见官网文档

模块

接下来我们一起了解下 dagger.js 的模块设计。

在 dagger.js 中,我们把 html 模板,脚本,层叠样式表等可复用的代码片段统称为模块。

dagger.js 内部维护了一个运行时模块管理器,开发者通过 json 格式的配置项注册模块,框架将在应用程序首次加载或页面内路由发生切换时触发模块资源按需动态加载、解析和执行。

与作用域数据类似,模块仅在其注册层级及子层级生效,避免对全局作用域造成污染。

您可以根据业务需求灵活配置模块的组合方式(每一个组合方案构成一个名空间)来实现代码复用。我们来看一个模块配置项的示例:

 <script type="dagger/configs">
     {
         "script": "https://codepen.io/dagger8224/pen/NWyVxwx.js",
         "style": "https://codepen.io/dagger8224/pen/NWyVxwx.css",
         "template": {
             "uri": "#template",
             "style": "style"
         }
     }
 </script>

上面的配置项中,我们注册了一个名为 script 的脚本模块,一个名为 style 的样式模块,和一个名为 template 的模板模块,并将样式模块的作用范围限定为模板模块内部。

示例链接:https://codepen.io/dagger8224/pen/rNJrzzj

路由

作为一个完备的单页应用开发框架,dagger.js 内置了基于浏览器 hash 的路由管理器。当页面路由发生切换时,根作用域下 router 对象的内容将同步变化,进而驱动页面视图产生响应式更新(需要配合 html 控制指令使用)。我们来看一个示例:

img

上例中,当路由从 root 切换至 parent1 之后,页面内容将发生切换。

示例链接:https://codepen.io/dagger8224/pen/zYRQrwP

路由对象的字段内容可以在下面的示例中查看:

img

示例链接:https://codepen.io/dagger8224/pen/PoQBovd

渲染性能

dagger.js 并未采用虚拟 DOM 方案,而是通过细粒度的指令执行来实现页面视图增量更新。在 js-framework-benchmark 测试场景中,其综合运行时性能与 React17 版本相当。

未来计划

dagger.js 目前已经在多家公司的 B 端管理系统当中得到应用。在未来,我们计划围绕框架持续建设周边生态,通过开源方式对框架进行推广运营,让更多的前端开发者有机会了解和使用 dagger.js。

总结

dagger.js 是一个轻量级无依赖的描述式前端开发框架,与主流框架相比,具有更低的学习和使用成本。用户仅需了解上文中介绍的指令,模块与路由的相关概念和用法,就可以快速上手使用 dagger.js 构建单页应用程序。

以上是对 dagger.js 主要功能特性的概要介绍。更多信息请查看官方文档:https://daggerjs.org github 地址:https://github.com/dagger8224/dagger.js

更多示例截图

three.js

img

示例链接:https://codepen.io/dagger8224/pen/QWmwaLq

3D Carousel

img

示例链接:https://codepen.io/dagger8224/pen/JjLRbmz

Tesla

img

示例链接:https://codepen.io/dagger8224/pen/RwMGvPv?editors=1010

color picker

img

示例链接:https://codepen.io/dagger8224/pen/vYRmGJp?editors=1010

progress bar

img

示例链接:https://codepen.io/dagger8224/pen/dympJXz?editors=1010

text animation

img

示例链接:https://codepen.io/dagger8224/pen/JjLXppg

您可以在 https://codepen.io/dagger8224/pens 网站查看用 dagger.js 编写的更多有趣的 demo:

  • empty page: https://codepen.io/dagger8224/pen/ZErWBpB
  • to do list: https://codepen.io/dagger8224/pen/QWQVYGN
  • $scope animation: https://codepen.io/dagger8224/pen/YzeNmRz
  • anime.js: https://codepen.io/dagger8224/pen/eYMpzvB
  • clock: https://codepen.io/dagger8224/pen/RwMWRYd?editors=1000
  • digital clock: https://codepen.io/dagger8224/pen/LYdZEag
  • add tags: https://codepen.io/dagger8224/pen/ZErjzwm