यह गाइड दिखाता है कि कैसे जोड़ें Real-time LaTeX Math rendering के बारे में राय ASP.NET ऐप के लिए Aspose.TeX for .NET.आप एक छोटा वेब एपीआई बनाएंगे जो लाटेक्स इनपुट को स्वीकार करता है, इसे रेंज करता है PNG, सही सामग्री प्रकार के साथ छवि बाइट्स को वापस करता है, और डिस्क पर परिणाम कैश करता है. walkthrough में सटीक NuGet पैकेज, न्यूनतम कार्य कोड, सुरक्षा गार्ड्स और प्रदर्शन टिप्स शामिल हैं।.


आप क्या बनाएंगे

  • एक ASP.NET Core ऐप के साथ: - अंत POST /api/latex/png यह LaTeX को स्वीकार करता है और एक PNG छवि वापस करता है - सरल HTML पृष्ठ जहां उपयोगकर्ता एक समानता टाइप करते हैं और एक लाइव पूर्वावलोकन देखते हैं - डिस्क कैशिंग एक सामग्री हैश और DPI द्वारा कुंजी - बुनियादी इनपुट वैलिडिंग और सैंडबॉक्स वर्क डिपार्टमेंट

आप कोड को कॉपी कर सकते हैं और इसे वैसे ही चला सकते हैं जैसे कि यह है।.


पूर्वानुमान

  • Windows, Linux या macOS के साथ .NET 6 या बाद में
  • Visual Studio 2022 के बारे में या कोड के खिलाफ C# विस्तार के साथ
  • नॉर्वे पैकेज Aspose.TeX

Aspose.TeX exposes TeXOptions, TeXConfig.ObjectLaTeX, PngSaveOptions, ImageDevice, TeXJob, InputFileSystemDirectory,और OutputFileSystemDirectory.आप इन का उपयोग LaTeX को PNG में रेंगने के लिए करेंगे।.


परियोजना लैपटॉप

बनाएं एक ASP.NET Core Web API के बारे में परियोजना, फिर एक हल्के सेवा और न्यूनतम HTML पृष्ठ जोड़ें।.

AsposeTexDemo/
  Program.cs
  Services/
    LatexRenderer.cs
  wwwroot/
    index.html

सेवा: LaTeX to PNG renderer

इस सेवा को LaTeX को एक अस्थायी .tex फ़ाइल, Aspose.TeX काम चलाता है, और PNG बेट्स को वापस करता है. यह एक सरल डिस्क कैश भी लागू करता है.

// File: Services/LatexRenderer.cs
using System.Security.Cryptography;
using System.Text;
using Aspose.TeX;

namespace AsposeTexDemo.Services;

public sealed class LatexRenderer
{
    private readonly string _cacheRoot;
    private readonly ILogger<LatexRenderer> _log;

    public LatexRenderer(IWebHostEnvironment env, ILogger<LatexRenderer> log)
    {
        _cacheRoot = Path.Combine(env.ContentRootPath, "tex-cache");
        Directory.CreateDirectory(_cacheRoot);
        _log = log;
    }

    // Public entry point. Renders LaTeX to PNG and returns bytes.
    public async Task<byte[]> RenderPngAsync(string latexBody, int dpi = 200, CancellationToken ct = default)
    {
        // Validate and normalize input
        var normalized = NormalizeLatex(latexBody);
        ValidateLatex(normalized);

        // Cache key depends on content and dpi
        var key = Hash($"{normalized}\n{dpi}");
        var cacheDir = Path.Combine(_cacheRoot, key);
        var cachePng = Path.Combine(cacheDir, "out.png");

        if (File.Exists(cachePng))
        {
            _log.LogDebug("Cache hit: {Key}", key);
            return await File.ReadAllBytesAsync(cachePng, ct);
        }

        Directory.CreateDirectory(cacheDir);

        // Prepare a minimal document that wraps the math
        var texDoc = BuildStandaloneDocument(normalized);

        // Write the .tex source into an isolated working folder
        var workDir = Path.Combine(cacheDir, "work");
        Directory.CreateDirectory(workDir);
        var texPath = Path.Combine(workDir, "doc.tex");
        await File.WriteAllTextAsync(texPath, texDoc, Encoding.UTF8, ct);

        // Configure Aspose.TeX conversion options
        var options = TeXOptions.ConsoleAppOptions(TeXConfig.ObjectLaTeX);
        options.InputWorkingDirectory  = new InputFileSystemDirectory(workDir);
        options.OutputWorkingDirectory = new OutputFileSystemDirectory(workDir);

        var png = new PngSaveOptions
        {
            // If you want higher fidelity on HiDPI displays, raise this number
            Resolution = dpi,

            // When false, the ImageDevice buffers PNG bytes in memory so you can capture them without file I/O
            // You can also leave the default (true) and read the file from disk. Both modes are shown below.
            DeviceWritesImages = false
        };
        options.SaveOptions = png;

        // Run the job; capture PNG bytes from the device
        var device = new ImageDevice();
        new TeXJob(texPath, device, options).Run();

        if (device.Result == null || device.Result.Length == 0)
            throw new InvalidOperationException("No PNG output generated by TeX engine.");

        var pngBytes = device.Result[0];

        // Persist into cache for the next request
        await File.WriteAllBytesAsync(cachePng, pngBytes, ct);

        // Clean up working files except cachePng if you want to keep cache slim
        TryDeleteDirectory(workDir);

        return pngBytes;
    }

