DoconutOptions
กำหนดค่าบริการ Doconut
DoconutOptions (namespace Doconut) คืออ็อบเจกต์การกำหนดค่าหนึ่งเดียวสำหรับ SDK ทั้งหมด คุณกำหนดค่าเพียงครั้งเดียว ภายใน AddDoconut() และมันถูกลงทะเบียนเป็น singleton.
นี่เป็นการเปลี่ยนแปลงทั้งตำแหน่งและรูปแบบ. ในไลบรารี .NET Standard ก่อนหน้า
DoconutOptions อินสแตนซ์ถูกสร้างขึ้นในช่วงเวลาของ pipeline และส่งต่อให้
UseDoconut(new DoconutOptions { … }). ที่นี่ middleware ไม่รับตัวเลือกใดเลย —
ทุกอย่างถูกตั้งค่าระหว่างการลงทะเบียนบริการ.
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 ในการผลิตบนโหนดเดียว (ดู แนวคิดหลัก → การจัดการเซสชันและความปลอดภัย). ก่อนหน้านี้สะกดเป็น UnSafeMode. |
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 | แฟล็กความเข้ากันได้ที่สงวนไว้. การทำงานปัจจุบันไม่ได้ใช้มัน; รีสตาร์ทแอปพลิเคชันหลังจากเปลี่ยนใบอนุญาต. |
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). แบบต่อเนื่อง — คืนค่าอินสแตนซ์ตัวเลือก. AddDoconut() จะโยน InvalidOperationException สำหรับใบอนุญาตที่หายไป, ไฟล์ legacy TRIAL, หรือใบอนุญาตแบบชำระเงินที่ไม่ให้ความสามารถของปลั๊กอิน. การลงทะเบียนแบบชั่วคราว/เดโมจะคงอยู่หลังจากหมดอายุและจะอยู่ภายใต้ประตูรันไทม์ (ดู แนวคิดหลัก → ระบบปลั๊กอิน).
วิดเจ็ต Converter ที่เปิดให้เลือกใช้จะถูกเปิดด้วย AddConverterWidget() และแสดงผ่านคุณสมบัติอ่านอย่างเดียว ConverterWidget; ตัวเลือกของมันถูกอธิบายในหน้าปลั๊กอิน Converter (ปลั๊กอิน → ปลั๊กอินแปลง). วิดเจ็ต Signer ที่เปิดให้เลือกใช้จะเปิดด้วยวิธีเดียวกัน, ด้วย AddSignerWidget(), และแสดงผ่านคุณสมบัติอ่านอย่างเดียว SignerWidget; ดู ปลั๊กอินผู้ลงนาม.
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() ตรวจสอบตัวเลือก ตรวจสอบอย่างรวดเร็ว, ดังนั้นการกำหนดค่าที่ผิดพลาดจะแสดงเป็นข้อยกเว้นที่ชัดเจนขณะเริ่มต้นแทนการเกิด 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"] ?? "";
});
// เส้นทางที่กำหนดเอง (e.g. เพื่อหลีกเลี่ยงความขัดแย้งของเส้นทาง)
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'). ทางเลือกทั่วไปหนึ่งคือตรงกับรูปแบบคำขอ DocImage.axd ประวัติบนสาขา MapWhen ด้วย BasePath: '/'.
หน้านี้เป็นประโยชน์หรือไม่?