În epoca digitală de astăzi, gestionarea eficientă a imaginii este esențială pentru aplicațiile web și API-urile. Unul dintre aspectele cheie ale managementului imaginilor este compresia, care ajută la reducerea dimensiunilor fișierului fără a compromite semnificativ calitatea. Acest ghid vă îndreaptă prin construirea unei API dinamice de compresiune a imaginelor folosind Aspose.Imaging pentru .NET. În cele din urmă, veți avea o API web funcțională ASP.NET Core care acceptă imaginile și returnează rezultatul comprimat în funcție de parametrii de căutare (format, calitate, resetare și mai mult).

Aspose.Imaging este o bibliotecă puternică pentru a lucra cu imagini în .NET. susține mai multe formate și oferă funcții de manipulare robuste, inclusiv fluxuri de lucru pierdute (JPEG) și fără pierderi (PNG).

Ce vei construi

  • • Punctul final: POST /api/images/compress?format=jpeg&quality=75&maxWidth=1280&maxHeight=1280
  • Inputs: fișier multiparțial (imaginea), parametri de căutare opționale pentru format / calitate / reziză
  • Outputs: fluxul de imagine comprimat cu corect Content-Type și capetele de caching
  • Safety: validarea tipului de conținut, limitele de dimensiune și codul/encodul păstrat

Prevederile

  • .NET 8 (sau .Net 6+)
  • Proiectul ASP.NET Core Web API
  • Încă nu: Aspose.Imaging
  • Opțional: inițializarea licenței în start-up-ul aplicației (dacă utilizați o construcție licențiată)

Structura proiectului (minimală)

/Controllers
  ImageController.cs
/Services
  ImageCompressionService.cs
/Models
  CompressionRequest.cs
Program.cs
appsettings.json

Exemplu complet (Service + Controller)

Înlocuiți spațiile de nume ale locatorului cu spațiul nominal al proiectului dvs.

/Models/CompressionRequest.cs

namespace ImageApi.Models;

public sealed class CompressionRequest
{
    // "jpeg" or "png"
    public string Format { get; init; } = "jpeg";

    // 1..100 (applies to JPEG only; PNG is lossless)
    public int? Quality { get; init; } = 80;

    // Optional resize bounds; image is resized preserving aspect ratio if either is provided.
    public int? MaxWidth { get; init; }
    public int? MaxHeight { get; init; }

    // If true, strip metadata (EXIF, IPTC) where applicable to reduce size further.
    public bool StripMetadata { get; init; } = true;

    // Guardrails
    public void Validate()
    {
        var fmt = Format?.ToLowerInvariant();
        if (fmt is not "jpeg" and not "png")
            throw new ArgumentException("Unsupported format. Use 'jpeg' or 'png'.");

        if (Quality is { } q && (q < 1 || q > 100))
            throw new ArgumentException("Quality must be between 1 and 100.");

        if (MaxWidth is { } w && w <= 0) throw new ArgumentException("MaxWidth must be positive.");
        if (MaxHeight is { } h && h <= 0) throw new ArgumentException("MaxHeight must be positive.");
    }
}

/Services/ImageCompressionService.cs

using Aspose.Imaging;
using Aspose.Imaging.ImageOptions;
using ImageApi.Models;

namespace ImageApi.Services;

public interface IImageCompressionService
{
    Task<(MemoryStream output, string contentType, string fileExt)> CompressAsync(
        Stream input, CompressionRequest req, CancellationToken ct = default);
}

public sealed class ImageCompressionService : IImageCompressionService
{
    private readonly ILogger<ImageCompressionService> _logger;

    public ImageCompressionService(ILogger<ImageCompressionService> logger)
    {
        _logger = logger;
    }

    public async Task<(MemoryStream output, string contentType, string fileExt)> CompressAsync(
        Stream input, CompressionRequest req, CancellationToken ct = default)
    {
        req.Validate();

        // Defensive copy to a seekable stream
        var inbound = new MemoryStream();
        await input.CopyToAsync(inbound, ct).ConfigureAwait(false);
        inbound.Position = 0;

        // Load image via Aspose.Imaging
        using var image = Image.Load(inbound);

        // Optional: strip metadata (where applicable)
        if (req.StripMetadata)
        {
            TryStripMetadata(image);
        }

        // Optional resize (preserve aspect ratio)
        if (req.MaxWidth.HasValue || req.MaxHeight.HasValue)
        {
            ResizeInPlace(image, req.MaxWidth, req.MaxHeight);
        }

        // Choose encoder and options
        string fmt = req.Format.ToLowerInvariant();
        var (options, contentType, ext) = BuildOptions(fmt, req.Quality);

        // Save to output
        var output = new MemoryStream();
        image.Save(output, options);
        output.Position = 0;

        _logger.LogInformation("Compressed image to {Bytes} bytes as {Ext}", output.Length, ext);
        return (output, contentType, ext);
    }

