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 相关文章推荐
关于jquery动态增减控件的一些想法和小插件
Aug 01 Javascript
js原生态函数中使用jQuery中的 $(this)无效的解决方法
May 25 Javascript
js 连接数据库如何操作数据库中的数据
Nov 23 Javascript
js拼接html注意问题示例探讨
Jul 14 Javascript
JavaScript获取文本框内选中文本的方法
Feb 20 Javascript
详解BootStrap中Affix控件的使用及保持布局的美观的方法
Jul 08 Javascript
JavaScript限制在客户区可见范围的拖拽(解决scrollLeft和scrollTop的问题)(2)
May 17 Javascript
深入理解js 中async 函数的含义和用法
May 13 Javascript
关于JS解构的5种有趣用法
Sep 05 Javascript
layui之数据表格--与后台交互获取数据的方法
Sep 29 Javascript
Node.js API详解之 vm模块用法实例分析
May 27 Javascript
通过JS判断网页是否为手机打开
Oct 28 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+MySQL实现无极限分类栏目的方法
2015/12/23 PHP
PHP中list方法用法示例
2016/12/01 PHP
关于Curl在Swoole协程中的解决方案详析
2019/09/12 PHP
phpfpm的作用和用法
2019/10/10 PHP
JavaScript 模仿vbs中的 DateAdd() 函数的代码
2007/08/13 Javascript
PNG背景在不同浏览器下的应用
2009/06/22 Javascript
JavaScript 函数调用规则
2009/09/14 Javascript
JavaScript中继承的一些示例方法与属性参考
2010/08/07 Javascript
jquery blockUI 遮罩不能消失与不能提交的解决方法
2011/09/17 Javascript
浅谈轻量级js模板引擎simplite
2015/02/13 Javascript
javascript中typeof操作符和constucor属性检测
2015/02/26 Javascript
浅谈JavaScript中数组的增删改查
2016/06/20 Javascript
JS如何生成一个不重复的ID的函数
2016/12/25 Javascript
详解微信小程序——自定义圆形进度条
2016/12/29 Javascript
ES6的异步终极解决方案分享
2019/07/11 Javascript
JS中作用域以及变量范围分析
2020/07/18 Javascript
JavaScript仿京东轮播图效果
2021/02/25 Javascript
Python实现大文件排序的方法
2015/07/10 Python
Python实现嵌套列表及字典并按某一元素去重复功能示例
2017/11/30 Python
Python 微信之获取好友昵称并制作wordcloud的实例
2019/02/21 Python
详解pyppeteer(python版puppeteer)基本使用
2019/06/12 Python
如何基于Python批量下载音乐
2019/11/11 Python
浅谈keras中自定义二分类任务评价指标metrics的方法以及代码
2020/06/11 Python
Keras官方中文文档:性能评估Metrices详解
2020/06/15 Python
Python中logger日志模块详解
2020/08/04 Python
使用OpenCV实现人脸图像卡通化的示例代码
2021/01/15 Python
python 实现IP子网计算
2021/02/18 Python
买卖正宗运动鞋:GOAT
2019/12/06 全球购物
介绍下java.util.Arrays类
2012/10/16 面试题
个人自我评价分享
2013/12/20 职场文书
农村婚礼证婚词
2014/01/10 职场文书
信息学院毕业生自荐信范文
2014/03/04 职场文书
男性健康日的活动方案
2014/08/18 职场文书
2014年教师节演讲稿范文
2014/09/10 职场文书
优化经济发展环境工作总结
2015/08/11 职场文书
搞笑欢迎词大全
2015/09/30 职场文书