文档章节

react-router browserHistory刷新页面404问题解决

熊建刚
 熊建刚
发布于 2017/12/28 19:48
字数 1484
阅读 1440
收藏 4

使用React开发新项目时,遇见了刷新页面,直接访问二级或三级路由时,访问失败,出现404或资源加载异常的情况,本篇针对此问题进行分析并总结解决方案。

查看个人博客

背景

使用webpack-dev-server做本地开发服务器时,正常情况只需要简单使用webpack-dev-server指令启动即可,但是当项目处于以下两种情况时,往往需要有嵌套路由和异步加载路由:

  1. 我们使用react-router这种路由库构建单页面应用路由;
  2. 使用html-webpack-plugin插件动态将加载js的<script>标签注入html文档;

这时,访问localhost:9090是可以正常加载页面和js等文件的,但是当我们需要访问二级甚至三级路由或者刷新页面时,如localhost:9090/posts/92时,可能会出现两种情况:

  1. 页面加载失败,返回Cannot Get(404)
  2. 服务响应,但是没有返回webpack处理输出的html文件,导致无法加载js资源,第二种情况如图:

react-router-browser-history

那么我们怎么处理才能正常访问,各页面路由呢?博主追踪溯源,查找文档配置后解决了问题,本篇就是对整个解决问题过程的总结。

分析问题

发现问题后,我们就要开始分析,解决问题了,我们判断这个问题一般是两方面原因造成:

  1. react-router路前端由配置;
  2. webpack-dev-server服务配置;

react-router

因为前端路由更容易确定问题,更方便分析,而且对于react-router更熟悉,所以首先去查询react-router路由库相关配置信息,发现文档中提到了使用browserHistory时,会创建真实的URL,处理初始/请求没有问题,但是对于跳转路由后,刷新页面或者直接访问该URL时,会发现无法正确相应,更多信息查看参考文档,文档中也提供了几种服务器配置解决方式:

Node

const express = require('express')
const path = require('path')
const port = process.env.PORT || 8080
const app = express()

// 通常用于加载静态资源
app.use(express.static(__dirname + '/public'))

// 在你应用 JavaScript 文件中包含了一个 script 标签
// 的 index.html 中处理任何一个 route
app.get('*', function (request, response){
  response.sendFile(path.resolve(__dirname, 'public', 'index.html'))
})

app.listen(port)
console.log("server started on port " + port)

在使用Node作为服务时,需要使用通配符*监听所有请求,返回目标html文档(引用js资源的html)。

Nginx

如果使用的是nginx服务器,则只需要使用try_files 指令

server {
  ...
  location / {
    try_files $uri /index.html
  }
}

Apache

如果使用Apache服务器,则需要在项目根目录创建.htaccess文件,文件包含如下内容:

RewriteBase /
RewriteRule ^index\.html$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.html [L]

以下都是针对服务器的配置,可惜的是我们目前还没引入相关服务器,只是使用了webpack-dev-server的内置服务,但是我们已经找到问题所在了,就是路由请求无法匹配返回html文档,所以接下来就该去webpack-dev-server文档中查找解决方式了。

webpack-dev-server

在这里不得不吐槽一下webpack-dev-server官方文档,博主反复看了几遍,才看清楚了问题所在,这里也分两种情况:

  1. 没有修改output.publicPath,即webpack配置文件中没有声明值,属于默认情况;
  2. 设置了output.publicPath为自定义值;

点此查看文档

默认情况

默认情况下,没有修改output.publicPath值,只需要设置webpack-dev-server的historyApiFallback配置:

devServer: {
  historyApiFallback: true
}

If you are using the HTML5 history API you probably need to serve your index.html in place of 404 responses, which can be done by setting historyApiFallback: true

如果你的应用使用HTML5 history API,你可能需要使用index.html响应404或者问题请求,只需要设置g historyApiFallback: true即可

自定义值

However, if you have modified output.publicPath in your Webpack configuration, you need to specify the URL to redirect to. This is done using the historyApiFallback.index option

如果你在webpack配置文件中修改了 output.publicPath 值,那么你就需要声明请求重定向,配置historyApiFallback.index 值。

// output.publicPath: '/assets/'
historyApiFallback: {
  index: '/assets/'
}

Proxy

发现使用以上方式,并不能完全解决我的问题,总会有路由请求响应异常,于是博主继续查找更好的解决方案:

点此查看文档

The proxy can be optionally bypassed based on the return from a function. The function can inspect the HTTP request, response, and any given proxy options. It must return either false or a URL path that will be served instead of continuing to proxy the request.