    private static void ResizeInPlace(Image image, int? maxW, int? maxH)
    {
        var w = image.Width;
        var h = image.Height;

        double scaleW = maxW.HasValue ? (double)maxW.Value / w : 1.0;
        double scaleH = maxH.HasValue ? (double)maxH.Value / h : 1.0;
        double scale = Math.Min(scaleW, scaleH);

        if (scale < 1.0)
        {
            int newW = Math.Max(1, (int)Math.Round(w * scale));
            int newH = Math.Max(1, (int)Math.Round(h * scale));
            image.Resize(newW, newH);
        }
    }

    private static (ImageOptionsBase options, string contentType, string ext) BuildOptions(string fmt, int? quality)
    {
        switch (fmt)
        {
            case "jpeg":
            {
                var q = quality ?? 80;
                var jpeg = new JpegOptions { Quality = q };
                return (jpeg, "image/jpeg", "jpg");
            }
            case "png":
            {
                // PNG is lossless; using defaults ensures broad compatibility.
                // Many PNG tunables exist, but defaults are safe and effective.
                var png = new PngOptions();
                return (png, "image/png", "png");
            }
            default:
                throw new ArgumentOutOfRangeException(nameof(fmt), "Unsupported format.");
        }
    }

    private static void TryStripMetadata(Image image)
    {
        try
        {
            // Not every format exposes EXIF/IPTC the same way; a best-effort clear:
            if (image is RasterImage raster)
            {
                raster.RemoveAllFonts();
                raster.SetPropertyItems(Array.Empty<PropertyItem>());
            }
        }
        catch
        {
            // Non-fatal; ignore if format doesn't support these operations
        }
    }
}

Notes

  • JpegOptions.Quality (1-100) controlează compresia pierderii.
  • Defaultele PNG sunt de obicei fine pentru prima versiune; dacă aveți nevoie de pNG-uri mai mici, puteți adăuga tuning avansat mai târziu.
  • TryStripMetadata este o abordare de cel mai bun efort; APIs metadata variază în funcție de format de sursă.

/Controllers/ImageController.cs

using ImageApi.Models;
using ImageApi.Services;
using Microsoft.AspNetCore.Mvc;

namespace ImageApi.Controllers;

[ApiController]
[Route("api/images")]
public sealed class ImageController : ControllerBase
{
    private static readonly HashSet<string> AllowedContentTypes = new(StringComparer.OrdinalIgnoreCase)
    {
        "image/jpeg", "image/png", "image/gif", "image/webp", "image/bmp", "image/tiff"
    };

    private readonly IImageCompressionService _svc;
    private readonly ILogger<ImageController> _logger;

    public ImageController(IImageCompressionService svc, ILogger<ImageController> logger)
    {
        _svc = svc;
        _logger = logger;
    }

    // POST /api/images/compress?format=jpeg&quality=75&maxWidth=1280&maxHeight=1280
    [HttpPost("compress")]
    [RequestSizeLimit(25_000_000)] // 25 MB cap; adjust to your needs
    public async Task<IActionResult> Compress(
        [FromQuery] string? format,
        [FromQuery] int? quality,
        [FromQuery] int? maxWidth,
        [FromQuery] int? maxHeight,
        [FromQuery] bool stripMetadata = true,
        IFormFile? file = null,
        CancellationToken ct = default)
    {
        if (file is null || file.Length == 0)
            return BadRequest("No file uploaded.");

        if (!AllowedContentTypes.Contains(file.ContentType))
            return BadRequest("Unsupported content type. Upload a common raster image (JPEG, PNG, GIF, WebP, BMP, TIFF).");

        var req = new CompressionRequest
        {
            Format = string.IsNullOrWhiteSpace(format) ? "jpeg" : format!,
            Quality = quality,
            MaxWidth = maxWidth,
            MaxHeight = maxHeight,
            StripMetadata = stripMetadata
        };

        await using var input = file.OpenReadStream();
        var (output, contentType, ext) = await _svc.CompressAsync(input, req, ct);

        // Strong caching for immutable responses (tune for your app/CDN)
        Response.Headers.CacheControl = "public,max-age=31536000,immutable";

        return File(output, contentType, fileDownloadName: BuildDownloadName(file.FileName, ext));
    }

    private static string BuildDownloadName(string originalName, string newExt)
    {
        var baseName = Path.GetFileNameWithoutExtension(originalName);
        return $"{baseName}-compressed.{newExt}";
    }
}

Program.cs (înregistrare + licență opțională)

