vue 文件目录结构详解


Posted in Javascript onNovember 24, 2017

项目简介

基于 vue.js 的前端开发环境,用于前后端分离后的单页应用开发,可以在开发时使用 ES Next、scss 等最新语言特性。项目包含:

  1. 基础库: vue.js、vue-router、vuex、whatwg-fetch
  2. 编译/打包工具:webpack、babel、node-sass
  3. 单元测试工具:karma、mocha、sinon-chai
  4. 本地服务器:express

目录结构

├── README.md            项目介绍
├── index.html           入口页面
├── build              构建脚本目录
│  ├── build-server.js         运行本地构建服务器,可以访问构建后的页面
│  ├── build.js            生产环境构建脚本
│  ├── dev-client.js          开发服务器热重载脚本,主要用来实现开发阶段的页面自动刷新
│  ├── dev-server.js          运行本地开发服务器
│  ├── utils.js            构建相关工具方法
│  ├── webpack.base.conf.js      wabpack基础配置
│  ├── webpack.dev.conf.js       wabpack开发环境配置
│  └── webpack.prod.conf.js      wabpack生产环境配置
├── config             项目配置
│  ├── dev.env.js           开发环境变量
│  ├── index.js            项目配置文件
│  ├── prod.env.js           生产环境变量
│  └── test.env.js           测试环境变量
├── mock              mock数据目录
│  └── hello.js
├── package.json          npm包配置文件,里面定义了项目的npm脚本,依赖包等信息
├── src               源码目录  
│  ├── main.js             入口js文件
│  ├── app.vue             根组件
│  ├── components           公共组件目录
│  │  └── title.vue
│  ├── assets             资源目录,这里的资源会被wabpack构建
│  │  └── images
│  │    └── logo.png
│  ├── routes             前端路由
│  │  └── index.js
│  ├── store              应用级数据(state)
│  │  └── index.js
│  └── views              页面目录
│    ├── hello.vue
│    └── notfound.vue
├── static             纯静态资源,不会被wabpack构建。
└── test              测试文件目录(unit&e2e)
  └── unit              单元测试
    ├── index.js            入口脚本
    ├── karma.conf.js          karma配置文件
    └── specs              单测case目录
      └── Hello.spec.js

环境安装

本项目依赖 node.js, 使用前先安装 node.js 和 cnpm(显著提升依赖包的下载速度)。

自行下载并安装 node.js: https://nodejs.org/en/download/

然后安装 cnpm 命令:

npm install -g cnpm --registry=https://registry.npm.taobao.org

快速开始

git clone https://github.com/hanan198501/vue-spa-template.git 
cd vue-spa-template
cnpm install
npm run dev

命令列表:

#开启本地开发服务器,监控项目文件的变化,实时构建并自动刷新浏览器,浏览器访问 http://localhost:8081
npm run dev

#使用生产环境配置构建项目,构建好的文件会输出到 "dist" 目录,
npm run build

#运行构建服务器,可以查看构建的页面
npm run build-server

#运行单元测试
npm run unit

前后端分离

项目基于 spa 方式实现前后端分离,服务器通过 nginx 区分前端页面和后端接口请求,分发到不同服务。前端物理上只有一个入口页面, 路由由前端控制(基于vue-router),根据不同的 url 加载相应数据和组件进行渲染。

接口 mock

前后端分离后,开发前需要和后端同学定义好接口信息(请求地址,参数,返回信息等),前端通过 mock 的方式,即可开始编码,无需等待后端接口 ready。 项目的本地开发服务器是基于 express 搭建的,通过 express 的中间件机制,我们已经在 dev-server 中添加了接口 mock 功能。 开发时,接口的 mock 数据统一放在 mock 目录下,每个文件内如下:

module.exports = {

 // 接口地址
 api: '/api/hello',

 // 返回数据 参考http://expressjs.com/zh-cn/4x/api.html
 response: function (req, res) {
  res.send(`
   <p>hello vue!</p>
  `);
 }
}

模块化

开发时可以使用 ES2015 module 语法,构建时每个文件会编译成 amd 模块。

组件化

整个应用通过 vue 组件的方式搭建起来,通过 vue-router 控制相应组件的展现,组件树结构如下:

app.vue             根组件(整个应用只有一个)
  ├──view1.vue          页面级组件,放在 views 目录里面,有子组件时,可以建立子目录
  │  ├──component1.vue        功能组件,公用的放在 components 目录,否则放在 views 子目录
  │  ├──component2.vue
  │  └──component3.vue
  ├──view2.vue
  │  ├──component1.vue
  │  └──component4.vue
  └──view3.vue
    ├──component5.vue
    ……

单元测试

可以为每个组件编写单元测试,放在 test/unit/specs 目录下面, 单元测试用例的目录结构建议和测试的文件保持一致(相对于src),每个测试用例文件名以 .spec.js结尾。 执行 npm run unit 时会遍历所有的 spec.js 文件,产出测试报告在 test/unit/coverage 目录。

