ระบบปลั๊กอิน
ขยายตัวดูด้วยปลั๊กอิน
แกนหลักของ Doconut ยังคงกระชับ; ฟังก์ชันเสริมจะจัดส่งเป็น ปลั๊กอิน — แพ็กเกจ NuGet แยกที่ให้ผู้ดูหรือบริการและเปิดใช้งานโดยใบอนุญาตของคุณ. หน้านี้อธิบายโมเดลการลงทะเบียน, สิ่งที่เกิดขึ้นเมื่อเริ่มต้นเมื่อใบอนุญาตไม่ครอบคลุมปลั๊กอิน, และวิธีการเชื่อมต่อผู้ดูของคุณเอง.
การลงทะเบียนปลั๊กอิน
แต่ละแพ็กเกจปลั๊กอินเปิดเผยคลาสปลั๊กอินหนึ่งคลาส. ลงทะเบียนมันครั้งเดียวใน Application_Start:
Doconut.DoconutHost.Initialize(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});
// ปลั๊กอินที่ลงทะเบียนซึ่งไม่มีใบอนุญาตจะทำการโยนที่นี่ใน Application_Start และ
// ไซต์จะตอบทุกคำขอด้วยรหัส 500 ว่าง เหตุผลอยู่ในบันทึกเหตุการณ์ของ WindowsAddPlugin<TPlugin>() สร้างปลั๊กอินและให้มันลงทะเบียนการสนับสนุนของมันกับ DoconutOptions. ทุกอย่างที่ปลั๊กอินสนับสนุนจะถูกแท็กด้วย ความสามารถที่จำเป็น ของปลั๊กอิน, และ DoconutHost.Initialize ตรวจสอบปลั๊กอินที่ลงทะเบียนทั้งหมดกับใบอนุญาตก่อนที่ไซต์จะให้บริการคำขอแรก.
ใบอนุญาตปลั๊กอินที่หายไปทำให้ไซต์หยุดทำงาน
เมื่อไม่มีใบอนุญาตที่ใช้งานให้ความสามารถของปลั๊กอินที่ลงทะเบียน — ไม่มีใบอนุญาตเลย, ไฟล์ legacy TRIAL, หรือใบอนุญาตที่ชำระแล้วแต่ไม่มีความสามารถนั้น — DoconutHost.Initialize จะโยน InvalidOperationException จาก Application_Start:
The Converter plugin is registered via AddPlugin but no active license grants Converter.
Remove the AddPlugin<...>() call or install a license (or trial/demo) that includes Converter.ใน System.Web, ข้อยกเว้นใน Application_Start จะไม่สร้างหน้าข้อผิดพลาด. ทุกคำขอตอบด้วย 500 ว่าง, บันทึก IIS ไม่แสดงอะไรที่เป็นประโยชน์, และข้อความปรากฏเฉพาะใน Windows event log (Application log, source ASP.NET). เมื่อไซต์หยุดตอบสนองทันทีหลังจากเพิ่มบรรทัด AddPlugin, ตรวจสอบไฟล์ใบอนุญาตใน wwwroot ก่อน — ดูที่ การตั้งค่าใบอนุญาต.
สัญญา
ปลั๊กอินจะทำการนำเข้าตัวอินเทอร์เฟซที่มีขนาดเล็กโดยเจตนา:
public interface IDoconutPlugin
{
string Name { get; } // เช่น "Doconut DICOM Viewer"
LicenseCapability RequiredCapability { get; } // ประตูตรวจสอบใบอนุญาต
void Register(IDoconutPluginBuilder builder); // ร่วมพัฒนาผู้ชม/บริการ
}ภายใน Register, ตัวสร้างรับการสนับสนุนสองประเภท:
builder.RegisterViewer(extension, factory)— ตัวดูสำหรับส่วนขยายไฟล์; โรงงานจะคืนค่าIFormatViewer(ปลั๊กอิน DICOM ลงทะเบียน.dcmและ.imaด้วยวิธีนี้),builder.RegisterService<TContract>(() => …)— บริการที่มีประเภทที่ส่วนอื่นของ pipeline สามารถค้นหาได้.
ความสามารถและการกำหนดเงื่อนไข
ความสามารถคือหน่วยของใบอนุญาต. Converter, Dicom และ Signer จัดส่งเป็นปลั๊กอินแบบเลือกใช้; Search และ Annotation เป็นฟีเจอร์ในตัวที่กำหนดเงื่อนไขเช่นเดียวกัน. ตัวดูพื้นฐาน ไม่ เป็นความสามารถ — มันเป็นเงื่อนไขเบื้องต้น, เปิดเผยเป็น IsViewerLicensed บนบริการใบอนุญาต.
การตรวจสอบขณะเริ่มต้นโดยทั่วไปจะเก็บปลั๊กอินที่ไม่มีใบอนุญาตออกจาก pipeline ของคำขอ. โรงงานตัวดูยังใช้กฎป้องกันสองข้อ, ซึ่งสำคัญหากสิทธิ์เปลี่ยนแปลงขณะไซต์ทำงาน:
- ปลั๊กอินที่แทนที่ตัวดูในตัว (มันอ้างสิทธิ์ส่วนขยายที่ตัวดูในตัวก็จัดการได้): หากความสามารถได้รับใบอนุญาต, ตัวดูของปลั๊กอินจะชนะ; หากไม่มี, Doconut จะกลับไปใช้ตัวดูในตัว. ผู้ใช้ยังคงเห็นเอกสารของพวกเขา; แต่พวกเขาจะไม่ได้รับพฤติกรรมของปลั๊กอิน.
- รูปแบบที่มีเฉพาะปลั๊กอิน (
.dcmและ.ima— DICOM ไม่มีตัวดูในตัว): หากไม่มีความสามารถ, การเปิดจะล้มเหลว:
LicenseException: This document type requires the 'Dicom' plugin license.ใบอนุญาตชั่วคราวที่ใช้งานอยู่ให้ทุกความสามารถ. นั่นคือความประหลาดใจคลาสสิกเมื่อเปิดใช้งานจริง: บรรทัด AddPlugin เดียวกันที่ทำงานระหว่างการประเมินจะทำให้ไซต์หยุดเมื่อใบอนุญาตที่ซื้อไม่มีความสามารถเหล่านั้น. เปรียบเทียบ IsCapabilityGranted(...) กับสิ่งที่คุณซื้อก่อนการปรับใช้. ด้วย ไม่มีใบอนุญาตเลย, ไม่มีอะไรถูกให้ — ใบอนุญาตที่หายไปไม่ใช่ใบอนุญาตชั่วคราว.
การกำหนดเงื่อนไขเดียวกันส่งถึงเบราว์เซอร์: Viewer.ReferenceScripts() และ ReferenceCss() ส่งไฟล์สำหรับฟีเจอร์ที่กำหนดเงื่อนไขด้วยใบอนุญาต (Search, Annotation) เฉพาะเมื่อ ใบอนุญาตให้สิทธิ์, ดังนั้นหน้าจะไม่มีการเสนอฟีเจอร์ที่เซิร์ฟเวอร์จะปฏิเสธ.
แผนที่ฟีเจอร์และปลั๊กอิน
| ฟีเจอร์ | วิธีเปิดใช้งาน | ความสามารถ | การสนับสนุน |
|---|---|---|---|
| คำอธิบาย | รวมอยู่ในตัวดู; รวมทรัพยากรคำอธิบาย | Annotation | การเขียนในเบราว์เซอร์, การคงสภาพเซสชัน, การส่งออกแบบฝัง |
| ค้นหา | รวมอยู่ในตัวดูรูปแบบที่ค้นหาได้; รวมทรัพยากรการค้นหา | Search | ดัชนีข้อความพื้นฐาน, ไฮไลท์, การนำทางผลลัพธ์ |
| ตัวแปลง | ติดตั้ง Doconut.NETFramework.Converter และลงทะเบียน ConverterPlugin | Converter | บริการแปลง C# และวิดเจ็ตเว็บเสริม |
| DICOM | ติดตั้ง Doconut.NETFramework.Dicom และลงทะเบียน DicomPlugin | Dicom | การดูภาพทางการแพทย์สำหรับ .dcm และ .ima |
| ผู้ลงนาม | ติดตั้ง Doconut.NETFramework.Signer และลงทะเบียน SignerPlugin | Signer | ลายเซ็นที่มองเห็นได้และตราดิจิทัลสำหรับ PDF และ Word: บริการลงนาม C# และวิดเจ็ตเว็บเสริม |
คำอธิบายและการค้นหาไม่ใช้ AddPlugin<TPlugin>(). ตัวแปลง, DICOM และผู้ลงนามแต่ละรายการมีหน้าภายใต้ ปลั๊กอิน พร้อมการกำหนดค่าและการใช้งาน. ในแพ็กเกจนี้, DICOM แสดงผลหน้า, เฟรม, และแอนิเมชัน, แต่ไม่อ่านเมตาดาต้าเชิงเทคนิค — ดูที่ ปลั๊กอิน DICOM.
ตัวดูแบบกำหนดเอง — ตัวจัดการรูปแบบของคุณ
คุณสามารถเชื่อมต่อผู้ดูเข้ากับ pipeline โดยไม่ต้องเขียนแพ็กเกจปลั๊กอิน, โดยตรงใน Application_Start:
Doconut.DoconutHost.Initialize(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // ทำการ implement IFormatViewer
() => new ImageConfig { ImageResolution = 150 }); // กำหนดค่าเริ่มต้นแบบเลือก
});
// ตัวจัดการรูปแบบที่ factory สร้างขึ้น แทนที่สมาชิกเหล่านี้ด้วยการเรนเดอร์ของคุณเอง.
public sealed class MyCustomViewer : Doconut.Core.Interfaces.IFormatViewer
{
public ViewerType ViewerType => ViewerType.None;
public int TotalPages => 0;
public int DefaultWidth => 0;
public int DefaultHeight => 0;
public bool PreferOcr => false;
public Task LoadAsync(Stream documentStream, BaseConfig config, CancellationToken ct = default)
=> Task.CompletedTask;
public Task<byte[]> GetPageImageAsync(int pageNumber, CancellationToken ct = default)
=> Task.FromResult(Array.Empty<byte>());
public void Dispose() { }
}ตัวดูแบบกำหนดเองมีลำดับความสำคัญเหนือ ทุกอย่าง — ทั้งในตัวและปลั๊กอิน — และไม่ได้ถูกกำหนดเงื่อนไขด้วยใบอนุญาต: พวกมันคือโค้ดของคุณ. เมื่อคุณไม่ได้ให้การกำหนดค่าเริ่มต้น, โรงงานจะใช้ ImageConfig.
สรุป
- ปลั๊กอินถูกลงทะเบียนอย่างชัดเจนใน
DoconutHost.Initialize, และความสามารถของพวกมันได้รับการตรวจสอบที่นั่น; สิทธิ์ที่หายไปทำให้ไซต์หยุดทำงานด้วย500ว่างที่สาเหตุอยู่ใน Windows event log. - ปลั๊กอินแบบ Override ลดระดับอย่างราบรื่น; รูปแบบที่มีเฉพาะปลั๊กอินล้มเหลวด้วย
LicenseException. - ใบอนุญาตชั่วคราวที่ใช้งานอยู่ปลดล็อกทุกอย่าง; การผลิตปลดล็อกสิ่งที่คุณซื้อ. ตรวจสอบกับ
IDoconutLicenseServiceก่อนส่งมอบ.
หน้านี้เป็นประโยชน์หรือไม่?