    private static void TryDeleteDirectory(string dir)
    {
        try { if (Directory.Exists(dir)) Directory.Delete(dir, true); }
        catch { /* swallow to avoid noisy logs in high traffic */ }
    }

    // Minimal, safe preamble for math using Object LaTeX
    private static string BuildStandaloneDocument(string latexBody)
    {
        // With standalone class, the output image is tightly cropped around content
        return
$@"\documentclass{{standalone}}
\usepackage{{amsmath}}
\usepackage{{amssymb}}
\begin{{document}}
{latexBody}
\end{{document}}";
    }

    // Allow plain math snippets like x^2 + y^2 = z^2 and also wrapped forms like \[ ... \]
    private static string NormalizeLatex(string input)
    {
        input = input.Trim();

        // If user did not wrap math, wrap in display math to get proper spacing
        if (!(input.StartsWith(@"\[") && input.EndsWith(@"\]"))
            && !(input.StartsWith(@"$$") && input.EndsWith(@"$$")))
        {
            return $"\\[{input}\\]";
        }
        return input;
    }

    // Very conservative validation to avoid file inclusion or shell escapes
    private static void ValidateLatex(string input)
    {
        // Disallow commands that can touch the filesystem or process environment
        string[] blocked = {
            @"\write18", @"\input", @"\include", @"\openout", @"\write", @"\read",
            @"\usepackage", // preamble is fixed in BuildStandaloneDocument; avoid arbitrary packages
            @"\loop", @"\csname", @"\newread", @"\newwrite"
        };

        foreach (var b in blocked)
        {
            if (input.Contains(b, StringComparison.OrdinalIgnoreCase))
                throw new ArgumentException($"The LaTeX contains a forbidden command: {b}");
        }

        if (input.Length > 4000)
            throw new ArgumentException("Equation too long. Please keep input under 4000 characters.");
    }

    private static string Hash(string s)
    {
        using var sha = SHA256.Create();
        var bytes = sha.ComputeHash(Encoding.UTF8.GetBytes(s));
        return Convert.ToHexString(bytes).ToLowerInvariant();
    }
}

Web API: कम से कम ASP.NET कोर एंडपॉइंट

यह एक JSON अनुबंध को परिभाषित करता है, रिंडर को पंजीकृत करता है, और एक POST अंत अंक PNG को वापस करता है।.

// File: Program.cs
using System.Text.Json.Serialization;
using AsposeTexDemo.Services;

var builder = WebApplication.CreateBuilder(args);

// Optional: serve a simple static page for testing
builder.Services.AddDirectoryBrowser();

// Add the renderer
builder.Services.AddSingleton<LatexRenderer>();

// Configure Kestrel limits for small payloads
builder.WebHost.ConfigureKestrel(opt =>
{
    opt.Limits.MaxRequestBodySize = 256 * 1024; // 256 KB per request is plenty for math
});

var app = builder.Build();

// Serve wwwroot for quick manual testing
app.UseDefaultFiles();
app.UseStaticFiles();

// DTOs
public record LatexRequest(
    [property: JsonPropertyName("latex")] string Latex,
    [property: JsonPropertyName("dpi")]   int? Dpi
);

