每个前端开发者都可以开发一个属于自己的库或框架「Strve.js生态初步建成」

开发 前端
Strve.js是一个可以将字符串转换为视图的JS库。这里的字符串指的是模板字符串,所以你仅需要在JavaScript中开发视图。Strve.js不仅易于上手,还便于灵活拆装不同的代码块。

[[441664]]

前言

从3个月之前,就想自己开发一个库,从而提高一下自己的能力。庆幸的是在年前就开发出来了,并且生态也初步建成。这里提到的生态包括:Create Strve App、Strve Router以及其他辅助Strve.js开发的工具。

说实话,这段时间是挺难熬的,这也算是今年给自己一个礼物吧!

我开发Strve.js的初衷是之前接触过JSX语法,一直觉的JSX语法非常酷,可以在JS中写HTML标签,于是就想开发一款类似JSX语法的库。刚开始也开发了一段时间,搭配Babel可以简单实现JSX语法。但是到后来觉得并不是那么完美,还要解决一些类似修改数据更新视图的一些问题。熬了几天夜,也没有完美的解决。最后,还是放弃了这种方案。

我当时在想,如果我仅仅想在JS中写HTML标签,那么使用JS中的模板字符串就已经具备在字符串内写HTML标签的能力了,为什么不换一下思路,研究一下在模板字符串中写HTML标签这种更加方便直接的方案呢?刚开始我就是从基础着手,写一串字符串,然后怎么想办法将字符串挂载到页面中。借鉴了React、Vue这些框架的思想,在页面指定一个挂载元素。这就简单实现了在模板字符串内开发HTML,但是随之而来的是不能做到数据变页面变,从更加专业的角度上讲就是数据驱动页面。并且更新页面后尽可能的少修改DOM元素,减少重排带来的性能上的影响。这从最初的简单的在JS写HTML又上升到一个层面上,怎么实现一个MVVM框架。

市面上知名的MVVM框架有Vue、React、Angular,既然自己想设计一个MVVM框架,那么可以借鉴一下它们的思想。首先,非常喜欢Vue的渐进式设计思想,只要你是一个前端小白就可以立马上手,这是非常值得借鉴的。另外又借鉴了React框架中的“All in JS”以及异步更新数据的思想。最后,它们两个框架都使用了虚拟DOM来提升性能,那么我们也可以引入虚拟DOM机制。

之前,听过尤老师的几期中文分享,谈到框架的话题说,框架的设计就是不断的取舍。这其中肯定还会复杂很多,我上面也就是简单的概括了一下。能不能实现我所预期的那样,当时我也不知道,当时就想把东西做出来。前面一个多月是非常痛苦的,几乎是闭门造车。主要的难点是怎么将模板字符串转化成虚拟DOM结构,并且代码量控制在最小。然后将转化的虚拟DOM进行Diff算法,更有效的更新DOM。

最终,功夫不负有心人,我终于如愿以偿的完成了Strve.js的开发。这个小型库,也算不上是框架吧!设计的初衷上面也说了就是自己想练练手,看自己也能不能开发出起码不是很差的库或者框架。

下面,我将详细介绍Strve.js,如果有疑问或者其他问题可以留言哦!谢谢阅读!

Github

https://github.com/maomincoding/strve

Doc

https://maomincoding.github.io/strvejs-doc/

介绍

Strve.js的读音/str'vi/,是字符串(String)与视图(View)的拼接。Strve.js是一个可以将字符串转换为视图的JS库。这里的字符串指的是模板字符串,所以你仅需要在JavaScript中开发视图。Strve.js不仅易于上手,还便于灵活拆装不同的代码块。

使用模板字符串开发视图主要是利用了原生JavaScript的能力,可以更加灵活地分离代码块,你仅仅只关注JavaScript文件。从另一方面来看,目前源代码文件仅仅4kb左右,当然这是目前版本文件的大小。在之后的版本,会增加功能,肯定会增加代码量。不过,Strve.js会尽力做到轻量级。

Strve.js又是一款轻量级的MVVM框架,你只需要关心数据以及如何操作它,其他工作交给Strve.js内部处理。Strve.js首先会将模板字符串转化为虚拟DOM,然后进行Diff算法通过比较前后两次的状态差异更新真实DOM。这也是很多框架为了提升浏览器性能采用的方案,但是Strve.js更加轻量。

