许可

功能、许可证层级与许可证服务

此页面是运行时参考,说明许可证如何影响 Doconut 的行为:每种许可证状态允许的操作、功能如何授予,以及如何在代码中检查所有这些信息。(有关 加载 许可证,请参阅 License Setup。)

许可证状态及其作用

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

已过期订阅日期的付费许可证仍然可以工作——保持清洁,并具备其功能——在该日期之前发布的所有构建上。仅在该日期之后发布的构建会被拒绝。

有两点值得牢记的后果:

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

功能

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

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

整个流水线使用的唯一门控是 IsCapabilityGranted:

csharp
var lic = Doconut.DoconutHost.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)来自 DoconutHost.Services。它是单例 —— 许可证在 DoconutHost.Initialize 中仅解析一次:

成员含义
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
// GET /Features - 从 SDK 使用的相同真相源对 UI 进行功能标记
public ActionResult Index()
{
    var lic = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(new
    {
        viewer     = lic.IsViewerLicensed || lic.IsTemporary,
        search     = lic.IsCapabilityGranted(LicenseCapability.Search),
        annotation = lic.IsCapabilityGranted(LicenseCapability.Annotation),
        conversion = lic.HasConverter,
        dicom      = lic.HasDicom,
    }, JsonRequestBehavior.AllowGet);
}

健康检查

Doconut 注册了一个 "doconut" 健康检查,用于报告许可证状态。Classic ASP.NET 没有自己的健康端点,因此从控制器中公开它:

csharp
// GET /Health - Doconut 注册了一个 "doconut" 健康检查,用于报告许可证状态:
// 健康(有效),降级(试用或无许可证文件),不健康(被拒绝或已过期)。
public async Task<ActionResult> Index()
{
    var health = Doconut.DoconutHost.Services.GetRequiredService<HealthCheckService>();
    HealthReport report = await health.CheckHealthAsync();

    Response.StatusCode = report.Status == HealthStatus.Unhealthy ? 503 : 200;
    return Content(report.Status.ToString(), "text/plain");
}

将其接入监控后,订阅即将到期时会触发警报,而不是生成支持工单。当许可证被拒绝或 IsExpired 为 true 时,检查会报告 Unhealthy;对于付费许可证,这意味着订阅日期已过,随后发布的包将被拒绝 —— 当前构建仍保持正常渲染。请参阅 Doconut 主机 获取状态值。

版本升级

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

此页面对您有帮助吗?