资讯专栏INFORMATION COLUMN

vue-cli 项目结构

int64 / 2666人阅读

摘要:项目结构为我们搭建开发所需要的环境目录结构及主要功能项目构建相关代码生产环境构建代码检查等版本热重载相关构建本地服务器构建工具相关基础配置开发环境配置生产环境配置项目开发环境配置开发环境

Vue-cli 项目结构 vue-cli

为我们搭建开发所需要的环境

目录结构及主要功能
  |-- build                            // 项目构建(webpack)相关代码
  |   |-- build.js                     // 生产环境构建代码
  |   |-- check-version.js             // 检查node、npm等版本
  |   |-- dev-client.js                // 热重载相关
  |   |-- dev-server.js                // 构建本地服务器
  |   |-- utils.js                     // 构建工具相关
  |   |-- webpack.base.conf.js         // webpack基础配置
  |   |-- webpack.dev.conf.js          // webpack开发环境配置
  |   |-- webpack.prod.conf.js         // webpack生产环境配置
  |-- config                           // 项目开发环境配置
  |   |-- dev.env.js                   // 开发环境变量
  |   |-- index.js                     // 项目一些配置变量
  |   |-- prod.env.js                  // 生产环境变量
  |   |-- test.env.js                  // 测试环境变量
  |-- src                              // 源码目录
  |   |-- components                     // vue公共组件
  |   |-- store                          // vuex的状态管理
  |   |-- App.vue                        // 页面入口文件
  |   |-- main.js                        // 程序入口文件,加载各种公共组件
  |-- static                           // 静态文件,比如一些图片,json数据等
  |   |-- data                           // 群聊分析得到的数据用于数据可视化
  |-- .babelrc                         // ES6语法编译配置
  |-- .editorconfig                    // 定义代码格式
  |-- .gitignore                       // git上传需要忽略的文件格式
  |-- README.md                        // 项目说明
  |-- favicon.ico 
  |-- index.html                       // 入口页面
  |-- package.json                     // 项目基本信息
重要文件解释: 一、package.json

package.json文件是项目根目录下的一个文件,定义该项目开发所需要的各种模块以及一些项目配置信息.在项目根目录下运行npm i可以安装所需依赖包.
里面的scripts字段,定义了可以快速使用npm命令代替繁琐的命令执行文件,其中npm run dev相当于执行 node build/dev-server.js 也就是开启了一个node写的开发行建议服务器,是相关命令的缩写.

"scripts": {
    "dev": "node build/dev-server.js",
    "build": "node build/build.js"
}

dependencies字段:项目运行所依赖的模块;
devDependencies字段: 指定项目开发所依赖的模块;

二、webpack

dev-server.js

// 检查 Node 和 npm 版本
require("./check-versions")()

// 获取 config/index.js 的默认配置
var config = require("../config")

// 如果 Node 的环境无法判断当前是 dev / product 环境
// 使用 config.dev.env.NODE_ENV 作为当前的环境

if (!process.env.NODE_ENV) process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)

// 使用 NodeJS 自带的文件路径工具
var path = require("path")

// 使用 express
var express = require("express")

// 使用 webpack
var webpack = require("webpack")

// 一个可以强制打开浏览器并跳转到指定 url 的插件
var opn = require("opn")

// 使用 proxyTable
var proxyMiddleware = require("http-proxy-middleware")

// 使用 dev 环境的 webpack 配置
var webpackConfig = require("./webpack.dev.conf")

// default port where dev server listens for incoming traffic

// 如果没有指定运行端口,使用 config.dev.port 作为运行端口
var port = process.env.PORT || config.dev.port

// Define HTTP proxies to your custom API backend
// https://github.com/chimurai/http-proxy-middleware

// 使用 config.dev.proxyTable 的配置作为 proxyTable 的代理配置
var proxyTable = config.dev.proxyTable

// 使用 express 启动一个服务
var app = express()

// 启动 webpack 进行编译
var compiler = webpack(webpackConfig)

// 启动 webpack-dev-middleware,将 编译后的文件暂存到内存中
var devMiddleware = require("webpack-dev-middleware")(compiler, {
  publicPath: webpackConfig.output.publicPath,
  stats: {
    colors: true,
    chunks: false
  }
})

// 启动 webpack-hot-middleware,也就是我们常说的 Hot-reload
var hotMiddleware = require("webpack-hot-middleware")(compiler)
// force page reload when html-webpack-plugin template changes
compiler.plugin("compilation", function (compilation) {
  compilation.plugin("html-webpack-plugin-after-emit", function (data, cb) {
    hotMiddleware.publish({ action: "reload" })
    cb()
  })
})

// proxy api requests
// 将 proxyTable 中的请求配置挂在到启动的 express 服务上
Object.keys(proxyTable).forEach(function (context) {
  var options = proxyTable[context]
  if (typeof options === "string") {
    options = { target: options }
  }
  app.use(proxyMiddleware(context, options))
})

// handle fallback for HTML5 history API
// 使用 connect-history-api-fallback 匹配资源,如果不匹配就可以重定向到指定地址
app.use(require("connect-history-api-fallback")())

