Instalasi

Tambahkan Doconut ke proyek .NET Standard 2.1 Anda

Penampil Doconut dasar untuk .NET Standard tersedia sebagai satu paket NuGet yang dapat dipasang ke aplikasi ASP.NET Core apa pun. Plugin opsional menggunakan paket terpisah. Halaman ini menginstal paket dasar, memastikan host Anda dapat menggunakannya, dan mendaftarkan middleware — hal minimum yang diperlukan sebelum render pertama Anda.

Periksa kerangka kerja host terlebih dahulu

Perpustakaan menargetkan netstandard2.1. Itu merupakan kontrak yang lebih sempit dibandingkan build netstandard2.0 sebelumnya, dan itu adalah hal pertama yang harus diverifikasi:

HostDidukung
.NET Core 3.0 atau lebih baru, termasuk .NET 5/6/7/8Ya
.NET Framework (semua versi)Tidak — netstandard2.1 tidak dapat dikonsumsi oleh .NET Framework

Paket ini berjalan hanya di Windows. Untuk host Linux, gunakan Doconut.NET8 atau Doconut.NET6.

Jika aplikasi berjalan di .NET Framework, ini bukan paket yang tepat. Gunakan Doconut.NETFramework sebagai gantinya; mulai dari 26.9.0 paket ini memerlukan .NET Framework 4.7.2.

Instal paket

bash
dotnet add package Doconut.NETStandard

Perintah tanpa versi menginstal rilis stabil terbaru. Untuk mengunci rilis yang dijelaskan dalam dokumentasi ini, berikan versi sebagai opsi terpisah:

bash
dotnet add package Doconut.NETStandard --version 26.10.0

Doconut.NETStandard adalah ID paket. Akhiran versi merupakan bagian dari nama file Doconut.NETStandard.<version>.nupkg yang diunduh dan bukan bagian dari ID.

Nomor versi adalah generasi

Ini lebih penting di sini daripada nama paket. Kedua generasi perpustakaan .NET Standard dipublikasikan dengan ID paket yang sama, dan hanya versi yang membedakannya:

VersiTargetAPI
26.7.0 dan di bawahnyanetstandard2.0integrasi sebelumnya
26.8.0 dan di atasnyanetstandard2.1integrasi yang didokumentasikan di sini

Tidak ada shim kompatibilitas dan tidak ada paket berdampingan. Meningkatkan versi adalah peningkatan, dan kompiler akan melaporkan perbedaan API secara langsung.

Jangan pilih dokumentasi hanya berdasarkan nama paket:

  • new Viewer(_cache, _accessor, …), UnSafeMode, synchronous OpenDocument(...), viewer.InitCache(), UseDoconutWebFarm, dan skrip viewer yang disalin secara manual mengidentifikasi integrasi sebelumnya;
  • AddDoconut(), UseDoconutResources(), sebuah Viewer yang disuntikkan, dan OpenDocumentAsync(...) mengidentifikasi integrasi saat ini yang didokumentasikan di sini.

Manual penyiapan sebelumnya yang diterjemahkan tetap tersedia. Gunakan panduan migrasi untuk mengubah generasi; pembaruan paket tidak secara otomatis mengonversi startup, masa pakai viewer, atau sumber daya browser.

Daftarkan Doconut

AddDoconut() adalah satu-satunya titik masuk pendaftaran — ada satu overload, dan ia menghubungkan layanan Viewer, layanan lisensi, serta infrastruktur rendering ke dalam kontainer DI.

Dua pemanggilan middleware menyelesaikan penyiapan, dan urutannya penting: UseDoconutResources() harus dijalankan sebelum UseDoconut(). UseDoconut() adalah middleware terminal, sehingga memanggilnya terlebih dahulu berarti setiap permintaan ke aset /doconut-res tidak pernah mencapai penangan sumber daya dan menghasilkan 404. UseDoconut() menjawab setiap permintaan yang mencapainya, jadi pasang pada cabang terpisah dengan app.Map. Penyambungan sesi juga diperlukan — keamanan dokumen default Doconut memvalidasi setiap permintaan halaman terhadap status sesi ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // session state membutuhkan cache (MVC/Razor Pages sudah menambah satu)
builder.Services.AddSession(); // Keamanan dokumen Doconut bergantung pada session state ASP.NET

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

