Vue項目打包部署的實戰(zhàn)過程記錄

更新時間：2021年09月29日 11:45:24 作者：MuMa

我們使用nginx部署Vue項目,實質(zhì)上就是將Vue項目打包后的內(nèi)容同步到nginx指向的文件夾,下面這篇文章主要給大家介紹了關(guān)于Vue項目打包部署的相關(guān)資料,需要的朋友可以參考下

前言

使用Vue做前后端分離項目時，通常前端是單獨部署，用戶訪問的也是前端項目地址，因此前端開發(fā)人員很有必要熟悉一下項目部署的流程與各類問題的解決辦法了。Vue項目打包部署本身不復雜，不過一些前端同學可能對服務(wù)器接觸不多，部署過程中還是會遇到這樣那樣的問題。本文介紹一下使用nginx服務(wù)器代理前端項目的方法以及項目部署的相關(guān)問題，內(nèi)容概覽：

一、準備工作——服務(wù)器和nginx使用

1. 準備一臺服務(wù)器

我的是ubuntu系統(tǒng)，linux系統(tǒng)的操作都差不多。沒有服務(wù)器怎么破？

如果你只是想體驗一下，可以嘗試各大廠的云服務(wù)器免費試用套餐，比如華為云免費試用，本文相關(guān)操作即是在華為云上完成的。不過如果想時常練練手，我覺得可以購買一臺云服務(wù)器，比如上面的華為云或者阿里云都還挺可靠。我的個人網(wǎng)站就是部署在阿里云，你可以點擊我的推廣鏈接進行購買，近期有活動首次購買不到100塊/年。

2. nginx安裝和啟動

輕裝簡行，這部分不作過多贅述（畢竟網(wǎng)上相關(guān)教程一大堆），正常情況下僅需下面兩個指令：

# 安裝，安裝完成后使用nginx -v檢查，如果輸出nginx的版本信息表明安裝成功
sudo apt-get install nginx
# 啟動
sudo service nginx start

啟動后，正常情況下，直接訪問 http://服務(wù)器ip 或 http://域名（本文測試用的服務(wù)器沒有配置域名，所以用ip，就本文而言，域名和ip沒有太大區(qū)別）應該就能看到nginx服務(wù)器的默認頁面了——如果訪問不到，有可能是你的云服務(wù)器默認的http服務(wù)端口（80端口）沒有對外開放，在服務(wù)器安全組配置一下即可。

3. 了解nginx: 修改nginx配置，讓nginx服務(wù)器代理我們創(chuàng)建的文件

查看nginx的配置，linux系統(tǒng)下的配置文件通常會存放在/etc目錄下，nginx的配置文件就在/etc/nginx文件夾，打開文件/etc/nginx/sites-available/default（nginx可以有多個配置文件，通常我們配置nginx也是修改這個文件）：

可以看到默認情況下，nginx代理的根目錄是/var/www/html，輸入 http://服務(wù)器ip會訪問這個文件夾下的文件，會根據(jù)index的配置值來找默認訪問的文件，比如index.html、index.htm之類。

我們可以更改root的值來修改nginx服務(wù)代理的文件夾：

創(chuàng)建文件夾/www，并創(chuàng)建index.html，寫入"Hello world"字符串

mkdir /www
echo 'Hello world' > /www/index.html

修改root值為 /www

sudo nginx -t 檢查nginx配置是否正確

加載nginx配置：sudo nginx -s reload

再次訪問頁面，發(fā)現(xiàn)頁面內(nèi)容已經(jīng)變成了我們創(chuàng)建的index.html:

二、Vue項目打包同步文件到遠程服務(wù)器

1. 打包

默認情況下，使用vue-cli創(chuàng)建的項目，package.json里的script應該已經(jīng)配置了build指令，直接執(zhí)行yarn build 或者 npm run build即可。

2. 同步到遠程服務(wù)器

我們使用nginx部署Vue項目，實質(zhì)上就是將Vue項目打包后的內(nèi)容同步到nginx指向的文件夾。之前的步驟已經(jīng)介紹了怎樣配置nginx指向我們創(chuàng)建的文件夾，剩下的問題就是怎么把打包好的文件同步到服務(wù)器上指定的文件夾里，比如同步到之前步驟中創(chuàng)建的/www。同步文件可以在git-bash或者powershell使用scp指令，如果是linux環(huán)境開發(fā)，還可以使用rsync指令:

