ระบบปลั๊กอิน

ขยายตัวดูด้วยปลั๊กอิน

แกนหลักของ Doconut ยังคงเบา; ฟังก์ชันเสริมจะมาพร้อมกับ ปลั๊กอิน — แพ็กเกจ NuGet แยกที่ให้ผู้ดูหรือบริการและเปิดใช้งานโดยใบอนุญาตของคุณ หน้านี้อธิบายโมเดลการลงทะเบียน, วิธีการทำงานของการกำหนดสิทธิ์ในเวลารัน, และวิธีการเชื่อมต่อผู้ดูของคุณเอง.

โมเดลนี้เป็นใหม่ในรุ่นนี้. ไลบรารี .NET Standard ก่อนหน้านี้ไม่มีรีจิสทรีปลั๊กอิน: การแปลงทำงานบนผู้ดูเองและใบอนุญาตปลั๊กอินถูกติดตั้งผ่านการเรียก Viewer.SetLicensePlugin(...) แบบสถิต. ทั้งสองไม่ได้เป็นกลไกการลงทะเบียนที่นี่.

การลงทะเบียนปลั๊กอิน

แต่ละแพ็กเกจปลั๊กอินจะเปิดเผยคลาสปลั๊กอินหนึ่งคลาส คุณลงทะเบียนมันครั้งเดียว, ตอนเริ่มต้น:

