vue 文件目录详解

项目简介

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

  • 基础库: vue.jsvue-routervuexwhatwg-fetch
  • 编译/打包工具:webpackbabelnode-sass
  • 单元测试工具:karmamochasinon-chai
  • 本地服务器:express

目录结构


   
   
  1. ├── README .md 项目介绍
  2. ├── index .html 入口页面
  3. ├── build 构建脚本目录
  4. │   ├── build-server .js 运行本地构建服务器,可以访问构建后的页面
  5. │   ├── build .js 生产环境构建脚本
  6. │   ├── dev-client .js 开发服务器热重载脚本,主要用来实现开发阶段的页面自动刷新
  7. │   ├── dev-server .js 运行本地开发服务器
  8. │   ├── utils .js 构建相关工具方法
  9. │   ├── webpack .base .conf .js wabpack基础配置
  10. │   ├── webpack .dev .conf .js wabpack开发环境配置
  11. │   └── webpack .prod .conf .js wabpack生产环境配置
  12. ├── config 项目配置
  13. │   ├── dev .env .js 开发环境变量
  14. │   ├── index .js 项目配置文件
  15. │   ├── prod .env .js 生产环境变量
  16. │   └── test .env .js 测试环境变量
  17. ├── mock mock数据目录
  18. │   └── hello .js
  19. ├── package .json npm包配置文件,里面定义了项目的 npm脚本,依赖包等信息
  20. ├── src 源码目录
  21. │   ├── main .js 入口 js文件
  22. │   ├── app .vue 根组件
  23. │ ├── components 公共组件目录
  24. │   │   └── title .vue
  25. │   ├── assets 资源目录,这里的资源会被 wabpack构建
  26. │   │   └── images
  27. │   │   └── logo .png
  28. │   ├── routes 前端路由
  29. │   │   └── index .js
  30. │   ├── store 应用级数据( state
  31. │   │   └── index .js
  32. │   └── views 页面目录
  33. │   ├── hello .vue
  34. │   └── notfound .vue
  35. ├── static 纯静态资源,不会被 wabpack构建。
  36. └── test 测试文件目录( unit& e2e
  37. └── unit 单元测试
  38. ├── index .js 入口脚本
  39. ├── karma .conf .js karma配置文件
  40. └── specs 单测 case目录
  41. └── Hello .spec .js

环境安装

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

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

  2. 然后安装 cnpm 命令:

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

快速开始


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

命令列表:


   
   
  1. #开启本地开发服务器,监控项目文件的变化,实时构建并自动刷新浏览器,浏览器访问 http://localhost:8081
  2. npm run dev
  3. #使用生产环境配置构建项目,构建好的文件会输出到 "dist" 目录,
  4. npm run build
  5. #运行构建服务器,可以查看构建的页面
  6. npm run build-server
  7. #运行单元测试
  8. npm run unit

前后端分离

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

接口 mock

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


   
   
  1. module.exports = {
  2. // 接口地址
  3. api: '/api/hello',
  4. // 返回数据 参考http://expressjs.com/zh-cn/4x/api.html
  5. response: function (req, res) {
  6. res.send( `
  7. <p>hello vue!</p>
  8. `);
  9. }
  10. }

模块化

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

组件化

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


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

单元测试

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

联调方式

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


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

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

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值