Electron Notarize 使用教程

Electron Notarize 使用教程

notarize 项目地址: https://gitcode.com/gh_mirrors/el/electron-notarize

1. 项目介绍

electron-notarize 是一个用于将 Electron 应用程序进行 macOS 公证的工具。在 macOS 10.14 及更高版本中，用户可以在启用 Gatekeeper 的情况下启动经过公证的应用程序。公证过程包括将应用程序上传到 Apple 进行处理，并在分发前对其进行代码签名和附加 Apple 的票据。

2. 项目快速启动

安装

首先，通过 npm 安装 electron-notarize：

npm install @electron/notarize --save-dev

使用示例

以下是一个简单的使用示例，假设你已经有一个打包好的 Electron 应用程序：

const { notarize } = require('@electron/notarize');

async function notarizeApp() {
  await notarize({
    appPath: '/path/to/your/app.app',
    appleId: 'your-apple-id',
    appleIdPassword: 'your-app-specific-password',
    teamId: 'your-team-id'
  });
}

notarizeApp().catch(console.error);

关键参数说明

• appPath: 你的 Electron 应用程序的绝对路径。
• appleId: 你的 Apple Developer 账户的用户名。
• appleIdPassword: 你的 Apple ID 的应用专用密码。
• teamId: 你的开发者团队的 Team ID。

3. 应用案例和最佳实践

应用案例

假设你正在开发一个跨平台的桌面应用程序，并希望在 macOS 上提供最佳的用户体验。通过使用 electron-notarize，你可以确保你的应用程序在 macOS 上通过 Gatekeeper 的检查，从而提高用户信任度。

最佳实践

1. 使用环境变量：不要在代码中硬编码你的 Apple ID 和密码。使用环境变量来存储这些敏感信息。
2. 调试日志：在开发过程中，使用 DEBUG=electron-notarize* 环境变量来启用调试日志，以便更好地了解公证过程。
3. 验证公证：使用 stapler validate 命令来验证你的应用程序是否已经成功公证。

4. 典型生态项目

Electron

electron-notarize 是 Electron 生态系统中的一个重要工具。Electron 是一个用于构建跨平台桌面应用程序的开源框架，它结合了 Chromium 和 Node.js。

Electron Forge

Electron Forge 是一个用于打包和分发 Electron 应用程序的工具集。它集成了 electron-notarize，使得在构建过程中自动进行公证变得非常简单。

Electron Builder

Electron Builder 是另一个流行的 Electron 应用程序打包工具，它也支持集成 electron-notarize，以便在打包过程中自动进行公证。

通过这些工具和 electron-notarize 的结合，开发者可以轻松地构建、打包和分发符合 macOS 安全标准的 Electron 应用程序。

notarize 项目地址: https://gitcode.com/gh_mirrors/el/electron-notarize