Vue或React的多页应用脚手架

简介:

前言

一直以来都在研究多页应用如何能有一套像SPA一样优雅的开发模式

本套架构在项目上使用感觉还不错(已跑在上百个页面的项目上),所以决定开源出来给大家

阅读完本文能实现在项目中使用ES6(7)+组件化(.vue | .jsx)开发多页应用

(其实我是想把它做为大家多页应用的脚手架)

目录结构介绍

TIPS:任何的项目的架构都和目录结构有关,所以这部分非常重要,请仔细耐心阅读

我们先宏观的看下结构


 
 
  1. |--- public // 生产环境下所需的文件 
  2.     |--- static 
  3.         |--- css 
  4.         |--- es6 
  5.         |--- fonts 
  6.         |--- images 
  7.     |--- views 
  8. |--- src 
  9.     |--- assets 
  10.         |--- fonts 
  11.         |--- images 
  12.     |--- components 
  13.     |--- js 
  14.     |--- sass 
  15.     |--- static 
  16.         |--- css 
  17.         |--- es6 
  18.         |--- fonts 
  19.         |--- images 
  20.     |--- views  

src里的assets,components,js,sass里的文件最后都会生成到src/static下,这个作为我们dev中引用的资源文件。而public不用说,是线上访问的文件。

我们展开介绍下具体的页面应该如何对应它的资源。拿js和views为例


 
 
  1. |--- views 
  2.     |--- home // 官网介绍 业务模块 
  3.         |--- index.html 
  4.         ... 
  5.     |--- shopping // 购物业务模块 
  6.         |--- buy.html 
  7.         ... 
  8. |--- js 
  9.     |--- lib 
  10.         |--- vue.js 
  11.         |--- react.js 
  12.         |--- react.dom.js 
  13.         ... 
  14.     |--- home // 官网介绍业务模块的js 
  15.         |--- index.js 
  16.         ... 
  17.     |--- shopping // 购物业务模块的js 
  18.         |--- buy.js 
  19.         ... 
  20.     tools.js 
  21.     common.js  

在多页应用中,往往我们的页面以业务模块划分,业务模块由许多的页面组成。

如home,shopping,可能就分别为官网介绍和购物的业务模块。在这业务模块下,分别有许多个页面,那我们的js文件也需要命名一一对应。

当然,我们还有第三方的js库是不需要编译的,所以我们专门用一个lib文件夹来存放他们。(包括你自己编写的指令或者filter等,不需要编译的,也直接放在lib下引入即可)

另外,你还有许多自己写的需要编译的工具库直接放在js目录下即可(如,tools.js,common.js)

我们的sass也是同理


 
 
  1. |--- sass 
  2.     |--- home 
  3.         |--- index.scss 
  4.         ... 
  5.     |--- shopping 
  6.         |--- buy.scss 
  7.         ...  

他们编译在static下的文件将为


 
 
  1. |--- static 
  2.     |--- css // scss 编译后的 
  3.         |--- home 
  4.             |--- index.css 
  5.         |--- shopping 
  6.             |--- buy.css 
  7.     |--- js // babel处理后的js 
  8.         |--- home 
  9.             |--- index.js 
  10.         |--- shopping 
  11.             |--- buy.js  

页面引用的路径就为(home/index.html为例)


 
 
  1. ... 
  2. <link rel="stylesheet" href="../../static/css/home/index.css"> 
  3.  
  4. ... 
  5.  
  6. <script src="../../static/es6/lib/vue(react).js"></script> 
  7. <script src="../../static/es6/lib/react.dom.js"></script> 
  8. <script src="../../static/es6/home/index.js"></script> 
  9. ...  

js和sass搞定了后,我们的难点是编写组件的过程中,如何知道应该编译哪个入口js文件呢?

所以我们需要对我们的组件名进行一些约定,这也就是约定大于配置的前提。


 
 
  1. |--- components 
  2.     |--- home // home 业务模块 
  3.         |--- home-header.vue(jsx) 
  4.         |--- index-info.vue(jsx) 
  5.         ... 
  6.     |--- shopping  // shopping 业务模块 
  7.         |--- buy-list.vue(jsx) 
  8.         ...  

我们components下的业务模块名和之前的sass,js一样。具体组件那就有所不同。

我们分为几种类型的组件

一、当前页面使用的组件

二、当前业务模块下的公用组件

三、所有业务模块的通用组件

当前页面组件的命名,我们约定为 [页面]-[组件].vue(jsx)