代理提供通过函数返回值响应请求方式,针对不同请求进行不同处理,函数参数接收HTTP请求和响应体,以及代理配置对象,这个函数必须返回false或URL路径,以表明如何继续处理请求,返回URL时,源请求将被代理到该URL路径请求。

proxy: {
  '/': {
    target: 'https://api.example.com',
    secure: false,
    bypass: function(req, res, proxyOptions) {
      if (req.headers.accept.indexOf('html') !== -1) {
        console.log('Skipping proxy for browser request.');
        return '/index.html';
      }
    }
  }
}

如上配置,可以监听https://api.example.com域下的/开头的请求(等效于所有请求),然后判断请求头中accept字段是否包含html,若包含,则代理请求至/index.html,随后将返回index.html文档至浏览器。

解决问题

综合以上方案,因为在webpack配置中修改了output.publicPath/assets/,所以博主采用webpack-dev-server Proxy代理方式解决了问题:

const PUBLICPATH = '/assets/'
...
proxy: {
  '/': {
    bypass: function (req, res, proxyOptions) {
      console.log('Skipping proxy for browser request.')
      return `${PUBLICPATH}/index.html`
    }
  }
}

监听所有前端路由,然后直接返回${PUBLICPATH}/index.htmlPUBLICPATH就是设置的output.publicPath值。

另外,博主总是习惯性的声明,虽然不设置该属性也能满足预期访问效果:

historyApiFallback: true

© 著作权归作者所有

共有 人打赏支持
熊建刚
粉丝 64
博文 21
码字总数 88314
作品 0
海淀
程序员
私信 提问
react-router使用教程

安装命令 npm install -S react-router 基本用法 使用时,路由器Router就是React的一个组件,Router组件本身只是个容器,真正的路由要通过Route组件定义 import React from 'react';import R...

别人说我名字很长
2017/01/22
0
0
我的react组件化开发道路(一) 一脸懵比的踩坑中

前言 因为先前做过一个使用阿里的ant design的项目,但是由于ant design中有很多组件还遗留着坑,问题是这些坑,还找不到解决的方法(或者我太low,方法可能有,只是我没找到),既然解决不了,...

梅气灶
2016/11/17
2.1K
16
React-router路由实践

首先,在该项目开始之前,还请大家能够先下载一个项目脚手架。本教程基于该脚手架进行开发 Router,hashHistory,Route 首先下载react-router 需要注意的是,react-router更新很快,API也在持续...

一个胖子的我
2016/05/20
0
0
react,vue等部署单页面项目时,访问刷新出现404问题

1. 问题描述: 上个礼拜开发了个简单的单页面移动端页面,地址,然后进入到文章详情,刷新浏览器,发现浏览器出现404了,what happen? 如下图: image.png 2. 问题原因: 刷新页面时访问的资源...

极客教程
2017/11/14
0
0
使用react-router 浏览器刷新,页面404问题解决

首先我们先找到问题,再解决问题,别嫌我啰嗦,首先说说react路由history三种模式。 history 配置 React Router 是建立在 history 之上的。 简而言之,一个 history 知道如何去监听浏览器地址...

馒头
2016/03/18
4.5K
0

没有更多内容

加载失败,请刷新页面

加载更多

Pycharm上Django的使用 Day8

1.添加新条目 1>编写用于添加新条目的表单 在forms.py中创建一个与模型Entry相关联的表单 1处给字段'text'指定一个空标签 2处定义小部件widgets,widgets是一个HTML表单元素 2>定义new_entry...

不会TC的猫
28分钟前
3
0
MongoDB副本集

MongoDB介绍 早期版本使用master-slave,一主一从和MySQL类似,但slave在此架构中为只读,当主库宕机后,从库不能自动切换为主 目前已经淘汰master-slave模式,改为副本集,这种模式下有一个...

chencheng-linux
41分钟前
1
0
WebService 客户端记录

https://blog.csdn.net/qiuhan/article/details/49487009

呼呼南风
41分钟前
1
0
七牛云彭垚:智能平台的创新和发展

2018 年 11 月 14 日至 11 月 18 日,第二十届中国国际高新技术成果交易会(简称高交会)在深圳成功举办,七牛云作为国内领先的以数据智能和视觉智能为核心的企业级云计算服务商受邀参展。 ...

七牛云
48分钟前
1
0
Java内存模型原理,你真的理解透彻了吗?

内存模型产生背景 在介绍 Java 内存模型之前,我们先了解一下物理计算机中的并发问题,理解这些问题可以搞清楚内存模型产生的背景。 物理机遇到的并发问题与虚拟机中的情况有不少相似之处,物...

小刀爱编程
53分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部