Namespace

Tipe konfigurasi tidak lagi tersebar di empat namespace. Pada rilis ini hampir semuanya berada di namespace root Doconut:

csharp
using Doconut;                       // Viewer, DoconutOptions, DocOptions, semua konfigurasi format
using Doconut.Middleware;            // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds;                // konfigurasi cloud dan berbagi file
using Doconut.Configs.Conversion;    // ConversionTarget

Nama tipe itu sendiri tidak berubah — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig dan sisanya semuanya masih ada. Jika Anda memindahkan aplikasi yang ada, sebagian besar file tidak memerlukan apa pun kecuali dua baris using yang dihapus; lihat panduan migrasi.

Semua opsi

DoconutOptions menerima properti yang dapat diatur berikut ini. Semua bersifat opsional — nilai default di bawah ini berlaku ketika properti dibiarkan tidak disetel.

PropertiDefaultDeskripsi
ShowDoconutInfofalseKetika true, permintaan tanpa token mengembalikan banner versi alih-alih 404. Berguna sebagai pemeriksaan cepat; matikan di produksi.
UnsafeModefalseKetika true, melewati pemeriksaan keamanan sesi ASP.NET pada permintaan halaman. Matikan di produksi. Perhatikan ejaan — perpustakaan sebelumnya menyebut ini UnSafeMode.
MiddlewarePath"/doconut"Nilai koordinasi untuk endpoint halaman-gambar. Nilai ini divalidasi, namun tidak memasang cabang sendiri; jaga agar tetap selaras dengan pemetaan UseDoconut() yang sebenarnya dan klien BasePath.
ResourcesPath"/doconut-res"Lokasi sumber daya JS/CSS/gambar yang tersemat disajikan.
LicensePath"" (string kosong)Jalur ke file lisensi. Kosong berarti melanjutkan ke sumber berikutnya, lalu pencarian otomatis.
LicenseContent"" (string kosong)Konten lisensi mentah — dari variabel lingkungan, manajer rahasia, atau basis data.
LicenseStreamnullLisensi sebagai aliran, dibaca sekali saat startup.
ResetLicensefalseBendera kompatibilitas yang disiapkan. Lisensi dibaca selama AddDoconut(); restart aplikasi setelah mengganti lisensi.
MaxConcurrentEditorSessions200Jumlah maksimum sesi editor hidup (dokumen yang dibuka dengan DocOptions.EditMode). Di atasnya, sesi editor idle yang paling lama tidak digunakan akan ditutup. Sesi viewer normal tidak pernah dihitung. 0 atau nilai negatif berarti tidak ada batas.
EditorSnapshotEveryOps50Dengan persistensi editor diaktifkan (AddDoconutEditorPersistence), ambil snapshot dokumen hidup setiap N perubahan yang tercatat. 0 atau nilai negatif tidak pernah mengambil snapshot di tengah sesi. Tidak berpengaruh ketika persistensi dinonaktifkan.

Prioritas lisensi ketika lebih dari satu sumber diatur: LicenseStream mengalahkan LicenseContent mengalahkan LicensePath mengalahkan pencarian otomatis — lihat Pengaturan Lisensi.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // koordinasikan dengan pemetaan aplikasi dan BasePath klien
    options.ResourcesPath   = "/doconut-res"; // dari mana JS/CSS/gambar viewer disajikan
    options.UnsafeMode      = false;          // jaga keamanan session tetap aktif
    options.ShowDoconutInfo = false;
});

Langkah selanjutnya

Apakah halaman ini membantu?