DoconutOptions
Cấu hình các dịch vụ Doconut
DoconutOptions (namespace Doconut) là đối tượng cấu hình duy nhất cho toàn bộ SDK. Bạn cấu hình nó một lần, bên trong AddDoconut(), và nó được đăng ký như một singleton.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Properties
| Kiểu | Thuộc tính | Mặc định | Mô tả |
|---|---|---|---|
bool | ShowDoconutInfo | false | Khi true, một yêu cầu middleware không có token sẽ trả về một banner phiên bản (Doconut <version> is running on <host>) thay vì 404. Hữu ích như một kiểm tra nhanh; để false trong môi trường production. |
bool | UnsafeMode | false | Khi true, bỏ qua kiểm tra bảo mật ASP.NET-session trên các yêu cầu trang. Để false trong môi trường production (xem Core Concepts → Sessions & Security). |
string | MiddlewarePath | "/doconut" | Giá trị phối hợp cho endpoint page-image. Nó được xác thực, nhưng không gắn một nhánh pipeline; giữ nó đồng bộ với ánh xạ UseDoconut() thực tế và client BasePath. |
string | ResourcesPath | "/doconut-res" | Tiền tố đường dẫn URL cho các tài nguyên JS/CSS/hình ảnh/phông chữ được nhúng. |
string | LicensePath | "" | Đường dẫn tới tệp giấy phép. Trống → nguồn giấy phép tiếp theo, sau đó tự động khám phá; không tìm thấy → trạng thái đánh dấu nước đánh giá không có khả năng. |
string | LicenseContent | "" | Nội dung XML giấy phép thô (cơ sở dữ liệu, biến môi trường, secret manager). Có ưu tiên hơn LicensePath. |
Stream? | LicenseStream | null | Giấy phép dưới dạng stream, đọc một lần khi khởi động. Có ưu tiên hơn cả hai nguồn khác. |
bool | ResetLicense | false | Cờ tương thích dự trữ. Triển khai .NET 6 hiện tại không sử dụng nó; khởi động lại ứng dụng sau khi thay thế giấy phép. |
DoconutPluginRegistry | PluginRegistry | — | Registry chỉ đọc thu thập các đóng góp plugin; được sử dụng bởi factory viewer. Điền dữ liệu qua AddPlugin<T>(). |
Thứ tự ưu tiên giấy phép (được thực thi khi đăng ký dịch vụ): LicenseStream → LicenseContent → LicensePath → tự động khám phá (xem Getting Started → License Setup).
Methods
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Sử dụng phương thức này cho các gói Converter, DICOM và Signer đã phát hành theo lựa chọn. Annotation và Search bình thường là các tính năng có giấy phép tích hợp sẵn và không sử dụng AddPlugin<TPlugin>().
Đăng ký một plugin nội bộ (Converter, DICOM, Signer). Fluent — trả về instance của options. AddDoconut() ném InvalidOperationException khi thiếu giấy phép, tệp legacy TRIAL, hoặc giấy phép trả phí không cấp quyền cho plugin. Các đăng ký tạm thời/Demo được giữ lại sau khi hết hạn và sẽ chịu rào cản thời gian chạy (xem Core Concepts → Plugin System).
Widget Converter theo lựa chọn được bật bằng AddConverterWidget() và được hiển thị qua thuộc tính chỉ đọc ConverterWidget; các tùy chọn của nó được tài liệu trên trang Converter Plugin (Plugins → Converter Plugin). Widget Signer theo lựa chọn cũng được bật tương tự, với AddSignerWidget(), và được hiển thị qua thuộc tính chỉ đọc SignerWidget; xem Signer Plugin.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — dấu chấm đầu tùy chọn
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Đăng ký một custom viewer cho một phần mở rộng tệp. Custom viewer có ưu tiên hơn các viewer tích hợp sẵn và plugin và không bị giới hạn bởi giấy phép. Khi defaultConfig bị bỏ qua và một tài liệu mở mà không có cấu hình rõ ràng, một ImageConfig sẽ được sử dụng.
Ném ArgumentException (Extension must be a non-empty file extension.) khi phần mở rộng trống và ArgumentNullException khi factory null.
Startup validation
AddDoconut() xác thực các options fail-fast, vì vậy một cấu hình sai sẽ xuất hiện dưới dạng ngoại lệ rõ ràng khi khởi động thay vì các lỗi 404 gây nhầm lẫn khi yêu cầu:
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.Common configurations
// Môi trường sản xuất: giấy phép rõ ràng, mọi thứ được khóa chặt (tất cả các mặc định bảo mật)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// Đường dẫn tùy chỉnh (ví dụ: để tránh xung đột tuyến đường)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});Khi bạn thay đổi ResourcesPath, giữ ResPath của widget client đồng bộ (xem ViewerConfig).
MiddlewarePath không phải là một bộ ánh xạ route ASP.NET Core tự động. Nếu Doconut chỉ nên trả lời dưới một tiền tố tùy chỉnh, gắn UseDoconut() vào nhánh đó (ví dụ với app.Map("/docs-engine", branch => branch.UseDoconut())) và đặt client BasePath thành tiền tố đó mà không có ký tự đầu / ('docs-engine').
Trang này có hữu ích không?