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

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

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

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

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

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. การลงทะเบียนชั่วคราว/สาธิตจะคงอยู่จนกว่าจะหมดอายุ, แต่ความสามารถในระหว่างทำงานจะถูกยกเลิกหลังจากวันที่หมดอายุ.

สัญญา

ปลั๊กอินจะทำการนำเข้าหน้าตา (interface) ที่มีขนาดเล็กโดยเจตนา:

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

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

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

ความสามารถและการควบคุม

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

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

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

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

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

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

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

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

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

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

ปลั๊กอินแพ็กเกจความสามารถการสนับสนุน
ConverterDoconut.NET6.ConverterConverterความสามารถการแปลงเอกสาร
DICOMDoconut.NET6.DicomDicomการชมภาพการแพทย์ (.dcm และ .ima — รูปแบบที่เป็นเฉพาะปลั๊กอิน)
SignerDoconut.NET6.SignerSignerการเซ็น PDF และ Word

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

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

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

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implements 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 เมื่อคุณไม่ได้ให้การกำหนดค่าเริ่มต้น.

สรุปประเด็นสำคัญ

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

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