using Aspose.Imaging;
using ImageApi.Services;

var builder = WebApplication.CreateBuilder(args);

// Optional: initialize Aspose license from a file or stream if you have one
// var license = new Aspose.Imaging.License();
// license.SetLicense("Aspose.Total.lic");

builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
builder.Services.AddSingleton<IImageCompressionService, ImageCompressionService>();

var app = builder.Build();

app.UseRouting();
app.UseAuthorization();
app.MapControllers();

// Enable for local testing
app.UseSwagger();
app.UseSwaggerUI();

app.Run();

Ghidul pas cu pas

Pasul 1: Setarea proiectului

Creați un proiect ASP.NET Core Web API. Aspose.Imaging Pachetul NuGet. Creați Models, Services, şi Controllers dosare, după cum este arătat mai sus.

Pasul 2: Configurați Aspose.Imaging (licență opțională)

Dacă aveți o licență, inițializați-o la startup (a se vedea Program.csAcest lucru evită evaluarea indicatorilor de apă și asigură funcționalitatea completă.

Pasul 3: Implementarea serviciului de compresie

pe care ImageCompressionService:

  • Încărcați imagini prin Image.Load(Stream)
  • Opțional strânge metadate
  • Opțional rezistă cu raportul aspectului păstrat
  • Scaune la JPEG sau PNG cu opțiuni adecvate formatului

Pasul 4: Construiți controlorul API

ImageController Expoziţii POST /api/images/compress Pentru a obține un fișier și parametri de interogare:

  • format: jpeg sau png (defaultă jpeg)
  • quality1 – 100 (numai JPEG; standard 80)
  • maxWidth/maxHeightLimite pentru descărcare
  • stripMetadata• deficitul true Pentru o producție mai mică

Pasul 5: Testarea API-ului

Utilizați orice client HTTP pentru a trimite un multipart/form-data solicitarea cu un singur câmp de fișier numit file, plus parametrii de interogare opționale. verificați:

  • Response Content-Type Formatul meciurilor
  • Dimensiunea fișierului returnat este redusă
  • Reînnoirea lucrărilor ca de așteptat

Opțiuni de design și cele mai bune practici

  • Setări de informare a formatului: utilizează JPEG Quality; PNG rămâne fără pierderi pentru producția predictabilă.
  • Downscale înainte de codare: Reducerea reduce mai întâi pixeli (cel mai mare câștig), apoi codarea scurte byte mai departe.
  • Sanitați intrările: tipul de conținut de păstrare, dimensiunea fișierului, limitele întrebării.
  • Streaming: Evitați citirea întregului fișier în memorie în mod repetat; păstrați fluxurile la scurtă durată și vizibile.
  • Caching: Marcați răspunsurile ca fiind imutabile dacă derivați numele / conținutul de la intrările deterministe; în caz contrar puneți titlurile de cache în cazul dvs. de utilizare.
  • Security: Validați tipul de conținut și respingeți încărcăturile suspecte.
  • Observabilitate: Dimensiunile de înregistrare înainte/după și parametrii utilizați; acest lucru vă ajută să tuneți defectele.
  • Trotling: În cazul în care este expus public, limite rate sau cer auth pentru a preveni abuzul.

Extinderi comune (drop-in mai târziu)

  • WebP/AVIF coduri pentru imagini mai mici (a adăugat noi opțiuni/contentTypeextinderea fișierului în BuildOptions).
  • PNG tuning (nivel de filtrare/compresie) dacă aveți nevoie de active extra mici fără pierderi.
  • Profilele de presetare* ca thumbnail, preview, hires Mapează la parametri cunoscuți.
  • ** Etichete** sau hashing de conținut pentru a servi răspunsuri identice din cache.
  • Async batch endpoint pentru a compresa mai multe fișiere la un moment dat.

Troubleshooting

    • Închiriere mare**: creștere RequestSizeLimit sau curge la depozit temp.
  • Colorile curate: Spatiul de culoare asigurat este gestionat prin defecțiuni; cazurile avansate pot necesita un tip de culoare explicit.
  • Nu există reducere a dimensiunii (PNG): PNG este fără pierderi; permite redimensionarea sau schimbarea la JPEG pentru economii mai puternice de byte.

Rezumatul

Acum aveți o API de compresie a imaginii dinamice gata de producție folosind Aspose.Imaging. Controlerul gestionează încărcăturile și parametrii; serviciul se aplică compresii sigure, formate-așteptare și revizuire opțională, apoi reîntoarce un răspuns tipat în mod corespunzător cu titluri de cache. De aici, puteți adăuga mai mulți formati, pre-seturi și strategii caching pentru a vă potrivi stack-ul web.

More in this category