联调方式

前后端分离后,由于服务端和前端的开发环境处于2台不同的机器上,前端的异步请求需要代理到后端机器中。 联调的时候,只需通过 proxy 参数运行 dev 脚本即可,所有 mock 目录下定义的接口将会转发到 proxy 参数指定的机器:

# 172.16.36.90:8083 为后端机器的环境地址
npm run dev -- --proxy=172.16.36.90:8083

这样,如果 mock 目录下有定义了接口 /api/hello ,将会转发到 http://172.16.36.90/:8083/api/hello

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
jQuery实现点击标题输入详细信息
Apr 16 Javascript
关于Javascript与iframe的那些事儿
Jul 04 Javascript
setTimeout()与setInterval()方法区别介绍
Dec 24 Javascript
javascript与有限状态机详解
May 08 Javascript
JavaScript实现信用卡校验方法
Apr 07 Javascript
JS实现双击屏幕滚动效果代码
Oct 28 Javascript
js+html5操作sqlite数据库的方法
Feb 02 Javascript
Bootstrap3 多个模态对话框无法显示的解决方案
Feb 23 Javascript
原生JavaScript实现的简单省市县三级联动功能示例
May 27 Javascript
jQuery实现左右滑动的toggle方法
Mar 03 jQuery
JS将网址url转化为JSON格式的方法
Jul 02 Javascript
vue实现的请求服务器端API接口示例
May 25 Javascript
获取本机IP地址的实例(JavaScript / Node.js)
Nov 24 #Javascript
js判断数组是否包含某个字符串变量的实例
Nov 24 #Javascript
最新Javascript程序员面试试题和解题方法
Nov 23 #Javascript
详解bootstrap导航栏.nav与.navbar区别
Nov 23 #Javascript
Vue添加请求拦截器及vue-resource 拦截器使用
Nov 23 #Javascript
bootstrap datetimepicker控件位置异常的解决方法
Nov 23 #Javascript
Bootstrap 3多级下拉菜单实例
Nov 23 #Javascript
You might like
用PHP实现的生成静态HTML速度快类库
2007/03/31 PHP
连接到txt文本的超链接,不直接打开而是点击后下载的处理方法
2009/07/01 PHP
PHP利用MySQL保存session的实现思路及示例代码
2014/09/09 PHP
centos+php+coreseek+sphinx+mysql之一coreseek安装篇
2016/10/25 PHP
详解PHP处理密码的几种方式
2016/11/30 PHP
PHP使用finfo_file()函数检测上传图片类型的实现方法
2017/04/18 PHP
laravel自定义分页效果
2017/07/23 PHP
php中输出json对象的值(实现方法)
2018/03/07 PHP
php设计模式之正面模式实例分析【星际争霸游戏案例】
2020/03/24 PHP
JavaScript While 循环基础教程
2007/04/05 Javascript
基于jQuery的简单的列表导航菜单
2011/03/02 Javascript
在javascript中对于DOM的加强
2013/04/11 Javascript
使用js画图之正弦曲线
2015/01/12 Javascript
JavaScript中将数组进行合并的基本方法讲解
2016/03/07 Javascript
vue高德地图之玩转周边
2017/06/16 Javascript
vue-music关于Player播放器组件详解
2017/11/28 Javascript
vuex 使用文档小结篇
2018/01/11 Javascript
jQuery Dom元素操作技巧
2018/02/04 jQuery
vscode下的vue文件格式化问题
2018/11/28 Javascript
详解如何在vscode里面调试js和node.js的方法步骤
2018/12/24 Javascript
用JS实现选项卡
2020/03/23 Javascript
vue video和vue-video-player实现视频铺满教程
2020/10/30 Javascript
HTML元素拖拽功能实现的完整实例
2020/12/04 Javascript
[05:20]卡尔工作室_DOTA2新手教学_DOTA2超强新手功能
2013/04/22 DOTA
[01:12]DOTA2 2015年秋季互动指南
2015/11/10 DOTA
在Python中操作列表之List.pop()方法的使用
2015/05/21 Python
python 使用matplotlib 实现从文件中读取x,y坐标的可视化方法
2019/07/04 Python
对python中的装包与解包实例详解
2019/08/24 Python
利用python计算时间差(返回天数)
2019/09/07 Python
Python异常处理机制结构实例解析
2020/07/23 Python
美国礼品卡交易网站:Cardpool
2018/08/27 全球购物
what is the difference between ext2 and ext3
2015/08/25 面试题
swtich是否能作用在byte上,是否能作用在long上,是否能作用在String上
2013/07/06 面试题
滴水洞导游词
2015/02/10 职场文书
2019暑假学生安全口号
2019/06/27 职场文书
《现实主义勇者的王国再建记》第三弹OST全曲试听片段公开
2022/04/04 日漫