app.MapPost("/api/latex/png", async (LatexRequest req, LatexRenderer renderer, HttpContext ctx, CancellationToken ct) =>
{
    if (string.IsNullOrWhiteSpace(req.Latex))
        return Results.BadRequest(new { error = "Missing 'latex'." });

    int dpi = req.Dpi is > 0 and <= 600 ? req.Dpi.Value : 200;

    try
    {
        var bytes = await renderer.RenderPngAsync(req.Latex, dpi, ct);
        ctx.Response.Headers.CacheControl = "public, max-age=31536000, immutable";
        return Results.File(bytes, "image/png");
    }
    catch (ArgumentException ex)
    {
        return Results.BadRequest(new { error = ex.Message });
    }
    catch (Exception ex)
    {
        // Hide engine details from clients; log the exception server-side if needed
        return Results.StatusCode(500);
    }
});

// Health check
app.MapGet("/health", () => Results.Ok(new { ok = true }));

app.Run();

सरल परीक्षण पृष्ठ

इसे नीचे डालें wwwroot/index.html किसी भी फ्रंट-एंड फ्रेमवर्क के बिना एक ब्राउज़र में एपीआई का प्रयास करें।.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8" />
  <title>Aspose.TeX LaTeX Demo</title>
  <meta name="viewport" content="width=device-width,initial-scale=1" />
  <style>
    body{font-family:system-ui,Segoe UI,Roboto,Arial,sans-serif;margin:2rem;line-height:1.4}
    textarea{width:100%;height:8rem}
    .row{display:flex;gap:1rem;align-items:flex-start;margin-top:1rem;flex-wrap:wrap}
    .card{border:1px solid #ddd;border-radius:8px;padding:1rem;flex:1 1 320px}
    img{max-width:100%;height:auto;border:1px solid #eee;border-radius:4px;background:#fff}
    label{font-weight:600}
    input[type=number]{width:6rem}
    .muted{color:#666;font-size:.9rem}
    .error{color:#b00020}
  </style>
</head>
<body>
  <h1>Real-time LaTeX to PNG with Aspose.TeX</h1>
  <p class="muted">Type LaTeX math and click Render. The server returns a PNG image rendered by Aspose.TeX.</p>

  <div class="card">
    <label for="latex">LaTeX</label><br />
    <textarea id="latex">x^2 + y^2 = z^2</textarea><br />
    <label for="dpi">DPI</label>
    <input id="dpi" type="number" min="72" max="600" value="200" />
    <button id="btn">Render</button>
    <div id="msg" class="error"></div>
  </div>

  <div class="row">
    <div class="card">
      <h3>Preview</h3>
      <img id="preview" alt="Rendered equation will appear here" />
    </div>
    <div class="card">
      <h3>cURL</h3>
      <pre id="curl" class="muted"></pre>
    </div>
  </div>

  <script>
    const btn = document.getElementById('btn');
    const latex = document.getElementById('latex');
    const dpi = document.getElementById('dpi');
    const img = document.getElementById('preview');
    const msg = document.getElementById('msg');
    const curl = document.getElementById('curl');

    function updateCurl() {
      const payload = JSON.stringify({ latex: latex.value, dpi: Number(dpi.value) }, null, 0);
      curl.textContent =
`curl -s -X POST http://localhost:5000/api/latex/png \
  -H "Content-Type: application/json" \
  -d '${payload}' --output out.png`;
    }

    updateCurl();

    [latex, dpi].forEach(el => el.addEventListener('input', updateCurl));

    btn.addEventListener('click', async () => {
      msg.textContent = '';
      img.src = '';
      try {
        const payload = { latex: latex.value, dpi: Number(dpi.value) };
        const res = await fetch('/api/latex/png', {
          method: 'POST',
          headers: { 'Content-Type': 'application/json' },
          body: JSON.stringify(payload)
        });
        if (!res.ok) {
          const err = await res.json().catch(() => ({}));
          msg.textContent = err.error || `Error ${res.status}`;
          return;
        }
        const blob = await res.blob();
        img.src = URL.createObjectURL(blob);
      } catch (e) {
        msg.textContent = 'Request failed.';
      }
    });
  </script>
</body>
</html>

परियोजना को चलाएं

dotnet run

खुले http://localhost:5000 या http://localhost:5173 आपकी लॉन्च प्रोफ़ाइल के आधार पर. एक समानता टाइप करें और Render पर क्लिक करें. सर्वर-साइड PNG आउटपुट के साथ पूर्वावलोकन अपडेट।.


कॉन्फ़िगरेशन और डिप्लोमाइज़ेशन नोट

  1. Aspose.TeX license यदि आपके पास लाइसेंस फ़ाइल है, तो मूल्यांकन सीमाओं को हटाने के लिए स्टार्टअप के दौरान इसे सेट करें।.
  2. छिपाएं स्थान रेंजर नीचे कैश फ़ाइल लिखता है tex-cache/ सामग्री जड़ में. लिनक्स या कंटेनर किए गए वितरण पर आप इस पथ को एक स्थायी मात्रा पर रख सकते हैं. यदि आवश्यक हो तो इसे एक कार्यक्रम पर साफ करें.
  3. आकार सीमा का अनुरोध करें उदाहरण अनुरोध आकार को 256 KB पर कवर करता है. यदि आप बड़े इनपुट का समर्थन करते हैं तो इसे बढ़ाएं.
  4. क्रॉस-उत्तर पहुंच यदि आप साइट से अलग स्रोत से एपीआई का उपयोग करते हैं, तो CORS को अनुकूलित करें।.

सुरक्षा चेकलिस्ट

  • सेवा संभावित रूप से खतरनाक आदेशों को अस्वीकार करती है जैसे \input, \include,और \write18.अनुमति सूची को मजबूत रखें और प्रीमियम को स्थिर रखें BuildStandaloneDocument.
  • रोगी उपयोग लोड को अवरुद्ध करने के लिए इनपुट लंबाई को सीमित करें।.
  • अनुरोध के अनुसार एक अद्वितीय कार्य निर्देशिका में रेंज करें और सफलता के बाद निर्देशिका को हटा दें. नमूना केवल कैश किए गए PNG को रखता है.
  • सार्वजनिक साइटों के लिए विपरीत प्रॉक्सी या एपीआई गेटवे स्तर पर दर सीमा पर विचार करें।.

प्रदर्शन टिप्स

  • उपयोग करें डिस्क कैश एक ही संतुलनों को पुनः गणना करने से बचने के लिए नमूना परिणामों को डिडुप्लिकेट करने के लिए LaTeX प्लस DPI हैश करता है।.
  • रखें DPI अधिकांश यूआई आवश्यकताओं के लिए 150 से 300 के बीच। उच्च डीपीआई render time और image size को बढ़ाता है।.
  • स्टार्टअप पर एक सामान्य सूत्र रेंज करके ऐप को गर्म करें यदि आप चाहते हैं कि पहला उपयोगकर्ता अनुरोध तुरंत हो।.
  • यदि आप ज़ूम करने योग्य सामग्री के लिए वेक्टर आउटपुट की आवश्यकता है, तो SvgSaveOptions और SvgDevice,फिर, स्विच को एम्बेड करें. पाइपलाइन के बाकी हिस्से एक ही हैं।.

परेशानियों

  • खाली आउटपुट या त्रुटियां सर्वर लॉग की जाँच करें. यदि LaTeX स्थायी पूर्वावलोकन के बाहर पैकेज का उपयोग करता है, तो उन्हें हटा दें. \usepackage उपयोगकर्ता के लिए डिजाइन में प्रवेश.
  • कटौती या बड़े मार्जिन के standalone दस्तावेज़ वर्ग आमतौर पर सीमाओं को कटौती करता है. यदि आप अभी भी अतिरिक्त स्थान देखते हैं, तो \[ और \] इनमें से एक को डिजाइन करने के लिए या इनमें से एक को डिजाइन करने के लिए हटा दें।.
  • पाठक का शिकार बढ़ी PngSaveOptions.Resolution.200 से 300 डीपीआई पर, अधिकांश यूआई मामले क्रिस्टल दिखते हैं।.

API Quick Reference कोड में इस्तेमाल किया जाता है

  • TeXOptions.ConsoleAppOptions(TeXConfig.ObjectLaTeX): Object LaTeX इंजन के लिए विकल्प बनाता है
  • PngSaveOptions: नियंत्रण PNG आउटपुट के साथ Resolution और DeviceWritesImages
  • ImageDevice: PNG के लिए बैफर स्मृति में परिणाम जब DeviceWritesImages = false
  • TeXJob(texPath, device, options).Run(): संकलित करें .tex डिवाइस में फ़ाइल
  • InputFileSystemDirectory और OutputFileSystemDirectory: इनपुट और आउटपुट के लिए कार्य निर्देशिकाओं को परिभाषित करें

इन बिल्ड ब्लॉकों के साथ, आपका ASP.NET ऐप अनुरोध पर LaTeX का प्रदर्शन कर सकता है, परिणामों को कैश कर सकता है, और विश्वसनीय रूप से क्रिस्टल PNG संचरणों को सेवा कर सकता है।.

More in this category