uni-app
uni-app x
uniCloud
HBuilder X
uni 小程序 sdk
uni-ad广告
开发者服务
uni-app x
uni-app
uni-app x
uniCloud
HBuilder X
uni 小程序 sdk
uni-ad广告
开发者服务
简体中文
API
getApp()
getApp 兼容性
返回值
UniApp 的方法
getAndroidApplication(): Application
getHarmonyAbility(): UIAbility
示例
全局方法调用
参见
通用类型
展示全部

# getApp()

getApp() 函数用于获取当前应用实例，可通过应用实例调用 App.uvue methods 中定义的方法, 详见。

  • HBuilderX 4.31以前，getApp返回的是vue实例。并且在uts插件中无法使用。
  • HBuilderX 4.31+，新增了UniApp对象，用于管理app，getApp返回的是UniApp对象。而vue实例，则是UniApp对象的一个vm属性。

UniApp对象可以在uts插件和uvue页面中同时使用，但vm属性以及相关的globalData仍然只能在uvue页面中才能使用。

# getApp 兼容性

Web 微信小程序 Android iOS iOS uni-app x UTS 插件 HarmonyOS
4.0 √ √ √ 4.31 4.61

# 返回值

类型
UniApp
名称 类型 必备 默认值 兼容性 描述
vm ComponentPublicInstance 否 -
App vue 实例对象
globalData any 是 -
全局对象
$vm ComponentPublicInstance 否 -
App vue 实例对象 已废弃，仅为了向下兼容保留

# UniApp 的方法

# getAndroidApplication(): Application

getAndroidApplication 获取 Android 应用 Application 上下文

# getAndroidApplication 兼容性
Web 微信小程序 Android iOS HarmonyOS
x x 4.31 x x
# 返回值
类型
Application

# getHarmonyAbility(): UIAbility

getHarmonyAbility 获取 鸿蒙应用 Ability 实例

# getHarmonyAbility 兼容性
Web 微信小程序 Android iOS HarmonyOS
x x x x 4.61
# 返回值
类型
UIAbility

# 示例

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

扫码体验（手机浏览器跳转到App直达页）

示例

<template>
  <!-- #ifdef APP -->
  <scroll-view style="flex: 1; padding-bottom: 20px">
  <!-- #endif -->
    <view>
      <page-head title="getApp"></page-head>
      <view class="uni-padding-wrap">
        <button @click="getGlobalData">get globalData</button>
        <template v-if="data.originGlobalData.str.length">
          <text class="uni-common-mt bold">初始的 globalData:</text>
          <text class="uni-common-mt">globalData string: {{ data.originGlobalData.str }}</text>
          <text class="uni-common-mt">globalData number: {{ data.originGlobalData.num }}</text>
          <text class="uni-common-mt">globalData boolean: {{ data.originGlobalData.bool }}</text>
          <text class="uni-common-mt">globalData object: {{ data.originGlobalData.obj }}</text>
          <text class="uni-common-mt">globalData null: {{ data.originGlobalData.null }}</text>
          <text class="uni-common-mt">globalData array: {{ data.originGlobalData.arr }}</text>
          <text class="uni-common-mt">globalData Set: {{ data.originGlobalData.set }}</text>
          <text class="uni-common-mt">globalData Map: {{ data.originGlobalData.map }}</text>
          <text class="uni-common-mt">globalData fun 返回值: {{ data.originGlobalDataFuncRes }}</text>
        </template>
        <button @click="setGlobalData" class="uni-common-mt">
          set globalData
        </button>
        <template v-if="data.newGlobalData.bool">
          <text class="uni-common-mt bold">更新后的 globalData:</text>
          <text class="uni-common-mt">globalData string: {{ data.newGlobalData.str }}</text>
          <text class="uni-common-mt">globalData number: {{ data.newGlobalData.num }}</text>
          <text class="uni-common-mt">globalData boolean: {{ data.newGlobalData.bool }}</text>
          <text class="uni-common-mt">globalData object: {{ data.newGlobalData.obj }}</text>
          <text class="uni-common-mt">globalData null: {{ data.newGlobalData.null }}</text>
          <text class="uni-common-mt">globalData array: {{ data.newGlobalData.arr }}</text>
          <text class="uni-common-mt">globalData Set: {{ data.newGlobalData.set }}</text>
          <text class="uni-common-mt">globalData Map: {{ data.newGlobalData.map }}</text>
          <text class="uni-common-mt">globalData fun 返回值: {{ data.newGlobalDataFuncRes }}</text>
        </template>
        <text class="uni-common-mt">点击按钮调用 App.uvue methods</text>
        <text class="uni-common-mt">increaseLifeCycleNum 方法</text>
        <button class="uni-common-mt" @click="_increaseLifeCycleNum">
          increase lifeCycleNum
        </button>
        <text class="uni-common-mt">lifeCycleNum: {{ data.lifeCycleNum }}</text>
        <!-- #ifndef MP -->
        <button class="uni-common-mt" @click="getAndroidApplication">
          getAndroidApplication
        </button>
        <text class="uni-common-mt">androidApplication is null: {{ data.androidApplication == null }}</text>
        <!-- #endif -->
      </view>
    </view>
  <!-- #ifdef APP -->
  </scroll-view>
  <!-- #endif -->
