DoconutExtensions

Pendaftaran layanan dan middleware

DoconutExtensions (namespace Doconut.Middleware) adalah kelas statis dengan tiga pemanggilan yang dilakukan setiap host Doconut: satu pendaftaran layanan dan dua pendaftaran middleware.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // panggil UseSession() sebelum UseDoconut()
app.UseDoconutResources(); // harus didaftarkan sebelum UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() menjawab setiap permintaan yang sampai kepadanya, jadi pasang pada cabang terpisah dengan app.Map.

AddDoconut

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

Membangun DoconutOptions, memvalidasi mereka secara fail-fast (lihat DoconutOptions → Startup validation), dan mendaftarkan grafik layanan lengkap:

ServiceLifetimeRole
DoconutOptionsSingletonObjek konfigurasi
Layanan cache sesiSingletonToken → cache sesi (IMemoryCache juga terdaftar)
IDoconutLicenseServiceSingletonLisensi dimuat sekali saat startup (prioritas: LicenseStream → LicenseContent → LicensePath → pencarian otomatis)
Pipeline gambar halamanSingletonMelakukan pemrosesan gambar untuk halaman (watermark, rotasi, skala, anotasi)
Keamanan dokumen (penyimpanan akses)SingletonMemberikan izin untuk pengikatan token-ke-sesi
ViewerTransientFasade publik buka/tutup
DocumentConverterTransientFasade konversi — memerlukan plugin Converter
DocumentSignerTransientFasade penandatanganan — memerlukan plugin Signer (lihat Signer Plugin)
DistributedDocumentPublisherTransientMenerbitkan artefak dokumen ke penyimpanan bersama (lihat Distributed Deployments)
Health check "doconut"—Melaporkan status lisensi/kedaluwarsa melalui pemeriksaan kesehatan ASP.NET

Dua perilaku yang penting untuk diketahui:

  • Converter memerlukan plugin-nya. Resolving DocumentConverter without options.AddPlugin<ConverterPlugin>() throws:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner mengikuti aturan yang sama: tanpa options.AddPlugin<SignerPlugin>() ia melempar No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • Entitlement plugin divalidasi saat startup. Lisensi yang hilang, file legacy TRIAL, atau lisensi berbayar tanpa kemampuan plugin yang terdaftar gagal pada waktu AddDoconut(). Registrasi Temporary/Demo bertahan melewati tanggal kedaluwarsa, sementara gerbang runtime mencabut kemampuan yang telah kedaluwarsa.

Pemeriksaan kesehatan terintegrasi dengan mekanisme standar ASP.NET Core — petakan jika Anda ingin status lisensi pada endpoint kesehatan Anda:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Menambahkan middleware gambar halaman Doconut. Ia melayani setiap permintaan yang membawa parameter kueri ?token= — halaman, thumbnail, pencarian, anotasi, aksi halaman (tabel permintaan lengkap ada di Core Concepts → How the Viewer Works) — dan menjawab permintaan lain dengan 404 (atau banner ShowDoconutInfo): ia tidak pernah meneruskan permintaan ke sisa pipeline. Pasang pada cabang terpisah, seperti pada contoh di halaman ini. Ketika UnsafeMode berada dalam keadaan false, lapisan keamanan dokumen secara otomatis terhubung sebelum itu.

Alternatif umum mempertahankan bentuk permintaan historis DocImage.axd dengan cabang MapWhen (klien kemudian menggunakan 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)

Melayani JS, CSS, gambar, dan font yang tersemat di DoconutOptions.ResourcesPath (default /doconut-res). Ini adalah berkas-berkas yang Viewer.ReferenceCss() / ReferenceScripts() menghasilkan tag untuknya.

Selalu panggil sebelum UseDoconut(). Jika area penampil tetap kosong dan konsol browser menampilkan 404 untuk /doconut-res/..., panggilan ini hilang atau berada di tempat yang salah.

Menyajikan dari penyimpanan bersama

Dua pendaftaran tambahan ada untuk penyebaran di mana node yang merender dokumen tidak selalu merupakan node yang menyajikan halamannya. Keduanya dibahas secara menyeluruh dalam Distributed Deployments; tanda tangan adalah:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // antrian publikasi latar belakang opt-in
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // penyimpanan pendukung bersama untuk unggahan widget

Bagian pembacaan adalah middleware terpisah dari assembly Doconut.Clouds, yang dikirim dalam paket yang sama:

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

Ringkasan Urutan

csharp
app.UseRouting();
app.UseSession();          // panggil UseSession() sebelum UseDoconut()
app.UseDoconutResources(); // harus didaftarkan sebelum UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // atau cabang MapWhen

Apakah halaman ini membantu?