DoconutOptions
กำหนดค่าบริการ Doconut
DoconutOptions (namespace Doconut) คืออ็อบเจ็กต์การกำหนดค่าเดียวสำหรับ SDK ทั้งหมด คุณกำหนดค่าเพียงครั้งเดียวภายใน AddDoconut() และมันถูกลงทะเบียนเป็น singleton.
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‑session ในคำขอหน้า. ปล่อย false ในการผลิต (ดู แนวคิดหลัก → เซสชันและความปลอดภัย). |
string | MiddlewarePath | "/doconut" | ค่าการประสานงานสำหรับ endpoint หน้า‑รูปภาพ มันได้รับการตรวจสอบ แต่ไม่ได้เมานท์สาขา pipeline; ให้สอดคล้องกับการแมป UseDoconut() จริงและ client 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 → การค้นหาอัตโนมัติ (ดู เริ่มต้นใช้งาน → การตั้งค่าใบอนุญาต).
วิธีการ
AddPlugin<TPlugin>()
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 Plugin (Plugins → Converter Plugin). วิดเจ็ต Signer ที่เปิดให้เลือกใช้จะเปิดด้วยวิธีเดียวกัน, ด้วย AddSignerWidget(), และแสดงผ่านคุณสมบัติอ่านอย่างเดียว SignerWidget; ดู ปลั๊กอิน Signer.
RegisterViewer(extension, factory, defaultConfig?)
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 ที่ทำให้สับสนในระหว่างการร้องขอ:
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.การกำหนดค่าทั่วไป
// 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 ของวิดเจ็ต client ให้สอดคล้อง (ดู ViewerConfig).
MiddlewarePath ไม่ใช่ mapper เส้นทาง ASP.NET Core อัตโนมัติ. หาก Doconut ควรตอบเฉพาะภายใต้คำนำหน้าที่กำหนดเอง, ให้ mount UseDoconut() บนสาขานั้น (เช่นด้วย app.Map("/docs-engine", branch => branch.UseDoconut())) และตั้งค่า client BasePath ให้เป็นคำนำหน้านั้นโดยไม่มี / นำหน้า ('docs-engine').
หน้านี้เป็นประโยชน์หรือไม่?