DoconutExtensions
การลงทะเบียนบริการและ middleware
DoconutExtensions (namespace Doconut.Middleware) คือคลาส static ที่มีสามการเรียกใช้ที่โฮสต์ Doconut ทุกตัวทำ: การลงทะเบียนบริการหนึ่งรายการและการลงทะเบียน middleware สองรายการ.
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession(); // เรียก UseSession() ก่อน UseDoconut()
app.UseDoconutResources(); // ต้องลงทะเบียนก่อน UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());UseDoconut() ตอบทุกคำขอที่มาถึงมัน, ดังนั้นให้เมานท์บนสาขาแยกของมันด้วย app.Map.
AddDoconut
IServiceCollection AddDoconut(this IServiceCollection services, Action<DoconutOptions>? configure = null)สร้าง DoconutOptions, ตรวจสอบความถูกต้องแบบ fail-fast (ดู DoconutOptions → การตรวจสอบ Startup), และลงทะเบียนกราฟบริการทั้งหมด:
| บริการ | อายุการใช้งาน | บทบาท |
|---|---|---|
DoconutOptions | Singleton | อ็อบเจ็กต์การกำหนดค่า |
| บริการแคชเซสชัน | Singleton | Token → แคชเซสชัน (IMemoryCache ถูกลงทะเบียนด้วย) |
IDoconutLicenseService | Singleton | ใบอนุญาตโหลดครั้งเดียวที่เริ่มต้น (ลำดับความสำคัญ: LicenseStream → LicenseContent → LicensePath → การค้นหาอัตโนมัติ) |
| กระบวนการ pipeline ของภาพหน้า | Singleton | ทำการประมวลผลภาพสำหรับหน้า (ลายน้ำ, หมุน, ปรับขนาด, คำอธิบาย) |
| ความปลอดภัยของเอกสาร (ที่เก็บการเข้าถึง) | Singleton | มอบสิทธิ์สำหรับการผูก token กับเซสชัน |
Viewer | Transient | ส่วนหน้าสาธารณะสำหรับเปิด/ปิด |
DocumentConverter | Transient | ส่วนหน้าแปลง — ต้องการปลั๊กอิน Converter |
DocumentSigner | Transient | ส่วนหน้าการลงนาม — ต้องการปลั๊กอิน Signer (ดู ปลั๊กอิน Signer) |
DistributedDocumentPublisher | Transient | เผยแพร่ศิลปวัตถุของเอกสารไปยังที่เก็บข้อมูลร่วม |
การตรวจสอบสุขภาพ "doconut" | — | รายงานสถานะใบอนุญาต/หมดอายุผ่านการตรวจสอบสุขภาพของ ASP.NET |
ไม่มีการเรียกที่เทียบเท่าในไลบรารี .NET Standard ก่อนหน้า. มันสร้าง
new Viewer(cache, accessor) ต่อคำขอและส่งตัวเลือกไปยัง middleware; ทั้งสองถูกแทนที่โดยการลงทะเบียนเดียวนี้.
พฤติกรรมสองอย่างที่ควรรู้:
- Converter ต้องการปลั๊กอินของมัน. Resolving
DocumentConverterwithoutoptions.AddPlugin<ConverterPlugin>()throws:
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>().
- การให้สิทธิ์ปลั๊กอินจะตรวจสอบที่การเริ่มต้น. หากไม่มีใบอนุญาต, ไฟล์ legacy
TRIAL, หรือใบอนุญาตแบบชำระเงินที่ไม่มีความสามารถของปลั๊กอินที่ลงทะเบียนไว้ จะล้มเหลวในช่วงเวลาAddDoconut(). การลงทะเบียนแบบ Temporary/Demo จะคงอยู่จนกว่าจะถึงวันหมดอายุ, ในขณะที่เกตเวย์ระหว่างการทำงานจะยกเลิกความสามารถที่หมดอายุแล้ว.
การตรวจสอบสุขภาพรวมเข้ากับกลไกมาตรฐานของ ASP.NET Core — ทำแผนที่หากคุณต้องการสถานะใบอนุญาตบน endpoint สุขภาพของคุณ:
app.MapHealthChecks("/health");UseDoconut
IApplicationBuilder UseDoconut(this IApplicationBuilder app)เพิ่ม middleware ของ Doconut page-image. มันให้บริการทุกคำขอที่มีพารามิเตอร์ query ?token= — หน้า, รูปย่อ, การค้นหา, คำอธิบาย, การกระทำของหน้า (ตารางคำขอเต็มอยู่ใน Core Concepts → How the Viewer Works) — และตอบคำขออื่นด้วย 404 (หรือแบนเนอร์ ShowDoconutInfo): มันไม่ส่งต่อคำขอใด ๆ ไปยังส่วนที่เหลือของ pipeline. เมานท์บนสาขาแยกของมัน, เช่นในตัวอย่างบนหน้านี้. เมื่อ UnsafeMode เป็น false, ชั้นความปลอดภัยของเอกสารจะเชื่อมต่อโดยอัตโนมัติก่อนมัน.
ไม่รับอาร์กิวเมนต์ใด ๆ. การส่งผ่านอินสแตนซ์ DoconutOptions ที่นี่เป็นรูปแบบของไลบรารีเวอร์ชันก่อนและไม่สามารถคอมไพล์ได้อีกต่อไป.
การตั้งค่าทั่วไปจะรักษารูปแบบคำขอ DocImage.axd แบบเดิมด้วยสาขา MapWhen
(ลูกค้าจึงใช้ BasePath: '/'):
app.MapWhen(
ctx => ctx.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
branch => branch.UseDoconut());UseDoconutResources
IApplicationBuilder UseDoconutResources(this IApplicationBuilder app)ให้บริการ JS, CSS, รูปภาพ, และฟอนต์ที่ฝังอยู่ที่ DoconutOptions.ResourcesPath (ค่าเริ่มต้น /doconut-res). เหล่านี้คือไฟล์ที่ Viewer.ReferenceCss() / ReferenceScripts() สร้างแท็กสำหรับ.
เรียกใช้ก่อน UseDoconut() เสมอ. หากพื้นที่ viewer ว่างเปล่าและคอนโซลของเบราว์เซอร์แสดง 404 สำหรับ /doconut-res/..., การเรียกนี้หายไปหรืออยู่ในตำแหน่งผิด.
นี่คือการแทนที่ที่สนับสนุนสำหรับการเชื่อมต่อ middleware การจัดการ embedded‑resource ด้วยตนเอง.
การให้บริการจากที่เก็บข้อมูลร่วม
มีการลงทะเบียนเพิ่มเติมสองรายการสำหรับการปรับใช้ที่โหนดที่เรนเดอร์เอกสารเป็น ไม่จำเป็นต้องเป็นโหนดที่ให้บริการหน้าของมัน. ทั้งสองครอบคลุมตั้งแต่ต้นจนจบใน การปรับใช้แบบกระจาย; ลายเซ็นคือ:
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null) // คิวเผยแพร่เบื้องหลังแบบ opt‑in
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure) // ที่เก็บข้อมูลสนับสนุนแบบแชร์สำหรับการอัปโหลดวิดเจ็ตด้านการอ่านเป็น middleware แยกจาก assembly Doconut.Clouds, ซึ่งมาพร้อมในแพ็กเกจเดียวกัน:
IApplicationBuilder UseDoconutCloud<THandler>(
this IApplicationBuilder app,
Action<CloudOptions>? configure = null,
string pathPrefix = "/doconut-cloud")
where THandler : BaseCloudHandlerUseDoconutWebFarm(...) และ WebFarmOptions ไม่อยู่ในรุ่นนี้. ดู คู่มือการย้าย สำหรับการแมปการตั้งค่าทีละรายการ.
สรุปการจัดลำดับ
app.UseRouting();
app.UseSession(); // เรียก UseSession() ก่อน UseDoconut()
app.UseDoconutResources(); // ต้องลงทะเบียนก่อน UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // หรือสาขา MapWhenหน้านี้เป็นประโยชน์หรือไม่?