用途
本技能用于指导 Syncfusion Vue 组件的授权(Licensing)相关事项,包括授权要求、许可证密钥生成、注册方法以及校验错误的排查。当用户询问 Syncfusion Vue 授权、许可证密钥、许可证注册、许可证校验错误、试用许可证或许可证相关内容时,可使用本技能。
授权概述
Syncfusion 许可证密钥校验在 2022 Volume 1 版本(v20.1.0.47)中针对 Essential JS2 平台引入。所有从 npm、CDN 或构建流程引用 Syncfusion 包的 Vue 应用,都必须注册有效的许可证密钥,以避免校验警告。
许可证密钥与解锁密钥
- 许可证密钥(License Key):在应用代码中注册的字符串,用于校验 Syncfusion 包的使用。
- 解锁密钥(Unlock Key):仅在 Syncfusion 安装程序流程中使用。
注意:许可证密钥与安装程序解锁密钥并不相同。
核心要求
- 许可证密钥校验在 v20.1.0.47+(2022 Volume 1)引入。
- 许可证密钥与版本以及平台/版本(edition)相关。
- 校验在离线状态下进行(运行时无需互联网)。
- 使用 npm 包或试用安装程序时需要许可证密钥。
- 使用已授权的安装程序时不需要许可证密钥。
许可证类型
- 试用许可证:30 天评估期,功能完整,可生成试用密钥,过期后显示警告。
- 社区许可证:面向符合条件的个人/组织(营收低于 100 万美元)免费,功能与付费许可证相同,需每年续订。
- 付费许可证:适用于企业用途的商业许可证,可为永久或订阅制,包含技术支持。
基于版本(Edition)与基于平台(Platform)
- v31.1.17+(基于版本):UI Edition、Document SDK、PDF Viewer SDK、DOCX Editor SDK、Spreadsheet Editor SDK、Enterprise Edition(所有版本合并)。
- v30.x.x 及更早(基于平台):Vue、JavaScript、Angular、React、Blazor 等。
构建服务器场景
- 使用 npm 包:需要许可证密钥,通过 NPX 命令注册。
- 使用试用安装程序:需要许可证密钥,30 天后出现试用警告。
- 使用已授权的安装程序:不需要许可证密钥,已内置许可证校验。
离线校验
- 应用运行时无需互联网连接。
- 启动时根据包元数据在本地完成许可证校验。
- 可在隔离网络环境和离线开发中使用。
- 无外部 API 调用,不影响性能。
文档与导航指南
生成许可证密钥
参考:references/license-generation.md
内容包括:基于版本的授权(v31.1.17+),涵盖 UI Edition、Document SDK、PDF Viewer SDK、DOCX Editor SDK、Spreadsheet Editor SDK、Enterprise Edition;基于平台的授权(v30.x.x 及更早),涵盖 Vue、JavaScript、Angular 等;从 License & Downloads 页面生成密钥;Claim License Key 页面用法;与版本和平台相关的许可证密钥。
注册许可证密钥
参考:references/license-registration.md
内容包括:环境变量方法 SYNCFUSION_LICENSE;CI/CD 集成(GitHub Actions、Azure Pipelines);有效许可证、有效试用、许可证过期等场景。
排查许可证错误
参考:references/licensing-errors.md
内容包括:许可证密钥未注册错误;无效密钥错误;试用过期错误(30 天);平台不匹配错误;版本不匹配错误;NPX 命令校验错误。
快速开始
1. 生成许可证密钥
访问 License & Downloads 页面:
对于 v31.1.17+(基于版本):
- 选择 31.x.x 或更高版本
- 选择所需的版本(edition):UI Edition、Document SDK、PDF Viewer SDK、DOCX Editor SDK、Spreadsheet Editor SDK
- 推荐:选择全部 5 个版本以获取 Enterprise Edition 密钥
- 点击 “Get License Key”
对于 v30.x.x 及更早(基于平台):
- 选择 30.x.x 或更早版本
- 选择平台:Vue、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 许可证密钥注册文档。