Instalace
Přidejte Doconut do svého projektu .NET Standard 2.1
Základní prohlížeč Doconut pro .NET Standard je distribuován jako jediný NuGet balíček, který lze připojit k libovolné aplikaci ASP.NET Core. Volitelné rozšíření jsou k dispozici v samostatných balíčcích. Tato stránka nainstaluje základní balíček, ověří, že jej váš hostitel dokáže použít, a zaregistruje middleware — což je minimální požadavek před prvním vykreslením.
Zkontrolujte nejprve framework hostitele
Knihovna cílí na netstandard2.1. Jedná se o užší kontrakt než předchozí sestavení netstandard2.0 a je to první věc, kterou je potřeba ověřit:
| Hostitel | Podporováno |
|---|---|
| .NET Core 3.0 nebo novější, včetně .NET 5/6/7/8 | Ano |
| .NET Framework (jakákoli verze) | Ne — netstandard2.1 nelze použít v .NET Framework |
Balíček funguje pouze na Windows. Pro Linuxový hostitel použijte Doconut.NET8 nebo Doconut.NET6.
Pokud aplikace běží na .NET Framework, nejde o správný balíček. Použijte Doconut.NETFramework; od verze 26.9.0 vyžaduje .NET Framework 4.7.2.
Instalace balíčku
dotnet add package Doconut.NETStandardPříkaz bez specifikace verze nainstaluje nejnovější stabilní vydání. Pokud chcete použít konkrétní verzi, kterou tato dokumentace popisuje, předejte verzi jako samostatnou volbu:
dotnet add package Doconut.NETStandard --version 26.10.0Doconut.NETStandard je identifikátor balíčku. Přípona verze patří ke staženému souboru Doconut.NETStandard.<version>.nupkg a není součástí ID.
Číslo verze představuje generaci
Toto je zde důležitější než název balíčku. Obě generace knihovny .NET Standard jsou publikovány pod stejným ID balíčku a pouze verze je od sebe odlišuje:
| Verze | Cíl | API |
|---|---|---|
| 26.7.0 a nižší | netstandard2.0 | předchozí integrace |
| 26.8.0 a vyšší | netstandard2.1 | integrace dokumentovaná zde |
Neexistuje žádná kompatibilní vrstva ani balíček vedle sebe. Zvýšení verze je aktualizací a kompilátor okamžitě nahlásí rozdíly v API.
Nevybírejte dokumentaci jen podle názvu balíčku:
new Viewer(_cache, _accessor, …),UnSafeMode, synchronníOpenDocument(...),viewer.InitCache(),UseDoconutWebFarma ručně zkopírované skripty prohlížeče identifikují předchozí integraci;AddDoconut(),UseDoconutResources(), vloženýVieweraOpenDocumentAsync(...)identifikují aktuální integraci dokumentovanou zde.
Přeložený předchozí manuál nastavení je nadále k dispozici. Použijte průvodce migrací k přechodu mezi generacemi; aktualizace balíčku automaticky nepřevádí startovací kód, životnost prohlížeče ani zdroje prohlížeče.
Zaregistrujte Doconut
AddDoconut() je jediný vstupní bod registrace — existuje jediný přetížení a on propojí službu Viewer, licenční službu a vykreslovací infrastrukturu do kontejneru DI.
Dvě volání middleware dokončují nastavení a jejich pořadí je podstatné: UseDoconutResources() musí běžet před UseDoconut(). UseDoconut() je koncový middleware, takže pokud jej spustíte jako první, každý požadavek na asset /doconut-res nikdy nedosáhne obsluhy zdrojů a skončí chybou 404. UseDoconut() odpovídá na každý požadavek, který k němu dorazí, proto jej umístěte na vlastní větev pomocí app.Map. Propojení se seancí je také nutné — výchozí zabezpečení dokumentu Doconut ověřuje každý požadavek stránky vůči stavu ASP.NET session.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // stav relace potřebuje mezipaměť (MVC/Razor Pages již přidávají jednu)
builder.Services.AddSession(); // Doconut zabezpečení dokumentu vychází z ASP.NET stavu relace
app.UseSession(); // zavolejte UseSession() před UseDoconut()
app.UseDoconutResources(); // musí být zaregistrováno před UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());Jmenné prostory
Konfigurační typy již nejsou rozprostřeny ve čtyřech jmenných prostorech. V tomto vydání se téměř vše nachází v kořenovém jmenném prostoru Doconut:
using Doconut; // Viewer, DoconutOptions, DocOptions, všechny konfigurace formátů
using Doconut.Middleware; // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds; // konfigurace cloudu a sdílení souborů
using Doconut.Configs.Conversion; // ConversionTargetSamotné názvy typů se nezměnily — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig a ostatní jsou stále k dispozici. Pokud přesouváte existující aplikaci, většina souborů potřebuje jen dvě odstraněné řádky using; viz průvodce migrací.
Všechny možnosti
DoconutOptions přijímá následující nastavitelná vlastnosti. Každá je volitelná — výchozí hodnoty uvedené níže se použijí, pokud není vlastnost nastavena.
| Vlastnost | Výchozí | Popis |
|---|---|---|
ShowDoconutInfo | false | Když je true, požadavek bez token vrátí banner verze místo 404. Užitočné jako rychlá kontrola; v produkci vypněte. |
UnsafeMode | false | Když je true, přeskočí se kontrola zabezpečení ASP.NET‑session u požadavků na stránky. V produkci vypněte. Poznámka k pravopisu — předchozí knihovna toto nazývala UnSafeMode. |
MiddlewarePath | "/doconut" | Koordinační hodnota pro koncový bod page‑image. Je ověřena, ale sama o sobě nevytváří větev; udržujte ji v souladu se skutečným mapováním UseDoconut() a klientským BasePath. |
ResourcesPath | "/doconut-res" | Odkud jsou poskytovány vložené zdroje JS/CSS/obrázky. |
LicensePath | "" (prázdný řetězec) | Cesta k licenčnímu souboru. Prázdná hodnota znamená přechod na další zdroj, poté automatické vyhledání. |
LicenseContent | "" (prázdný řetězec) | Surový obsah licence — z proměnné prostředí, správce tajemství nebo databáze. |
LicenseStream | null | Licence jako proud, načtený jednou při spuštění. |
ResetLicense | false | Rezervovaný příznak kompatibility. Licence se čte během AddDoconut(); po výměně licence restartujte aplikaci. |
MaxConcurrentEditorSessions | 200 | Maximální počet aktivních editorových seancí (dokumenty otevřené pomocí DocOptions.EditMode). Přes tento limit se nejméně nedávno použité nečinné seance uzavřou. Normální seance prohlížeče se nepočítají. 0 nebo záporná hodnota znamená neomezený počet. |
EditorSnapshotEveryOps | 50 | Při povolené perzistenci editoru (AddDoconutEditorPersistence) se po každých N zaznamenaných změnách vytvoří snímek živého dokumentu. 0 nebo záporná hodnota nikdy neprovádí snímky během seance. Nemá žádný vliv, pokud je perzistence vypnuta. |
Priorita licencí, když je nastaveno více zdrojů: LicenseStream má přednost před LicenseContent, který má přednost před LicensePath, který má přednost před automatickým vyhledáním — viz Nastavení licence.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.MiddlewarePath = "/doconut"; // koordinujte s mapováním aplikace a BasePath klienta
options.ResourcesPath = "/doconut-res"; // odkud jsou servírovány JS/CSS/obrázky vieweru
options.UnsafeMode = false; // udržujte zabezpečení relace
options.ShowDoconutInfo = false;
});Další kroky
- Rychlý start — otevřete svůj první dokument a vykreslete jej v prohlížeči.
- Nastavení licence — kde Doconut hledá váš licenční soubor.
Byla tato stránka užitečná?