scp -r dist/* root@117.78.4.26:/www
或
rsync -avr --delete-after dist/* root@117.78.4.26:/www

注意這里以及后續(xù)步驟是root使用用戶遠程同步，應該根據(jù)你的具體情況替換root和ip(ip換為你自己的服務(wù)器IP)。

為了方便，可以在package.json腳本中加一個push命令，以使用yarn為例（如果你使用npm，則push命令中yarn改成npm run即可）：

 "scripts": {
    "build": "vue-cli-service build",
    "push": "yarn build && scp -r dist/* root@117.78.4.26:/www"
  },

這樣就可以直接執(zhí)行yarn push 或者npm run push直接發(fā)布了。不過還有一個小問題，就是命令執(zhí)行的時候要求輸入遠程服務(wù)器的root密碼（這里使用root來連接遠程的，你可以用別的用戶，畢竟root用戶權(quán)限太高了）。

為了避免每次執(zhí)行都要輸入root密碼，我們可以將本機的ssh同步到遠程服務(wù)器的authorized_keys文件中。

3. 同步ssh key

生成ssh key：使用git bash或者powershell執(zhí)行ssh-keygen可以生成ssh key。會詢問生成的key存放地址，直接回車就行，如果已經(jīng)存在，則會詢問是否覆蓋：

同步ssh key到遠程服務(wù)器，使用ssh-copy-id指令同步

ssh-copy-id -i ~/.ssh/id_rsa.pub root@117.78.4.26

輸入密碼后，之后再次同步就不需要輸入密碼了。其實ssh_key是同步到了服務(wù)器（此處是root用戶家目錄）~/.ssh/authorized_keys文件里：

當然你也可以手動復制本地~/.ssh/id_rsa.pub（注意是pub結(jié)尾的公鑰）文件內(nèi)容追加到服務(wù)器~/.ssh/authorized_keys的后面（從命名可以看出該文件可以存儲多個ssh key）

注意：這里全程使用的是root用戶，所以沒有文件操作權(quán)限問題。如果你的文件夾創(chuàng)建用戶不是遠程登錄用戶，或許會存在同步文件失敗的問題，此時需要遠程服務(wù)器修改文件夾的讀寫權(quán)限（命令 chmod）。

創(chuàng)建了一個測試項目（點擊本鏈接可以在gihub查看）[1]試一下，打包、文件上傳一句指令搞定啦：

訪問一下，果然看到了我們熟悉的界面：

至此，常規(guī)情況下發(fā)布Vue項目就介紹完了，接下來介紹非域名根路徑下發(fā)布以及history路由模式發(fā)布方法。

三、非域名根路徑發(fā)布

有時候同一臺服務(wù)器同一端口下可能會根據(jù)目錄劃分出多個不同的項目，比如我們希望項目部署到http://a.com/test下，這樣訪問http://a.com/test訪問到的是項目的首頁，而非test前綴的地址會訪問到其它項目。此時需要修改nginx配置以及Vue打包配置。

1. nginx配置

只需要添加一條location規(guī)則，分配訪問路徑和指定訪問文件夾。我們可以把/test指向之前創(chuàng)建的/www文件夾，這里因為文件夾名稱和訪問路徑不一致，需要用到alias這個配置：

如果文件夾名稱與訪問路徑一致都為test，那這里可以用root來配置：

這里要將/test配置放到/之前，意味著在路由進入的時候，會優(yōu)先匹配/test。如果根路徑/下的項目有子路由/test，那http://xxxx/test只會訪問到/www里的項目，而不會訪問該子路由。

2. 項目配置

為了解決打包后資源路徑不對的問題，需要在vue.config.js中配置publicPath，這里有兩種配置方式，分別將publicPath配置為./和/test：

更新nginx配置，發(fā)布后即可正常訪問啦。這里的兩種配置方式是有區(qū)別的，接下來會看一下它們的區(qū)別。如果不進行項目配置，直接發(fā)布訪問會出現(xiàn)JS、CSS等資源找不到導致頁面空白的問題：

該問題原因是資源引用路徑不對，頁面審查元素可以看到，頁面引用的js都是從根路徑下引用的：

查看打包后的文件結(jié)構(gòu)，可以看到j(luò)s/css/img/static等資源文件是與index.html處于同級別的：

對于兩種配置方式，看看都是怎么生效的：

publicPath配置為./，打包后資源引用路徑為相對路徑：

publicPath配置為/test，打包后資源相對路徑為從域名根目錄開始的絕對路徑：

兩種配置都可以正確地找到JS、CSS等資源。不過還有個問題，那就是static中的靜態(tài)資源依舊會找不到。

3. 絕對路徑引用的靜態(tài)資源找不到的問題

因為在打包過程中，public下的靜態(tài)資源都不會被webpack處理，我們需要通過絕對路徑來引用它們。當項目部署到非域名根路徑上時，這點非常頭疼，你需要在每個引用的URL前面加上process.env.BASE_URL（該值即對應上文配置的publicPath），以使得資源能被正常訪問到。我們可以在main.js把這個變量值綁定到Vue.prototype，這樣每個Vue組件都可以使用它：

Vue.prototype.$pb = process.env.BASE_URL

在模板中使用：

<img :src="`${$pb}static/logo.png`">

然而，更加頭疼并且沒有良好解決方案的問題是在組件style部分使用public文件夾下的靜態(tài)資源：

如果需要使用圖片等作為背景圖片等，盡量使用內(nèi)聯(lián)方式使用吧，像在模板中使用一樣。
如果需要引入樣式文件，則在index.html中使用插值方式引入吧。

關(guān)于靜態(tài)資源的問題，vue-cli的推薦是盡量**將資源作為你的模塊依賴圖的一部分導入（即放到assets中，使用相對路徑引用），**避免該問題的同時也帶來其它好處：

四、history模式部署

默認情況下，Vue項目使用的是hash路由模式，就是URL中會包含一個#號的這種形式。#號以及之后的內(nèi)容是路由地址的hash部分。正常情況下，當瀏覽器地址欄地址改變，瀏覽器會重新加載頁面，而如果是hash部分修改的話，則不會，這就是前端路由的原理，允許根據(jù)不同的路由頁面局部更新而不刷新整個頁面。H5新增了history的pushState接口，也允許前端操作改變路由地址但是不觸發(fā)頁面刷新，history模式即利用這一接口來實現(xiàn)。因此使用history模式可以去掉路由中的#號。