DoconutHost

Kořen kompozice pro System.Web

DoconutHost (namespace Doconut) je statická třída, která vlastní služby Doconut pro celý pracovní proces. Aplikace ASP.NET Core vytvářejí tyto služby v kontejneru samotného frameworku; klasické ASP.NET nemá kontejner, takže DoconutHost vytvoří jeden a udržuje jej. Handler DocImage.axd a modul zdrojů získávají vše, co potřebují, z něj, a to samé dělá i váš kód.

ČlenÚčel
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null)Vytvoří služby — jednou
static IServiceProvider Services { get; }Vytvořený kontejner
static bool IsInitialized { get; }true po jednorázovém spuštění Initialize
static void Shutdown()Zastaví práci na pozadí a uvolní kontejner

Inicializace

Zavolejte ji z Application_Start v Global.asax.cs:

csharp
// Global.asax.cs, Application_Start – jednou na pracovní proces. Druhé volání je nečinné:
// volby prvního volání vyhrávají.
Doconut.DoconutHost.Initialize(
    options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    },
    services =>
    {
        // Volitelné. Spouští se po registracích Doconut a před vytvořením kontejneru,
        // aby mohl přidat služby nebo nahradit jednu registrovanou službu Doconut.
        services.AddMemoryCache();
    });
  • configure přijímá DoconutOptions: licence, bezpečnostní přepínače, pluginy, widgety.
  • configureServices je volitelný. Spouští se po tom, co Doconut zaregistroval své služby a před tím, než je kontejner vytvořen, takže může přidat služby — AddDoconutDistributed pro webfarm je obvyklý — nebo nahradit registraci, kterou Doconut provedl.

První volání vyhrává. Initialize je idempotentní: druhé volání vrátí okamžitě a žádný z jeho delegátů se nespustí. To udržuje duplicitní Application_Start neškodný, ale také to znamená, že konfiguraci nelze změnit opětovným voláním Initialize — místo toho recyklujte aplikační pool.

Výjimka vyhozená zde — plugin bez licence, neplatné možnosti, neúplná konfigurace farmy — nastane uvnitř Application_Start. ASP.NET pak odpoví na každý požadavek prázdným 500 a výjimka je zaznamenána pouze v protokolu událostí Windows (aplikace, zdroj ASP.NET).

Služby a IsInitialized

System.Web nemá injekci přes konstruktor pro controllery, stránky nebo handlery, takže služby Doconut řešte tam, kde je používáte:

csharp
// System.Web nemá injekci přes konstruktor: řešte služby Doconut tam, kde je používáte.
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

// Registrováno pouze když je plugin Converter aktivní (viz stránka pluginu).
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();

Services vyhodí InvalidOperationException (DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.), když je čteno před Initialize. Kód, který může běžet dříve — modul, statický konstruktor — může nejprve zkontrolovat IsInitialized.

Co váš kód typicky řeší:

SlužbaŽivotnostRole
ViewerPřechodnáOtevírání, zavírání, anotace, pomocníci zdrojů — viz Viewer
DocumentConverterPřechodnáKonverze — vždy registrovaná; její vyřešení bez pluginu Converter vyhodí InvalidOperationException, který uvádí plugin, který je třeba přidat
DocumentSignerPřechodnáPodepisování — vyžaduje plugin Signer (viz Signer Plugin)
IDoconutLicenseServiceSingletonNačtená licence a její schopnosti — viz Licensing
DoconutOptionsSingletonMožnosti předané Initialize
HealthCheckServiceSingletonSpouští kontrolu zdraví "doconut" (dole)

Řešte z DoconutHost.Services, nikdy ne z vlastního kontejneru. Registrace Doconut do jiného kontejneru vytvoří druhou, oddělenou sadu služeb, kterou handler a modul nikdy nevidí: dokumenty otevřené skrze něj jsou neznámé DocImage.axd.

Vypnutí

csharp
// Global.asax.cs, Application_End – zastavuje backgroundovou práci a uvolňuje kontejner.
// Bezpečné volat dvakrát a bezpečné, když Initialize nikdy neběžel.
Doconut.DoconutHost.Shutdown();

Shutdown zastavuje práci Doconut na pozadí (používanou distribuovaným režimem) a uvolňuje kontejner. Je bezpečné volat dvakrát a je bezpečné, když Initialize nikdy neběhl — například když se aplikační pool recykluje před prvním požadavkem.

Kontrola zdraví

Doconut registruje kontrolu zdraví nazvanou "doconut", která hlásí stav licence. Klasické ASP.NET nemá vlastní koncový bod pro kontrolu zdraví, takže ji vystavte z controlleru:

csharp
// GET /Health – Doconut registruje kontrolu zdraví "doconut", která hlásí stav licence:
// Zdravý (platný), Degradovaný (zkušební nebo chybí licenční soubor), Nezdravý (odmítnutý nebo prošlý).
public async Task<ActionResult> Index()
{
    var health = Doconut.DoconutHost.Services.GetRequiredService<HealthCheckService>();
    HealthReport report = await health.CheckHealthAsync();

    Response.StatusCode = report.Status == HealthStatus.Unhealthy ? 503 : 200;
    return Content(report.Status.ToString(), "text/plain");
}
StavVýznam
HealthyPlatná licence je načtena
DegradedZkušební verze nebo nebyl nalezen soubor licence
UnhealthyLicence byla odmítnuta (např. upravený soubor) nebo vypršela

Rozšíření metod ASP.NET Core

Balíček také obsahuje UseDoconut() a UseDoconutResources(), rozšíření pipeline ASP.NET Core, protože sdílí svůj kód s balíčky ASP.NET Core. V tomto balíčku jsou oba označeny jako [Obsolete] a nejsou používány: aplikace System.Web nemá požadavek pipeline, do které by je šlo přidat. Jejich náhradou jsou dvě registrace Web.config z Installation:

ASP.NET Core.NET Framework 4.7.2
builder.Services.AddDoconut(...)DoconutHost.Initialize(...) v Application_Start
app.UseDoconut()Doconut.DocImageHandler na DocImage.axd v Web.config
app.UseDoconutResources()Doconut.DoconutResourceModule v Web.config
Injekce přes konstruktorDoconutHost.Services.GetRequiredService<T>()
Vypnutí hostiteleDoconutHost.Shutdown() v Application_End

Byla tato stránka užitečná?