路由配置
icejs 推荐使用 配置式路由 进行应用的路由管理,如果希望使用文件约定路由可参考 文档。
#
配置路由信息应用的路由信息统一在 src/routes.ts
中配置,配置协议支持多级嵌套,具体如下:
注意:路由有一个按顺序匹配的规则,从上到下一旦命中路由匹配规则就会停止遍历,因此如果你在最前面配置了 / 这样一个路由,则所有的路由都会命中该规则,导致其他路由没有效果,所以在开发时要注意路由的顺序以及
exact
属性的使用。
#
运行时配置在 src/app.ts
中,我们可以配置路由的类型和基础路径等信息,具体配置如下:
options:
- type: 路由类型,默认值
hash
,可选值browser|hash|static
- basename: 路由基准地址
- fallback: 开启按需加载时配置 fallback UI
- modifyRoutes: 动态修改路由
- history: 自定义创建 history 对象,详见
#
路由组件参数对于路由组件(即页面级组件),可通过组件 props
获取到如下属性:
location
:当前路由的 location 对象,包含pathname
、search
、hash
、state
属性history
:详见 history apisearchParams
:当前 URL 的查询参数对象(需要开启 parseSearchParams)match
:当前路由和 URL match 后的对象,包含path
、url
、params
、isExact
属性
对于非路由组件,组件内如想获取上述属性需要借助 useHistory, useLocation, useParams, withRouter 等 API。
#
路由跳转通常使用 Link
组件或者 history
API 进行路由的跳转:
路由跳转传递参数,除了通过 url params 如 /projects/:id
以及 url query 如 /project?id=1
以外,也可通过 state
参数:
注意:state 传递参数仅支持 BrowserHistory 不支持 HashHistory,通过
src/app.ts
里的router.type
字段可配置。
在 about 页面即可通过 location
访问到对应的 state:
#
按需加载参考 代码分割 。
#
路由高阶组件通过 src/routes.ts
中的 wrappers
字段可配置路由的高阶组件,常用于路由级别的权限检验。
#
配置 wrappers注意:Wrapper 组件不支持通过 lazy 导入
#
实现高阶组件通过 wrappers
配置我们可以对路由组件进行自定义包装,如上示例通过 WrapperPage 高阶组件对路由组件进行权限判断,如果是登录状态,则渲染 User 组件,否则跳转到 /login
路由。
useAuth
API 需要结合 plugin-ice-auth 插件实现,可参考 权限管理 。
#
常见问题#
HashHistory 与 BrowserHistory前端路由通常有两种实现方式:HashHistory 和 BrowserHistory,路由都带着 #
说明使用的是 HashHistory。这两种方式优缺点:
特点\方案 | HashHistory | BrowserHistory |
---|---|---|
美观度 | 不好,有 # 号 | 好 |
易用性 | 简单 | 中等,需要 server 配合 |
依赖 server 端配置 | 不依赖 | 依赖 |
跟锚点功能冲突 | 冲突 | 不冲突 |
兼容性 | IE8 | IE10 |
state 传递参数 | 不支持 | 支持 |
开发者可以根据自己的实际情况选择对应方案。
#
如何使用 BrowserRouter本地开发时,只需要在 src/app.ts
中增加以下配置即可:
线上运行时需要服务端支持,否则会出现刷新 404 问题,具体方案请参考社区文档:
#
如何使用动态路由在某些场景下可能需要动态指定路由即 /user/:id
,使用方式如下:
路由配置:
动态路由参数: