В днешната дигитална ера ефективното управление на изображението е от решаващо значение за уеб приложения и АПИ. Един от ключовите аспекти на управлението на картината е компресията, която помага в намаляването на размера на файловете без значително да се компрометира качеството. Този ръководство ви насочва през изграждането на динамична 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

Допълнителен пример (Service + Controller)

Заменете имената на мястото с името на пространството на вашия проект.

/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 Това е най-добрият подход; метаданните 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 Controller

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 преди кодиране: Рециклиране намалява пикселите първо (най-големи размери печелят), а след това кодиращ бутове по-нататък.
  • Sanitize inputs: Тип на съдържание, размер на файла, граници за запитване.
  • Streaming: Избягвайте четенето на целия файл в паметта отново и отново; запазвайте потоците с кратък срок на живот и търсене.
  • Caching: Маркирайте отговорите като непроменени, ако извлечете име/контент от детерминистични вноски; в противен случай тонирайте ключовете за кеш към вашия случай на употреба.
  • Сигурност: Валидиране на типа съдържание и отхвърляне на подозрителни плащания.
  • Забележка: Размери за записване преди/после и използвани параметри; това ви помага да изчистите дефектите.
  • Тротиране: Ако е изложена публично, лимит на лимита или изисква аут, за да се предотврати злоупотреба.

Общо разширение (по-късно изтегляне)

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

Troubleshooting

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

Резюме

Сега имате готов за производство динамичен API за компресия на изображението с помощта на Aspose.Imaging. контролерът управлява изтеглянията и параметрите; услугата прилага безопасна, формат-уверена композия и опционално рециклиране, а след това връща правилно запечатан отговор с кеш заглавия. Оттук можете да добавите повече формати, пресети и кешинг стратегии, за да отговаря на вашия уеб стак.

More in this category