В современном цифровом возрасте эффективная обработка изображений имеет решающее значение для веб-приложений и АПИ. Одним из ключевых аспектов управления изображением является компрессия, которая помогает уменьшить размеры файлов без существенного ущерба качеству. Этот водитель проходит через строительство динамического API компостировки изображения с помощью Aspose.Imaging для .NET. В конце концов, у вас будет функциональный ASP.NET Core Web API, который принимает изображение и возвращает комплектованный выход в соответствии с параметрами запроса (формат, качество, рецидивы и многое другое).

Aspose.Imaging является мощной библиотекой для работы с изображениями в .NET. Она поддерживает множество форматов и обеспечивает прочные функции манипуляции, включая потери (JPEG) и безпотери рабочих потоков (PNG).

Что вы будете строить

  • Окончательный пункт *: POST /api/images/compress?format=jpeg&quality=75&maxWidth=1280&maxHeight=1280
  • Ввод: многофункциональный файл (изображение), факультативные параметры запроса для формата / качества / размера
  • Выходы: компрессированный поток изображения с правильным Content-Type и кашинг-главы
  • Безопасность: Валидация типа контента, ограничения размеров и сохранный декод/экод

Предупреждения

  • .NET 8 (или .Net 6+)
  • Программа ASP.NET Core Web API
  • НУГЕТ : Aspose.Imaging
  • Опциональная: лицензионная инициатива в приложении стартап (если вы используете лицензированную конструкцию)

Структура проекта (минимум)

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

Полный пример (сервис + контролер)

Замените именовые пространства местонахождения именами вашего проекта.

/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) контролирует потери компрессии.
  • ПНГ дефолты обычно хороши для первой версии; если вам нужны дополнительные мелкие PNG, вы можете добавить передовые тонинг позже.
  • TryStripMetadata Это наилучший подход; метаданные АПИ варьируются в зависимости от формата источника.

/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 (регистрация + факультативная лицензия)

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

Step-by-Step Руководство

Шаг 1: Сделайте проект

Создание проекта ASP.NET Core Web API. Aspose.Imaging Создайте пакеты. создайте Models, Services, и Controllers Карты, как показано выше.

Шаг 2: Настройка Aspose.Imaging (опциональное лицензирование)

Если у вас есть лицензия, начните ее на стартапе (см. Program.csЭто избегает оценки водных знаков и обеспечивает полную функциональность.

Шаг 3: Использование компрессионного сервиса

И в ImageCompressionService:

  • Загрузить изображения через Image.Load(Stream)
  • Опционально стягивают метаданные
  • Опционально рецидивы с сохранением аспектного соотношения
  • Сэкономить на JPEG или PNG с формат-подходящими вариантами

Шаг 4: Создайте API-контролер

ImageController экспозиции POST /api/images/compress Использование файла и запросов параметров:

  • format: jpeg или png (по умолчанию jpeg)
  • quality1–100 (только JPEG; по умолчанию 80)
  • maxWidth/maxHeightОграничения для снижения
  • stripMetadata• дефолт true Для меньшего выхода

Шаг 5: Проверьте API

Используйте любой HTTP-клиент для отправки multipart/form-data Заявление с одним файловым полем, названным file, плюс факультативные параметры запроса. проверите:

  • Response Content-Type Формат матча
  • Размер возвращенного файла уменьшается
  • Реконструкция работ, как ожидалось

Выбор дизайна и лучшие практики

  • Формат-уверенные настройки: JPEG использует QualityПНГ остается без потерь для прогнозируемого выхода.
  • Downscale before encoding: Resizing сокращает пикселы сначала (больший размер выигрывает), а затем кодирование резюме байтов дальше.
  • Sanitize inputs: Guard тип контента, размер файла, границы запросов.
  • Streaming: избегайте читать весь файл в память неоднократно; сохраняйте потоки короткой и поисковой.
  • Caching: Маркируйте ответы как неизменные, если вы получаете имя/контент из детерминистских введений; в противном случае нажмите заголовки кеш к вашему случае использования.
  • Безопасность: подтверждает тип контента и отвергает подозрительные платежные заряды.
  • Обсервативность: размеры записей до/после и используемые параметры; это помогает уточнить дефолты.
  • Троттинг: если публично выявлен, ограничение ставки или требование аутх для предотвращения злоупотребления.

Общие расширения (позднее вводятся)

  • *WebP/AVIF коды для даже более мелких изображений (добавить новые опции/contentType/Файл расширения в BuildOptions).
  • PNG tuning (фильтрационный/компрессионный уровень), если вам нужны дополнительные мелкие активы без убытков.
  • Представьте профили как thumbnail, preview, hires Изображение известных параметров.
  • Этаги или hashing контента для обслуживания идентичных ответов из кеш.
  • *Async batch endpoint для компрессии нескольких файлов одновременно.

Troubleshooting

  • ** Большие входы**: увеличение RequestSizeLimit или потока в темное хранение.
  • Верные цвета: Обеспечение цветового пространства обрабатывается по умолчанию; в передовых случаях может потребоваться четкий тип цвета.
  • Нет уменьшения размеров (PNG): PNG без убытков; позволяет переводить или переключаться на JPEG для более сильных сбережений байтов.

Совокупность

Теперь у вас есть готовый к производству динамический компрессионный API с использованием Aspose.Imaging. Контролер справляется с загрузками и параметрами; сервис применяет безопасную, формат-уверенную компромисс и факультативную рецидиву, а затем возвращается правильно напечатанный ответ с кеш-главами. Отсюда вы можете добавить больше форматов, пресетов и кешинных стратегий, чтобы соответствовать вашему веб-стаку.

More in this category