Instalación

Agregar Doconut a su proyecto .NET Standard 2.1

El visor base Doconut para .NET Standard se entrega como un paquete NuGet que se conecta a cualquier aplicación ASP.NET Core. Los complementos opcionales usan paquetes separados. Esta página instala el paquete base, confirma que su host pueda consumirlo y registra el middleware — lo mínimo necesario antes de su primera renderización.

Verifique primero el framework del host

La biblioteca apunta a netstandard2.1. Ese es un contrato más estrecho que la compilación anterior netstandard2.0, y es lo primero que hay que verificar:

HostCompatible
.NET Core 3.0 o posterior, incluyendo .NET 5/6/7/8Sí
.NET Framework (cualquier versión)No — netstandard2.1 no puede ser consumido por .NET Framework

El paquete se ejecuta solo en Windows. Para un host Linux, use Doconut.NET8 o Doconut.NET6.

Si la aplicación se ejecuta en .NET Framework, este no es el paquete correcto. Use Doconut.NETFramework en su lugar; a partir de la versión 26.9.0 requiere .NET Framework 4.7.2.

Instalar el paquete

bash
dotnet add package Doconut.NETStandard

El comando sin versión instala la última versión estable. Para fijar la versión que describe esta documentación, pase la versión como una opción separada:

bash
dotnet add package Doconut.NETStandard --version 26.10.0

Doconut.NETStandard es el ID del paquete. El sufijo de versión pertenece al nombre de archivo descargado Doconut.NETStandard.<version>.nupkg y no forma parte del ID.

El número de versión es la generación

Esto importa más aquí que el nombre del paquete. Ambas generaciones de la biblioteca .NET Standard se publican bajo el mismo ID de paquete, y solo la versión las diferencia:

VersiónObjetivoAPI
26.7.0 y anterioresnetstandard2.0la integración anterior
26.8.0 y posterioresnetstandard2.1la integración documentada aquí

No hay un shim de compatibilidad ni un paquete lado a lado. Incrementar la versión es la actualización, y el compilador informará inmediatamente las diferencias de API.

No seleccione la documentación solo por el nombre del paquete:

  • new Viewer(_cache, _accessor, …), UnSafeMode, síncrono OpenDocument(...), viewer.InitCache(), UseDoconutWebFarm, y scripts del visor copiados manualmente identifican la integración anterior;
  • AddDoconut(), UseDoconutResources(), un Viewer inyectado, y OpenDocumentAsync(...) identifican la integración actual documentada aquí.

El manual de configuración anterior traducido sigue disponible. Use la guía de migración para cambiar de generación; una actualización del paquete no convierte automáticamente el inicio, la vida útil del visor o los recursos del navegador.

Registrar Doconut

AddDoconut() es el único punto de entrada de registro — hay una única sobrecarga, y conecta el servicio Viewer, el servicio de licencia y la infraestructura de renderizado al contenedor DI.

Dos llamadas de middleware completan la configuración, y su orden importa: UseDoconutResources() debe ejecutarse antes que UseDoconut(). UseDoconut() es middleware terminal, por lo que llamarlo primero hace que cualquier solicitud a un recurso /doconut-res nunca llegue al manejador de recursos y devuelva 404. UseDoconut() responde a cada solicitud que lo alcanza, así que móntelo en su propia rama con app.Map. El cableado de sesión también es necesario — la seguridad de documento predeterminada de Doconut valida cada solicitud de página contra el estado de sesión de ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // el estado de sesión necesita una caché (MVC/Razor Pages ya añaden una)
builder.Services.AddSession(); // La seguridad de documentos Doconut depende del estado de sesión de ASP.NET

app.UseSession();          // llame a UseSession() antes de UseDoconut()
app.UseDoconutResources(); // debe registrarse antes de UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Espacios de nombres

Los tipos de configuración ya no están repartidos en cuatro espacios de nombres. En esta versión, casi todo vive en el espacio de nombres raíz Doconut:

csharp
using Doconut;                       // Viewer, DoconutOptions, DocOptions, todas las configuraciones de formato
using Doconut.Middleware;            // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds;                // configuraciones de nube y de uso compartido de archivos
using Doconut.Configs.Conversion;    // ConversionTarget

Los nombres de tipo en sí no cambiaron — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig y el resto siguen allí. Si está migrando una aplicación existente, la mayoría de los archivos solo necesitan dos líneas using eliminadas; vea la guía de migración.

Todas las opciones

DoconutOptions acepta el siguiente conjunto de propiedades configurables. Cada una es opcional — los valores predeterminados a continuación se aplican cuando una propiedad queda sin establecer.

PropiedadValor predeterminadoDescripción
ShowDoconutInfofalseCuando true, una solicitud sin token devuelve una pancarta de versión en lugar de un 404. Útil como verificación rápida; desactívalo en producción.
UnsafeModefalseCuando true, omite la verificación de seguridad de sesión ASP.NET en las solicitudes de página. Desactívalo en producción. Nota la ortografía — la biblioteca anterior llamaba a esto UnSafeMode.
MiddlewarePath"/doconut"Valor de coordinación para el endpoint de página-imagen. Se valida, pero no monta una rama por sí mismo; mantenlo alineado con el mapeo real de UseDoconut() y el cliente BasePath.
ResourcesPath"/doconut-res"Dónde se sirven los recursos incrustados JS/CSS/imagen.
LicensePath"" (empty string)Ruta al archivo de licencia. Vacío significa pasar al siguiente origen, luego búsqueda automática.
LicenseContent"" (empty string)Contenido bruto de la licencia — de una variable de entorno, un gestor de secretos o una base de datos.
LicenseStreamnullLicencia como flujo, leída una vez al iniciar.
ResetLicensefalseBandera de compatibilidad reservada. La licencia se lee durante AddDoconut(); reinicie la aplicación después de reemplazar una licencia.
MaxConcurrentEditorSessions200Número máximo de sesiones de editor en vivo (documentos abiertos con DocOptions.EditMode). Por encima de este número, la sesión de editor inactiva menos recientemente usada se cierra. Las sesiones normales del visor nunca se cuentan. 0 o un valor negativo significa sin límite.
EditorSnapshotEveryOps50Con la persistencia del editor habilitada (AddDoconutEditorPersistence), crea una instantánea del documento en vivo cada N cambios registrados. 0 o un valor negativo nunca crea instantáneas durante la sesión. No tiene efecto cuando la persistencia está deshabilitada.

Prioridad de licencia cuando se establece más de una fuente: LicenseStream supera a LicenseContent, que supera a LicensePath, que supera a la búsqueda automática — vea Configuración de licencia.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // coordine con el mapeo de la aplicación y BasePath del cliente
    options.ResourcesPath   = "/doconut-res"; // de donde se sirven los JS/CSS/imágenes del visor
    options.UnsafeMode      = false;          // mantenga la seguridad de sesión activada
    options.ShowDoconutInfo = false;
});

Próximos pasos

¿Fue útil esta página?