Strve.js目前仅仅3个API,是不是很容易上手? 如果你想上手项目,那么请看下面怎么安装它吧!

安装

CDN

如果你使用原生 ES Modules。

  1. <script type="module"
  2.   import { Strve, render, updateView } from 'https://cdn.jsdelivr.net/npm/strvejs/dist/strve.esm.min.js'
  3. </script> 
  1. npm i strvejs 

命令行工具

create-strve-app

一套快速搭建Strve.js项目的命令行工具。与早期的脚手架 Create Strve 相比,Create Strve App 更胜一筹,可直接输入命令快速创建Strve项目。Create Strve App是用Vite来构建的,它是一种新型前端构建工具,能够显著提升前端开发体验。

npm

  1. npm init strve-app@latest 

yarn

  1. yarn create strve-app 

pnpm

  1. pnpm create strve-app 

create-strve

Create Strve 是基于Strve.js的项目构建工具,您可以使用它更方便灵活地搭建页面。

全局安装

  1. npm install create-strve -g 

查看版本

  1. create-strve -v 

初始化项目

  1. create-strve init <projectName> 

快速上手

尝试 Strve.js 最简单的方法是使用直接引入CDN链接。你可以在浏览器打开它,跟着例子学习一些基础用法。

  1. <!DOCTYPE html> 
  2. <html lang="en"
  3.  
  4. <head> 
  5.     <meta charset="UTF-8"
  6.     <title>Hello Strve.js</title> 
  7. </head> 
  8.  
  9. <body> 
  10.     <div id="app"></div> 
  11.     <script type="module"
  12.         import { Strve, updateView, render } from 'https://cdn.jsdelivr.net/npm/strvejs/dist/strve.esm.js'
  13.  
  14.         const state = { 
  15.             arr: ['1''2'], 
  16.             msg: 'hello'
  17.             a: 1 
  18.         }; 
  19.  
  20.         function App() { 
  21.             return render` 
  22.               <div class='inner'
  23.                   <p>{state.msg}</p> 
  24.                   <p>${state.a + state.a}</p>  
  25.                   <button id='btn2' onclick=${usePush}>push</button> 
  26.                   <ul> 
  27.                     ${state.arr.map((todo) => render`<li key=${todo}>${todo}</li>`)} 
  28.                   </ul> 
  29.               </div> 
  30.           `; 
  31.         } 
  32.  
  33.         function usePush() { 
  34.             updateView(() => { 
  35.                 state.arr.push('3'); 
  36.             }); 
  37.         } 
  38.  
  39.         Strve('#app', { 
  40.             data: { state }, 
  41.             template: App 
  42.         }); 
  43.     </script> 
  44. </body> 
  45.  
  46. </html> 

如果你还想深入学习其他关于 Strve.js 的内容,你可以继续往下阅读。

使用

API

Strve.js目前仅仅有三个API。

  • Strve
  • render
  • updateView

是不是很简单!快来看看这三个API是什么意思?怎么使用它们?

Strve

参数:

  • string
  • object

详细:

初始化Strve.js。第一个参数传入需要挂载到HTML页面的节点选择器名称。第二个参数传入一个对象,第一个属性data表示的意思是状态对象,第二个属性template表示模板函数。

  1. Strve('#app', { 
  2.     data: { state }, 
  3.     template: App 
  4. }); 

render

  • 类型:Function
  • 详细:

