不同的历史模式

在创建路由器实例时,history 配置允许我们在不同的历史模式中进行选择。

Hash 模式

hash 模式是用 createWebHashHistory() 创建的:

  1. import { createRouter, createWebHashHistory } from 'vue-router'
  2. const router = createRouter({
  3. history: createWebHashHistory(),
  4. routes: [
  5. //...
  6. ],
  7. })

它在内部传递的实际 URL 之前使用了一个哈希字符(#)。由于这部分 URL 从未被发送到服务器,所以它不需要在服务器层面上进行任何特殊处理。不过,它在 SEO 中确实有不好的影响。如果你担心这个问题,可以使用 HTML5 模式。

HTML5 模式

createWebHistory() 创建 HTML5 模式,推荐使用这个模式:

  1. import { createRouter, createWebHistory } from 'vue-router'
  2. const router = createRouter({
  3. history: createWebHistory(),
  4. routes: [
  5. //...
  6. ],
  7. })

当使用这种历史模式时,URL 会看起来很 “正常”,例如 https://example.com/user/id。漂亮!

不过,问题来了。由于我们的应用是一个单页的客户端应用,如果没有适当的服务器配置,用户在浏览器中直接访问 https://example.com/user/id,就会得到一个 404 错误。这就丑了。

不用担心:要解决这个问题,你需要做的就是在你的服务器上添加一个简单的回退路由。如果 URL 不匹配任何静态资源,它应提供与你的应用程序中的 index.html 相同的页面。漂亮依旧!

服务器配置示例

注意:以下示例假定你正在从根目录提供服务。如果你部署到子目录,你应该使用Vue CLI 的 publicPath 配置和相关的路由器的 base 属性。你还需要调整下面的例子,以使用子目录而不是根目录(例如,将RewriteBase/ 替换为 RewriteBase/name-of-your-subfolder/)。

Apache

  1. <IfModule mod_rewrite.c>
  2. RewriteEngine On
  3. RewriteBase /
  4. RewriteRule ^index\.html$ - [L]
  5. RewriteCond %{REQUEST_FILENAME} !-f
  6. RewriteCond %{REQUEST_FILENAME} !-d
  7. RewriteRule . /index.html [L]
  8. </IfModule>

也可以使用 FallbackResource 代替 mod_rewrite

nginx

  1. location / {
  2. try_files $uri $uri/ /index.html;
  3. }

原生 Node.js

  1. const http = require('http')
  2. const fs = require('fs')
  3. const httpPort = 80
  4. http
  5. .createServer((req, res) => {
  6. fs.readFile('index.html', 'utf-8', (err, content) => {
  7. if (err) {
  8. console.log('We cannot open "index.html" file.')
  9. }
  10. res.writeHead(200, {
  11. 'Content-Type': 'text/html; charset=utf-8',
  12. })
  13. res.end(content)
  14. })
  15. })
  16. .listen(httpPort, () => {
  17. console.log('Server listening on: http://localhost:%s', httpPort)
  18. })

Express + Node.js

对于 Node.js/Express,可以考虑使用 connect-history-api-fallback 中间件

Internet Information Services (IIS)

  1. 安装 IIS UrlRewrite
  2. 在网站的根目录下创建一个 web.config 文件,内容如下:
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration>
  3. <system.webServer>
  4. <rewrite>
  5. <rules>
  6. <rule name="Handle History Mode and custom 404/500" stopProcessing="true">
  7. <match url="(.*)" />
  8. <conditions logicalGrouping="MatchAll">
  9. <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
  10. <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
  11. </conditions>
  12. <action type="Rewrite" url="/" />
  13. </rule>
  14. </rules>
  15. </rewrite>
  16. </system.webServer>
  17. </configuration>

Caddy v2

  1. try_files {path} /

Caddy v1

  1. rewrite {
  2. regexp .*
  3. to {path} /
  4. }

Firebase hosting

将此添加到你的 firebase.json 中:

  1. {
  2. "hosting": {
  3. "public": "dist",
  4. "rewrites": [
  5. {
  6. "source": "**",
  7. "destination": "/index.html"
  8. }
  9. ]
  10. }
  11. }

Netlify

创建一个 _redirects 文件,包含在你的部署文件中:

  1. /* /index.html 200

在 vue-cli、nuxt 和 vite 项目中,这个文件通常放在名为 staticpublic 的目录下。

你可以在 Netlify 文档中找到更多关于语法的信息。你也可以创建一个 netlify.toml 来结合其他 Netlify 功能的重定向。

Caveat

这有一个注意事项。你的服务器将不再报告 404 错误,因为现在所有未找到的路径都会显示你的 index.html 文件。为了解决这个问题,你应该在你的 Vue 应用程序中实现一个万能的路由来显示 404 页面。

  1. const router = createRouter({
  2. history: createWebHistory(),
  3. routes: [{ path: '/:pathMatch(.*)', component: NotFoundComponent }],
  4. })

另外,如果你使用的是 Node.js 服务器,你可以通过在服务器端使用路由器来匹配传入的 URL,如果没有匹配到路由,则用 404 来响应,从而实现回退。查看 Vue 服务器端渲染文档了解更多信息。