图解Vue.js项目及其目录结构

2 篇文章 0 订阅

  项目包含:

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

build:最终发布的代码的存放位置。
  config:配置路径、端口号等一些信息,我们刚开始学习的时候选择默认配置。
  node_modules:npm 加载的项目依赖模块。
  src:这里是我们开发的主要目录,基本上要做的事情都在这个目录里面,里面包含了几个目录及文件:
  assets:放置一些图片,如logo等
  components:目录里放的是一个组件文件,可以不用。
   App.vue:项目入口文件,我们也可以将组件写这里,而不使用components目录。
   main.js :项目的核心文件
   static:静态资源目录,如图片、字体等。
   test:初始测试目录,可删除
   .XXXX文件:配置文件。
   index.html:首页入口文件,可以添加一些meta信息或者同统计代码啥的。
   package.json:项目配置文件。
   README.md:项目的说明文件。

 

目录结构

  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.  
  4. #使用生产环境配置构建项目,构建好的文件会输出到 "dist" 目录,

  5. npm run build

  6.  
  7. #运行构建服务器,可以查看构建的页面

  8. npm run build-server

  9.  
  10. #运行单元测试

  11. npm run unit

前后端分离

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

接口 mock

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

  1. module.exports = {

  2.  
  3. // 接口地址

  4. api: '/api/hello',

  5.  
  6. // 返回数据 参考http://expressjs.com/zh-cn/4x/api.html

  7. response: function (req, res) {

  8. res.send(`

  9. <p>hello vue!</p>

  10. `);

  11. }

  12. }

  13.  

模块化

开发时可以使用 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. # 192.168.36.90:8088 为后端机器的环境地址

  2. npm run dev -- --proxy=192.168.36.90:8088

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

è¿éåå¾çæè¿°

运行项目:

  • 1.cd project-name

  • 2.npm install

  • 3.npm run dev

  • 4.在浏览器输入localhost:8080

  •  

  • main.js 是我们的入口文件,主要作用是初始化vue实例并使用需要的插件
 
  1. import Vue from 'vue'

  2. import App from './App'

  3.  
  4. /* eslint-disable no-new */

  5. new Vue({

  6. el: '#app',

  7. template: '<App/>',

  8. components: { App }

  9. })

  • App.vue是我们的主组件,所有页面都是在App.vue下进行切换的。其实你也可以理解为所有的路由也是App.vue的子组件。所以我将router标示为App.vue的子组件。
<template>
  <div id="app">
    <img src="./assets/logo.png">
    <hello></hello>
  </div>
</template>
 
<script>
import Hello from './components/Hello'
 
export default {
  name: 'app',
  components: {
    Hello
  }
}
</script>
 
<style>
#app {
  font-family: 'Avenir', Helvetica, Arial, sans-serif;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  text-align: center;
  color: #2c3e50;
  margin-top: 60px;
}
</style>
--------------------- 

来源:CSDN 
原文:https://blog.csdn.net/lhy2199/article/details/81710673 
版权声明:本文为博主原创文章,转载请附上博文链接!
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值