如下


 
 
  1. |--- components 
  2.     |--- home 
  3.         |--- index-info.vue(jsx)  

这个 index-info 的组件就仅仅只有在home/index.html页面下使用,当你修改了这个组件后,会自动编译home/index.js路口js文件并刷新页面。

当前业务模块下的公用组件,我们约定为 [业务模块]-[组件].vue(jsx)

如下


 
 
  1. |--- components 
  2.     |--- common 
  3.         |--- loading.vue(jsx)  

这个home-header组件就属于home业务模块下的公用组件,当你修改了这个组件后,会自动编译home业务模块下所有的js文件并刷新页面。

剩下的就是所有业务模块下的通用组件,我们约定全放在components/common目录下,不需要具体命名约定


 
 
  1. |--- components 
  2.     |--- common 
  3.         |--- loading.vue(jsx)  

这个loading组件就属于所有业务模块下的公用组件,当你修改了这个组件后,会自动编译所有业务模块下的js文件并刷新页面。

编译组件的原理以及为什么约定命名的原因是:

我会根据组件更改变动,去读取文件夹名,组件名,并编译对应名的路口js

至此,我们就把组件的问题也解决了

由于我采用的是主gulp辅webpack,webpack仅仅只编译用,所以编译基本达到秒编译。比单纯利用webpack做构建快得多。如果单纯采用webpack做构建,需要去配置entry,配置HTMLPlugin。所以会慢得多,然而我这一套并不需要如此繁琐。

图片&&字体文件

这其实是一个大坑

我们的实现目标是组件能相对路径引入图片或字体文件


 
 
  1. // 如 在html标签里这样 
  2. <template> 
  3.     <figure> 
  4.         <img src="../../assets/images/home/logo.jpg" alt="头像"> 
  5.     </figure> 
  6. </template> 
  7.  
  8. // 在style里这样 
  9. <style rel="stylesheet/scss" lang="sass"> 
  10.     @import "../../sass/home/index-info"; 
  11.     // 甚至可能在这@import面引入相对路径,这都会算是在组件里引入相对路径 
  12.     #bg h3 { 
  13.         background: url("../../assets/images/holmes.jpg"); 
  14.         color: #fff; 
  15.     } 
  16. </style>  

这个坑,真是不可描述,我个人尝试了各种体位,才把这个坑配置好。

直接给大家看最后实现是怎样的。

dev 的路径是这样,页面可以显示图片或字体。

build 后的路径是这样

这样就达到了开发和发布后的资源统一,摸索这一步真是挺累的 T.T,有兴趣的自己看源码吧。

环境变量的配置

我们在webpack中经常会遇见不同环境下不同配置的问题

首先可在package.json里配置一条script


 
 
  1. // package.json 
  2. "scripts": { 
  3.     "build": "NODE_ENV=production gulp build", 
  4.     "dev": "NODE_ENV=dev gulp reload" 
  5. },  

假设我们需要为不同环境配置不同的api请求地址,就可以利用我们在package.json设置的NODE_ENV来识别当前环境(这部分我在gulpfile中处理了,所以在文件里可直接识别NODE_ENV,如下)


 
 
  1. //  src/js/ajaxurl.js 
  2.   
  3. const server1 = 'https://production.server.com'; 
  4. const server2 = 'https://dev.server.com'; 
  5.  
  6. let useServer = null; 
  7. if(NODE_ENV === 'production') { 
  8.     useServer = server1; 
  9. } else if(NODE_ENV === 'dev') { 
  10.     useServer = server2; 
  11. } 
  12.  
  13. export default useServer; 
  14. // src/js/home/index.js 
  15.  
  16. import url from '../ajaxurl'; 
  17. console.log(url);  

这样就解决了我们不同环境下不同配置的问题,我默认配置了dev和production,大家可以自行拓展。比如

假设你需要在 开发中 配置测试,你可以写一条NODE_ENV=test gulp reload。

如果需要 预发布打包 测试,就可以另一条NODE_ENV=preproduction gulp build。

总之就是打包使用gulp build,开发使用gulp reload。

注意事项

开发:执行命令 npm run dev

发布:执行命令 npm run build (BTW,别忘了去gulpfile.js里替换你的CDN链接,进入gulp文件修改 const CDN = 'yourCDNLink'这里的变量即可)

命名一定要按约定来!

命名一定要按约定来!

命名一定要按约定来!

否则不知道要编译谁!!!

