DoconutHost

שורש ההרכבה עבור System.Web

DoconutHost (namespace Doconut) היא מחלקה סטטית שמחזיקה את השירותים של Doconut לכל תהליך העובד. יישומי ASP.NET Core בונים את השירותים האלה לתוך המכולה של המסגרת; ב‑ASP.NET הקלאסי אין מכולה, ולכן DoconutHost בונה אחת ושומר אותה. המטפל DocImage.axd ומודול המשאבים פותרים את כל מה שהם צריכים ממנה, וכך גם הקוד שלך.

חברמטרה
static void Initialize(Action<DoconutOptions>? configure = null, Action<IServiceCollection>? configureServices = null)בונה את השירותים — פעם אחת
static IServiceProvider Services { get; }המכולה שנבנתה
static bool IsInitialized { get; }true פעם אחת אחרי שהInitialize רץ
static void Shutdown()עוצר עבודה ברקע ומשחרר את המכולה

אתחול

קרא לזה מApplication_Start בGlobal.asax.cs:

csharp
// Global.asax.cs, Application_Start - פעם אחת לכל תהליך עובד. קריאה שנייה היא ללא פעולה:
// האפשרויות של הקריאה הראשונה מנצחות.
Doconut.DoconutHost.Initialize(
    options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    },
    services =>
    {
        // אופציונלי. רץ אחרי הרישומים של Doconut לפני שהקונטיינר נבנה,
        // כך הוא יכול להוסיף שירותים או להחליף שירות אחד שנרשם על ידי Doconut.
        services.AddMemoryCache();
    });
  • configure מקבל את DoconutOptions: רישיון, מתגי אבטחה, תוספים, ווידג'טים.
  • configureServices הוא אופציונלי. הוא רץ אחרי ש‑Doconut רשם את השירותים שלו ולפני שהמכולה נבנית, ולכן הוא יכול להוסיף שירותים — AddDoconutDistributed עבור חוות אינטרנט הוא הרגיל — או להחליף רישום ש‑Doconut יצר.

הקריאה הראשונה מנצחת. Initialize היא אידמפוטנטית: קריאה שנייה מחזירה מייד, ואף אחד מהנציגים שלה אינו רץ. זה משאיר את Application_Start המוכפל ללא נזק, אך גם משמעותו שהגדרות לא ניתנות לשינוי על ידי קריאה חוזרת לInitialize — יש למחזר את מאגר היישומים במקום זאת.

חריגה שנזרקת כאן — תוסף ללא רישיון, אפשרויות לא תקינות, תצורת חווה לא מלאה — מתרחשת בתוך Application_Start. ASP.NET לאחר מכן משיב לכל בקשה עם 500 ריק, והחריגה נרשמת רק ביומן האירועים של Windows (יומן היישום, מקור ASP.NET).

שירותים ו‑IsInitialized

ל‑System.Web אין הזרקת קונסטרקטור עבור בקרים, דפים או מטפלים, ולכן יש לפתור את השירותים של Doconut במקום שבו אתה משתמש בהם:

csharp
// ל‑System.Web אין הזרקת קונסטרקטור: יש לפתור שירותי Doconut במקומות שבהם משתמשים בהם.
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

// רשום רק כאשר תוסף ה‑Converter פעיל (ראו את דף התוסף).
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();

Services זורק InvalidOperationException (DoconutHost.Initialize must be called in Application_Start (Global.asax) before any Doconut request is served.) כאשר נקרא לפני Initialize. קוד שיכול לרוץ מוקדם יותר — מודול, קונסטרקטור סטטי — יכול לבדוק את IsInitialized תחילה.

מה שהקוד שלך פותר בדרך כלל:

שירותמשך חייםתפקיד
Viewerזמניפתיחה, סגירה, אנוטציות, עוזרי משאבים — ראה Viewer
DocumentConverterזמניהמרה — תמיד רשומה; פתרון ללא תוסף הממיר זורק InvalidOperationException שמציין את התוסף להוספה
DocumentSignerזמניחתימה — דורש את תוסף ה‑Signer (ראה Signer Plugin)
IDoconutLicenseServiceיחידהרישיון הטעון והיכולות שלו — ראה Licensing
DoconutOptionsיחידהאופציות שהועברו לInitialize
HealthCheckServiceיחידמריץ את בדיקת הבריאות "doconut" (להלן)

פתור מDoconutHost.Services, לעולם לא ממכולה שלך. רישום Doconut במכולה אחרת בונה סט שירותים שני ונפרד שהמטפל והממודול אף פעם לא רואים: מסמכים שנפתחים דרכו אינם ידועים לDocImage.axd.

כיבוי

csharp
// Global.asax.cs, Application_End - מפסיק עבודה ברקע ומשחרר את הקונטיינר.
// בטוח לקרוא פעמיים, ובטוח גם כאשר Initialize לא רץ מעולם.
Doconut.DoconutHost.Shutdown();

Shutdown עוצר את העבודה ברקע של Doconut (משמשת במצב המבוזר) ומשחרר את המכולה. בטוח לקרוא פעמיים, ובטוח גם כאשר Initialize מעולם לא רץ — לדוגמה כאשר מאגר היישומים מתחדש לפני הבקשה הראשונה.

בדיקת בריאות

Doconut רושמת בדיקת בריאות בשם "doconut" המדווחת על מצב הרישיון. ב‑ASP.NET הקלאסי אין נקודת קצה לבדיקת בריאות משלה, ולכן חשוף אותה ממבקר:

csharp
// GET /Health - Doconut רושמת בדיקת בריאות "doconut" שמדווחת על מצב הרישיון:
// בריא (תקף), פגום (גרסת ניסיון או ללא קובץ רישיון), לא בריא (נדחה או פג תוקף).
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");
}
מצבמשמעות
Healthyרישיון תקף נטען
Degradedנסיון, או שלא נמצא קובץ רישיון
Unhealthyהרישיון נדחה (לדוגמה, קובץ ערוך) או שפג תוקפו

שיטות ההרחבה של ASP.NET Core

החבילה גם מכילה את UseDoconut() ו‑UseDoconutResources(), הרחבות צינור העבודה של ASP.NET Core, מכיוון שהיא חולקת קוד עם חבילות ASP.NET Core. בחבילה זו שניים מסומנים כ[Obsolete] ולא משמשים: ליישום System.Web אין צינור בקשות להוסיף אליהם. החלופות שלהם הן שני הרישומים Web.config מInstallation:

ASP.NET Core.NET Framework 4.7.2
builder.Services.AddDoconut(...)DoconutHost.Initialize(...) בApplication_Start
app.UseDoconut()Doconut.DocImageHandler על DocImage.axd בWeb.config
app.UseDoconutResources()Doconut.DoconutResourceModule בWeb.config
הזרקת קונסטרקטורDoconutHost.Services.GetRequiredService<T>()
כיבוי המארחDoconutHost.Shutdown() בApplication_End

האם דף זה היה מועיל?