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

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

แกนหลักของ Doconut มีขนาดเบา; ฟังก์ชันเสริมจะมาพร้อมกับ plugins — แพ็กเกจ 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. การลงทะเบียน Temporary/Demo จะถูกเก็บไว้จนกว่าจะหมดอายุ, แต่ความสามารถในเวลารันจะถูกยกเลิกหลังจากวันที่หมดอายุ.

สัญญา

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

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.

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

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

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

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

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

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

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

ปลั๊กอินแพ็กเกจความสามารถให้การสนับสนุน
ตัวแปลงDoconut.NET8.ConverterConverterความสามารถการแปลงเอกสาร
DICOMDoconut.NET8.DicomDicomการชมภาพทางการแพทย์ (.dcm and .ima — plugin-only formats)
ผู้ลงนามDoconut.NET8.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() — การขาดหรือสิทธิ์ที่ไม่เพียงพอแบบไม่ใช่ Temporary จะล้มเหลวอย่างรวดเร็ว.
  • ปลั๊กอินแบบ Override จะลดระดับอย่างราบรื่น; รูปแบบเฉพาะปลั๊กอินจะล้มเหลวพร้อมกับ LicenseException.
  • ใบอนุญาต Temporary ที่ใช้งานอยู่จะปลดล็อกทุกอย่าง; การผลิตจะปลดล็อกสิ่งที่คุณซื้อ. ตรวจสอบกับ IDoconutLicenseService ก่อนส่งมอบ.

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