Vue.js 專案目錄結構
Vue環境搭建
和其他前端開發一樣,Vue.js的開發環境也需要Node.js、npm和webpack等工具的支援。其中,Node.js 就是執行在服務端的JavaScript,npm是一個包管理工具,用來管理Vue.js專案所依賴的包,而webpack則是前端一個常用的模組化打包工具,它的作用就是將JavaScript程式碼或者其他靜態檔案進行分析和壓縮,最終合併打包成瀏覽器可以識別的程式碼。
安裝Node
安裝Node.js有多種方式,最簡單的方式是直接從Node.js官網下載可執行安裝程式直接安裝。如果是Mac環境,還可以使用Homebrew進行安裝,安裝的命令如下:
brew install node
通常,安裝Node.js後npm包管理工具也會隨之安裝。安裝完成後,可以使用node -v命令來檢測是否安裝成功。
安裝webpack
webpack是前端一個常用的模組化打包工具,需要在專案目錄中安裝,安裝命令如下:
npm install webpack --save
安裝vue-cli
vue-cli是一個Vue.js腳手架命令列工具,安裝的命令如下:
npm install -g @vue/cli
yarn global add @vue/cli-init
接下來,就可以vue-cli腳手架工具提供的vue init命令來初始化一個Vue.js專案,命令如下:
vue init <template-name> <project-name>
其中,init是用來初始化一個vue專案的,template-name是vue-cli官方為開發者提供的5種模板,分別是webpack、webpack-simple、browserify、browserify-simple和simple。
-
webpack:webpack+vue-loader功能全面的模板,支援的功能包括熱載入、linting檢測和css擴充套件;
-
webpack-simple:webpack+vue-loader實現的簡單模板,用於快速搭建vue開發環境;
-
browserify:browserify+vueify實現的功能全面的模板,支援的功能包括熱載入、linting和單元檢測;
-
browserify-simple:browserify+vueify實現的簡單模板,用於快速搭建vue的開發環境;
-
simple:一個最簡單的單頁應用模板;
Vue專案結構
vue-cli腳手架工具就是為我們搭建了開發所需要的環境,為我們省去了很多精力,版本2.0和3.0的專案結構有所區別。下面是2.0的專案結構:
-- 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 // 專案基本資訊
而3.0的目錄結構則是下面這樣的:
|-- .node_modules
|-- .public
|-- .src
| |--.babelrc
| |--.editorconfig
| |--.gitignore
| |--babel.config.js
| |--index.html
| |--package.json
| |--package-lock.json
|-- .README.md
|-- .webpack.config.js
package.json
package.json檔案是專案根目錄下的一個檔案,定義該專案開發所需要的各種模組以及一些專案配置資訊(如專案名稱、版本、描述、作者等)。
package.json 裡的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欄位則用於指定專案開發時所依賴的模組。在命令列中執行“npm install”命令,會自動安裝dependencies和devDempendencies欄位中的模組。
webpack配置
dev-server.js
下面來看一下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 + '\n')
// when env is testing, don't need open it
// 如果不是測試環境,自動開啟瀏覽器並跳到我們的開發地址
if (process.env.NODE_ENV !== 'testing') {
opn(uri)
}
})
webpack.base.confg.js
再來看一下webpack.base.confg.js的基礎配置。
module.export = {
// 編譯入口檔案
entry: {},
// 編譯輸出路徑
output: {},
// 一些解決方案配置
resolve: {},
resolveLoader: {},
module: {
// 各種不同型別檔案載入器配置
loaders: {
...
...
// js檔案用babel轉碼
{
test: /\.js$/,
loader: 'babel',
include: projectRoot,
// 哪些檔案不需要轉碼
exclude: /node_modules/
},
...
...
}
},
// vue檔案一些相關配置
vue: {}
}
當然,作為一個專業的打包工具,webpack的內容遠不如這些,可以通過
webpack官方文件來了解更多的內容。
babelrc
babel直譯器的配置檔案,存放在根目錄下,babel是一個轉碼器,專案裡需要用它將ES6程式碼轉為ES5程式碼。
{
//設定轉碼規則
"presets": [
["env", { "modules": false }],
"stage-2"
],
//轉碼用的外掛
"plugins": ["transform-runtime"],
"comments": false,
//對BABEL_ENV或者NODE_ENV指定的不同的環境變數,進行不同的編譯操作
"env": {
"test": {
"presets": ["env", "stage-2"],
"plugins": [ "istanbul" ]
}
}
}
editorconfig
該檔案定義專案的編碼規範,編譯器的行為會與.editorconfig檔案中定義的一致,並且其優先順序比編譯器自身的設定要高,這在多人合作開發專案時十分有用而且必要。例如:
root = true
[*] // 對所有檔案應用下面的規則
charset = utf-8 // 編碼規則用utf-8
indent_style = space // 縮排用空格
indent_size = 2 // 縮排數量為2個空格
end_of_line = lf // 換行符格式
insert_final_newline = true // 是否在檔案的最後插入一個空行
trim_trailing_whitespace = true // 是否刪除行尾的空格
Vue-cli模板
當我們執行命令“npm run build” 命令後,vue-cli會自動進行專案釋出打包,該命令最終執行的 是node build/build.js的命令 ,也即是package.json的scripts 欄位內容。
"scripts": {
"dev": "node build/dev-server.js",
"build": "node build/build.js"
},
在執行完npm run build命令後,在你的專案根目錄生成了dist資料夾,這個資料夾裡邊就是我們要傳到伺服器上的檔案。dist資料夾下目錄包括:
- index.html 主頁檔案:因為我們開發的是單頁web應用,所以說一般只有一個html檔案。
- static 靜態資原始檔夾:裡邊js、CSS和一些圖片。
main.js
main.js是整個專案的入口檔案,在src資料夾下,原始碼如下:
import Vue from 'vue'
import App from './App'
import router from './router'
Vue.config.productionTip = false //生產環境提示,這裡設定成了false
/* eslint-disable no-new */
new Vue({
el: '#app',
router,
template: '<App/>',
components: { App }
})
通過程式碼可以看出這裡引進了App的元件和的模板,它是通過 import App from ‘./App’這句程式碼引入的。
App.vue
App.vue是示例專案的主要檔案,原始碼如下:
<template>
<div id="app">
<img src="./assets/logo.png">
<router-view></router-view>
</div>
</template>
<script>
export default {
name: 'app'
}
</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>
app.vue檔案主要由三部分組成:
- 標籤包裹的內容:這是模板的HTMLDom結構,裡邊引入了一張圖片和標籤,標籤說明使用了路由機制。我們會在以後專門拿出一篇文章講Vue-router。
- 標籤包括的js內容:你可以在這裡些一些頁面的動態效果和Vue的邏輯程式碼。
- css樣式:只在本模板中起作用。
路由檔案
router/index.js是專案的路由檔案,原始碼如下:
import Vue from 'vue'
import Router from 'vue-router'
import Hello from '@/components/Hello'
Vue.use(Router)
export default new Router({
routes: [
{
path: '/',
name: 'Hello',
component: Hello
}
]
})
可以看到, import Hello from ‘@/components/Hello’這句話, 檔案引入了/components/Hello.vue檔案。這個檔案裡就配置了一個路由,就是當我們訪問網站時給我們顯示Hello.vue的內容。
Hello.vue
就是我們看到的歡迎介面。
<template>
<div class="hello">
<h1>{{ msg }}</h1>
<h2>Essential Links</h2>
<ul>
<li><a href="https://vuejs.org" target="_blank">Core Docs</a></li>
<li><a href="https://forum.vuejs.org" target="_blank">Forum</a></li>
<li><a href="https://gitter.im/vuejs/vue" target="_blank">Gitter Chat</a></li>
<li><a href="https://twitter.com/vuejs" target="_blank">Twitter</a></li>
<br>
<li><a href="http://vuejs-templates.github.io/webpack/" target="_blank">Docs for This Template</a></li>
</ul>
<h2>Ecosystem</h2>
<ul>
<li><a href="http://router.vuejs.org/" target="_blank">vue-router</a></li>
<li><a href="http://vuex.vuejs.org/" target="_blank">vuex</a></li>
<li><a href="http://vue-loader.vuejs.org/" target="_blank">vue-loader</a></li>
<li><a href="https://github.com/vuejs/awesome-vue" target="_blank">awesome-vue</a></li>
</ul>
</div>
</template>
<script>
export default {
name: 'hello',
data () {
return {
msg: 'Welcome to Your Vue.js App'
}
}
}
</script>
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
h1, h2 {
font-weight: normal;
}
ul {
list-style-type: none;
padding: 0;
}
li {
display: inline-block;
margin: 0 10px;
}
a {
color: #42b983;
}
</style>