V dnešnom digitálnom veku je efektívna manipulácia s obrazom kľúčová pre webové aplikácie a API. Jedným z hlavných aspektov manažmentu obrazu je kompresia, ktorá pomáha pri znižovaní veľkosti súborov bez významného ohrozenia kvality. Tento sprievodca vás prechádza budovaním dynamickej kompresiovej API s použitím Aspose.Imaging pre .NET. Na konci budete mať funkčnú ASP.NET Core Web API, ktorý prijíma obrázky a vráti komprimovaný výsledok podľa parametrov dotazu (formát, kvalita, resing a ďalšie).

Aspose.Imaging je silná knižnica pre prácu s obrázkami v .NET. Podporuje mnoho formátov a poskytuje robustné funkcie manipulácie, vrátane straty (JPEG) a bez strat (PNG) pracovných tokov.

Čo budeš stavať

  • • Výsledok *: POST /api/images/compress?format=jpeg&quality=75&maxWidth=1280&maxHeight=1280
  • Vstupy: viacúčelové súbory (obrázok), voliteľné parametre dotazu pre formát / kvalitu / rozmer
  • ** Výstupy**: Komprimovaný tok obrazu s správnym Content-Type a caching hlavy
  • Safety: Validácia typu obsahu, limity veľkosti a uložený dekód/ekód

Predpoklady

  • • NET 8 (alebo .NET 6+)
  • ASP.NET Core Web API projekt
  • V tomto prípade: Aspose.Imaging
  • Voliteľné: inicializácia licencie v aplikácii startup (ak používate licencovanú stavbu)

Projektová štruktúra (minimálne)

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

Kompletný príklad (Service + Controller)

Nahraďte názvové priestory miestnika názvom priestoru vášho projektu.

/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) kontroluje kompresiu straty.
  • PNG defaulty sú zvyčajne dobré pre prvú verziu; ak potrebujete extra malé PNS, môžete neskôr pridať pokročilé tuning.
  • TryStripMetadata je to najlepšie úsilie prístup; metadata APIs sa líši podľa zdrojového formátu.

/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 (DI registrácia + voliteľná licencia)

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

Krok za krokom sprievodca

Krok 1: Nastavenie projektu

Vytvorte projekt ASP.NET Core Web API. Aspose.Imaging NuGet balíček. vytvoriť Models, Services, a Controllers mapy, ako je uvedené vyššie.

Krok 2: Nastavenie Aspose.Imaging (voliteľná licencia)

Ak máte licenciu, iniciujte ju na startup (pozri Program.csTo zabraňuje hodnoteniu vodných značiek a zabezpečuje plnú funkčnosť.

Krok 3: Vykonávanie kompresnej služby

a The ImageCompressionService:

  • Nahrať obrázky cez Image.Load(Stream)
  • Opcionálne strips metadata
  • Opcionálne rezuje s zachovaným pomerom
  • Ušetriť na JPEG alebo PNG s formátovo vhodnými možnosťami

Krok 4: Vytvorte ovládač API

ImageController Expozície POST /api/images/compress Vytvorenie súboru a parametre dotazu:

  • format: jpeg alebo png (do štandardného jpeg)
  • quality: 1 – 100 (len JPEG; predvolený 80)
  • maxWidth/maxHeightObmedzenia pre downscaling
  • stripMetadata• Default true pre menšiu produkciu

Krok 5: Vyskúšajte API

Použite akýkoľvek HTTP klient na odoslanie multipart/form-data žiadosť s jedným súborovým poľom s názvom file, plus voliteľné vyhľadávacie parametre. skontrolujte:

  • Response Content-Type Formát zápasov
  • Vrátená veľkosť súboru je znížená
  • Odstránenie práce podľa očakávania

Výber dizajnu a najlepších postupov

  • ** Formátové nastavenia**: JPEG používa QualityPNG zostáva bez straty pre predvídateľný výnos.
  • Downscale pred kódovaním: Resizing znižuje pixelov najprv (veľká veľkosť výhry), potom kódovanie skrutky byty ďalej.
  • Sanitizujte vstupy: typ obsahu, veľkosť súboru, hranice dotazu.
  • ** Streaming**: Vyhnite sa čítaniu celého súboru do pamäte opakovane; udržujte toky krátkodobé a vyhľadávateľné.
  • Caching: Značka odpovie ako nezmeniteľná, ak odvodíte názov/súčasť z deterministických vstupov; inak nastavíte cache hlavičky do vášho použitia.
  • Bezpečnosť: Validujte typ obsahu a odmietnite podozrivé platobné zaťaženie.
  • Observovateľnosť: Prihlásenie veľkosti pred/po a použitých parametrov; to vám pomôže nastaviť predvolby.
  • Trotling: Ak je vystavený verejne, limit sadzby alebo vyžaduje auth, aby sa zabránilo zneužití.

Zvyčajné rozšírenia (drop-in neskôr)

  • WebP/AVIF kódovanie pre ešte menšie obrázky (pridať nové možnosti/contentType/file rozšírenie v BuildOptions).
  • PNG tuning (úroveň filtrovania/kompresie) ak potrebujete extra malé bez straty aktíva.
  • Predložiť profily ako thumbnail, preview, hires Zoznam známych parametrov.
  • ETags alebo obsahový hashing slúži na rovnaké odpovede z cache.
  • Async batch endpoint na kompresiu viacerých súborov naraz.

Troubleshooting

  • ** Veľké vstupy**: Zvýšenie RequestSizeLimit alebo stream na temp skladovanie.
  • Rôzne farby: Uistite sa, že farebný priestor sa zaoberá predvolenými podmienkami; pokročilé prípady môžu vyžadovať explicitný typ farieb.
  • Žiadne zníženie veľkosti (PNG): PNG je bez straty; umožňuje resize alebo prepnutie na JPEG pre silnejšie úspory bytov.

Zhrnutie

Teraz máte pripravený na výrobu dynamický kompresný API s použitím Aspose.Imaging. Ovládač spravuje nahrávky a parametre; služba sa vzťahuje na bezpečné, formát-pozorné kompresiu a voliteľné resing, potom prúdi späť správne vytlačenú odpoveď s cache hlavičky. Odtiaľ môžete pridať ďalšie formáty, predvolby a caching stratégie prispôsobiť váš web stack.

More in this category