许可证设置
Doconut 在何处查找您的许可证文件
没有许可证时,Doconut 仍然渲染文档——每页仅带有评估水印。本页介绍提供许可证的四种方式,以及当设置多个时的确切优先级。
许可证在 一次,在 AddDoconut() 期间 加载。这与之前的 .NET Standard 库不同,之前是将许可证交给 Viewer 实例或通过静态 Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...) 调用设置的。这些方法在此版本中不再是启动机制——请参阅 迁移指南。
提供许可证的四种方式
共有四种:在 DoconutOptions 上的三种显式来源——流、原始内容或文件路径——以及当未设置任何来源时的自动发现。当设置多个时,优先级如下:
LicenseStream 优先于 LicenseContent 优先于 LicensePath 优先于 auto-search.
按路径
LicensePath 按原样传递给 File.Exists。相对路径会相对于进程的 当前工作目录 解析——而不是您的项目文件夹,也不是 Program.cs 所在的文件夹。如果路径无法解析,Doconut 不会抛出异常,也 不会 回退到自动搜索——它仅仅不加载许可证,查看器会显示水印。仅当 LicensePath、LicenseContent 或 LicenseStream 均未设置时,才会运行自动搜索。同一文件夹中的每个插件许可证文件(Doconut.Viewer.<Capability>.lic)会随之读取,因此当插件许可证与基础许可证并列时,LicensePath 与 AddPlugin<...>() 能协同工作。
建议使用绝对路径(例如由 IWebHostEnvironment.WebRootPath 或 AppContext.BaseDirectory 构建),或者完全跳过 LicensePath,依赖下面的自动发现。
builder.Services.AddDoconut(options =>
{
options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});按流
LicenseStream 在启动时读取一次——当许可证来自机密存储而非磁盘文件时非常有用。
// 优先级:LicenseStream > LicenseContent > LicensePath > 自动搜索。
builder.Services.AddDoconut(options =>
{
options.LicenseStream = licenseStream;
});按内容
LicenseContent 接受许可证文本本身——可以来自环境变量、数据库或机密管理器:
// License XML 来自数据库、环境变量或密钥管理器 —
// 磁盘上没有文件。仅次于 LicenseStream。
builder.Services.AddDoconut(options =>
{
options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});自动发现
如果未配置这三种显式来源,Doconut 将自行搜索许可证:
// 不进行任何配置,Doconut 会自行搜索许可证,仅在以下两个文件夹中:
// 1. {CurrentDirectory}/wwwroot
// 2. {AppContext.BaseDirectory}/wwwroot (构建输出文件夹中的 wwwroot)
// 它首先查找 Doconut.lic,然后是 Doconut.Viewer.lic,以及任何按功能划分的
// Doconut.Viewer.<Capability>.lic 文件与其并列。
builder.Services.AddDoconut();按顺序探查的文件夹以及在每个文件夹中查找的文件名如下:
1. {CurrentDirectory}/wwwroot
2. {AppContext.BaseDirectory}/wwwroot
Filenames (checked in each folder above, in order):
Doconut.lic — base viewer license (checked first)
Doconut.Viewer.lic — base viewer license
Doconut.Viewer.<Capability>.lic — per-capability license, alongside the base license不会读取 wwwroot 文件夹之外的任何内容:位于输出文件夹本身或 wwwroot/lib 中的 .lic 将被忽略。
如果您之前向 Viewer 构造函数传入了 List<string>(每个功能一个)的许可证路径——请将这些伴随文件放在 Doconut.Viewer.lic 旁边,让自动发现读取它们。DoconutOptions 上没有路径列表选项。
复制许可证到输出文件夹
当进程不是从项目文件夹运行时——已发布的应用、IIS、容器或测试运行器——第一次探测会失败,第二次探测 {AppContext.BaseDirectory}/wwwroot 必须找到该文件。SDK 自带的测试应用在每次构建时使用此 MSBuild 目标将许可证复制到那里:
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
<ItemGroup>
<DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
<StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
</ItemGroup>
<!-- 先删除,这样在 wwwroot 中重命名或删除 .lic 也会将其从输出中移除。 -->
<Delete Files="@(StaleOutputLicenses)" />
<Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>目标必须是 $(OutDir)wwwroot:复制到输出根目录的 .lic 永远不会被自动搜索到。本页上的 LicensePath 示例指向相同的位置。
将
.lic文件排除在源代码控制之外——将它们与应用一起部署,或通过LicenseContent或LicenseStream从您的密钥存储注入许可证。
没有许可证会怎样
缺少许可证不会抛出异常。AddDoconut() 成功,应用启动,查看器运行——但每页都会带有评估水印,且没有授予任何可选功能。
找到但被拒绝的许可证文件情况不同。无效签名、篡改、列入黑名单,或在许可证版本窗口之外的构建会导致 OpenDocumentAsync 抛出 LicenseException,并伴随 License.RejectionMessage。没有拒绝信息的日历过期许可证会继续以水印模式运行。
插件需要功能
为没有相应授权的插件注册会产生不同的结果:缺少许可证、旧版 TRIAL 文件,或付费许可证未包含该功能时,AddDoconut() 会抛出 InvalidOperationException,导致应用无法启动。例如,注册 Converter 插件而没有授予 Converter 的许可证:
InvalidOperationException: The Converter plugin is registered via AddPlugin but no active
license grants Converter. Remove the AddPlugin<...>() call or install a license (or
trial/demo) that includes Converter.该信息会直接告诉您解决办法:要么删除该插件的 options.AddPlugin<...>() 调用,要么安装付费许可证或授予该功能的有效临时/演示(NFR)许可证。临时注册允许在到期后仍然存活,以便已配置的应用在运行时降级而不是在重启时崩溃;一旦到期,其功能仍会被撤销。
验证已加载的许可证
使用 IDoconutLicenseService,这是 SDK 使用的相同权威来源,用于公开经过身份验证的诊断端点或驱动功能标记。不要返回许可证内容或密钥。
app.MapGet("/api/doconut/license", (IDoconutLicenseService license) => Results.Ok(new
{
viewer = license.IsViewerLicensed || license.IsTemporary,
temporary = license.IsTemporary,
search = license.IsCapabilityGranted(LicenseCapability.Search),
annotation = license.IsCapabilityGranted(LicenseCapability.Annotation),
converter = license.HasConverter,
dicom = license.HasDicom
}));许可证在 AddDoconut() 注册期间读取。ResetLicense 目前是一个兼容性属性,没有活动的重新加载路径,因此更换许可证文件需要重新启动应用程序。
故障排查矩阵
| 症状 | 可能原因 | 检查 |
|---|---|---|
| 查看器工作正常但每页都有水印 | 未加载许可证,或许可证已日历过期 | 解决 IDoconutLicenseService;验证输出目录和进程工作目录 |
AddDoconut() 对插件抛出异常 | 许可证未授予该插件功能 | 检查 IsCapabilityGranted(...) 并移除未购买的注册 |
| 配置的相对路径在本地可用但在 IIS/容器中不可用 | 进程工作目录已更改 | 使用 AppContext.BaseDirectory 或绝对路径 |
替换的 .lic 文件无效 | 单例许可证服务已创建 | 重新启动应用程序 |
OpenDocumentAsync 抛出 LicenseException | 签名、域、版本窗口、黑名单或插件运行时门禁拒绝了许可证 | 在不向不受信任的客户端暴露的情况下读取异常/拒绝信息 |
| 按功能的许可证以前可用但现在不可用 | 旧代码将显式许可证路径传递给 Viewer 构造函数 | 将伴随的 .lic 文件移动到 Doconut.Viewer.lic 旁边,让自动发现加载它们 |
下一步
此页面对您有帮助吗?