# @capgo/capacitor-firebase-crashlytics 中文文档

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

版本：8\.3\.1
npm 元数据更新时间：2026-09-14T15:49:25.105Z
中文译文更新时间：2026-11-09T16:08:01.938Z
软件包许可：MPL-2\.0

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

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

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

- 包体积（解压后）：107 kB，30 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-11-24T15:41:26.530Z
- 最新版本发布：2026-09-14T15:49:24.795Z
- 近 30 天下载量：2251（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

Firebase Crashlytics的电容插件.

## 安装

```sh
npm install @capgo/capacitor-firebase-crashlytics
```

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

## README

# @ capgo/ 电容- firebase- crashlytics( 电容/电容)

[![Capgo - Instant updates for Capacitor](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-firebase)](https://capgo.app/)

## [QQ 与 Capgo 为您的 App 即时更新](https://capgo.app/?ref=plugin)

## [缺少一个功能? 我们会为你建造插件..](https://capgo.app/consulting/?ref=plugin)

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

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 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 (中文(简体) ) | 折旧 |

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-firebase-crashlytics` plugin in my project.
```

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

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

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

### 机器人

#### 崩溃分解插件

首先,将 Crashlytics Gradle 插件的依赖性添加到您的根级( 项目级) Gradle 文件(`<project>/build.gradle`:

```diff
buildscript {
    dependencies {
+       // Add the dependency for the Crashlytics Gradle plugin
+       classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.9'
    }
}
```

将 Crashlytics Gradle 插件添加到您的模块( 应用级别) Gradle 文件( 通常是) `<project>/<app-module>/build.gradle`:

```gradle
apply plugin: 'com.google.firebase.crashlytics'
```

#### 变量

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

-   `$firebaseCrashlyticsVersion` 版本 `com.google.firebase:firebase-crashlytics` (默认 : `20.0.3`(中文(简体) )

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

### iOS系统

要生成人类可读崩溃报告, Crashlytics 需要您工程的调试符号 (dSYM) 文件 . 下列步骤描述您在构建您的应用程序时如何将 dSYM 文件自动上传到 Firebase :

1.  打开您的项目的 Xcode 工作空间, 然后在左侧导航器中选择其项目文件 .
2.  从 **目标** 列表中,选择主构建目标.
3.  点击 **构建设置** 选项卡,然后完成以下步骤,使 Xcode 为您的构建生成 dSYMS .
    1.  点击 **全体**,然后查找 `debug information format`。 。 。 .
    2.  设定 **调试信息格式** 改为 `DWARF with dSYM File` 为你所有的建筑类型.
4.  点击 **构建阶段** 选项卡并完成下列步骤:
    1.  点击 **\+ 键** 按钮,然后选择 **新建运行脚本阶段**。 。 。 .
        
        确定这个新 **运行脚本** 相位是您的工程的最后一个构建相; 否则 Crashlytics 无法正确处理 dSYMs .
        
    2.  扩展新 **运行脚本** 节.
        
    3.  脚本字段(位于 _贝壳_ 根据您的软件包管理器添加运行的脚本 :
        
        **可可树:**
        
        ```
        "${PODS_ROOT}/FirebaseCrashlytics/run"
        ```
        
        **Swift 软件包管理器 :**
        
        ```
        "${BUILD_DIR%/Build/*}/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/run"
        ```
        
    4.  在那个 **输入文件** 区域,根据您的软件包管理器添加以下文件位置的路径 :
        
        **可可树:**
        
        ```
        ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TARGET_NAME}
        ```
        
        ```
        $(SRCROOT)/$(BUILT_PRODUCTS_DIR)/$(INFOPLIST_PATH)
        ```
        
        **Swift 软件包管理器 :**
        
        ```
        ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}
        ```
        
        ```
        ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}
        ```
        
        ```
        ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Info.plist
        ```
        
        ```
        $(TARGET_BUILD_DIR)/$(UNLOCALIZED_RESOURCES_FOLDER_PATH)/GoogleService-Info.plist
        ```
        
        ```
        $(TARGET_BUILD_DIR)/$(EXECUTABLE_PATH)
        ```
        
        如果你有的话 `ENABLE_USER_SCRIPT_SANDBOXING=YES` 财务报告和审定财务报表 `ENABLE_DEBUG_DYLIB=YES` 在您的项目构建设置中,还包括:
        
        ```
        ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}.debug.dylib
        ```
        

## 配置

此插件不需要配置 .

## 演示

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

## 启动模板

以下启动模板可供使用:

-   [角起火点](https://ionstarter.dev/)

## 使用量

```typescript
import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

const crash = async () => {
  await FirebaseCrashlytics.crash({ message: 'Test' });
};

const setCustomKey = async () => {
  await FirebaseCrashlytics.setCustomKey({
    key: 'page',
    value: 'home',
    type: 'string',
  });
};

const setUserId = async () => {
  await FirebaseCrashlytics.setUserId({
    userId: '123',
  });
};

const log = async () => {
  await FirebaseCrashlytics.log({
    message: 'Test',
  });
};

const setEnabled = async () => {
  await FirebaseCrashlytics.setEnabled({
    enabled: true,
  });
};

const isEnabled = async () => {
  const { enabled } = await FirebaseCrashlytics.isEnabled();
  return enabled;
};

const didCrashOnPreviousExecution = async () => {
  const { crashed } = await FirebaseCrashlytics.didCrashOnPreviousExecution();
  return crashed;
};

const sendUnsentReports = async () => {
  await FirebaseCrashlytics.sendUnsentReports();
};

const deleteUnsentReports = async () => {
  await FirebaseCrashlytics.deleteUnsentReports();
};

const recordException = async () => {
  await FirebaseCrashlytics.recordException({
    message: 'This is a non-fatal message.',
  });
};

import * as StackTrace from 'stacktrace-js';
const recordExceptionWithStacktrace = async (error: Error) => {
  const stacktrace = await StackTrace.fromError(error);
  await FirebaseCrashlytics.recordException({
    message: 'This is a non-fatal message.',
    stacktrace,
  });
};
```

## API 密码

-   [`crash(...)`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-crash)
-   [`setCustomKey(...)`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-setcustomkey)
-   [`setUserId(...)`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-setuserid)
-   [`log(...)`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-log)
-   [`setEnabled(...)`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-setenabled)
-   [`isEnabled()`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-isenabled)
-   [`didCrashOnPreviousExecution()`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-didcrashonpreviousexecution)
-   [`sendUnsentReports()`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-sendunsentreports)
-   [`deleteUnsentReports()`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-deleteunsentreports)
-   [`recordException(...)`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-recordexception)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-type-aliases)

### 崩溃(...)

```typescript
crash(options: CrashOptions) => Promise<void>
```

强制坠机测试实施.

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[CrashOptions](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-crashoptions)` |

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

* * *

### 设置 CustomKey (...)

```typescript
setCustomKey(options: SetCustomKeyOptions) => Promise<void>
```

设置一个自定义密钥和值,该密钥和值与随后的致命和非致命报告相关.

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[CustomKeyAndValue](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-customkeyandvalue)` |

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

* * *

### set 用户(...)

```typescript
setUserId(options: SetUserIdOptions) => Promise<void>
```

设置一个与随后的致命和非致命报告相关的用户ID(识别符).

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetUserIdOptions](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-setuseridoptions)` |

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

* * *

### 日志(...)

```typescript
log(options: LogOptions) => Promise<void>
```

添加自定义日志消息, 这些信息会随崩溃数据一同发送, 以给自己更多导致崩溃的事件的背景 .

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[LogOptions](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-logoptions)` |

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

* * *

### 设置可启用(...)

```typescript
setEnabled(options: SetEnabledOptions) => Promise<void>
```

启用/ 无法自动收集数据 . 该值在应用程序的下一轮运行之前不应用 .

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetEnabledOptions](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-setenabledoptions)` |

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

* * *

### 已启用

```typescript
isEnabled() => Promise<IsEnabledResult>
```

返回是否启用自动数据收集.

仅供iOS使用.

**回返情况:** `Promise<[IsEnabledResult](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-isenabledresult)>`

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

* * *

### 先前的崩溃执行 ()

```typescript
didCrashOnPreviousExecution() => Promise<DidCrashOnPreviousExecutionResult>
```

返回应用程序在上次执行中是否崩溃 .

仅供Android和iOS使用.

**回返情况:** `Promise<[DidCrashOnPreviousExecutionResult](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-didcrashonpreviousexecutionresult)>`

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

* * *

### 发送未经同意的报告( )

```typescript
sendUnsentReports() => Promise<void>
```

在下次启动时将任何未发送的报告上传到崩溃分析 .

当自动数据收集被启用时,崩溃器会在启动时自动上传报告.

仅供Android和iOS使用.

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

* * *

### 删除未经同意的报告( )

```typescript
deleteUnsentReports() => Promise<void>
```

删除设备上任何未发送的报告.

仅供Android和iOS使用.

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

* * *

### 记录例外(...)

```typescript
recordException(options: RecordExceptionOptions) => Promise<void>
```

记录一份非致命报告 发送到Crashlytics.

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[RecordExceptionOptions](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-recordexceptionoptions)` |

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

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<GetPluginVersionResult>
```

获取此插件的版本 .

**回返情况:** `Promise<[GetPluginVersionResult](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-getpluginversionresult)>`

**自:** 8.0.2 联合国

* * *

### 接口

#### 崩溃选项

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`message`** | `string` | 0.1.0 (中文(简体) ) |

#### 自定义密钥和 Value

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`key`** | `string` | 7.1.0 (中文(简体) ) |
| **`value`** | `string | number | boolean` | 7.1.0 (中文(简体) ) |
| **`type`** | `'string' | 'boolean' | 'long' | 'double' | 'int' | 'float'` | 7.1.0 (中文(简体) ) |

#### 设置用户选择

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`userId`** | `string` | 0.1.0 (中文(简体) ) |

#### 日志选项

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`message`** | `string` | 0.1.0 (中文(简体) ) |

#### 设置可选选项

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`enabled`** | `boolean` | 0.1.0 (中文(简体) ) |

#### 已启用结果

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`enabled`** | `boolean` | 0.1.0 (中文(简体) ) |

#### DidCrash 上一个执行结果

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`crashed`** | `boolean` | 0.1.0 (中文(简体) ) |

#### 记录例外选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`message`** | `string` | 将信息记录为非致命例外. | 0.1.0 (中文(简体) ) |
| **`code`** | `number` | 特定出错域内的出错代码 . **请注意:** 如果 `stacktrace` 提供。 仅供iOS使用. | 0.1.0 (中文(简体) ) |
| **`domain`** | `string` | 包含错误域的字符串 . **请注意:** 如果 `stacktrace` 提供。 仅供iOS使用. | 0.1.0 (中文(简体) ) |
| **`keysAndValues`** | `CustomKeyAndValue[]` | 除应用级自定义密钥外,还有一系列密钥和与非致命例外关联的值. **请注意:** 如果 `stacktrace` 提供. | 7.1.0 (中文(简体) ) |
| **`stacktrace`** | `StackFrame[]` | 由 sacktrace.js 生成的堆栈. | 1.1.0 国家 |

#### 堆叠外观

由 stacktrace.js 生成的 Stacktrace 子集.

| Prop | 类型 |
| --- | --- |
| **`lineNumber`** | `number` |
| **`fileName`** | `string` |
| **`functionName`** | `string` |

#### 获取 PluginVersion 结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`version`** | `string` | 此插件的语义版本 . | 8.0.2 联合国 |

### 类型异名

#### 设置自定义关键选项

`[CustomKeyAndValue](https://npmcn.com/package/%40capgo/capacitor-firebase-crashlytics/#readme-customkeyandvalue)`

## 测试您的执行

[给](https://firebase.google.com/docs/crashlytics/force-a-crash) 您可以找到更多关于如何测试火地崩溃处理程序的信息. 除其他外,你会找到如何正确的信息 [调整工程的调试设置](https://firebase.google.com/docs/crashlytics/force-a-crash?platform=ios#adjust_your_projects_debug_settings) 在iOS下如何进行 [试试看](https://firebase.google.com/docs/crashlytics/force-a-crash?platform=ios#test_it_out)。 。 。 .

如果你得到iOS的模糊的崩溃报告, 请确保你有 [初始化崩溃](https://firebase.google.com/docs/crashlytics/get-started?platform=ios#initialize-crashlytics) 正确,看一看 [本指南](https://firebase.google.com/docs/crashlytics/get-deobfuscated-reports?platform=ios)如果Crashlytics找不到你的应用程序的dSYM,它提供了一些解决问题的方法.

## 更改日志

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

## 许可证

见 [自由主义](https://github.com/cap-go/capacitor-firebase/blob/main/packages/crashlytics/LICENSE)。 。 。 .

## 贷项

此插件基于 [社区火灾基地崩溃](https://github.com/capacitor-community/firebase-crashlytics) 插件 . 感谢所有为这个项目捐款的人!

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

## 常见问题

### @capgo/capacitor-firebase-crashlytics 是什么？

Firebase Crashlytics的电容插件\.

### 如何安装 @capgo/capacitor-firebase-crashlytics？

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

### @capgo/capacitor-firebase-crashlytics 支持 TypeScript 吗？

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

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

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

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

@capgo/capacitor-firebase-crashlytics 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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