DoconutExtensions

Registro de serviços e middleware

DoconutExtensions (namespace Doconut.Middleware) é a classe estática com as três chamadas que todo host Doconut faz: um registro de serviço e duas registrações de middleware.

csharp
builder.Services.AddDoconut(options => { /* … */ });
// …
app.UseSession();          // chame UseSession() antes de UseDoconut()
app.UseDoconutResources(); // deve ser registrado antes de UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

UseDoconut() responde a cada requisição que o alcança, então monte‑o em seu próprio ramo com app.Map.

AddDoconut

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

Constrói o DoconutOptions, valida‑os de forma fail‑fast (veja DoconutOptions → validação de inicialização), e registra o grafo completo de serviços:

ServiçoTempo de vidaFunção
DoconutOptionsSingletonO objeto de configuração
Serviço de cache de sessãoSingletonToken → cache de sessão (IMemoryCache também está registrado)
IDoconutLicenseServiceSingletonLicença carregada uma vez na inicialização (precedência: LicenseStream → LicenseContent → LicensePath → pesquisa automática)
Pipeline de página-imagemSingletonExecuta processamento de imagens para páginas (marca d'água, rotação, escala, anotações)
Segurança de documento (armazenamento de acesso)SingletonConcessões para vinculação token‑para‑sessão
ViewerTransientA fachada pública de abrir/fechar
DocumentConverterTransientFachada de conversão — requer o plugin Converter
DocumentSignerTransientFachada de assinatura — requer o plugin Signer (veja Plugin Signer)
DistributedDocumentPublisherTransientPublica artefatos de um documento para armazenamento compartilhado (veja Implantações Distribuídas)
Health check "doconut"—Reporta o estado da licença/expiração através das verificações de saúde do ASP.NET

Dois comportamentos que vale a pena conhecer:

  • Converter requer seu plugin. Resolver DocumentConverter sem options.AddPlugin<ConverterPlugin>() lança:
text
InvalidOperationException: No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>().

DocumentSigner segue a mesma regra: sem options.AddPlugin<SignerPlugin>() lança No IDocumentSigner is registered. Add the signing plugin: options.AddPlugin<Doconut.Plugins.Signer.SignerPlugin>().

  • A concessão de plugin é validada na inicialização. Uma licença ausente, arquivo legado TRIAL, ou licença paga sem a capacidade de plugin registrada falha no momento AddDoconut(). Registros Temporários/Demo sobrevivem à sua data de expiração, enquanto os portões de tempo de execução revogam as capacidades expiradas.

A verificação de saúde integra‑se ao mecanismo padrão do ASP.NET Core — mapeie‑a se quiser o estado da licença no seu endpoint de saúde:

csharp
app.MapHealthChecks("/health");

UseDoconut

text
IApplicationBuilder UseDoconut(this IApplicationBuilder app)

Adiciona o middleware de página‑imagem do Doconut. Ele atende a cada requisição que contém um parâmetro de consulta ?token= — páginas, miniaturas, busca, anotações, ações de página (a tabela completa de requisições está em Conceitos Principais → Como o Visualizador Funciona) — e responde a qualquer outra requisição por conta própria com 404 (ou o banner ShowDoconutInfo): nunca encaminha a requisição para o restante do pipeline. Monte‑o em seu próprio ramo, como nos exemplos desta página. Quando UnsafeMode está false, a camada de segurança de documento é conectada automaticamente antes dele.

Uma alternativa comum mantém o formato histórico de requisição DocImage.axd com um ramo MapWhen (o cliente então usa 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)

Serve o JS, CSS, imagens e fontes incorporados em DoconutOptions.ResourcesPath (padrão /doconut-res). Estes são os arquivos para os quais Viewer.ReferenceCss() / ReferenceScripts() emitem tags.

Sempre chame‑a antes de UseDoconut(). Se a área do visualizador permanecer vazia e o console do navegador mostrar 404s para /doconut-res/..., esta chamada está ausente ou fora de lugar.

Serving from shared storage

Existem duas registrações adicionais para implantações onde o nó que renderiza um documento não é necessariamente o nó que serve suas páginas. Ambas são cobertas de ponta a ponta em Implantações Distribuídas; as assinaturas são:

text
IServiceCollection AddDoconutDistributedAsyncPublish(this IServiceCollection services, Action<DistributedAsyncPublishOptions>? configure = null)   // fila de publicação em segundo plano opt-in
IServiceCollection AddDoconutDistributedWidgets(this IServiceCollection services, Action<DistributedWidgetsOptions> configure)                     // armazenamento de apoio compartilhado para uploads de widget

O lado de leitura é um middleware separado da assembly Doconut.Clouds, que é entregue no mesmo pacote:

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

Ordering recap

csharp
app.UseRouting();
app.UseSession();          // chame UseSession() antes de UseDoconut()
app.UseDoconutResources(); // deve ser registrado antes de UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut()); // ou um ramo MapWhen

Esta página foi útil?