render`` 是一个标签函数,标签函数的语法是函数名后面直接带一个模板字符串,并从模板字符串中的插值表达式中获取参数。比如说,你可以在模板字符串中直接可以写HTML标签。

  1. function App() { 
  2.     return render` 
  3.         <div class='inner'
  4.             <h1>Hello</h1> 
  5.         </div > 
  6.     `; 

updateView

参数:

  • Function

详细:

它仅仅有一个参数,这个参数是一个函数。函数体中需要执行将改变页面状态的值,例如以下示例中的state.msg。

  1. const state = { 
  2.     msg:'1' 
  3. }; 
  4.  
  5. function App() { 
  6.     return render` 
  7.         <div class='inner'
  8.             <button onclick=${useChange}>change</button> 
  9.             <p>{state.msg}</p> 
  10.         } 
  11.         </div > 
  12.     `; 
  13.  
  14. function useChange() { 
  15.     updateView(() => { 
  16.         state.msg = '2'
  17.     }); 
  18. }

插值

Strve.js 使用了基于 JavaScript 的模板字符串语法,允许开发者声明式地将 DOM 绑定至底层实例的数据。所有 Strve.js 的模板字符串都是合法的 HTML,所以能被遵循规范的浏览器和 HTML 解析器解析。

在底层的实现上,Strve.js 将模板字符串编译成虚拟 DOM 渲染函数,并把 DOM 操作次数减到最少。

在Strve.js中,你可以尽情的使用JavaScript 的模板字符串,感受它独特的魅力吧!

文本

数据绑定最常见的形式就是使用符号${}的文本插值:

  1. const state = { 
  2.     msg: 'hello' 
  3. }; 
  4.  
  5. function App() { 
  6.     return render` 
  7.         <div class='inner'
  8.             <p>${state.msg}</p> 
  9.         </div > 
  10.     `; 

 另外你还可以使用更简便的方法符号{},同样可以达到预想的效果。

  1. const state = { 
  2.     msg: 'hello' 
  3. }; 
  4.  
  5. function App() { 
  6.     return render` 
  7.         <div class='inner'
  8.             <p>{state.msg}</p> 
  9.         </div > 
  10.     `; 

 但是,使用这种符号{}需要注意的是,它只适用于标签内的文本插值。例如如下这种情况,它是不起作用的,不过你可以使用强大的符号${}。

  1. // Bad 
  2. function App() { 
  3.     return render` 
  4.         <div class='inner'
  5.             <input type="text" value={state.msg}/> 
  6.         } 
  7.         </div > 
  8.     `; 
  9.  
  10. // Good 
  11. function App() { 
  12.     return render` 
  13.         <div class='inner'
  14.             <input type="text" value=${state.msg}/> 
  15.         } 
  16.         </div > 
  17.     `; 

表达式

目前仅支持在符号${}中使用表达式。例如,

  1. const state = { 
  2.     a: 1, 
  3.     b: 2 
  4. }; 
  5.  
  6. function App() { 
  7.     return render` 
  8.         <div class='inner'
  9.             <p>${String(state.a + state.b)}</p> 
  10.         } 
  11.         </div > 
  12.     `; 

属性绑定

前面,我们可以看到使用符号${}可以与属性value绑定值。

  1. function App() { 
  2.     return render` 
  3.         <div class='inner'
  4.             <input type="text" value=${state.msg}/> 
  5.         } 
  6.         </div > 
  7.     `; 

 另外,你还可以绑定其他属性,例如class。

  1. const state = { 
  2.     isRed: true 
  3. }; 
  4.  
  5. function App() { 
  6.     return render` 
  7.     <div class='inner'
  8.         <p class=${state.isRed ? 'red' : ''}>Strve.js</p> 
  9.     </div > 
  10. `; 

条件渲染

我们也可以使用符号${},这块内容只会在指令的表达式返回 true 值的时候被渲染。

  1. const state = { 
  2.     isShow: false 
  3. }; 
  4.  
  5. function App() { 
  6.     return render` 
  7.         <div class='inner'
  8.             <button onclick=${useShow}>show</button> 
  9.             ${state.isShow ? render`<p>Strve.js</p>` : '' 
  10.         } 
  11.         </div > 
  12.     `; 
  13.  
  14. function useShow() { 
  15.     updateView(() => { 
  16.         state.isShow = !state.isShow; 
  17.     }); 

列表渲染

我们可以用符号${}基于一个数组来渲染一个列表。比如我们使用数组的map方法来渲染列表,并且可以动态添加数组项。

  1. const state = { 
  2.     arr: ['1''2'
  3. }; 
  4.  
  5. function App() { 
  6.     return render` 
  7.         <div class='inner'
  8.             <button onclick=${usePush}>push</button> 
  9.             <ul> 
  10.             ${state.arr.map((todo) => render`<li key=${todo}>${todo}</li>`)} 
  11.             </ul> 
  12.         } 
  13.         </div > 
  14.     `; 
  15.  
  16. function usePush() { 
  17.     updateView(() => { 
  18.         state.arr.push('3'); 
  19.     }); 

事件处理

我们可以使用原生onclick指令来监听 DOM 事件,并在触发事件时执行一些 JavaScript。需要使用符号${}来绑定事件。

  1. function App() { 
  2.     return render` 
  3.         <div class='inner'
  4.             <button onclick=${useClick}>sayHello</button> 
  5.         } 
  6.         </div > 
  7.     `; 
  8.  
  9. function useClick() { 
  10.     console.log('hello'); 

与Vue.js搭配

Strve.js不仅可以单独使用,也可以与Vue.js搭配使用。你需要在Vue实例挂载完成后被调用Strve()注册方法,并且第一个参数已经在template标签中存在。

App.vue

  1. <template> 
  2.   <div id="container"
  3.     <HelloWorld/> 
  4.   </div> 
  5. </template> 
  6.  
  7. <script> 
  8. import HelloWorld ,{hello} from './components/HelloWorld.vue'
  9. import { about,state } from './components/About.vue'
  10. import { render, Strve } from "strvejs"
  11. const AppTm = () => render` 
  12.       <div> 
  13.         ${hello()} 
  14.         ${about()} 
  15.       </div> 
  16. `; 
  17. export default { 
  18.   name"App"
  19.   components:{ 
  20.     HelloWorld 
  21.   }, 
  22.   mounted() { 
  23.     Strve("#container", { 
  24.       data: {state}, 
  25.       template: AppTm, 
  26.     }); 
  27.   }, 
  28. }; 
  29. </script> 

如果需要与Vue共享一个方法,推荐在setup方法中使用。

HelloWorld.vue

  1. <template> 
  2.   <div> 
  3.     <img src="../assets/logo.png" alt="" @click="useCliimg"
  4.   </div> 
  5. </template> 
  6. <script> 
  7. import { render } from "strvejs"
  8. import styles from '../assets/hello/hello.module.css'
  9.  
  10. export const hello = ()=>render` 
  11. <h2 class="${styles.color}" onclick=${useCliimg}>hello</h2> 
  12. function useCliimg(){ 
  13.     console.log(1); 
  14.  
  15. export default { 
  16.   name:'HelloWorld'
  17.   setup(){ 
  18.     return { 
  19.       useCliimg 
  20.     } 
  21.   } 
  22. </script> 

如果,你想在Vue组件中完全使用Strve.js,当然也可以。不过最后,推荐使用export default导出组件名。

About.vue

  1. <script> 
  2. import { render, updateView } from "strvejs"
  3. import styles from '../assets/about/about.module.css'
  4.  
  5. export const about = ()=>render` 
  6. <div> 
  7.     <p>{state.msg}</p> 
  8.    <h2 class="${styles.color}" onclick=${useClick}>about</h2> 
  9. </div> 
  10. export const state = { 
  11.     msg:"hello" 
  12.  
  13. function useClick() { 
  14.     updateView(()=>{ 
  15.         state.msg = 'world'
  16.     }) 
  17. export default { 
  18.     name:"About" 
  19. </script> 

与React.js搭配

Strve.js与Vue.js搭配相比,与React.js搭配使用更为灵活。同样需要在组件第一次渲染完成后调用Strve()方法注册方法。

App.js

  1. import {useEffect} from 'react' 
  2. import {Strve,render,updateView} from 'strvejs'
  3. import './App.css'
  4.  
  5. const state = { 
  6.   msg:"Hello" 
  7.  
  8. function Home(){ 
  9.   return render`<h1 onclick=${useClick}>{state.msg}</h1>` 
  10.  
  11. function useClick(){ 
  12.   updateView(()=>{ 
  13.     state.msg = "World"
  14.   }) 
  15.  
  16. function App() { 
  17.   useEffect(()=>{ 
  18.     Strve(".App",{ 
  19.       data:{state}, 
  20.       template: Home 
  21.     }) 
  22.   }) 
  23.   return (<div className="App"></div>); 
  24.  
  25. export default App; 

工具

create-strve-app

一套快速搭建Strve.js项目的命令行工具。与早期的脚手架 Create Strve 相比,Create Strve App 更胜一筹,可直接输入命令快速创建Strve项目。Create Strve App是用Vite来构建的,它是一种新型前端构建工具,能够显著提升前端开发体验。

搭建你的第一个 Strve 项目

npm

  1. npm init strve-app@latest 

yarn

  1. yarn create strve-app 

pnpm

  1. pnpm create strve-app 

选择模板

你可以根据自己的需要选择对应的模板。

  • strve

只包含Strve.js基本使用的功能。此模板适用于项目中仅仅单页面,没有跳转其他页面的应用。

  • strve-apps

不仅包含了Strve.js的基本使用的功能,而且还包含了Strve Router,适用于跳转多页面以及稍微复杂的应用。

create-strve

在前面我们也简单介绍过,Create Strve是基于Strve.js的项目构建工具,您可以使用它更方便灵活地搭建页面。Create Strve同样是用Vite来构建的。

不过,在这里推荐使用Create Strve App,它相对安装更加灵活以及快速。

安装

全局安装

  1. npm install create-strve -g 

查看版本

  1. create-strve -v 

初始化项目

  1. create-strve init <projectName> 

strve-router

Strve Router 是 Strve.js 的官方路由管理器。 它与 Strve.js 的核心深度集成,可以轻松构建单页应用程序。

目前只支持Hash模式。

开始

尝试 Strve Router 最简单的方法是使用直接导入 CDN 链接。 您可以在浏览器中打开它并按照示例学习一些基本用法。

  1. <!DOCTYPE html> 
  2. <html lang="en"
  3.  
  4. <head> 
  5.     <meta charset="UTF-8"
  6.     <title>StrveRouter</title> 
  7. </head> 
  8.  
  9. <body> 
  10.     <div id="app"></div> 
  11.     <script type="module"
  12.         import { Strve, render, updateView } from 'https://cdn.jsdelivr.net/npm/strvejs/dist/strve.esm.js'
  13.         import StrveRouter from 'https://cdn.jsdelivr.net/npm/strve-router/dist/strve-router.esm.js'
  14.  
  15.         const state = { 
  16.             msg: 'Hello!' 
  17.         }; 
  18.  
  19.         const strveRouter = new StrveRouter([{ 
  20.             path: '/'
  21.             template: Home 
  22.         }, { 
  23.             path: '/about'
  24.             template: About 
  25.         }]); 
  26.  
  27.         strveRouter.routerHashUpdate(updateView, () => { 
  28.             console.log(strveRouter.param2Obj()); 
  29.         }); 
  30.  
  31.         function Home() { 
  32.             return render` 
  33.                 <div class='innter'
  34.                     <button onclick="${goAbout}">goAbout</button> 
  35.                     <h1>Home</h1> 
  36.                 </div> 
  37.             ` 
  38.         } 
  39.  
  40.         function About() { 
  41.             return render` 
  42.                 <div class="innter"
  43.                     <button onclick="${goback}">goback</button> 
  44.                     <button onclick="${goHome}">goHome</button> 
  45.                     <h2>About</h2> 
  46.                 </div> 
  47.             ` 
  48.         } 
  49.  
  50.         function App() { 
  51.             return render` 
  52.               <div class='inner'
  53.                 <p>{state.msg}</p> 
  54.                 ${strveRouter.routerView()} 
  55.               </div > 
  56.           `; 
  57.         } 
  58.  
  59.         function goback() { 
  60.             strveRouter.back(); 
  61.         } 
  62.  
  63.         function goAbout() { 
  64.             console.log('goAbout'); 
  65.             strveRouter.routerLink({ 
  66.                 path: '/about'
  67.                 query: { 
  68.                     id: 1, 
  69.                     name"maomin" 
  70.                 } 
  71.             }); 
  72.         } 
  73.  
  74.         function goHome() { 
  75.             console.log('goHome'); 
  76.             strveRouter.routerLink('/'); 
  77.         } 
  78.  
  79.         Strve('#app', { 
  80.             data: { state }, 
  81.             template: App 
  82.         }); 
  83.     </script> 
  84. </body> 
  85.  
  86. </html> 

安装

npm

  1. npm install strve-router 

yarn

  1. yarn add strve-router 

pnpm

  1. pnpm add strve-router 

使用

如果在一个模块化工程中使用它,可以引入StrveRouter对象,然后实例化。参数是需要注册的路由组件,path属性代表路径,template属性代表引入的组件。

匹配到相应的路径页面会相应的更新,所以这里必须注册一个routerHashUpdate()方法,然后第一个参数传入updateViewAPI,第二个参数则是一个自定义方法。最后导出strveRouter实例。

比如这里在一个router文件夹下创建一个index.js文件。

  1. import StrveRouter from 'strve-router'
  2. import {updateView} from 'strvejs'
  3.  
  4. import Home from '../template/homepage.js'
  5. import About from '../template/aboutpage.js'
  6.  
  7. const strveRouter = new StrveRouter([{ 
  8.     path: '/'
  9.     template: Home 
  10. }, { 
  11.     path: '/about'
  12.     template: About 
  13. }]); 
  14.  
  15. strveRouter.routerHashUpdate(updateView,()=>{ 
  16.     console.log('router'); 
  17. }); 
  18.  
  19. export default strveRouter 

路由匹配到的组件将渲染到routerView()方法所在的地方,一般会放在主页面入口文件下(例如App.js)。

  1. import { render } from 'strvejs'
  2. import strveRouter from './router/index'
  3. function template() { 
  4.   return render` 
  5.         <div class='inner'
  6.         ${strveRouter.routerView()} 
  7.         </div> 
  8.     `; 
  9.  
  10. export default template; 

 如果需要跳转到对应页面,使用strveRouter.routerLink()方法,可以传对应的路径和需要传的参数,也可以直接传一个路径字符串。

  1. import { render } from 'strvejs' 
  2. import strveRouter from '../router/index.js' 
  3.  
  4. function Home(){ 
  5.     return render` 
  6.         <div> 
  7.             <button onclick="${goAbout}">goAbout</button> 
  8.             <h1>Home</h1> 
  9.         </div> 
  10.     ` 
  11.  
  12. function goAbout(){ 
  13.     strveRouter.routerLink({ 
  14.         path: '/about'
  15.         query: { 
  16.             id: 1, 
  17.             name"maomin" 
  18.         } 
  19.     }); 
  20.  
  21. export default Home 

最后,如果你需要实现后退、前进跳转页面这样操作时,同样提供了几个方法。

  • strveRouter.forward(): 向前跳转1个页面
  • strveRouter.back(): 向后跳转1个页面
  • strveRouter.go(n): 向前跳转n个页面

其它

IDE支持

Visual Studio Code

模板字符串自动补全标签

打开设置下的Settings.json,加入如下代码:

  1. "emmet.triggerExpansionOnTab"true
  2. "emmet.showAbbreviationSuggestions"true
  3. "emmet.showExpandedAbbreviation""always"
  4. "emmet.includeLanguages": { 
  5.     "javascript""html" 

 

责任编辑:姜华 来源: 前端历劫之路
相关推荐

2019-09-19 09:02:52

开发者技能工具

2021-12-19 07:22:16

Create前端工具

2022-02-23 10:48:52

TodoList应用项目Strve开发

2021-11-29 00:17:41

JS符串转换

2022-04-20 06:56:33

Strve.js前端

2012-10-23 14:01:21

Yibo 客户端已经停

2023-04-02 13:46:26

人工智能OpenAI漏洞

2023-08-10 08:31:53

工具实用网站

2023-06-27 07:55:03

前端开发工具

2022-02-21 06:02:49

Strve.jsCodepenReact

2014-08-26 10:05:37

框架开发AngularJS

2021-12-15 20:06:48

ReactJSSentry开发者

2021-01-26 09:13:07

前端开发者程序员

2019-07-18 10:14:32

前端Javascript图表库

2022-04-27 09:48:56

JS前端开发

2021-12-16 23:40:33

部署ReactTypeScript

2014-08-01 10:24:11

2023-02-13 00:18:22

前端库框架集合

2019-08-09 10:52:58

Linux内核Spark

2021-04-08 10:40:24

前端工具代码
点赞
收藏

51CTO技术栈公众号