DoconutExtensions

การลงทะเบียนบริการและมิดเดิลแวร์

DoconutExtensions (namespace Doconut.Middleware) คือคลาสสเตติกที่มีการเรียกใช้สามอย่างที่โฮสต์ Doconut ทุกตัวทำ: การลงทะเบียนบริการหนึ่งรายการและการลงทะเบียนมิดเดิลแวร์สองรายการ.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // เรียก UseSession() ก่อน UseDoconut()
app.UseDoconutResources(); // ต้องลงทะเบียนก่อน UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() ตอบสนองต่อทุกคำขอที่มาถึง, ดังนั้นให้ติดตั้งบนสาขาแยกของมันด้วย app.Map.

AddDoconut

text
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)

สร้าง DoconutOptions, ตรวจสอบความถูกต้องแบบ fail-fast (ดู DoconutOptions → การตรวจสอบการเริ่มต้น), และลงทะเบียนกราฟบริการทั้งหมด:

บริการอายุการใช้งานบทบาท
DoconutOptionsSingletonอ็อบเจกต์การกำหนดค่า
บริการแคชเซสชันSingletonToken → session cache (IMemoryCache ก็ถูกลงทะเบียนด้วย)
IDoconutLicenseServiceSingletonใบอนุญาตโหลดครั้งเดียวเมื่อเริ่มต้น (ลำดับความสำคัญ: LicenseStream → LicenseContent → LicensePath → auto-search)
Page-image pipelineSingletonทำการประมวลผลภาพสำหรับหน้า (ลายน้ำ, หมุน, ปรับขนาด, คำอธิบาย)
Document security (access store)Singletonสิทธิ์สำหรับการผูก token กับเซสชัน
ViewerTransientส่วนหน้าสาธารณะสำหรับเปิด/ปิด
DocumentConverterTransientส่วนหน้าการแปลง — ต้องการปลั๊กอิน Converter
DocumentSignerTransientส่วนหน้าการลงนาม — ต้องการปลั๊กอิน Signer (ดู ปลั๊กอิน Signer)
DistributedDocumentPublisherTransientเผยแพร่ศิลปวัตถุของเอกสารไปยังที่เก็บร่วม (ดู การปรับใช้แบบกระจาย)
Health check "doconut"—รายงานสถานะใบอนุญาต/วันหมดอายุผ่านการตรวจสอบสุขภาพของ ASP.NET

พฤติกรรมสองอย่างที่ควรรู้:

  • Converter ต้องการปลั๊กอินของมัน. การแก้ไข DocumentConverter โดยไม่มี options.AddPlugin<ConverterPlugin>() จะทำให้เกิดข้อผิดพลาด:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner ปฏิบัติตามกฎเดียวกัน: หากไม่มี options.AddPlugin<SignerPlugin>() จะทำให้เกิด No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • สิทธิ์ของปลั๊กอินจะถูกตรวจสอบเมื่อเริ่มต้น. ใบอนุญาตที่หายไป, ไฟล์ TRIAL แบบเก่า, หรือใบอนุญาตแบบชำระเงินที่ไม่มีความสามารถของปลั๊กอินที่ลงทะเบียน จะล้มเหลวในช่วงเวลา AddDoconut(). การลงทะเบียนแบบชั่วคราว/สาธิตจะคงอยู่หลังวันหมดอายุ, ในขณะที่เกตเวย์รันไทม์จะยกเลิกความสามารถที่หมดอายุ.

การตรวจสอบสุขภาพรวมเข้ากับกลไกมาตรฐานของ ASP.NET Core — ทำแผนที่หากคุณต้องการสถานะใบอนุญาตบน endpoint สุขภาพของคุณ:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

เพิ่มมิดเดิลแวร์หน้า-ภาพของ Doconut. มันให้บริการทุกคำขอที่มีพารามิเตอร์ query ?token= — หน้า, รูปย่อ, การค้นหา, คำอธิบาย, การกระทำของหน้า (ตารางคำขอเต็มอยู่ใน แนวคิดหลัก → วิธีการทำงานของ Viewer) — และตอบสนองคำขออื่นใดด้วย 404 (หรือแบนเนอร์ ShowDoconutInfo): มันจะไม่ส่งต่อคำขอไปยังส่วนที่เหลือของ pipeline. ติดตั้งบนสาขาแยกของมัน, เช่นในตัวอย่างบนหน้านี้. เมื่อ UnsafeMode เป็น false, ชั้นความปลอดภัยของเอกสารจะเชื่อมต่อโดยอัตโนมัติก่อนมัน.

ทางเลือกที่พบบ่อยคือติดรูปแบบคำขอ DocImage.axd แบบเก่าด้วยสาขา MapWhen (จากนั้นไคลเอนต์จะใช้ BasePath: '/'):

csharp
app.MapWhen(
    ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

UseDoconutResources

text
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)

ให้บริการ JS, CSS, รูปภาพ, และฟอนต์ที่ฝังอยู่ที่ DoconutOptions.ResourcesPath (ค่าเริ่มต้น /doconut-res). เหล่านี้คือไฟล์ที่ Viewer.ReferenceCss() / ReferenceScripts() สร้างแท็กสำหรับ.

ควรเรียกใช้ก่อน UseDoconut() เสมอ. หากพื้นที่ผู้ชมว่างเปล่าและคอนโซลของเบราว์เซอร์แสดง 404 สำหรับ /doconut-res/..., การเรียกนี้หายไปหรือวางตำแหน่งไม่ถูกต้อง.

Serving from shared storage

มีการลงทะเบียนเพิ่มเติมสองรายการสำหรับการปรับใช้ที่โหนดที่เรนเดอร์เอกสารไม่จำเป็นต้องเป็นโหนดที่ให้บริการหน้าของมัน. ทั้งสองครอบคลุมตั้งแต่ต้นจนจบใน การปรับใช้แบบกระจาย; ลายเซ็นคือ:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // เปิดใช้งานคิวการเผยแพร่เบื้องหลัง
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // ที่เก็บข้อมูลสนับสนุนที่ใช้ร่วมกันสำหรับการอัปโหลด widget

ด้านการอ่านเป็นมิดเดิลแวร์แยกจากการประกอบ Doconut.Clouds, ซึ่งมาพร้อมในแพ็กเกจเดียวกัน:

text
IApplicationBuilder UseDoconutCloud<THandler>(
    this IApplicationBuilder app,
    Action<CloudOptions>? configure = null,
    string pathPrefix = "/doconut-cloud")
    where THandler : BaseCloudHandler

Ordering recap

csharp
app.UseRouting();
app.UseSession();          // เรียก UseSession() ก่อน UseDoconut()
app.UseDoconutResources(); // ต้องลงทะเบียนก่อน UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // หรือสาขา MapWhen

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