Vue專案部署遇到的問題及解決方案
寫在前面
Vue-Router
有兩種模式,預設是 hash
模式,另外一種是 history
模式。
- hash:也就是位址列裡的
#
符號。比如http://www.example/#/hello
,hash 的值為#/hello
。特點:hash 雖然出現 URL 中,但不會被包含在 HTTP 請求中,對後端不會產生什麼影響,改變 URL 不會過載頁面。 - history:利用了 HTML5 History Interface 中新增的
pushState()
和replaceState()
方法,來完成 URL 跳轉而無須重新載入頁面。(需要特定瀏覽器支援)
hash 和 history 兩種模式都是基於瀏覽器
vue-router
只是利用了這兩個特性(底層還是瀏覽器提供的介面)來實現前端路由。
使用場景
一般來說,兩種模式都是可以的。除非在意不太漂亮的 #
,只能選擇 history。
這兩種模式在開發環境下都沒有什麼太大的問題,但是當部署到生產環境中後,兩者有所不同。
hash 模式部署沒有什麼問題,只要訪問到伺服器上的 index.html,就可以訪問網站了。
history 模式下,前端的 URL 必須和實際向後端發起請求的 URL 一致,如 http://www.example.com/user/id
。如果後端缺少對 /user/id
的路由處理,將返回 404 錯誤。
不過這種模式要玩好,還需要後臺配置支援……所以呢,你要在服務端增加一個覆蓋所有情況的候選資源:如果 URL 匹配不到任何靜態資源,則應該返回同一個 index.html 頁面,這個頁面就是你 app 依賴的頁面。-Vue-Router, vue、react等單頁面專案應該這樣子部署到伺服器
問題起因
在做「年度賬單」專案的時候,專案部署的時候,用的是 hash 模式。APP安卓端分享出去的連結對於 #
做了特殊處理,encode 轉義成了 %23
,所以路由只能換成 history 的模式。
因此,現把解決的思路總結下,雖然 官網 上給出瞭解決方案,但在實際的編碼中也遇到了一些問題。
根目錄下
當專案在根目錄下部署的時候(如 http://www.example.com/
),vue
的相關檔案預設不需要修改,修改的是後端,這裡以 nginx 為例。
location / { try_files $uri $uri/ /index.html; }
$uri
就是訪問的 url,不包含 域名
和 querystring
。例如 /test/hello
當訪問 $uri
時,如果存在,則訪問 $uri/
, 不存在就訪問 /index.html
這樣配置好,訪問 http://example.com/
時就可以訪問到網站了,進入多級目錄後重新整理頁面也不會存在問題。
子級目錄下
這裡涉及到修改 vue
專案幾個配置檔案。
先定義幾個環境
- 部署的域名:
http://www.example.com:8080/
- nginx 的 root 目錄:
home/web/
- vue 的部署路徑:
home/web/h5-year-bill/
- vue 專案的連結:
http://www.example/h5-year-bill/
- vue 專案的靜態資源路徑:
http://www.example/h5-year-bill/static/
1. 打包後的靜態資源路徑需要修改
找到 build/config/index.js
,程式碼如下:
...
build: {
...
- assetsPublicPath
// 訪問路徑,修改成絕對路徑
+ assetsPublicPath: '/h5-year-bill/'
}
2. 路由檔案Vue-Router
有一個 base
屬性, 傳送門
base
型別: string
預設值: "/"
應用的基路徑。例如,如果整個單頁應用服務在 /app/ 下,然後 base 就應該設為 "/app/"
因此,找到 src/router/index.js
,程式碼如下:
// 不影響本地開發,相容性做了處理
const isHistoryMode = process.env.NODE_ENV === 'production' ? {
mode: 'history',
base: '/h5-year-bill/'
} : {
mode: 'hash'
};
const router = new Router({
...isHistoryMode,
routes
});
至此,打包配置的相關修改已全部完成,專案也能夠正常訪問。
但還是會有一個問題,跳轉到某個路由後,重新整理頁面,就會出現頁面空白,或者路由不通,此時就要修改 nginx 的配置了。
3. nginx 配置相關修改
nginx部署路徑/conf/nginx.conf
,修改如下:
#h5-year-bill
location ^~ /h5-year-bill {
root /home/web;
index index.html;
try_files $uri $uri/ /h5-year-bill/index.html last;
}
/h5-year-bill/
就是部署的網站目錄。
這樣幾項配置後,就可以在子目錄下訪問網站,重新整理也沒有問題。