A mai digitális korban a hatékony képkezelés kulcsfontosságú a webes alkalmazások és API-k számára. A képmenedzsment egyik kulcsszereplője a tömörítés, amely segít a fájlméretek csökkentésében anélkül, hogy jelentősen kompromisszumot jelentene a minőségben. Ez az útmutató egy dinamikus képkompresszió API létrehozásán keresztül megy keresztül az Aspose.Imaging .NET használatával.

Az Aspose.Imaging egy hatékony könyvtár a .NET képekkel való munkavégzéshez. sok formátumot támogat, és robusztus manipulációs funkciókat kínál, beleértve a veszteségmentes (JPEG) és a PNG (Lostless) munkafolyamatokat is.

Amit építesz

  • A végpont *: POST /api/images/compress?format=jpeg&quality=75&maxWidth=1280&maxHeight=1280
  • ** Bevezetések**: többoldalú fájl (kép), opcionális lekérdezés paraméterek formátum / minőség / méret
  • Outputs: Kompresszált képáramlás a helyes Content-Type A caching fejek
  • ** Biztonság**: Tartalmi típusú érvényesítés, méretkorlátozás és mentett dekód/encód

előfeltételek

  • A .NET 8 (vagy a .Net 6+)
  • ASP.NET Core Web API projekt
  • A NuGet: Aspose.Imaging
  • Opcionális: licenc kezdeményezése az alkalmazás indításában (ha engedélyezett építkezést használ)

A projekt struktúrája (minimális)

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

Teljes példa (Service + Controller)

Változtassa ki a helyszíni névterületeket a projekt nevű térrel.

/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) ellenőrzi a veszteség kompressziót.
  • A PNG hátrányok általában finomak az első verzió számára; ha extra kicsi pNG-ket igényel, későbbi fejlettegetést is hozzáadhat.
  • TryStripMetadata a legjobb erőfeszítésű megközelítés; A metadata API-k forrásformátum szerint változnak.

/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 (A regisztráció + opcionális licenc)

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();

lépésről lépésre útmutató

1. lépés: A projekt beállítása

Hozzon létre egy ASP.NET Core Web API projektet. Aspose.Imaging Kezdőlap Címkék Ezekkel megcímkézve: Create the Models, Services, és Controllers A fentiekhez hasonlóan.

2. lépés: Az Aspose.Imaging beállítása (opcionális engedélyezés)

Ha van egy licenc, indítsa el a startup (lásd: Program.csEz megakadályozza az értékelési vízjelzők és biztosítja a teljes funkcionalitást.

3. lépés: Végezze el a tömörítési szolgáltatást

A ImageCompressionService:

  • Képek feltöltése a Image.Load(Stream)
  • Opcionálisan vágja le a metadatait
  • Opcionálisan visszahúzódik a megőrzött szempont arányával
  • Megtakarítások JPEG vagy PNG formátum-megfelelő lehetőségekkel

4. lépés: építse fel az API Controller-t

ImageController kiállítások POST /api/images/compress Fájl és lekérdezés paraméterek:

  • format: jpeg vagy png (Előzetesen jpeg)
  • quality: 1–100 (csak JPEG; alapértelmezett 80)
  • maxWidth/maxHeight• A csökkenés korlátai
  • stripMetadata• Elmulasztott true Kisebb termelésért

5. lépés: tesztelje az API-t

A HTTP-kliens használatával küldjön egy multipart/form-data kérelem egyetlen fájl mező nevű file, plusz opcionális keresési paraméterek. ellenőrizze:

  • Response Content-Type mérkőzések formátum
  • A visszaküldött fájl mérete csökken
  • A várt munkák visszavonása

Tervezési lehetőségek és legjobb gyakorlatok

  • Format-figyelő beállítások: JPEG használata Quality· A PNG veszteségmentes marad a kiszámítható termeléshez.
  • Downscale előtt kódolás: Az újratöltés először csökkenti a pixeleket (a legnagyobb méret nyereségét), majd a kódolás további biteket.
  • Sanitize input: Tartalom típusa, fájlmérete, lekérdezés határai.
  • ** Streaming**: Kerülje az egész fájlt a memóriába ismételten olvasni; tartsa az áramlatokat rövid élettartamú és kereshető.
  • Caching: Megjelölje a válaszokat, mint változhatatlan, ha származik a név/tartalom a determinisztikus bejegyzések; máskülönben tüntesse a cache címkéket a használati eset.
  • Biztonság: Validálja a tartalom típusát és elutasítja a gyanús fizetéseket.
  • ** Megfigyelhetőség**: Regisztrációs méretek előtte/utána és használt paraméterek; ez segít megszüntetni az alapértelmezettségeket.
  • Törzsölés: Ha nyilvánosan ki vannak téve, az ár-korlát vagy az auth megköveteli a visszaélés megelőzését.

Közös kiterjesztések (drop-in később)

  • WebP/AVIF kódolók még kisebb képekhez (új opciók hozzáadása/contentTypefájl kiterjesztése a BuildOptions).
  • PNG tuning (szűrő/kompressziós szint), ha extra kis veszteségmentes eszközökre van szüksége.
    • Előzetes profilok* mint thumbnail, preview, hires Az ismert paraméterek mappázása.
  • ETags vagy tartalom hashing, hogy azonos válaszokat szolgáljon a cache-ből.
  • Async batch végpont, hogy egyszerre több fájlt tömörítse.

Troubleshooting

  • ** Nagy bevételek**: Növekedés RequestSizeLimit vagy a temp tároláshoz.
  • Fekete színek: A biztonsági színterületet alapértelmezett módon kezelik; a fejlett eseteknek kifejezett színtípusra lehet szükségük.
  • Nincs méretcsökkentés (PNG): A PNG veszteségmentes; lehetővé teszi a visszaváltást vagy a JPEG-re való váltást erősebb byte megtakarítások érdekében.

Összefoglaló

Most már van egy gyártásra kész dinamikus képkompressziós API használatával Aspose.Imaging. A vezérlő kezeli a felvételek és paraméterek; a szolgáltatás alkalmazza a biztonságos, formátum-megfigyelés kompresszió és az opcionális resing, majd áramlik vissza egy megfelelően leírt válasz a cache címkék. innen, akkor hozzáadhat több formátumok, előkészületek, és caching stratégiák, hogy illeszkedjen a web stack.

More in this category