用途
本技能用于指导 Syncfusion React 的授权相关事项,包括授权要求、许可证密钥生成、注册方法,以及授权验证错误的排查。适用于用户咨询 Syncfusion React 授权、许可证密钥、许可证注册、授权验证错误、试用许可证等场景。
授权概述
Syncfusion 许可证密钥验证自 2022 Volume 1 版本(v20.1.0.47)起为 Essential JS2 平台引入。所有从 npm、CDN 或构建产物中引用 Syncfusion 包的 React 应用,都必须注册有效的许可证密钥,以避免验证警告。
许可证密钥与解锁密钥的区别:
- 许可证密钥(License Key):在应用代码中注册、用于验证 Syncfusion 包使用的字符串。
- 解锁密钥(Unlock Key):仅在 Syncfusion 安装程序过程中使用。
- 重要:许可证密钥与安装程序解锁密钥并不相同。
核心要求:
- 许可证密钥验证自 v20.1.0.47+(2022 Volume 1)引入。
- 许可证密钥与版本和平台/版本(Edition)相关。
- 验证在离线状态下进行(运行时无需联网)。
- 使用 npm 包或试用安装程序时需要密钥。
- 使用已授权安装程序时不需要密钥。
授权类型
- 试用许可证:30 天评估期,功能完整,生成试用密钥,过期后显示警告。
- 社区许可证:对符合条件的个人/组织免费(年收入低于 100 万美元),功能与付费许可证相同,需每年续订。
- 付费许可证:面向企业使用的商业许可证,可为永久或订阅制,包含技术支持。
授权按版本(Edition)或平台划分:
- v31.1.17+(基于 Edition):UI Edition、Document SDK、PDF Viewer SDK、DOCX Editor SDK、Spreadsheet Editor SDK、Enterprise Edition(合并全部 Edition)。
- v30.x.x 及更早(基于平台):React、Angular、Vue、JavaScript、Blazor 等。
构建服务器场景
- 使用 npm 包:需要许可证密钥——通过 NPX 命令注册。
- 使用试用安装程序:需要许可证密钥——30 天后出现试用警告。
- 使用已授权安装程序:不需要许可证密钥——已包含内嵌的授权验证。
离线验证
- 应用运行时无需互联网连接。
- 启动时在本地依据包元数据验证许可证。
- 可在隔离网络环境和离线开发中使用。
- 无外部 API 调用,无性能影响。
生成许可证密钥
(详见参考文档 license-generation.md)
- 基于 Edition 的授权(v31.1.17+):UI Edition、Document SDK、PDF Viewer SDK、DOCX Editor SDK、Spreadsheet Editor SDK。
- 基于平台的授权(v30.x.x 及更早):React、JavaScript、Angular 等。
- 从 License & Downloads 页面生成密钥。
- 使用 Claim License Key 页面。
- 密钥与版本和平台相关。
注册许可证密钥
(详见参考文档 license-registration.md)
- 环境变量方法:SYNCFUSION_LICENSE。
- CI/CD 集成:GitHub Actions、Azure Pipelines。
- 覆盖活跃许可证、活跃试用、许可证过期等场景。
排查授权错误
(详见参考文档 licensing-errors.md)
- 许可证密钥未注册错误。
- 无效密钥错误。
- 试用过期错误(30 天)。
- 平台不匹配错误。
- 版本不匹配错误。
- NPX 命令验证错误。
快速开始
1. 生成许可证密钥
访问 License & Downloads 页面:
对于 v31.1.17+(基于 Edition):
- 选择 31.x.x 或更高版本。
- 选择所需的 Edition:UI Edition、Document SDK、PDF Viewer SDK、DOCX Editor SDK、Spreadsheet Editor SDK。
- 建议:选择全部 5 个 Edition 以获得 Enterprise Edition 密钥。
- 点击“Get License Key”。
对于 v30.x.x 及更早(基于平台):
- 选择 30.x.x 或更低版本。
- 选择平台:React、JavaScript 等。
- 点击“Get License Key”。
2. 在应用中注册许可证密钥
推荐方法:使用环境变量注册许可证密钥,可防止意外将许可证密钥提交到源代码管理。
步骤 1:设置环境变量:
Windows
setx SYNCFUSION_LICENSE "Your_License_Key_Here"
Mac/Linux
export SYNCFUSION_LICENSE='Your_License_Key_Here'
步骤 2:使用 NPX 命令激活许可证:
npx syncfusion-license activate
步骤 3:清除缓存:
Windows PowerShell
Remove-Item -Recurse -Force node_modules.cache
macOS/Linux
rm -rf node_modules/.cache
注意:关于其他许可证密钥注册方法,请参阅 Syncfusion 许可证密钥注册文档。
适用场景
适用于需要在 React 应用中配置、注册或排查 Syncfusion 组件授权的开发与构建场景,包括本地开发、CI/CD 流程以及离线/隔离网络环境。
限制
- 具体密钥申请与账号操作需在 Syncfusion 官方 License & Downloads 页面完成。
- 密钥与版本、平台/Edition 绑定,不匹配会导致验证错误。
- 试用许可证过期后会持续显示警告。
- 本技能资料未提供具体价格、代码示例的完整实现细节及更多扩展场景,相关事实暂未提供。