У сучасному цифровому віці ефективне обробка зображень є ключовим для веб-прикладів та АПІ. Однією з найважливіших аспектів управління знімком є компресія, яка допомагає зменшити розміри файлів без значних компромісів на якість. Цей посібник проходить через будівництво динамічного 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) контролює компресію втрат.
  • ПНГ дефолти, як правило, хороші для першої версії; якщо вам потрібні додаткові дрібні ПНГ, ви можете додати передові тонуси пізніше.
  • TryStripMetadata Це найкращий підхід; метаданні APIs варіюються за формою джерела.

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

Крок за кроком інструкція

Крок 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 використовує QualityPNG залишається без втрат для прогнозованого видобутку.
  • Downscale перед кодуванням: відновлення спочатку зменшує пікселі (найбільший розмір виграє), а потім зашифрує байти далі.
  • Здорове введення: тип контенту зберігання, розмір файлу, межі запиту.
  • Стримування: Уникайте читання повного файлу в пам’ять неодноразово; зберігайте потоки короткочасними і пошуковими.
  • Caching: Маркує відповіді як незмінні, якщо ви отримуєте ім’я/контент з детерміналістичних входів; в іншому випадку натисніть заголовки кеші до вашого випадку використання.
  • Безпека: підтверджуйте тип контенту і відмовляйтеся від підозрілих платежів.
  • Постежність: Розміри запису до/після та параметри, що використовуються; це допомагає виправити дефолти.
  • Тортлінг: у разі публічної експозиції, обмеження ставки або вимагає аутх для запобігання зловживання.

Загальні розширення (доступні пізніше)

  • WebP/AVIF шифрування для навіть менших зображень (додати нові варіанти/contentTypeРозширення файлу в BuildOptions).
  • ПНГ-тунінг (фільтр / рівень компресії), якщо вам потрібні екстра-маленькі безпоручні активи.
    • Завантажити профіль* як thumbnail, preview, hires Використання відомих параметрів.
  • ** ETags** або hashing контенту для обслуговування ідентичних відповідей з кеші.
  • Async batch кінцевий пункт для компресії кількох файлів одночасно.

Troubleshooting

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

резюме

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

More in this category