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:
// 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 มีลักษณะเป็น idempotent: การเรียกครั้งที่สองจะคืนค่าโดยทันที, และ ไม่มี delegate ใดของมันทำงาน. สิ่งนี้ทำให้ Application_Start ที่ซ้ำซ้อนไม่เป็นอันตราย, แต่ก็หมายความว่าการกำหนดค่าไม่สามารถเปลี่ยนแปลงได้โดยการเรียก Initialize อีกครั้ง — ให้รีไซเคิล application pool แทน
ข้อยกเว้นที่ถูกโยนที่นี่ — ปลั๊กอินที่ไม่มีใบอนุญาต, ตัวเลือกไม่ถูกต้อง, การกำหนดค่า farm ที่ไม่สมบูรณ์ — เกิดขึ้นภายใน Application_Start. ASP.NET จากนั้นจะตอบทุกคำขอด้วย 500 ที่ว่างเปล่า, และข้อยกเว้นจะถูกบันทึกไว้เฉพาะใน Windows event log (Application log, source ASP.NET).
บริการและ IsInitialized
System.Web ไม่มีการฉีดคอนสตรัคเตอร์สำหรับคอนโทรลเลอร์, หน้า, หรือ handler, ดังนั้นให้ดึงบริการของ Doconut ที่คุณใช้
// 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 | Transient | เปิด, ปิด, คำอธิบาย, ตัวช่วยทรัพยากร — ดู Viewer |
DocumentConverter | Transient | การแปลง — ลงทะเบียนเสมอ; การดึงโดยไม่มีปลั๊กอิน Converter จะโยน InvalidOperationException ที่ระบุชื่อปลั๊กอินที่ต้องเพิ่ม |
DocumentSigner | Transient | การลงนาม — ต้องการปลั๊กอิน Signer (ดู Signer Plugin) |
IDoconutLicenseService | Singleton | ใบอนุญาตที่โหลดและความสามารถของมัน — ดู Licensing |
DoconutOptions | Singleton | ตัวเลือกที่ส่งไปยัง Initialize |
HealthCheckService | Singleton | ดำเนินการตรวจสอบสุขภาพ "doconut" (ด้านล่าง) |
ดึงจาก DoconutHost.Services, ไม่ใช่จากคอนเทนเนอร์ของคุณเอง. การลงทะเบียน Doconut เข้าในคอนเทนเนอร์อื่นจะสร้างชุดบริการที่สองแยกจากกันซึ่ง handler และโมดูลจะไม่เห็น: เอกสารที่เปิดผ่านมันจะไม่เป็นที่รู้จักของ DocImage.axd.
ปิดระบบ
// Global.asax.cs, Application_End - หยุดงานเบื้องหลังและทำลายคอนเทนเนอร์.
// ปลอดภัยที่จะเรียกสองครั้ง, และปลอดภัยเมื่อ Initialize ไม่เคยทำงาน.
Doconut.DoconutHost.Shutdown();Shutdown หยุดงานเบื้องหลังของ Doconut (ใช้ในโหมดกระจาย) และทำลายคอนเทนเนอร์. สามารถเรียกได้สองครั้งโดยปลอดภัย, และปลอดภัยเมื่อ Initialize ไม่เคยทำงาน — เช่นเมื่อ application pool รีไซเคิลก่อนคำขอแรก.
การตรวจสอบสุขภาพ
Doconut ลงทะเบียนการตรวจสอบสุขภาพชื่อ "doconut" ที่รายงานสถานะใบอนุญาต. ASP.NET แบบคลาสสิกไม่มี endpoint การตรวจสอบสุขภาพของตนเอง, ดังนั้นให้เปิดเผยจาก controller:
// 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(), ส่วนขยายของ pipeline ของ ASP.NET Core, เนื่องจากมันแชร์โค้ดกับแพคเกจ ASP.NET Core. ในแพคเกจนี้ทั้งสองถูกทำเครื่องหมายว่า [Obsolete] และไม่ได้ใช้: แอปพลิเคชัน System.Web ไม่มี pipeline ของคำขอให้เพิ่มเข้าไป. การแทนที่ของพวกมันคือการลงทะเบียน 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 |
หน้านี้เป็นประโยชน์หรือไม่?