Hvordan bruke Async DICOM JSON Serialisering i ASP.NET Core Web APIs
Denne veiledningen viser hvordan du kan bruke async DICOM JSON serialisering i ASP.NET Core web APIs. Asynk operasjoner er essensielle for high-throughput web applikasjoner for å forhindre trådblokkering og opprettholde responsivitet under belastning.
Hvorfor bruke Async serialisering?
Skalaffektivitet:- Ikke-blokkering I/O gjør det mulig å håndtere mer sammenhengende forespørsler.
• Responsivitet *:- Web-server forblir responsiv under stor filbehandling.
• Ressurseffektivitet:- Trusler frigjøres mens de venter på I/O-operasjoner.
Forutsetninger: Å forberede miljøet
- Installer Visual Studio eller noe kompatibelt .NET IDE.
- Skap et nytt ASP.NET Core Web API-prosjekt som tar sikte på .NET 8.
- Installere Aspose.Medical fra NuGet Package Manager.
Step-by-step guide til Async DICOM JSON serialisering
Steg 1: Installere Aspose.Medical
Legg til Aspose.Medical Library til prosjektet ditt ved hjelp av NuGet.
Install-Package Aspose.MedicalSteg 2: Inkludere nødvendige navnområder
Legg til referanser til de nødvendige navnene i kontrolløren din.
using Aspose.Medical.Dicom;
using Aspose.Medical.Dicom.Serialization;
using Microsoft.AspNetCore.Mvc;Trinn 3: Skap Async Deserialization Endpoint
Skap en sluttpunkt som deserialiserer JSON fra forespørselsorganet.
[HttpPost("import")]
public async Task<IActionResult> ImportDicomJson()
{
Dataset? dataset = await DicomJsonSerializer.DeserializeAsync(Request.Body);
if (dataset == null)
return BadRequest("Invalid DICOM JSON");
return Ok("DICOM data imported successfully");
}Steg 4: Skap Async Serialisering Endpoint
Skap en sluttpunkt som serialiserer DICOM til JSON i svaret.
[HttpGet("export/{filename}")]
public async Task ExportDicomJson(string filename)
{
DicomFile dcm = DicomFile.Open($"storage/{filename}");
Response.ContentType = "application/json";
await DicomJsonSerializer.SerializeAsync(Response.Body, dcm.Dataset);
}Steg 5: Å håndtere Cancellation Tokens
Pass avbestillings tokener for riktig forespørselsavbestilling håndtering.
[HttpPost("process")]
public async Task<IActionResult> ProcessDicomAsync(CancellationToken cancellationToken)
{
Dataset? dataset = await DicomJsonSerializer.DeserializeAsync(
Request.Body,
cancellationToken
);
if (cancellationToken.IsCancellationRequested)
return StatusCode(499, "Client Closed Request");
// Process dataset...
return Ok();
}Komplett ASP.NET Core Controller Eksempel
Her er en komplett kontrollør som implementerer async DICOM JSON-operasjoner:
using Aspose.Medical.Dicom;
using Aspose.Medical.Dicom.Serialization;
using Microsoft.AspNetCore.Mvc;
namespace DicomApi.Controllers;
[ApiController]
[Route("api/[controller]")]
public class DicomController : ControllerBase
{
private readonly string _storagePath = "dicom_storage";
public DicomController()
{
Directory.CreateDirectory(_storagePath);
}
/// <summary>
/// Import DICOM JSON and save as DICOM file
/// </summary>
[HttpPost("import")]
public async Task<IActionResult> ImportDicomJson(CancellationToken cancellationToken)
{
try
{
Dataset? dataset = await DicomJsonSerializer.DeserializeAsync(
Request.Body,
cancellationToken
);
if (dataset == null)
return BadRequest("Failed to deserialize DICOM JSON");
// Generate unique filename
string filename = $"{Guid.NewGuid()}.dcm";
string filepath = Path.Combine(_storagePath, filename);
// Save as DICOM file
DicomFile dcm = new DicomFile(dataset);
dcm.Save(filepath);
return Ok(new { message = "DICOM imported successfully", filename });
}
catch (OperationCanceledException)
{
return StatusCode(499, "Request cancelled");
}
catch (Exception ex)
{
return BadRequest($"Import failed: {ex.Message}");
}
}
/// <summary>
/// Export DICOM file as JSON stream
/// </summary>
[HttpGet("export/{filename}")]
public async Task ExportDicomJson(string filename, CancellationToken cancellationToken)
{
string filepath = Path.Combine(_storagePath, filename);
if (!System.IO.File.Exists(filepath))
{
Response.StatusCode = 404;
await Response.WriteAsync("File not found");
return;
}
try
{
DicomFile dcm = DicomFile.Open(filepath);
Response.ContentType = "application/json";
Response.Headers["Content-Disposition"] = $"attachment; filename=\"{filename}.json\"";
await DicomJsonSerializer.SerializeAsync(
Response.Body,
dcm.Dataset,
writeIndented: true
);
}
catch (OperationCanceledException)
{
// Client disconnected
}
catch (Exception ex)
{
Response.StatusCode = 500;
await Response.WriteAsync($"Export failed: {ex.Message}");
}
}
/// <summary>
/// Convert uploaded DICOM file to JSON
/// </summary>
[HttpPost("convert")]
[RequestSizeLimit(100_000_000)] // 100MB limit
public async Task ConvertDicomToJson(IFormFile file, CancellationToken cancellationToken)
{
if (file == null || file.Length == 0)
{
Response.StatusCode = 400;
await Response.WriteAsync("No file uploaded");
return;
}
try
{
// Save uploaded file temporarily
string tempPath = Path.GetTempFileName();
using (var stream = System.IO.File.Create(tempPath))
{
await file.CopyToAsync(stream, cancellationToken);
}
// Load and convert
DicomFile dcm = DicomFile.Open(tempPath);
Response.ContentType = "application/json";
await DicomJsonSerializer.SerializeAsync(
Response.Body,
dcm.Dataset,
writeIndented: true
);
// Cleanup temp file
System.IO.File.Delete(tempPath);
}
catch (OperationCanceledException)
{
// Client disconnected
}
catch (Exception ex)
{
Response.StatusCode = 500;
await Response.WriteAsync($"Conversion failed: {ex.Message}");
}
}
}Konfigurere begjær størrelse grenser
For store DICOM-filer, konfigurere forespørselsgrenser i Program.cs:
var builder = WebApplication.CreateBuilder(args);
// Configure Kestrel for large uploads
builder.WebHost.ConfigureKestrel(options =>
{
options.Limits.MaxRequestBodySize = 500_000_000; // 500MB
});
// Configure form options
builder.Services.Configure<FormOptions>(options =>
{
options.MultipartBodyLengthLimit = 500_000_000;
});
var app = builder.Build();Strømbehandling eksempler
Behandle DICOM-filer uten å lastes helt inn i hukommelsen:
[HttpPost("stream-process")]
public async Task StreamProcessDicom(CancellationToken cancellationToken)
{
// Read JSON from request body stream
using var reader = new StreamReader(Request.Body);
string json = await reader.ReadToEndAsync(cancellationToken);
// Deserialize
Dataset? dataset = DicomJsonSerializer.Deserialize(json);
if (dataset == null)
{
Response.StatusCode = 400;
await Response.WriteAsync("Invalid JSON");
return;
}
// Process and stream response
Response.ContentType = "application/json";
await DicomJsonSerializer.SerializeAsync(
Response.Body,
dataset,
writeIndented: true
);
}Feil håndtering Best Practices
Implementere omfattende feilbehandling:
[HttpPost("safe-import")]
public async Task<IActionResult> SafeImportDicomJson(CancellationToken cancellationToken)
{
try
{
Dataset? dataset = await DicomJsonSerializer.DeserializeAsync(
Request.Body,
cancellationToken
);
if (dataset == null)
return BadRequest(new { error = "Invalid DICOM JSON format" });
// Process dataset...
return Ok(new { success = true });
}
catch (OperationCanceledException)
{
return StatusCode(499, new { error = "Request cancelled by client" });
}
catch (JsonException ex)
{
return BadRequest(new { error = "JSON parsing error", details = ex.Message });
}
catch (OutOfMemoryException)
{
return StatusCode(507, new { error = "File too large to process" });
}
catch (Exception ex)
{
return StatusCode(500, new { error = "Internal server error", details = ex.Message });
}
}Ytterligere beste praksis
Bruker uttalelser for strømmer
Bruk alltid de riktige måtene:
using (FileStream fs = System.IO.File.OpenRead(filepath))
{
// Process stream
}Timeout konfigurasjon
Konfigurer egnede tidsutganger for lange operasjoner:
builder.WebHost.ConfigureKestrel(options =>
{
options.Limits.RequestHeadersTimeout = TimeSpan.FromMinutes(2);
options.Limits.KeepAliveTimeout = TimeSpan.FromMinutes(5);
});Ytterligere informasjon
- Async metoder forbedrer skalerbarhet, men ikke nødvendigvis akselerere individuelle forespørsler.
- Bruk annullerings tokener for å håndtere klientenes avkoblinger på riktig måte.
- Overvåke minnesbruk når du behandler store DICOM-filer.
Conclusion
Denne veiledningen har vist hvordan å implementere async DICOM JSON serialisering i ASP.NET Core web APIs ved hjelp av Aspose.Medical. Asynk operasjoner er avgjørende for å bygge skalerbare helsetjenester API som håndterer store medisinske bildedata effektivt.