DoconutHost
A raiz de composição para System.Web
DoconutHost (namespace Doconut) é uma classe estática que possui os serviços do Doconut para todo o processo de trabalho. Aplicações ASP.NET Core constroem esses serviços no próprio contêiner do framework; o ASP.NET clássico não tem contêiner, então DoconutHost cria um e o mantém. O manipulador DocImage.axd e o módulo de recursos resolvem tudo o que precisam a partir dele, e o seu código também.
| Membro | Propósito |
|---|---|
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null) | Constrói os serviços — uma vez |
static IServiceProvider Services { get; } | O contêiner construído |
static bool IsInitialized { get; } | true uma vez que Initialize tenha sido executado |
static void Shutdown() | Interrompe o trabalho em segundo plano e descarta o contêiner |
Inicializar
Chame-a a partir de Application_Start em Global.asax.cs:
// Global.asax.cs, Application_Start - uma vez por processo de trabalho. Uma segunda chamada não faz nada:
// as opções da primeira chamada vencem.
Doconut.DoconutHost.Initialize(
options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
},
services =>
{
// Opcional. Executa após os próprios registros do Doconut e antes de o contêiner ser construído,
// para que possa adicionar serviços ou substituir um registrado pelo Doconut.
services.AddMemoryCache();
});configurerecebe o DoconutOptions: licença, interruptores de segurança, plugins, widgets.configureServicesé opcional. Ele executa após o Doconut ter registrado seus próprios serviços e antes que o contêiner seja construído, portanto pode adicionar serviços —AddDoconutDistributedpara uma fazenda web é o usual — ou substituir um registro que o Doconut fez.
A primeira chamada vence. Initialize é idempotente: uma segunda chamada retorna imediatamente, e nenhum de seus delegados é executado. Isso mantém um Application_Start duplicado inofensivo, mas também significa que a configuração não pode ser alterada chamando Initialize novamente — recicle o pool de aplicativos em vez disso.
Uma exceção lançada aqui — um plugin sem licença, opções inválidas, uma configuração de fazenda incompleta — ocorre dentro de Application_Start. O ASP.NET então responde a cada requisição com um 500 vazio, e a exceção é registrada apenas no log de eventos do Windows (log de Aplicação, origem ASP.NET).
Serviços e IsInitialized
System.Web não possui injeção via construtor para controladores, páginas ou manipuladores, portanto resolva os serviços do Doconut onde você os utiliza:
// System.Web não tem injeção por construtor: resolva os serviços do Doconut onde você os utiliza.
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
// Registrado apenas quando o plugin Converter está (veja a página do plugin).
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();Services lança InvalidOperationException (DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.) quando lido antes de Initialize. Código que pode ser executado antes — um módulo, um construtor estático — pode verificar IsInitialized primeiro.
O que seu código normalmente resolve:
| Serviço | Tempo de vida | Função |
|---|---|---|
Viewer | Transient | Abrir, fechar, anotações, auxiliares de recurso — veja Viewer |
DocumentConverter | Transient | Conversão — sempre registrado; resolvê-lo sem o plugin Converter lança um InvalidOperationException que indica o plugin a ser adicionado |
DocumentSigner | Transient | Assinatura — requer o plugin Signer (veja Signer Plugin) |
IDoconutLicenseService | Singleton | A licença carregada e suas capacidades — veja Licensing |
DoconutOptions | Singleton | As opções passadas para Initialize |
HealthCheckService | Singleton | Executa a verificação de saúde "doconut" (abaixo) |
Resolva a partir de DoconutHost.Services, nunca de um contêiner próprio. Registrar o Doconut em outro contêiner cria um segundo conjunto separado de serviços que o manipulador e o módulo nunca veem: documentos abertos através dele são desconhecidos por DocImage.axd.
Encerramento
// Global.asax.cs, Application_End - interrompe o trabalho em segundo plano e descarta o contêiner.
// Seguro chamar duas vezes, e seguro quando Initialize nunca foi executado.
Doconut.DoconutHost.Shutdown();Shutdown interrompe o trabalho em segundo plano do Doconut (usado pelo modo distribuído) e descarta o contêiner. É seguro chamar duas vezes, e seguro quando Initialize nunca foi executado — por exemplo quando o pool de aplicativos recicla antes da primeira requisição.
Verificação de saúde
Doconut registra uma verificação de saúde chamada "doconut" que relata o estado da licença. O ASP.NET clássico não tem um endpoint de verificação de saúde próprio, portanto exponha-a a partir de um controlador:
// GET /Health - Doconut registra uma verificação de saúde "doconut" que relata o estado da licença:
// Saudável (válido), Degradado (versão de avaliação ou sem arquivo de licença), Não saudável (rejeitado ou expirado).
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");
}| Status | Significado |
|---|---|
Healthy | Uma licença válida está carregada |
Degraded | Teste, ou nenhum arquivo de licença encontrado |
Unhealthy | A licença foi rejeitada (por exemplo, um arquivo editado) ou expirou |
Os métodos de extensão do ASP.NET Core
O pacote também contém UseDoconut() e UseDoconutResources(), as extensões de pipeline do ASP.NET Core, porque compartilha seu código com os pacotes ASP.NET Core. Neste pacote ambos estão marcados como [Obsolete] e não são usados: uma aplicação System.Web não tem pipeline de requisição para adicioná-los. Seus substitutos são os dois registros Web.config de Installation:
| ASP.NET Core | .NET Framework 4.7.2 |
|---|---|
builder.Services.AddDoconut(...) | DoconutHost.Initialize(...) in Application_Start |
app.UseDoconut() | Doconut.DocImageHandler on DocImage.axd in Web.config |
app.UseDoconutResources() | Doconut.DoconutResourceModule in Web.config |
| Injeção via construtor | DoconutHost.Services.GetRequiredService<T>() |
| Desligamento do host | DoconutHost.Shutdown() in Application_End |
Esta página foi útil?