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


Posted in Javascript onDecember 29, 2017

使用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 browserHistory刷新页面404问题解决方法

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

分析问题

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

  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.html,PUBLICPATH就是设置的output.publicPath值。

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

historyApiFallback: true

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
Javascript继承(上)——对象构建介绍
Nov 08 Javascript
JavaScript常用全局属性与方法记录积累
Jul 03 Javascript
导航跟随滚动条置顶移动示例代码
Sep 11 Javascript
wap浏览自动跳转到wap页面的js代码
May 17 Javascript
JS动态改变表格边框宽度的方法
Mar 31 Javascript
jQuery实用技巧必备(下)
Nov 03 Javascript
javacript获取当前屏幕大小
Jun 04 Javascript
javascript 跨域问题以及解决办法
Jul 17 Javascript
浅谈Vue的响应式原理
May 30 Javascript
js JSON.stringify()基础详解
Jun 19 Javascript
Vue 实现分页与输入框关键字筛选功能
Jan 02 Javascript
在博客园博文中添加自定义右键菜单的方法详解
Feb 05 Javascript
node简单实现一个更改头像功能的示例
Dec 29 #Javascript
JavaScript 中使用 Generator的方法
Dec 29 #Javascript
js中url对象化管理分析
Dec 29 #Javascript
JS计算距当前时间的时间差实例
Dec 29 #Javascript
JS控制鼠标拒绝点击某一按钮的实例
Dec 29 #Javascript
JS实现简单的浮动碰撞效果示例
Dec 28 #Javascript
bootstrap-table.js扩展分页工具栏(增加跳转到xx页)功能
Dec 28 #Javascript
You might like
php microtime获取浮点的时间戳
2010/02/21 PHP
php使用filter过滤器验证邮箱 ipv6地址 url验证
2013/12/25 PHP
php判断文件上传类型及过滤不安全数据的方法
2014/12/17 PHP
PHP设计模式之简单投诉页面实例
2016/02/24 PHP
PHP实现的浏览器检查类
2016/04/11 PHP
海量经典的jQuery插件集合
2010/01/12 Javascript
javascript 正则表达式相关应介绍
2012/11/27 Javascript
extjs两个tbar问题探讨
2013/08/08 Javascript
基于NodeJS的前后端分离的思考与实践(一)全栈式开发
2014/09/26 NodeJs
jQuery中parents()方法用法实例
2015/01/07 Javascript
JavaScript生成随机字符串的方法
2015/03/19 Javascript
理解JavaScript的变量的入门教程
2015/07/07 Javascript
使用EVAL处理jqchart jquery 折线图返回数据无效的解决办法
2015/11/26 Javascript
JS中的进制转换以及作用
2016/06/26 Javascript
JS优化与惰性载入函数实例分析
2017/04/06 Javascript
基于Vue实现拖拽功能
2020/07/29 Javascript
基于vue-cli npm run build之后vendor.js文件过大的解决方法
2018/09/27 Javascript
在Python中marshal对象序列化的相关知识
2015/07/01 Python
对python中执行DOS命令的3种方法总结
2018/05/12 Python
TensorFlow实现iris数据集线性回归
2018/09/07 Python
解决pycharm 误删掉项目文件的处理方法
2018/10/22 Python
用html5的canvas和JavaScript创建一个绘图程序的简单实例
2016/07/06 HTML / CSS
香港交友网站:be2香港
2018/07/22 全球购物
在数据文件自动增长时,自动增长是否会阻塞对文件的更新
2014/05/01 面试题
店长岗位职责
2013/11/21 职场文书
应届毕业生个人自荐信范文
2013/11/30 职场文书
工程业务员工作职责
2013/12/07 职场文书
我的网上商城创业计划书
2013/12/26 职场文书
函授生自我鉴定
2014/03/25 职场文书
责任心演讲稿
2014/05/14 职场文书
2015年仓库工作总结
2015/04/09 职场文书
医院见习总结
2015/06/24 职场文书
学校运动会加油词
2015/07/18 职场文书
maven依赖的version声明控制方式
2022/01/18 Java/Android
九大龙王魂骨,山龙王留下躯干骨,榜首死的最憋屈(被捏碎)
2022/03/18 国漫
vue封装数字翻牌器
2022/04/20 Vue.js