// serve webpack bundle output
// 将暂存到内存中的 webpack 编译后的文件挂在到 express 服务上
app.use(devMiddleware)

// enable hot-reload and state-preserving
// compilation error display
// 将 Hot-reload 挂在到 express 服务上
app.use(hotMiddleware)

// serve pure static assets
// 拼接 static 文件夹的静态资源路径
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 为静态资源提供响应服务
app.use(staticPath, express.static("./static"))

// 让我们这个 express 服务监听 port 的请求,并且将此服务作为 dev-server.js 的接口暴露
module.exports = app.listen(port, function (err) {
  if (err) {
    console.log(err)
    return
  }
  var uri = "http://localhost:" + port
  console.log("Listening at " + uri + "
")

  // when env is testing, don"t need open it
  // 如果不是测试环境,自动打开浏览器并跳到我们的开发地址
  if (process.env.NODE_ENV !== "testing") {
    opn(uri)
  }
})

webpack.base.config.js : webpack的基础配置文件

.babelrc : Babel解释器的配置文件,存放在根目录下、Babel是一个转码器,项目里需要用它将ES6代码转为ES5代码.
具体代码详解请翻到页面底部的引用地址...

.editorconfig : 该文件定义项目的编码规范,编译器的行为会与.editorconfig文件中定义的一致,并且其优先级比编译器自身的设置要高,这在多人合作开发项目时十分有用而且必要。

npm run build 命令
将写好的网页放到服务器上,运行该命令后,vue-cli会自动将项目打包,生成dist文件夹,这个文件夹就是我们要传到服务器上的文件.

main.js文件

main.js是整个项目的入口文件,位于src文件夹下

Vue.config.productionTip = false   //生产环境提示,这里设置成了false

这里面最陌生的文件就是这句话,其他都是vue.js和ES6的写法,不多说.

还有就是通过 import App from "./App" 引入了App组件.

app.vue文件
  
  
  

标签里面是html结构,是一个出口.
标签为js内容
为css内容,其中scoped声明样式只在模板中起作用.

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/89840.html

相关文章

  • almost最好的Vue + Typescript系列01 环境搭建篇

    摘要:初来乍到,请多多关照也许这是第一套基于搭建基于的项目教程。年月初升级到了新的版本版,跟版本项目结构发生了很大的改变,目录结构更简洁更科学。并且可以选配,在此之前配置略麻烦,是的超级,静态类型,便捷的注解,使前端代码优雅。 前言 hello~ 大家好。 初来乍到,请多多关照 ?(๑•̀ㅂ•́)و✧也许这是第一套基于 vue-cli 3.x 搭建基于 typescript 的vue项目教程...

    isLishude 评论0 收藏0
  • vue-cli@3.0和之前版本的差异

    摘要:记使用方式和之前版本的差异的使用下载和安装项目生成的目录结构以上,目前版本的使用下载和安装项目生成的目录结构新的目录结构,隐藏了配置文件,封装了细节对比个区别区别下载包的包命变化。貌似是之前的版本有点问题 记vue-cli@3.0使用方式和之前版本的差异 @2.9.3的使用 1.下载vue-cli和安装项目 cnpm i -g vue-cli#2.9.3 vue init webpa...

    wow_worktile 评论0 收藏0
  • vue-cli “从入门到放弃”

    摘要:主要作用目录结构本地调试代码部署热加载单元测试在如今前端技术飞速发展的时代,和作为前端框架已经呈现出了三国鼎立的局面。 主要作用:目录结构、本地调试、代码部署、热加载、单元测试 在如今前端技术飞速发展的时代,angular.js、vue.js 和 react.js 作为前端框架已经呈现出了三国鼎立的局面。作为国人若你不知道 vue,小生表示可以理解,如果作为中国的前端猿不知道 vue,...

    DrizzleX 评论0 收藏0
  • vue-cli “从入门到放弃”

    摘要:主要作用目录结构本地调试代码部署热加载单元测试在如今前端技术飞速发展的时代,和作为前端框架已经呈现出了三国鼎立的局面。 主要作用:目录结构、本地调试、代码部署、热加载、单元测试 在如今前端技术飞速发展的时代,angular.js、vue.js 和 react.js 作为前端框架已经呈现出了三国鼎立的局面。作为国人若你不知道 vue,小生表示可以理解,如果作为中国的前端猿不知道 vue,...

    william 评论0 收藏0
  • vue-cli “从入门到放弃”

    摘要:主要作用目录结构本地调试代码部署热加载单元测试在如今前端技术飞速发展的时代,和作为前端框架已经呈现出了三国鼎立的局面。 主要作用:目录结构、本地调试、代码部署、热加载、单元测试 在如今前端技术飞速发展的时代,angular.js、vue.js 和 react.js 作为前端框架已经呈现出了三国鼎立的局面。作为国人若你不知道 vue,小生表示可以理解,如果作为中国的前端猿不知道 vue,...

    Joyven 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<