# @capacitor-firebase/app 中文文档

规范地址：https://npmcn.com/package/%40capacitor-firebase/app/

版本：8\.6\.0
npm 元数据更新时间：2026-10-31T07:03:44.114Z
中文译文更新时间：2026-11-09T02:59:38.552Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capacitor-firebase/app
原文对照：https://npmcn.com/package/%40capacitor-firebase/app/?lang=original
项目主页：https://capawesome.io/
源码仓库：https://github.com/capawesome-team/capacitor-firebase

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：47.5 kB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：firebase ^12\.6\.0，@capacitor/core \>=8\.0\.0
- 首次发布：2022-03-19T21:28:56.053Z
- 最新版本发布：2026-10-31T07:03:43.766Z
- 近 30 天下载量：63318（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 13 个）

## 中文简介

Android,iOS,和Web上的Firebase App的电容插件.

## 安装

```sh
npm install @capacitor-firebase/app
```

也可以使用：`pnpm add @capacitor-firebase/app`、`yarn add @capacitor-firebase/app`、`bun add @capacitor-firebase/app`

## README

# 电容火基应用插件

非官方电容插件 [火基地应用](https://firebase.google.com/docs)\[^1\]

[![Thousands of teams ship faster with Capawesome Cloud Native Builds and Live Updates](https://capawesome.io/assets/banners/cloud-teams-ship-faster-with-capacitor.png)](https://capawesome.io/)

## 使用大小写

Firebase App插件一般用于访问您应用程序的核心Firebase配置,例如:

-   **配置检查**:在运行时读取Firebase配置选项,如API密钥,应用程序ID,以及项目ID等,以验证该app是否与正确的Firebase项目相连接.
-   **多环境应用**:通过检查Google Cloud项目ID来区分中转和生产建设.
-   **调试屏幕**: 在内部调试视图中显示 Firebase 项目细节, 如存储桶或数据库 URL等 .

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 8.x.x (英语) | \>=8.x.x | 积极支持 |
| 7.x.x (中文(简体) ) | 7.x.x (中文(简体) ) | 折旧 |
| 6.x.x (中文(简体) ) | 6.x.x (中文(简体) ) | 折旧 |
| 5.x.x (中文(简体) ) | 5.x.x (中文(简体) ) | 折旧 |
| 1.x.x (中文(简体) ) | 4.x.x (中文(简体) ) | 折旧 |

## 指南

-   [如何在电容App中使用火把](https://capawesome.io/blog/how-to-use-firebase-in-a-capacitor-app/):整个插件家族的起步点和每个Firebase插件共享的设置.

## 安装

你可以用我们的 **AI 辅助设置** 以安装插件. 添加数据 [超级技能](https://github.com/capawesome-team/skills) 至您的 AI 工具,使用以下命令:

```bash
npx skills add capawesome-team/skills --skill capacitor-plugins
```

然后使用下列提示:

```
Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/app` plugin in my project.
```

如果你喜欢 **手动设置**,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capacitor-firebase/app firebase
npx cap sync
```

如果您还没有将 Firebase 添加到您的项目中([机器人](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) 编号 : [iOS系统](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) 编号 : [网页](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)) (中文(简体) ).

### 机器人

#### 变量

如果需要, 您可以在您的应用程序中定义以下工程变量 `variables.gradle` 要更改依赖的默认版本的文件 :

-   `$firebaseCommonVersion` 版本 `com.google.firebase:firebase-common` (默认 : `22.0.1`(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

### iOS系统

#### Swift 软件包管理器

在您的 `capacitor.config.json` (或 `capacitor.config.ts`) 避免 [SwiftPM 软件包识别相撞](https://github.com/capawesome-team/capacitor-firebase/issues/959)数字 :

```json
{
  "experimental": {
    "ios": {
      "spm": {
        "packageOptions": {
          "@capacitor-firebase/app": {
            "symlink": true
          }
        }
      }
    }
  }
}
```

**请注意**目标 `packageOptions` 支持需要控制器 CLI **8.4.0+ (中文(简体) )**。 。 。 .

## 配置

此插件不需要配置 .

## 演示

这里有一个实例: [robingenz/电容器-火力基地-插座-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)

## 使用量

以下例子显示了如何获得Firebase应用名称及其配置选项.

### 获取应用程序名称

获取 Firebase 应用程序的独有名称 :

```typescript
import { FirebaseApp } from '@capacitor-firebase/app';

const getName = async () => {
  const result = await FirebaseApp.getName();
};
```

### 获取 Firebase 配置选项

获取 Firebase app的配置选项, 如 API 密钥, 应用程序 ID, 以及工程 ID :

```typescript
import { FirebaseApp } from '@capacitor-firebase/app';

const getOptions = async () => {
  const result = await FirebaseApp.getOptions();
};
```

## API 密码

-   [`getName()`](https://npmcn.com/package/%40capacitor-firebase/app/#readme-getname)
-   [`getOptions()`](https://npmcn.com/package/%40capacitor-firebase/app/#readme-getoptions)
-   [接口](https://npmcn.com/package/%40capacitor-firebase/app/#readme-interfaces)

### 获取Name ()

```typescript
getName() => Promise<GetNameResult>
```

获取这个应用程序的名称 .

**回返情况:** `Promise<[GetNameResult](https://npmcn.com/package/%40capacitor-firebase/app/#readme-getnameresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 获取选项( )

```typescript
getOptions() => Promise<GetOptionsResult>
```

获取此应用程序的配置选项 .

**回返情况:** `Promise<[GetOptionsResult](https://npmcn.com/package/%40capacitor-firebase/app/#readme-getoptionsresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 接口

#### 获取Name

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`name`** | `string` | 此应用程序的独有名称. | 0.1.0 (中文(简体) ) |

#### 获取可选结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`apiKey`** | `string` | API 密钥用于认证您的应用程序中的请求 . | 0.1.0 (中文(简体) ) |
| **`applicationId`** | `string` | Google App ID 用于唯一识别一个应用程序实例. | 0.1.0 (中文(简体) ) |
| **`databaseUrl`** | `string` | 数据库根 URL . | 0.1.0 (中文(简体) ) |
| **`gcmSenderId`** | `string` | 工程编号. | 0.1.0 (中文(简体) ) |
| **`projectId`** | `string` | 谷歌云项目ID. | 0.1.0 (中文(简体) ) |
| **`storageBucket`** | `string` | 谷歌云存储桶名. | 0.1.0 (中文(简体) ) |

## 财务问题

### 此插件支持哪个平台 ?

该插件支持Android,iOS,和Web. 两者 `getName()` 财务报告和审定财务报表 `getOptions()` 可在所有三个平台上查阅.

### 在使用此插件之前, 是否需要配置什么 ?

不需要插件特定配置 。 然而,您必须先在您的项目中添加 Firebase 。 这个 [安装](https://npmcn.com/package/%40capacitor-firebase/app/#readme-installation) 区域链接到Firebase为Android,iOS,和Web设置指令.

### 什么信息会 `getOptions` 还我?

这个 `getOptions()` 方法返回 Firebase app的配置选项:用于认证请求的 API 密钥, Google App ID, 数据库根 URL, 项目号, Google Cloud 项目 ID, 和 Google Cloud 存储桶名.

### IOS上的SwiftPM包身份相撞,我该如何修复??

如果您使用 Swift 软件包管理器, 请添加 `symlink` 软件包选项 `@capacitor-firebase/app` 切换到 [安装](https://npmcn.com/package/%40capacitor-firebase/app/#readme-installation) 节。 说明SPM `packageOptions` 支持需要CLI 8.4.0或以后.

### 这是正式的Firebase插件吗?

不,这是Firebase App SDK的非官方电容插件. 该项目不附属于Google有限责任公司或其任何子公司或子公司,也不由其认可、赞助或批准.

### 我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

## 相关插件

-   [火场分析](https://capawesome.io/docs/sdks/capacitor/firebase/analytics/):记录事件并跟踪用户与Firebase Analytics的互动.
-   [Firebase 验证](https://capawesome.io/docs/sdks/capacitor/firebase/authentication/): 以 Firebase 认证用户 .
-   [火灾基地崩溃](https://capawesome.io/docs/sdks/capacitor/firebase/crashlytics/):跟踪并报告应用软件与火地崩溃.
-   [火地云通讯](https://capawesome.io/docs/sdks/capacitor/firebase/cloud-messaging/): 以 Firebase Cloud Messageing 接收按压通知 .

## 通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 [《卡帕索克通讯》](https://cloud.capawesome.io/newsletter/)。 。 。 .

## 更改日志

见 [变动情况](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/app/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/app/LICENSE)。 。 。 .

\[^1\]: 这个项目不附属于Google LLC或其任何子公司或子公司,也不获得其认可、支持、赞助或批准.

## 常见问题

### @capacitor-firebase/app 是什么？

Android,iOS,和Web上的Firebase App的电容插件\.

### 如何安装 @capacitor-firebase/app？

在项目目录运行 npm install @capacitor-firebase/app，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capacitor-firebase/app 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capacitor-firebase/app 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capacitor-firebase/app 可以商用吗？

@capacitor-firebase/app 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @capacitor-firebase/app 的下载量有多少？

根据 npm 官方下载统计，@capacitor-firebase/app 在 2026/10/09 – 2026/11/07 这 30 天内被下载 63,318 次，日均约 2,111 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capacitor-firebase/app 还在维护吗？

最新版本 8\.6\.0 发布于 2026/10/31（9 天前）；至今共发布 51 个版本，其中过去 12 个月发布了 13 个；首次发布于 2022/03/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

