许可

功能、许可层级和许可服务

本页是运行时参考,说明许可如何影响 Doconut 的行为:每种许可状态允许的内容、功能如何授予,以及如何在代码中检查所有这些。(有关加载许可,请参见 入门 → 许可设置。)

许可状态及其作用

状态是否打开文档?水印功能
完整(付费)许可(此构建在其订阅日期之前发布)是无已购买的(Has* 标志)
临时许可(Developer/NFR — 评估许可,在其到期日前)是基础查看器无水印;插件输出带水印全部 — 全面授予(评估渠道)
已过期的临时许可(已超过其 LicenseExpiry 日期)是评估水印未授予任何功能
完全没有许可文件是评估水印未授予任何功能
已找到但被拒绝(签名无效、被篡改、列入黑名单,或在许可订阅日期之后发布的构建)否 — 每次打开均出现 LicenseException——

已过期订阅日期的付费许可仍然可用——保持清洁,并保留其功能——适用于该日期之前发布的所有构建。仅在该日期之后发布的构建会被拒绝。

值得内部化的两个后果:

  • 缺少许可并非临时许可。 没有许可文件时,页面会显示水印,且没有任何功能(搜索、注释、插件)激活。完整且无水印的体验需要实际的 临时许可(获取一个)。
  • 只有被拒绝的许可会阻止打开。 已过期的临时许可仍使应用运行并显示评估水印,已过期的付费许可在其覆盖的构建上仍保持清洁渲染;但部署在 许可订阅日期之后 发布的构建会被拒绝,并通过 LicenseException 快速失败,因此你可以在部署时捕获,而不是悄悄发布带水印的输出。该异常(来自 OpenDocumentAsync)携带来自 License.RejectionMessage 的原因。

功能

Doconut 通过 功能 来控制可选功能。它涵盖内置的 搜索 和 注释 功能以及可选的 转换器、Dicom 和 签名 插件,均由你的许可授予。基础查看器不是功能——它是前提条件,以 IsViewerLicensed 形式呈现:

csharp
var lic = app.Services.GetRequiredService<IDoconutLicenseService>();
bool viewerLicensed = lic.IsViewerLicensed; // 存在 non-TRIAL 许可证且覆盖此构建的版本

整个管道使用的唯一门控是 IsCapabilityGranted:

csharp
var lic = app.Services.GetRequiredService<IDoconutLicenseService>();
bool searchGranted = lic.IsCapabilityGranted(LicenseCapability.Search);

其逻辑直接取自实现:一个有效(未过期)的 临时 许可授予 所有 功能——包括尚未拥有专用购买标志的功能;真实的已购买许可仅授予其 Has* 标志,并对任何未映射的功能采用 默认拒绝。 (旧版 TRIAL 类型文件 不是 权益——它被视为未授权:带水印,未授予任何功能。)

临时许可

临时(Developer/NFR)许可通过 ExpiryNote 标记,并携带硬性到期日期:

成员含义
IsTemporary存在 ExpiryNote 标记(检测方式为标记存在——永不匹配注释文本,它是动态的)
ExpiryNote嵌入许可中的信息文本
LicenseExpiry硬性到期日期(DateTime?)

到期语义因层级而异:临时许可在其 LicenseExpiry 仅日期 时到期(其订阅窗口被忽略;缺少日期的临时许可被视为已过期,安全失效)。其他所有许可在其订阅/更新窗口日期到期;对于付费许可,IsExpired 仅报告该日期已过——在此日期之前发布的构建保持清洁并保留其功能。

IDoconutLicenseService 参考

注入 IDoconutLicenseService(命名空间 Doconut.Core.Interfaces;以单例方式注册——许可在启动时解析一次):

成员含义
License完整的 DoconutLicenseInfo 快照(如下)
IsTrial旧版 TRIAL 类型文件(视为未授权——不是权益)
IsTemporary / ExpiryNote / LicenseExpiry临时许可标记
IsExpired根据上述层级规则已过期
IsVersionValid此构建位于许可的支持窗口内
IsViewerLicensed找到非 TRIAL 文件 且 版本受覆盖——基础前提条件
IsCapabilityGranted(cap)单一功能门控
HasSearch HasAnnotation HasEditor HasConverter HasDicom HasDocumentTools HasSigner HasRedactor HasComparer HasForms HasProtector HasCompressor每个功能对应一个标志:由覆盖此构建的许可购买,或由活动的临时许可授予。IsCapabilityGranted 按功能回答相同的问题
IsValidForDomain(host)主机覆盖;V4 许可使用通配符 *.*
LicenseRejectionReason非空 ⇒ 打开被阻止,并显示此消息

DoconutLicenseInfo 公开用于管理面板的友好显示快照:Owner、LicenseType、Domain、IsLicenseFileFound、IsVersionValid、IsTrial、IsExpired、Has* 标志、临时许可字段,以及 RejectionMessage。

csharp
// 使用 SDK 所使用的相同真实来源对 UI 进行 Feature-flag
app.MapGet("/api/features", (IDoconutLicenseService lic) => Results.Ok(new
{
    viewer     = lic.IsViewerLicensed || lic.IsTemporary,
    search     = lic.IsCapabilityGranted(LicenseCapability.Search),
    annotation = lic.IsCapabilityGranted(LicenseCapability.Annotation),
    conversion = lic.HasConverter,
    dicom      = lic.HasDicom,
}));

健康检查

AddDoconut() 注册一个 "doconut" 健康检查,通过标准 ASP.NET Core 机制报告许可/到期状态:

csharp
app.MapHealthChecks("/health");

将其接入监控后,过期的订阅会变成警报而不是支持工单。当许可被拒绝或 IsExpired 为真时,检查报告 Unhealthy;对于付费许可,这意味着订阅日期已过,且在其之后发布的包将被拒绝——当前构建保持清洁渲染。

版本升级

许可覆盖一个 版本窗口。将 NuGet 包更新到 超出该窗口的构建会使许可对该构建失效:IsVersionValid 变为 false,并使用 LicenseException 阻止打开(原因在 License.RejectionMessage 中)——故意快速失败,以便在部署时捕获陈旧或未授权的构建,而不是悄悄在生产输出上加水印。续订订阅,替换 .lic,并重新启动应用程序,使 AddDoconut() 加载新许可。

此页面对您有帮助吗?