csharp
builder.Services.AddDoconut(options =>
{
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

AddPlugin<TPlugin>() สร้างอินสแตนซ์ของปลั๊กอินและเรียกคอลแบ็ก Register ของมันต่อรีจิสทรีปลั๊กอินที่เก็บบน DoconutOptions. ทุกอย่างที่ปลั๊กอินให้จะถูกแท็กด้วย ความสามารถที่จำเป็น ของปลั๊กอิน. AddDoconut() ตรวจสอบปลั๊กอินที่ลงทะเบียนทันที: ใบอนุญาตหาย, ไฟล์ legacy TRIAL, หรือใบอนุญาตแบบชำระเงินที่ไม่มีความสามารถจะทำให้การเริ่มต้นล้มเหลวด้วย InvalidOperationException. การลงทะเบียน Temporary/Demo จะคงอยู่จนกว่าจะหมดอายุ, แต่ความสามารถในเวลารันจะถูกยกเลิกหลังจากวันหมดอายุ.

สัญญา

ปลั๊กอินจะทำการใช้งานอินเทอร์เฟซที่มีขนาดเล็กโดยเจตนา:

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // เช่น "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // ประตูใบอนุญาต
    void Register(IDoconutPluginBuilder builder); // สนับสนุนผู้ชม/บริการ
}

ภายใน Register, ตัวสร้างรับการสนับสนุนสองประเภท:

  • builder.RegisterViewer(extension, factory) — ผู้ดูสำหรับส่วนขยายไฟล์; ฟactory คืนค่า IFormatViewer (ปลั๊กอิน DICOM ลงทะเบียน .dcm และ .ima ด้วยวิธีนี้),
  • builder.RegisterService<TContract>(() => …) — บริการที่มีประเภทซึ่งส่วนอื่นของ pipeline สามารถค้นหาได้.

ความสามารถและการกำหนดสิทธิ์

ความสามารถคือหน่วยของใบอนุญาต. Converter, Dicom และ Signer มาพร้อมกับปลั๊กอินแบบเลือกใช้; Search และ Annotation เป็นฟีเจอร์ในตัวที่กำหนดสิทธิ์ในลักษณะเดียวกัน. ตัวดูพื้นฐาน ไม่ เป็นความสามารถ — มันเป็นเงื่อนไขเบื้องต้น, เปิดเผยเป็น IsViewerLicensed บนบริการใบอนุญาต.

การตรวจสอบตอนเริ่มต้นโดยปกติจะป้องกันปลั๊กอินที่ไม่มีใบอนุญาตจากการเข้าสู่ pipeline ของคำขอ. ฟactory ผู้ดูยังใช้กฎการทำงานสองข้อเพื่อป้องกัน, ซึ่งสำคัญหากสิทธิ์เปลี่ยนแปลงหลังจากเริ่มต้น:

  • ปลั๊กอินแทนที่ผู้ดูในตัว (ปลั๊กอินอ้างสิทธิ์ส่วนขยายที่รีจิสทรีในตัวก็จัดการได้): หากมีความสามารถที่ได้รับใบอนุญาต, ผู้ดูปลั๊กอินจะชนะ; หากไม่มี, Doconut จะกลับไปใช้ผู้ดูในตัวโดยเงียบ. ผู้ใช้ยังคงเห็นเอกสารของพวกเขา — แต่จะไม่ได้ฟีเจอร์ปลั๊กอิน.
  • รูปแบบเฉพาะปลั๊กอิน (.dcm และ .ima — DICOM ไม่มีผู้ดูในตัว): หากไม่มีความสามารถ การเรียกเปิดจะล้มเหลวอย่างรุนแรง:
text
LicenseException: This document type requires the 'Dicom' plugin license.

ใบอนุญาต Temporary ที่ใช้งานอยู่ให้ทุกความสามารถ (พร้อมการดูพื้นฐานที่สะอาด, ไม่มีลายน้ำ). นี่เป็นแหล่งที่มาของความประหลาดใจเมื่อเปิดใช้งานจริง: การลงทะเบียนปลั๊กอินเดียวกันกับใบอนุญาตที่ซื้อซึ่งละเว้นความสามารถหนึ่งทำให้ AddDoconut() ล้มเหลวในระหว่างการเริ่มต้น. เปรียบเทียบ IsCapabilityGranted(...) กับแผนของคุณก่อนทำการปรับใช้. ด้านตรงข้าม: ด้วย ไม่มีใบอนุญาตเลย, จะไม่มีอะไรถูกมอบให้ — ใบอนุญาตที่หายไปไม่ใช่ใบอนุญาต Temporary.

การกำหนดสิทธิ์เดียวกันปรากฏบนฝั่งไคลเอนต์: Viewer.ReferenceScripts() และ ReferenceCss() ส่งออกชุดสคริปต์/สไตล์สำหรับฟีเจอร์ที่กำหนดสิทธิ์ (ค้นหา, คำอธิบาย, …) เฉพาะเมื่อ ใบอนุญาตเปิดใช้งาน, ดังนั้น UI ของวิดเจ็ตจะสอดคล้องกับสิ่งที่เซิร์ฟเวอร์จะทำจริง.

แผนที่ฟีเจอร์และปลั๊กอิน

UI ของผลิตภัณฑ์ใช้คำว่า "ปลั๊กอิน" เป็นป้ายฟีเจอร์กว้าง, แต่การลงทะเบียนบนเซิร์ฟเวอร์แตกต่าง:

ฟีเจอร์วิธีเปิดใช้งานความสามารถการสนับสนุน
คำอธิบายรวมอยู่ในผู้ดู; รวมทรัพยากรคำอธิบายAnnotationการสร้างในเบราว์เซอร์, การคงสภาพเซสชัน, และการส่งออกที่ฝังไว้
การค้นหารวมอยู่ในผู้ดูรูปแบบที่ค้นหาได้; รวมทรัพยากรการค้นหาและเปิดใช้งานการสกัดข้อมูลเมื่อจำเป็นSearchดัชนีข้อความพื้นเมือง, ไฮไลท์, และการนำทางผลลัพธ์
ตัวแปลงติดตั้ง Doconut.NETStandard.Converter และลงทะเบียน ConverterPluginConverterบริการแปลง C# และวิดเจ็ตเว็บแบบเลือกใช้
DICOMติดตั้ง Doconut.NETStandard.Dicom และลงทะเบียน DicomPluginDicomการดูภาพทางการแพทย์สำหรับ .dcm และ .ima
ผู้ลงนามติดตั้ง Doconut.NETStandard.Signer และลงทะเบียน SignerPluginSignerลายเซ็นที่มองเห็นได้และตราดิจิทัลสำหรับ PDF และ Word: บริการลงนาม C# และวิดเจ็ตเว็บแบบเลือกใช้

คำอธิบายและการค้นหาปกติไม่ใช้ AddPlugin<TPlugin>(); ชุดของพวกเขาจะถูกส่งออกเฉพาะเมื่อใบอนุญาตมอบความสามารถที่สอดคล้อง. ตัวแปลง, DICOM และผู้ลงนามเป็นการนำไปใช้แบบ opt-in IDoconutPlugin.

แพ็กเกจปลั๊กอินที่ปล่อยออกมา

ปลั๊กอินแพ็กเกจความสามารถการสนับสนุน
ตัวแปลงDoconut.NETStandard.ConverterConverterความสามารถการแปลงเอกสาร
DICOMDoconut.NETStandard.DicomDicomการดูภาพทางการแพทย์ (.dcm และ .ima — รูปแบบเฉพาะปลั๊กอิน)
ผู้ลงนามDoconut.NETStandard.SignerSignerการลงนาม PDF และ Word

แต่ละรายการมีหน้าที่อุทิศให้ภายใต้ ปลั๊กอิน พร้อมการกำหนดค่าและการใช้งาน.

ผู้ดูแบบกำหนดเอง — ตัวจัดการรูปแบบของคุณ

คุณสามารถเชื่อมผู้ดูเข้ากับ pipeline ได้โดยไม่ต้องเขียนแพ็กเกจปลั๊กอิน, โดยตรงจาก Program.cs:

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implements IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // กำหนดค่าเริ่มต้นแบบเลือก
});

// ตัวจัดการรูปแบบที่โรงงานสร้างขึ้น. แทนที่สมาชิกเหล่านี้ด้วยการแสดงผลของคุณเอง.
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() { }
}

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

สรุป

  • ปลั๊กอินถูกลงทะเบียนอย่างชัดเจนและ LicenseCapability ของพวกมันจะถูกตรวจสอบระหว่าง AddDoconut() — การขาดหรือสิทธิ์ที่ไม่เพียงพอที่ไม่ใช่ Temporary จะล้มเหลวอย่างรวดเร็ว.
  • ปลั๊กอินแบบแทนที่จะลดระดับอย่างราบรื่น; รูปแบบเฉพาะปลั๊กอินจะล้มเหลวด้วย LicenseException.
  • ใบอนุญาต Temporary ที่ใช้งานอยู่จะปลดล็อกทุกอย่าง; การผลิตจะปลดล็อกสิ่งที่คุณซื้อ. ตรวจสอบด้วย IDoconutLicenseService ก่อนการจัดส่ง.

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