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>();
});

คุณสมบัติ

ประเภท	คุณสมบัติ	ค่าเริ่มต้น	คำอธิบาย
`bool`	`ShowDoconutInfo`	`false`	เมื่อ `true` คำขอ middleware ที่ไม่มี token จะส่งแบนเนอร์เวอร์ชัน (`Doconut <version> is running on <host>`) แทน 404 มีประโยชน์เป็นการตรวจสอบเบื้องต้น; ให้ตั้งเป็น `false` ในการผลิต.
`bool`	`UnsafeMode`	`false`	เมื่อ `true` จะข้ามการตรวจสอบความปลอดภัยของเซสชัน ASP.NET ในคำขอหน้า ให้ตั้งเป็น `false` ในการผลิต (ดู Core Concepts → Sessions & Security).
`string`	`MiddlewarePath`	`"/doconut"`	ค่าประสานสำหรับ endpoint หน้า‑ภาพ จะถูกตรวจสอบแต่ไม่เมานท์สาขา pipeline; ให้สอดคล้องกับการแมป `UseDoconut()` จริงและ `BasePath` ของไคลเอนต์.
`string`	`ResourcesPath`	`"/doconut-res"`	คำนำหน้าพาธ URL สำหรับทรัพยากร JS/CSS/รูปภาพ/ฟอนต์ที่ฝังอยู่.
`string`	`LicensePath`	`""`	พาธไปยังไฟล์ใบอนุญาต หากว่างเปล่า → แหล่งใบอนุญาตถัดไป, จากนั้นค้นหาอัตโนมัติ; ไม่พบใด ๆ → สถานะประเมินที่มีลายน้ำโดยไม่มีความสามารถ.
`string`	`LicenseContent`	`""`	เนื้อหาใบอนุญาต XML ดิบ (ฐานข้อมูล, ตัวแปรสภาพแวดล้อม, ตัวจัดการความลับ) มีลำดับความสำคัญเหนือ `LicensePath`.
`Stream?`	`LicenseStream`	`null`	ใบอนุญาตเป็นสตรีม, อ่านครั้งเดียวที่เริ่มต้น มีลำดับความสำคัญเหนือแหล่งอื่นทั้งสอง.
`bool`	`ResetLicense`	`false`	แฟล็กความเข้ากันได้ที่สงวนไว้ การทำงานของ .NET 8 ปัจจุบันไม่ได้ใช้มัน; รีสตาร์ทแอปพลิเคชันหลังจากเปลี่ยนใบอนุญาต.
`DoconutPluginRegistry`	`PluginRegistry`	—	รีจิสทรีแบบอ่านอย่างเดียวที่รวบรวมการสนับสนุนจากปลั๊กอิน; ถูกใช้โดยโรงงานตัวดูไฟล์ เติมข้อมูลผ่าน `AddPlugin<T>()`.

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

วิธีการ

AddPlugin()

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

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

วิดเจ็ต Converter ที่เปิดให้เลือกใช้จะถูกเปิดด้วย AddConverterWidget() และปรากฏผ่าน property ConverterWidget ที่อ่านได้อย่างเดียว; ตัวเลือกของมันถูกอธิบายไว้ในหน้า Converter Plugin (Plugins → Converter Plugin).

RegisterViewer(extension, factory, defaultConfig?)

ลงทะเบียน custom viewer สำหรับส่วนขยายไฟล์หนึ่ง ส่วนขยายที่กำหนดเองจะมีลำดับความสำคัญเหนือ viewer ที่มาพร้อมระบบและ viewer จากปลั๊กอิน และไม่ถูกจำกัดโดยใบอนุญาต เมื่อ 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: explicit license, everything locked down (all security defaults)
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});

// Custom paths (e.g. to avoid a route conflict)
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 ของไคลเอนต์ให้เป็น URL เดียวกัน.