uni.addInterceptor(name, interceptor) @addinterceptor

展示全部

# uni.addInterceptor(name, interceptor)

添加拦截器

# addInterceptor 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
4.0	4.41	3.97	4.11	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

name

string

是

需要拦截的 API 名称

interceptor

Interceptor

是

拦截器

# 参见

# uni.removeInterceptor(name, interceptor?)

删除拦截器

# removeInterceptor 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
4.0	4.41	3.97	4.11	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

name

string

是

需要删除拦截器的 API 名称

interceptor

Interceptor

否

拦截器

# 参见

# 示例

示例为hello uni-app x alpha分支，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例另见

示例

<template>
  <view style="flex: 1">
    <button @click="addInterceptor">添加路由拦截器</button>
    <button @click="removeInterceptor">移除路由拦截器</button>
    <text>点击下方按钮{{ msg }}</text>
    <button @click="navigateTo">navigatorTo API跳转到测试页面</button>
    <!-- #ifndef MP -->
    <navigator url="./page1">
      <button class="navigatorButton">navigator组件跳转到测试页面</button>
    </navigator>
    <!-- #endif -->
    <button @click="addSwitchTabInterceptor">添加switchTab拦截器</button>
    <button @click="removeSwitchTabInterceptor">移除switchTab拦截器</button>
    <button @click="switchTab">switchTab API</button>
  </view>
</template>

<script>
  const navigateToInterceptor = {
    invoke: function (options : NavigateToOptions) {
      console.log('拦截 navigateTo 接口传入参数为：', options)
      const url = './page2'
      uni.showToast({
        title: `重定向到页面:${url}`
      })
      options.url = url
    },
    success: function (res : NavigateToSuccess) {
      console.log('拦截 navigateTo 接口 success 返回参数为：', res)
    },
    fail: function (err : NavigateToFail) {
      console.log('拦截 navigateTo 接口 fail 返回参数为：', err)
    },
    complete: function (res : NavigateToComplete) {
      console.log('拦截 navigateTo 接口 complete 返回参数为：', res)
    }
  } as AddInterceptorOptions

  const switchTabInterceptor = {
    invoke: function (options : SwitchTabOptions) {
      console.log('拦截 switchTab 接口传入参数为：', options)
      options.url = '/pages/tabBar/API'
    },
    success: function (res : SwitchTabSuccess) {
      console.log('拦截 switchTab 接口 success 返回参数为：', res)
    },
    fail: function (err : SwitchTabFail) {
      console.log('拦截 switchTab 接口 fail 返回参数为：', err)
    },
    complete: function (res : SwitchTabComplete) {
      console.log('拦截 switchTab 接口 complete 返回参数为：', res)
    }
  } as AddInterceptorOptions

  export default {
    data() {
      return {
        msg: "会跳转到测试页面1"
      }
    },
    beforeUnmount() {
      // 移除 navigateTo 所有拦截器
      uni.removeInterceptor('navigateTo')
      uni.removeInterceptor('switchTab')
    },
    methods: {
      addInterceptor() {
        uni.addInterceptor('navigateTo', navigateToInterceptor)
        uni.showToast({
          title: '页面跳转/切换tabbar已拦截'
        })
        this.msg = "，路由被劫持到测试页面2"
      },
      removeInterceptor() {
        uni.removeInterceptor('navigateTo', navigateToInterceptor)
        uni.showToast({
          title: '拦截器已移除'
        })
        this.msg = "会跳转到测试页面1"
      },
      addSwitchTabInterceptor() {
        uni.addInterceptor('switchTab', switchTabInterceptor)
      },
      removeSwitchTabInterceptor() {
        uni.removeInterceptor('switchTab', switchTabInterceptor)
      },
      navigateTo() {
        uni.navigateTo({
          url: './page1',
          success(res) {
            console.log('res:', res)
          },
          fail(err) {
            console.error('err:', err)
          },
          complete(res) {
            console.log('res:', res)
          }
        })
      },
      switchTab() {
        uni.switchTab({
          url: '/pages/tabBar/component',
          success(res) {
            console.log('res:', res)
          },
          fail(err) {
            console.error('err:', err)
          },
          complete(res) {
            console.log('res:', res)
          }
        })
      }
    }
  }
</script>

# 通用类型

# GeneralCallbackResult

名称

类型

必备

默认值

兼容性

描述

errMsg

string

是

错误信息

# Tips

目前仅以下接口支持拦截器：navigateTo、redirectTo、reLaunch、switchTab、navigateBack、loadFontFace、pageScrollTo、startPullDownRefresh、setNavigationBarColor、setNavigationBarTitle、setTabBarBadge、removeTabBarBadge、setTabBarItem、setTabBarStyle、hideTabBar、showTabBar、showTabBarRedDot、hideTabBarRedDot
如需拦截request，可在插件市场搜索拦截器插件
小程序端拦截器无法拦截navigator组件