1. 程式人生 > >vue-cli 搭建

vue-cli 搭建

text 項目結構 ons 檢查 並且 route 語法 編譯 方法

一、安裝vue-cli

安裝vue-cli的前提是你已經安裝了npm,安裝npm你可以直接下載node的安裝包進行安裝。你可以在命令行工具裏輸入npm -v 檢測你是否安裝了npm和版本情況。出現版本號說明你已經安裝了npm和node,我這裏的npm版本為3.10.10。如果該命令不可以使用,需要安裝node軟件包,根據你的系統版本選擇下載安裝就可以了。

下載地址:http://nodejs.cn/download/

技術分享圖片

npm沒有問題,接下來我們可以用npm 命令安裝vue-cli了,在命令行輸入下面的命令:

npm install vue-cli -g

-g :代表全局安裝。如果你安裝時報錯,一般是網絡問題,你可以嘗試用cnpm來進行安裝。安裝完成後,可以用vue -V來進行查看 vue-cli的版本號。註意這裏的V是大寫的。我這裏版本號是2.8.1.

技術分享圖片

如果vue -V的命令管用了,說明已經順利的把vue-cli安裝到我們的計算機裏了。

二、初始化項目

我們用vue init命令來初始化項目,具體看一下這條命令的使用方法。

$ vue init <template-name> <project-name>

init:表示我要用vue-cli來初始化項目

vue init webpack vuecliTest

輸入命令後,會詢問我們幾個簡單的選項,我們根據自己的需要進行填寫就可以了。 

  • Project name :項目名稱 ,如果不需要更改直接回車就可以了。註意:這裏不能使用大寫,所以我把名稱改成了vueclitest
  • Project description:項目描述,默認為A Vue.js project,直接回車,不用編寫。
  • Author:作者,如果你有配置git的作者,他會讀取。
  • Install vue-router? 是否安裝vue的路由插件,我們這裏需要安裝,所以選擇Y
  • Use ESLint to lint your code? 是否用ESLint來限制你的代碼錯誤和風格。我們這裏不需要輸入n,如果你是大型團隊開發,最好是進行配置。
  • setup unit tests with Karma + Mocha? 是否需要安裝單元測試工具Karma+Mocha,我們這裏不需要,所以輸入n。
  • Setup e2e tests with Nightwatch?是否安裝e2e來進行用戶行為模擬測試,我們這裏不需要,所以輸入n。

技術分享圖片

命令行出現上面的文字,說明我們已經初始化好了第一步。命令行提示我們現在可以作的三件事情。

1、cd vuecliTest 進入我們的vue項目目錄。

2、npm install 安裝我們的項目依賴包,也就是安裝package.json裏的包,如果你網速不好,你也可以使用cnpm來安裝。

3、npm run dev
  發模式下運行我們的程序。給我們自動構建了開發用的服務器環境和在瀏覽器中打開,並實時監視我們的代碼更改,即時呈現給我們。

第2節: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文件是項目根目錄下的一個文件,定義該項目開發所需要的各種模塊以及一些項目配置信息(如項目名稱、版本、描述、作者等)。

package.json 裏的scripts字段,這個字段定義了你可以用npm運行的命令。在開發環境下,在命令行工具中運行npm run dev 就相當於執行 node build/dev-server.js .也就是開啟了一個node寫的開發行建議服務器。由此可以看出script字段是用來指定npm相關命令的縮寫。

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

dependencies字段和devDependencies字段

  • 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 + ‘\n‘)
 
  // when env is testing, don‘t need open it
  // 如果不是測試環境,自動打開瀏覽器並跳到我們的開發地址
  if (process.env.NODE_ENV !== ‘testing‘) {
    opn(uri)
  }
})

webpack.base.confg.js webpack的基礎配置文件

module.export = {
    // 編譯入口文件
    entry: {},
    // 編譯輸出路徑
    output: {},
    // 一些解決方案配置
    resolve: {},
    resolveLoader: {},
    module: {
        // 各種不同類型文件加載器配置
        loaders: {
        ...
        ...
        // js文件用babel轉碼
        {
            test: /\.js$/,
            loader: ‘babel‘,
            include: projectRoot,
            // 哪些文件不需要轉碼
            exclude: /node_modules/
        },
        ...
        ...
        }
    },
    // vue文件一些相關配置
    vue: {}
}

第3節:解讀Vue-cli的模板

一、npm run build 命令

有小夥伴問我,如何把寫好的Vue網頁放到服務器上,那我就在這裏講解一下,主要的命令就是要用到npm run build 命令。我們在命令行中輸入npm run build命令後,vue-cli會自動進行項目發布打包。你在package.json文件的scripts字段中可以看出,你執行的npm run build命令就相對執行的 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的組件和<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文件我們可以分成三部分解讀,

  • <template></template>標簽包裹的內容:這是模板的HTMLDom結構,裏邊引入了一張圖片和<router-view></router-view>標簽,<router-view>標簽說明使用了路由機制。我們會在以後專門拿出一篇文章講Vue-router。
  • <script></script>標簽包括的js內容:你可以在這裏些一些頁面的動態效果和Vue的邏輯代碼。
  • <style></style>標簽包裹的css內容:這裏就是你平時寫的CSS樣式,對頁面樣子進行裝飾用的,需要特別說明的是你可以用<style scoped></style>來聲明這些css樣式只在本模板中起作用。

四、router/index.js 路由文件

引文在app.vue中我們看到了路由文件,雖然router的內容比較多,但是我們先簡單的看一下。下篇文章我們就開始講Vue-router。

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><script><style>三個部分,以後我們大部分的工作都是寫這些.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>

總結:

這個教程只是帶著你大概瀏覽和重點講解了vue-cli的知識,如果你想完全弄明白vue-cli,我建議最好是有調理的閱讀所有代碼,這對你以後成為vue實際項目 的開發很有幫助。如果你是一個初學者,了解這些已經足夠向下學習了。這篇教程結束後,我們會學習vue-router的知識,vue-router是一個重點學習任務,我會竭盡所能把路由的知識都講透。很高興大家能和我一起學習,我們下篇教程見了。

vue-cli 搭建