DoconutOptions

กำหนดค่าบริการ Doconut

DoconutOptions (namespace Doconut) เป็นอ็อบเจกต์การกำหนดค่าเดียวสำหรับ SDK ทั้งหมด คุณกำหนดค่าเพียงครั้งเดียว ภายใน AddDoconut() และมันถูกลงทะเบียนเป็น singleton.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

คุณสมบัติ

ชนิดคุณสมบัติค่าเริ่มต้นคำอธิบาย
boolShowDoconutInfofalseเมื่อ true, คำขอ middleware ที่ไม่มีโทเคนจะคืนแบนเนอร์เวอร์ชัน (Doconut <version> is running on <host>) แทน 404 มีประโยชน์เป็นการตรวจสอบเบื้องต้น; ให้คงไว้ false ในการผลิต.
boolUnsafeModefalseเมื่อ true, ข้ามการตรวจสอบความปลอดภัยของ ASP.NET-session ในคำขอหน้า ให้คงไว้ false ในการผลิต (ดู แนวคิดหลัก → เซสชันและความปลอดภัย).
stringMiddlewarePath"/doconut"ค่าการประสานงานสำหรับ endpoint หน้า-ภาพ ถูกตรวจสอบความถูกต้อง แต่ไม่ได้เมานท์สาขา pipeline; ให้สอดคล้องกับการแมป UseDoconut() จริงและคลไอเอนท์ BasePath.
stringResourcesPath"/doconut-res"คำนำหน้าเส้นทาง URL สำหรับทรัพยากร JS/CSS/รูปภาพ/ฟอนต์ที่ฝังอยู่.
stringLicensePath""เส้นทางไปยังไฟล์ใบอนุญาต หากว่างเปล่า → แหล่งใบอนุญาตถัดไป, แล้วทำการค้นหาอัตโนมัติ; หากไม่พบ → สถานะการประเมินที่มีลายน้ำโดยไม่มีความสามารถ.
stringLicenseContent""เนื้อหาใบอนุญาต XML ดิบ (ฐานข้อมูล, ตัวแปรสภาพแวดล้อม, ตัวจัดการความลับ) มีลำดับความสำคัญเหนือ LicensePath.
Stream?LicenseStreamnullใบอนุญาตเป็นสตรีม อ่านครั้งเดียวที่เริ่มต้น มีลำดับความสำคัญเหนือแหล่งอื่นทั้งสอง.
boolResetLicensefalseแฟล็กความเข้ากันได้ที่สงวนไว้ การทำงานของ .NET 6 ปัจจุบันไม่ได้ใช้มัน; รีสตาร์ทแอปพลิเคชันหลังจากเปลี่ยนใบอนุญาต.
DoconutPluginRegistryPluginRegistry—รีจิสทรีแบบอ่านอย่างเดียวที่รวบรวมการสนับสนุนของปลั๊กอิน; ถูกใช้โดยโรงงานผู้ชม. เติมข้อมูลผ่าน AddPlugin<T>().

ลำดับความสำคัญของใบอนุญาต (บังคับใช้ที่การลงทะเบียนบริการ): LicenseStream → LicenseContent → LicensePath → การค้นหาอัตโนมัติ (ดู เริ่มต้นใช้งาน → ตั้งค่าใบอนุญาต).

เมธอด

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

ใช้เมธอดนี้สำหรับแพคเกจ Converter, DICOM และ Signer ที่เปิดให้เลือกใช้แล้ว การทำ annotation และการค้นหาแบบปกติเป็นฟีเจอร์ที่มีใบอนุญาตในตัวและไม่ใช้ AddPlugin<TPlugin>().

ลงทะเบียนปลั๊กอินของฝ่ายแรก (Converter, DICOM, Signer) แบบ fluent — คืนค่าอินสแตนซ์ของ options. AddDoconut() จะโยน InvalidOperationException สำหรับใบอนุญาตที่หายไป, ไฟล์ legacy TRIAL, หรือใบอนุญาตแบบชำระเงินที่ไม่ได้ให้ความสามารถของปลั๊กอิน การลงทะเบียนแบบชั่วคราว/เดโมจะคงอยู่หลังจากหมดอายุและจะอยู่ภายใต้ประตูรันไทม์ (ดู แนวคิดหลัก → ระบบปลั๊กอิน).

วิดเจ็ต Converter ที่เปิดให้เลือกใช้จะเปิดด้วย AddConverterWidget() และแสดงผ่านคุณสมบัติอ่านอย่างเดียว ConverterWidget; ตัวเลือกของมันถูกอธิบายในหน้าปลั๊กอิน Converter (ปลั๊กอิน → ปลั๊กอิน Converter). วิดเจ็ต Signer ที่เปิดให้เลือกใช้จะเปิดในลักษณะเดียวกันด้วย AddSignerWidget() และแสดงผ่านคุณสมบัติอ่านอย่างเดียว SignerWidget; ดู ปลั๊กอิน Signer.

RegisterViewer(extension, factory, defaultConfig?)

text
DoconutOptions RegisterViewer(
    string extension,                    // \".myext\" — จุดนำจุดเป็นตัวเลือก
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

ลงทะเบียน ผู้ชมแบบกำหนดเอง สำหรับส่วนขยายไฟล์ ผู้ชมแบบกำหนดเองจะมีลำดับความสำคัญเหนือผู้ชมในตัวและผู้ชมปลั๊กอินและไม่ได้ถูกจำกัดด้วยใบอนุญาต เมื่อ defaultConfig ถูกละเว้นและเอกสารเปิดโดยไม่มีการกำหนดค่าอย่างชัดเจน จะใช้ ImageConfig.

โยน ArgumentException (Extension must be a non-empty file extension.) สำหรับส่วนขยายว่างเปล่าและ ArgumentNullException สำหรับ factory ที่เป็น null.

การตรวจสอบการเริ่มต้น

AddDoconut() ตรวจสอบ options fail-fast, ดังนั้นการกำหนดค่าผิดพลาดจะแสดงเป็นข้อยกเว้นที่ชัดเจนในขณะเริ่มต้นแทนการแสดง 404 ที่ทำให้สับสนในเวลาคำขอ:

text
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.

การกำหนดค่าทั่วไป

csharp
// Production: ใบอนุญาตชัดเจน, ทุกอย่างถูกล็อก (ค่าเริ่มต้นด้านความปลอดภัยทั้งหมด)
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});

// เส้นทางที่กำหนดเอง (เช่น เพื่อหลีกเลี่ยงความขัดแย้งของเส้นทาง)
builder.Services.AddDoconut(options =>
{
    options.MiddlewarePath = "/docs-engine";
    options.ResourcesPath  = "/docs-assets";
});

เมื่อคุณเปลี่ยน ResourcesPath, ให้คง ResPath ของวิดเจ็ตไคลเอนต์ให้สอดคล้อง (ดู ViewerConfig).

MiddlewarePath ไม่ใช่ตัวแมปเส้นทาง ASP.NET Core อัตโนมัติ หาก Doconut ควรตอบเฉพาะภายใต้คำนำหน้าที่กำหนดเอง ให้เมานท์ UseDoconut() บนสาขานั้น (เช่นด้วย app.Map("/docs-engine", branch => branch.UseDoconut())) และตั้งค่าไคลเอนต์ BasePath ให้เป็นคำนำหน้านั้นโดยไม่มี / นำหน้า ('docs-engine').

หน้านี้เป็นประโยชน์หรือไม่?