</template>

<script setup lang="uts">
  import { state, setLifeCycleNum, updateGlobalData } from '@/store/index.uts'

  type MyGlobalData = {
    str : string,
    num : number,
    bool : boolean,
    obj : UTSJSONObject,
    null : string | null,
    arr : number[],
    set : string[],
    map : UTSJSONObject,
    fun : () => string
  }

  type DataType = {
    originGlobalData: MyGlobalData;
    originGlobalDataFuncRes: string;
    newGlobalData: MyGlobalData;
    newGlobalDataFuncRes: string;
    lifeCycleNum: number;
    androidApplication: any | null;
  }

  const data = reactive({
    originGlobalData: {
      str: '',
      num: 0,
      bool: false,
      obj: {
        str: '',
        num: 0,
        bool: false
      },
      null: null,
      arr: [] as number[],
      set: [] as string[],
      map: {},
      fun: () : string => ''
    },
    originGlobalDataFuncRes: '',
    newGlobalData: {
      str: '',
      num: 0,
      bool: false,
      obj: {
        str: '',
        num: 0,
        bool: false
      },
      null: null,
      arr: [] as number[],
      set: [] as string[],
      map: {},
      fun: () : string => ''
    },
    newGlobalDataFuncRes: '',
    lifeCycleNum: 0,
    androidApplication: null
  } as DataType)

  const getGlobalData = () => {
    data.originGlobalData.str = state.globalData.str
    data.originGlobalData.num = state.globalData.num
    data.originGlobalData.bool = state.globalData.bool
    data.originGlobalData.obj = state.globalData.obj
    data.originGlobalData.null = state.globalData.null
    data.originGlobalData.arr = state.globalData.arr
    state.globalData.set.forEach((value : string) => {
      data.originGlobalData.set.push(value)
    })
    state.globalData.map.forEach((value : any, key : string) => {
      data.originGlobalData.map[key] = value
    })
    data.originGlobalData.fun = state.globalData.fun
    data.originGlobalDataFuncRes = data.originGlobalData.fun()
  }

  const setGlobalData = () => {
    updateGlobalData('str', 'new globalData str')
    updateGlobalData('num', 100)
    updateGlobalData('bool', true)
    updateGlobalData('obj',{
      str: 'new globalData obj str',
      num: 200,
      bool: true
    })
    updateGlobalData('null', 'not null')
    updateGlobalData('arr', [1, 2, 3])
    updateGlobalData('set', new Set(['a', 'b', 'c']))
    updateGlobalData('map', new Map<string, any>([
      ['a', 1],
      ['b', 2],
      ['c', 3]
    ]))
    updateGlobalData('fun', () : string => {
      return 'new globalData fun'
    })

    data.newGlobalData.str = state.globalData.str
    data.newGlobalData.num = state.globalData.num
    data.newGlobalData.bool = state.globalData.bool
    data.newGlobalData.obj = state.globalData.obj
    data.newGlobalData.null = state.globalData.null
    data.newGlobalData.arr = state.globalData.arr
    console.log('state.globalData.arr',state.globalData.arr)
    console.log('state.globalData.set',state.globalData.set)
    state.globalData.set.forEach((value : string) => {
      data.newGlobalData.set.push(value)
    })
    state.globalData.map.forEach((value : any, key : string) => {
      data.newGlobalData.map[key] = value
    })
    data.newGlobalData.fun = state.globalData.fun
    data.newGlobalDataFuncRes = data.newGlobalData.fun()
  }

  const _increaseLifeCycleNum = () => {
    const app = getApp()
    app.vm!.increaseLifeCycleNum()
    data.lifeCycleNum = state.lifeCycleNum
  }

  // 自动化测试
  const setLifeCycleNumFunc = (num : number) => {
    setLifeCycleNum(num)
  }

  // #ifndef MP
  const getAndroidApplication = () : boolean => {
    const app = getApp()
    data.androidApplication = app.getAndroidApplication()
    return data.androidApplication !== null
  }
  // #endif

  onReady(() => {
    data.lifeCycleNum = state.lifeCycleNum
  })

  defineExpose({
    data,
    getGlobalData,
    setGlobalData,
    _increaseLifeCycleNum,
    setLifeCycleNumFunc,
    // #ifndef MP
    getAndroidApplication
    // #endif
  })
</script>

<style>
  .bold {
    font-weight: bold;
  }

  .hr {
    border-bottom: 1px solid #ccc;
  }
</style>

# 全局方法调用

以上示例，getApp()后调用了app.uvue里定义的increasetLifeCycleNum方法。app.uvue的源码另见

调整 ：HBuilderX 4.31 getApp() 返回值调整为 UniApp 类型，调用 App.uvue 中定义的全局方法，需要由 getApp().methodName() 调整为 getApp().vm?.methodName()。

# 参见

# 通用类型

# GeneralCallbackResult

名称 类型 必备 默认值 兼容性 描述
errMsg string 是 -
错误信息
本页导读
getApp()
getApp 兼容性
返回值
UniApp 的方法
getAndroidApplication(): Application
getHarmonyAbility(): UIAbility
示例
全局方法调用
参见
通用类型
GeneralCallbackResult