Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gloriasoft/uni-crazy-router
一个更贴合uni-app的router插件，一切都使用uni-app原生钩子实现和方法实现，抛弃了vue-router的影子
https://github.com/gloriasoft/uni-crazy-router
Last synced: about 2 months ago
JSON representation
一个更贴合uni-app的router插件，一切都使用uni-app原生钩子实现和方法实现，抛弃了vue-router的影子
- Host: GitHub
- URL: https://github.com/gloriasoft/uni-crazy-router
- Owner: gloriasoft
- License: mit
- Created: 2020-04-13T04:11:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T16:08:56.000Z (almost 2 years ago)
- Last Synced: 2024-10-05T15:36:13.609Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.88 MB
- Stars: 169
- Watchers: 6
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README-uni.md
- License: LICENSE
Awesome Lists containing this project
README
# uni-crazy-router
一个更贴合uni-app的router插件，一切都使用uni-app原生钩子实现和方法实现，抛弃了vue-router的影子
问题反馈QQ群:701697982 
## 优势
+ 支持uniapp vue3 版本(version >= 1.0.0)
+ uni-crazy-router是一个Vue的插件，安装和使用方便，是一个非常轻量级的路由插件
+ 不需要配置路由表
+ 使用的都是uni-app原生的跳转方法，不需要修改成vue-router的方式，直接使用uni.navigateTo等原生方法就可以进行跳转
+ 完全使用uni-app自身的钩子和属性实现，不耦合于vue的组件，更不依赖vue-router
+ beforeEach可以异步拦截路由的跳转
+ 新增路由级别的params参数，不耦合于uni-app自身的页面参数
+ 对页面跳转进行了防抖防刷新的处理，避免了小程序可以连续疯狂点击触发窗口的问题
## 示例项目
[uniapp vue3示例项目](https://github.com/devilwjp/uni-crazy-router-vue3-example)
[uniapp vue2示例项目](https://github.com/devilwjp/uni-crazy-router-example)
## 安装
```
npm i uni-crazy-router -S
```
## 引入
```javascript
import uniCrazyRouter from "uni-crazy-router"
```
___
## 配置
### uniapp vue3版本H5 production环境下的特殊配置
uni-app项目 vite.config.js中需要添加一个插件（插件需要通过npm安装）
因为uni vue3 vite在h5的production环境打包时会将uni.navigateTo等原生方法的字面量直接替换成底层函数，导致uni-crazy-router失效
插件会恢复uni的5个全局跳转方法名
```js
import { defineConfig } from 'vite'
import uni from '@dcloudio/vite-plugin-uni'
import path from 'path'
import h5ProdEffectPlugin from 'uni-vite-plugin-h5-prod-effect'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [
uni(),
// 对h5 production环境打包时的特殊处理，否则uni-crazy-router在这个环境会异常
h5ProdEffectPlugin()
],
})
```
### 第一步
uni-app项目 src/main.js
#### uniapp vue3版本
```javascript
// vue3 main.js
import {
createSSRApp
} from "vue";
import App from "./App.vue";
import { setupRouter } from './router' // 引入路由
export function createApp() {
const app = createSSRApp(App);
// 注册router
setupRouter(app)
return {
app,
};
}
```
#### uniapp vue2版本
```javascript
// vue2 main.js
import Vue from 'vue'
import App from './App'
import './router' // 引入路由
Vue.config.productionTip = false
App.mpType = 'app'
const app = new Vue({
...App
})
app.$mount()
```
### 第二步
创建src/router/index.js
#### uniapp vue3版本
```javascript
import uniCrazyRouter from "uni-crazy-router";
export function setupRouter (app) {
// 接收vue3的实例，并注册uni-crazy-router
app.use(uniCrazyRouter)
}
uniCrazyRouter.beforeEach(async (to, from ,next)=>{
// 逻辑代码
next()
})
uniCrazyRouter.afterEach((to, from)=>{
// 逻辑代码
})
uniCrazyRouter['on'+'Error']((to, from)=>{
// 逻辑代码
})
```
#### uniapp vue2版本
```javascript
import Vue from 'vue'
import uniCrazyRouter from "uni-crazy-router";
Vue.use(uniCrazyRouter)
uniCrazyRouter.beforeEach(async (to, from ,next)=>{
// 逻辑代码
next()
})
uniCrazyRouter.afterEach((to, from)=>{
// 逻辑代码
})
uniCrazyRouter['on'+'Error']((to, from)=>{
// 逻辑代码
})
```
### 第三步
通过原生方法触发跳转
```javascript
uni.navigateTo({
url: '/pages/test/test?a=1&b=1', // 不影响原生的参数传递
// 提供了基于页面级别的路由参数对象
routeParams: {
c:1,
d:1
},
// 提供了基于跳转过程的过程参数对象
passedParams: {
e:1,
f:1
}
})
```
### 第四步
在页面中获取相关信息
```javascript
export default {
data() {
return {
title: 'Hello'
}
},
onLoad() {
// 获取页面路由
// uni-app官方推荐方式，适用所有端
console.log(getCurrentPages()[getCurrentPages().length-1].route)
},
onShow() {
// 获取路由页面参数
console.log(this.$routeParams)
console.log(getCurrentPages()[getCurrentPages().length-1].$routeParams)
// 获取路由动作过程参数
console.log(this.$passedParams)
console.log(getCurrentPages()[getCurrentPages().length-1].$passedParams)
},
onUnload() {
},
methods: {
//....
}
}
```
___
## API
### 路由切换的API（原生）
**uni.navigateTo
uni.redirectTo
uni.reLaunch
uni.switchTab
uni.navigateBack**
#### 新增参数
+ routeParams {Object} 路由触发的页面参数，在页面加载后将一直存在并且不再改变
+ passedParams {Object} 路由触发的过程参数，每次通过主动触发路由的改变，就会被修改
routeParams和passedParams的值可以在页面vue实例中通过$routeParams和$passedParams获取(比如this.$routeParams)，也可以通过getCurrentPages()获取到页面栈中的页面对象，对象中同样存在$routeParams和$passedParams
+ query {Object} 原生的url参数对象
+ search {String} 原生的url参数的原始路径字符串
### 钩子函数与拦截器
钩子函数和拦截器与vue-router的使用方式雷同，开放了三个钩子
+ beforeEach (hookFunction)
**路由拦截中的next用法于vue-router有所不同，next暂时不接受参数，调用next代表不拦截，如果函数中没有调用next，代表了拦截，beforeEach接受的函数参数是个async函数，意味着函数中即便需要使用异步也必须包装成promise的形式，使用await获取异步的结果，不能直接使用回调性质的异步比如setTimeout等，因为只要整个async函数返回前没有调用next，就会当作拦截了，在拦截时需要跳转到其他页面，需要使用afterNotNext进行包装（详见afterNotNext）**
PS: 之后的1.0.0以上的版本会开放和vue-router一样的拦截函数方式，可以不使用promise包装异步
+ afterEach (hookFunction)
+ on Error (hookFunction)
**其中beforeEach有拦截功能，通过next方法来控制
beforeEach只能拦截主动的路由切换（由路由切换API触发）
被动触发行为不会经过beforeEach，包括：**
+ 小程序的原生返回按钮触发
+ 小程序的navigator组件触发
+ 小程序的返回首页按钮
+ 小程序的tabbar按钮
+ 浏览器的前进后退按钮
+ APP端IOS环境下，向右滑动返回的方式（并且也无法触发afterEach）
#### 参数
hookFunction {Function}
+ to {Object} {url, routeParams, passedParams, query, jumpType, search}
其中jumpType只有在beforeEach中出现，用于标识主动触发的类型（原生方法名）
+ from {Object} {url, routeParams, passedParams}
+ next {Function} 只有beforeEach才有
### 拦截后的附加执行函数
**afterNotNext (hookFunction)**
afterNotNext只对当前函数上下文有效
#### 参数
hookFunction {Function} 在beforeEach被拦截后同步执行
用在beforeEach拦截中，当遇到没有next的场景，会在拦截动作之后同步的触发传入的函数
因为uni-crazy-router做了防抖重复动作拦截，所以如果想在before里使用路由跳转动作，需要包装在afterNotNext里（需要注意的是，在拦截器中跳转到其他页面，还是会再次被进行拦截的，所以当跳转到一些不需要被拦截的页面时需要在拦截判断中去除这些页面地址，否则会造成跳转的死循环）
```javascript
uniCrazyRouter.beforeEach(async (to, from ,next)=>{
if (to.passedParams && to.passedParams.stop) {
uniCrazyRouter.afterNotNext(() => {
// 拦截路由，并且跳转去其他页面
uni.navigateTo({
url: '/pages/other/other'
})
})
return // 拦截路由，不执行next
}
next()
})
```
## 设计模式
[点击查看uni-crazy-router复杂用法示例项目](https://github.com/devilwjp/uni-crazy-router-example)
uni-crazy-router作为一款路由拦截插件同时支持多种开发模式，可以中心化的去管理所有的拦截逻辑（推荐），当然也可以去中心化的在不同的业务层中去单独的注册拦截处理
所有的钩子都是观察者模式设计，可以无数次的进行注册和销毁，不同的拦截逻辑并不需要写在一个拦截器中
这个例子就是合理的将不同的拦截逻辑进行拆分，（拦截的顺序是根据先注册的先处理，如果有一个拦截器被拦截了，之后的就会中断）
`router/index.js`
```javascript
import uniCrazyRouter from "uni-crazy-router"
import store from '@/store'
Vue.use(uniCrazyRouter)
// 先注册一个拦截，用来拦截是否登陆
const interceptLogin = uniCrazyRouter.beforeEach(async (to, from ,next) => {
// 判断是否登录，没有登陆就跳转到登录页，并且要去除对登录页的拦截，否则会死循环
if (!store.state.isLogin && to.url !== 'pages/login/login') {
uniCrazyRouter.afterNotNext(() => {
// 拦截路由，并且跳转去登录页
uni.navigateTo({
url: '/pages/login/login'
})
})
return // 拦截路由，不执行next
}
next()
})
// 再注册一个拦截，用来拦截是否vip用户
const interceptVip = uniCrazyRouter.beforeEach(async (to, from ,next) => {
if (to.url === 'pages/vip/vip' && !store.state.isVip) {
uni.showToast({
title: '您不是vip，无权访问'
})
return // 拦截路由，不执行next
}
next()
})
// 我们还可销毁已注册的拦截
setTimeout(() => {
interceptVip() // 销毁拦截器interceptVip
}, 10000)
```
我们将上面的例子进行逻辑和模块的重新整理，将两个拦截器的逻辑分别放到两个不同的js中，然后在`router/index.js`中引入
`router/index.js`
```javascript
import uniCrazyRouter from "uni-crazy-router"
import bindInterceptLogin from '@/router/interceptLogin'
import bindInterceptVip from '@/router/interceptVip'
Vue.use(uniCrazyRouter)
const interceptLogin = bindInterceptLogin()
const interceptVip = bindInterceptVip()
```
`router/interceptLogin`
```javascript
import uniCrazyRouter from "uni-crazy-router"
import store from '@/store'
function bindInterceptLogin () {
return uniCrazyRouter.beforeEach(async (to, from ,next) => {
// 判断是否登录，没有登陆就跳转到登录页，并且要去除对登录页的拦截，否则会死循环
if (!store.state.isLogin && to.url !== 'pages/login/login') {
uniCrazyRouter.afterNotNext(() => {
// 拦截路由，并且跳转去登录页
uni.navigateTo({
url: '/pages/login/login'
})
})
return // 拦截路由，不执行next
}
next()
})
}
export default bindInterceptLogin
```
`router/interceptVip`
```javascript
import uniCrazyRouter from "uni-crazy-router"
import store from '@/store'
function bindInterceptVip () {
return uniCrazyRouter.beforeEach(async (to, from ,next) => {
if (to.url === 'pages/vip/vip' && !store.state.isVip) {
uni.showToast({
title: '您不是vip，无权访问'
})
return // 拦截路由，不执行next
}
next()
})
}
export default bindInterceptVip
```
## 其他
获取当前页面的路径，请使用uni-app官方推荐的方式，不再重复包装
官方推荐通过getCurrentPages获取页面栈的页面对象，然后获取route属性