Cài đặt

Thêm Doconut vào dự án .NET 6 của bạn

Trình xem Doconut cơ bản cho .NET 6 được cung cấp dưới dạng một gói NuGet có thể tích hợp vào bất kỳ ứng dụng ASP.NET Core nào. Các plugin tùy chọn sử dụng các gói riêng biệt. Trang này cài đặt gói cơ bản và đăng ký middleware — mức tối thiểu cần thiết trước khi bạn thực hiện lần render đầu tiên.

Cài đặt gói

bash
dotnet add package Doconut.NET6

Lệnh không chỉ định phiên bản sẽ cài đặt bản phát hành ổn định mới nhất. Để tái tạo chính xác bản phát hành 26.7.0 hiện tại, hãy truyền phiên bản như một tùy chọn:

bash
dotnet add package Doconut.NET6 --version 26.7.0

Doconut.NET6 là ID của gói. Hậu tố .26.7.0 thuộc về tên tệp Doconut.NET6.26.7.0.nupkg đã tải xuống và không phải là một phần của ID.

Xác định tích hợp trước khi nâng cấp

ID gói Doconut.NET6 đã được sử dụng cho cả hai tích hợp classic và hiện tại của .NET 6. Không nên chọn tài liệu chỉ dựa trên tên gói:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), OpenDocument(...) đồng bộ, và các script viewer được sao chép thủ công xác định tích hợp classic;
  • AddDoconut(), UseDoconutResources(), một Viewer được tiêm, và OpenDocumentAsync(...) xác định tích hợp hiện tại được tài liệu hoá ở đây.

Bản hướng dẫn cài đặt classic đã được dịch sẵn vẫn còn sẵn sàng. Sử dụng hướng dẫn di chuyển để thay đổi thế hệ; một bản cập nhật gói thông thường sẽ không tự động chuyển đổi cấu hình khởi động, vòng đời viewer, hoặc tài nguyên trình duyệt.

Đăng ký Doconut

AddDoconut() là điểm vào duy nhất để đăng ký — chỉ có một overload, và nó kết nối dịch vụ Viewer, dịch vụ giấy phép, và hạ tầng render vào container DI.

Hai lời gọi middleware hoàn thành việc thiết lập, và thứ tự của chúng quan trọng: UseDoconutResources() phải chạy trước UseDoconut(). UseDoconut() là middleware cuối cùng, vì vậy nếu gọi nó trước sẽ khiến mọi yêu cầu tới tài nguyên /doconut-res không bao giờ tới trình xử lý tài nguyên và trả về 404. Việc kết nối session cũng cần thiết — bảo mật tài liệu mặc định của Doconut xác thực mỗi yêu cầu trang dựa trên trạng thái session của ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddSession(); // Doconut document security rides on ASP.NET session state

app.UseSession();          // call UseSession() before UseDoconut()
app.UseDoconutResources(); // must be registered before UseDoconut()
app.UseDoconut();

Tất cả các tùy chọn

DoconutOptions chấp nhận các thuộc tính có thể thiết lập sau. Mỗi thuộc tính đều là tùy chọn — các giá trị mặc định dưới đây sẽ áp dụng khi một thuộc tính không được đặt.

PropertyDefaultDescription
ShowDoconutInfofalseKhi true, một yêu cầu không có token sẽ trả về banner phiên bản thay vì 404. Hữu ích như kiểm tra nhanh; nên tắt trong môi trường production.
UnsafeModefalseKhi true, bỏ qua kiểm tra bảo mật session ASP.NET trên các yêu cầu trang. Nên tắt trong môi trường production.
MiddlewarePath"/doconut"Giá trị điều phối cho endpoint trang‑hình ảnh. Nó được xác thực, nhưng không tự mình gắn một nhánh; giữ nó đồng nhất với ánh xạ thực tế của UseDoconut() và BasePath của client.
ResourcesPath"/doconut-res"Nơi các tài nguyên JS/CSS/hình ảnh được nhúng sẽ được phục vụ từ.
LicensePath"" (empty string)Đường dẫn tới tệp giấy phép. Trống có nghĩa là sẽ chuyển sang nguồn tiếp theo, sau đó tự động tìm kiếm.
LicenseContent"" (empty string)Nội dung giấy phép thô — từ biến môi trường, trình quản lý bí mật, hoặc cơ sở dữ liệu.
LicenseStreamnullGiấy phép dưới dạng stream, đọc một lần khi khởi động.
ResetLicensefalseCờ tương thích dự trữ. Các dịch vụ .NET 6 hiện tại đọc giấy phép trong AddDoconut(); khởi động lại ứng dụng sau khi thay thế giấy phép.

Thứ tự ưu tiên giấy phép khi có hơn một nguồn được đặt: LicenseStream ưu tiên hơn LicenseContent, ưu tiên hơn LicensePath, ưu tiên hơn tự động tìm kiếm — xem Cài đặt giấy phép.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // coordinate with app mapping and client BasePath
    options.ResourcesPath   = "/doconut-res"; // where the viewer's JS/CSS/images are served from
    options.UnsafeMode      = false;          // keep session security on
    options.ShowDoconutInfo = false;
});

Các bước tiếp theo

Trang này có hữu ích không?