gulp配置很简单,大家可以看一下针对各自项目进行修改,不懂得可以直接问我。

如果你们不完全的前后端分离,把这个src直接放在后台目录下也没有问题。

写vue和react都没问题,我把示例demo都写好了,下面是分别两个的repo地址。

vue-multpage : https://github.com/MeCKodo/vue-multipage

react-multpage : https://github.com/MeCKodo/react-multipage

TODO

  • [ ] 项目的Unit test
  • [ ] 项目Cli脚手架

后话

本来是想写成vue-cli或者是create-react-app这种cli脚手架的,但是!本人真是太懒又没有时间了! 各位看官可以先尝试clone把玩把玩,如果有足够多人喜欢,我就把他写成cli,发布npm :)

我是用mac下开发完成的,用了半天多时间专门去给window写了兼容,window还可能会有bug,不是我说!window就是辣鸡!

最后给大家看下我们的某项目结构。

总览

js部分

sass部分

组件和页面



作者:二哲

来源:51CTO

相关文章
|
移动开发 前端开发 JavaScript
Vue与React两大前端框架的主要差异点
以上就是Vue和React的主要差异点,希望对你有所帮助。在选择使用哪一个框架时,需要根据项目的具体需求和团队的技术栈来决定。
905 83
|
存储 缓存 JavaScript
如何优化React或Vue应用的性能
需要注意的是,性能优化是一个持续的过程,需要根据具体的应用场景和性能问题进行针对性的优化。同时,不同的项目和团队可能有不同的优化重点和方法,要结合实际情况灵活运用这些优化策略,以达到最佳的性能效果。
913 158
|
JavaScript 前端开发 API
对比Vue框架与React库的主要区别
在选择Vue还是React时,考虑项目的需求、团队的熟悉程度和个人偏好至关重要。如果项目需要快速原型开发和较小的学习曲线,Vue可能是更好的选择。相反,如果项目需要更大的灵活性,或者项目团队已经有React的经验,那么React可能是更合适的选择。
721 13
|
缓存 前端开发 大数据
虚拟列表在Vue3中的具体应用场景有哪些?
虚拟列表在 Vue3 中通过仅渲染可视区域内容,显著提升大数据列表性能,适用于 ERP 表格、聊天界面、社交媒体、阅读器、日历及树形结构等场景,结合 `vue-virtual-scroller` 等工具可实现高效滚动与交互体验。
1365 1
|
JavaScript API 开发者
Vue框架中常见指令的应用概述。
通过以上的详细解析,你应该已经初窥Vue.js的指令的威力了。它们是Vue声明式编程模型的核心之一,无论是构建简单的静态网站还是复杂的单页面应用,你都会经常用到。记住,尽管Vue提供了大量预定义的指令,你还可以创建自定义指令以满足特定的需求。为你的Vue应用程序加上这些功能增强器,让编码变得更轻松、更愉快吧!
301 1
|
敏捷开发 人工智能 JavaScript
Figma-Low-Code:快速将Figma设计转换为Vue.js应用,支持低代码渲染、数据绑定
Figma-Low-Code 是一个开源项目,能够直接将 Figma 设计转换为 Vue.js 应用程序,减少设计师与开发者之间的交接时间,支持低代码渲染和数据绑定。
1957 3
Figma-Low-Code:快速将Figma设计转换为Vue.js应用,支持低代码渲染、数据绑定
|
JavaScript 前端开发 算法
vue和react 哪个更强大
vue和react 哪个更强大
568 3
|
缓存 NoSQL JavaScript
Vue.js应用结合Redis数据库:实践与优化
将Vue.js应用与Redis结合,可以实现高效的数据管理和快速响应的用户体验。通过合理的实践步骤和优化策略,可以充分发挥两者的优势,提高应用的性能和可靠性。希望本文能为您在实际开发中提供有价值的参考。
590 11
|
JavaScript 前端开发
【Vue.js】监听器功能(EventListener)的实际应用【合集】
而此次问题的核心就在于,Vue实例化的时机过早,在其所依赖的DOM结构尚未完整构建完成时就已启动挂载流程,从而导致无法找到对应的DOM元素,最终致使计算器功能出现异常,输出框错误地显示“{{current}}”,并且按钮的交互功能也完全丧失响应。为了让代码结构更为清晰,便于后续的维护与管理工作,我打算把HTML文件中标签内的JavaScript代码迁移到外部的JS文件里,随后在HTML文件中对其进行引用。
451 8