Този ръководство показва как да добавите реално време LaTeX математически rendering към приложението ASP.NET с помощта на Aspose.Tex за .NET. Ще изградите малка уеб API, която приема вноса на LaTEX, я връща в PNG, върна битовете на изображението с правилния тип съдържание и кеше резултатите на диска.
Какво ще изградите
Апликация ASP.NET Core с:
Endpoint
POST /api/latex/png
която приема LaTeX и връща PNG изображениеПросто HTML страница, където потребителите въвеждат уравнение и виждат преглед на живо
Качинг на диска с ключ от съдържание хаш и DPI
Основна валидация на вход и работните директории с пясъчни кутии
Можете да копирате кода и да го изпълните както е.
Предупреждения
Windows, Linux или macOS с .NET 6 или по-късно
Visual Studio 2022 или VS Code* с разширение C#
Пакет NuGet Aspose.TeX
dotnet add package Aspose.TeX
Aspose.TeX изложба TeXOptions
, TeXConfig.ObjectLaTeX
, PngSaveOptions
, ImageDevice
, TeXJob
, InputFileSystemDirectory
, и OutputFileSystemDirectory
Ще използвате тези, за да предадете LaTeX на PNG.
Дизайн Layout
Създайте ASP.NET Core Web API проект, след което добавете лесна услуга плюс минимална HTML страница.
AsposeTexDemo/
Program.cs
Services/
LatexRenderer.cs
wwwroot/
index.html
Услуга: LaTeX до 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();
}
}
Уеб API: минимална ASP.NET Core крайната точка
Това определя 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
да опитате API в браузър без никаква предната рамка.
<!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
Open http://localhost:5000
или http://localhost:5173
в зависимост от вашия профил за стартиране. вмъкнете уравнение и щракнете върху Render. Преглед на актуализациите с PNG изход от сървъра.
Конфигурация и разпространение на бележки
- Aspose.TeX лицензАко имате файл с лиценз, поставете го по време на стартиране, за да премахнете границите на оценката.
// in Program.cs, before first use
// new Aspose.TeX.License().SetLicense("Aspose.Total.lic");
- Местоположение на клавиатурата*Рендерът пише кеш файлове под
tex-cache/
в корена на съдържанието.На Linux или контейнерирани разпространения можете да монтирате този маршрут на траен обем. Чистете го по график, ако е необходимо.
- Местоположение на клавиатурата*Рендерът пише кеш файлове под
- Ограничение на размера на заявката*Примерната капачка изисква размер на 256 KB. Увеличете, ако поддържате по-големи вноски.
- Кръстоизточен достъп*Ако използвате API от различен произход от сайта, можете да активирате CORS съответно.
Списък на проверките за сигурност
- Услугата отхвърля потенциално опасни поръчки като
\input
,\include
, и\write18
Дръжте разрешителния списък твърд и поддържайте преамбюла фиксиран вBuildStandaloneDocument
. - Ограничете дължината на входа, за да блокирате патологичните плащания.
- Влезте в уникален работен каталог по искане и изтрийте каталога след успех.
- Помислете за ограничаване на скоростта на обратното ниво на прокси или API портала за публични сайтове.
Съвети за изпълнение
- Използвайте диск кеш, за да избегнете рекомпутиране на същите уравнения. пробата хашира LaTeX плюс DPI за дедупликация на резултатите.
- Дръжте DPI между 150 и 300 за повечето потребители на UI. По-висок DPI увеличава времето и размера на изображението.
- Загрейте приложението, като направите обща формула при стартиране, ако искате първото потребителско искане да бъде незабавно.
- Ако имате нужда от изход на вектор за zoomable съдържание, преминете към
SvgSaveOptions
иSvgDevice
, след това вградете SVG. останалата част от тръбопровода е същата.
Troubleshooting
- Бланк изход или грешки**Проверете записи на сървъра.Ако LaTeX използва пакети извън фиксирания преамбюл, изтрийте ги.
\usepackage
Потребителски вход по дизайн.
- Бланк изход или грешки**Проверете записи на сървъра.Ако LaTeX използва пакети извън фиксирания преамбюл, изтрийте ги.
- Клипиране или големи маргини*на
standalone
Класа на документи обикновено изпраща маргините стриктно. ако все още виждате допълнително пространство, вградете с\[
и\]
За да покажете материята или да ги премахнете за инлиен размер.
- Клипиране или големи маргини*на
- Изготвен текст *увеличаване
PngSaveOptions.Resolution
При 200 до 300 DPI повечето случаи на UI изглеждат хъркащи.
- Изготвен текст *увеличаване
API бърза референтност, използвана в кода
TeXOptions.ConsoleAppOptions(TeXConfig.ObjectLaTeX)
Създава опции за двигателя Object LaTeXPngSaveOptions
: контролира производството на PNG сResolution
иDeviceWritesImages
ImageDevice
: буфери PNG води до паметта, когатоDeviceWritesImages = false
TeXJob(texPath, device, options).Run()
Събиране на The.tex
Филмиране на устройствотоInputFileSystemDirectory
иOutputFileSystemDirectory
Определяне на работните директории за вход и изход
С тези строителни блокове приложението ASP.NET може да направи LaTeX на търсене, резултатите за кеш и надеждно да обслужва уравненията на PNG.