Na era digital de hoje, o gerenciamento de imagem eficiente é crucial para aplicações da web e APIs. Um dos aspectos chave da gestão da imagem é a compressão, que ajuda a reduzir os tamanhos de arquivos sem comprometer significativamente a qualidade. Este guia irá ajudá-lo através da construção de uma API de composição de imagens dinâmica usando Aspose.Imaging para .NET. No final, você terá uma funcional ASP.NET Core Web API que aceita imagens e devolve a saída comprimida de acordo com os parâmetros de consulta (formato, qualidade, rescisão e muito mais).

Aspose.Imaging é uma poderosa biblioteca para trabalhar com imagens em .NET. Ele suporta muitos formatos e fornece recursos de manipulação robustos, incluindo fluxos de trabalho perdidos (JPEG) e sem perdas (PNG).

O que você vai construir

    • O ponto final: POST /api/images/compress?format=jpeg&quality=75&maxWidth=1280&maxHeight=1280
  • Input: arquivo de múltiplas partes (imagem), parâmetros de query opcionais para formato/qualidade/resize
  • Outputs: fluxo de imagem comprimido com a correta Content-Type e caching cabeçalhos
  • Segurança: Validação de tipo de conteúdo, limites de tamanho e decodificador guardado/encodificação

Pré-requisitos

  • .NET 8 (ou .NET 6+)
  • Projeto ASP.NET Core Web API
  • Nuvem em: Aspose.Imaging
  • Opcional: inicialização de licença no aplicativo startup (se você está usando um edifício licenciado)

Estrutura do Projeto (Minimal)

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

Exemplo completo (Service + Controller)

Substitua os espaços de nome do locatário com o espaço de nomes do seu projeto.

/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) controla a compressão perdida.
  • Os padrões de PNG são tipicamente bons para uma primeira versão; se você precisar de pNGs extras menores, você pode adicionar tuning avançado mais tarde.
  • TryStripMetadata É uma abordagem de melhor esforço; APIs de metadados variam por formato fonte.

/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 (Licença de inscrição + licença opcional)

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

Guia passo a passo

Passo 1: Configurar o projeto

Crie um projeto ASP.NET Core Web API. Aspose.Imaging Compartilhe o pacote.Create the Models, Services, e Controllers arquivos como mostrado acima.

Passo 2: Configure Aspose.Imaging (licenciamento opcional)

Se você tiver uma licença, inicia-a no startup (ver Program.csIsso evita a avaliação de marcos de água e garante a plena funcionalidade.

Passo 3: Implementar o serviço de compressão

O que ImageCompressionService:

  • Carregar imagens através Image.Load(Stream)
  • Opcional cortar metadados
  • Resisão opcional com proporção de aspecto preservada
  • Poupança para JPEG ou PNG com opções de formato apropriadas

Passo 4: Construa o controlador API

ImageController Exposições POST /api/images/compress Faça um ficheiro e query parâmetros:

  • format: jpeg ou png (defeitualmente jpeg)
  • quality1 – 100 (apenas JPEG; padrão 80)
  • maxWidth/maxHeightLimitações para a descida
  • stripMetadata• Definição true Para uma produção menor

Passo 5: Teste a API

Use qualquer cliente HTTP para enviar um multipart/form-data solicitação com um único campo de arquivo chamado file, mais parâmetros de query opcionais. Verifique:

  • Response Content-Type O formato do jogo
  • O tamanho do arquivo devolvido é reduzido
  • Recuperação de trabalhos como esperado

Escolhas de Design e Melhores Práticas

  • Conhecimento de configurações: JPEG utiliza QualityPNG permanece sem perda para a produção previsível.
  • Downscale antes de codificar: Reduzir reduz os pixels primeiro (o maior tamanho ganha), depois codificando bits mais longe.
  • Sanitize inputs: Tipo de conteúdo guardado, tamanho de arquivo, limites de consulta.
  • Streaming: Evite ler todo o arquivo na memória repetidamente; mantenha os fluxos curtos e procuráveis.
  • Caching: Marca as respostas como imutáveis se você derivar nome/conteúdo de entradas deterministas; caso contrário, tune os cabeçalhos de cache para o seu caso de uso.
  • Security: Valide o tipo de conteúdo e rejeite cargas suspeitas.
  • Observabilidade: tamanhos de registro antes e depois e parâmetros usados; isso ajuda você a limpar padrões.
  • Trotling: Se exposto publicamente, limite de taxa ou exige auth para evitar o abuso.

Extensões comuns (drop-in mais tarde)

  • WebP/AVIF codificadores para imagens ainda menores (add new options/contentTypeExtensão do arquivo em BuildOptions).
  • PNG tuning (nivel de filtragem/compressão) se você precisar de ativos extra pequenos sem perda.
    • Predefinição de perfis* como thumbnail, preview, hires Mapeando para os parâmetros conhecidos.
  • ETags ou hashing de conteúdo para servir respostas idênticas do cache.
  • Async batch endpoint para compressar vários arquivos ao mesmo tempo.

Troubleshooting

  • Big Inputs: Aumentar RequestSizeLimit ou fluxo para temp armazenamento.
  • Colores brancos: O espaço de cor seguro é tratado por padrões; casos avançados podem precisar de um tipo de cores explícito.
  • Nenhuma redução de tamanho (PNG): PNG é sem perdas; permite reposição ou transição para JPEG para poupanças de byte mais fortes.

Resumo

Você agora tem uma API de compressão de imagem dinâmica pronta para produção usando Aspose.Imaging. O controlador gerencia uploades e parâmetros; o serviço aplica compresão segura, formato-conhecimento e redirecionamento opcional, então flui de volta uma resposta corretamente tipada com cabeçalhos de cache. A partir de aqui, você pode adicionar mais formatos, pré-sets e estratégias caching para se adequar ao seu web stack.

More in this category