ASP.NET Core：创建和打开 PDF（在浏览器中）

Question

在 ASP.NET Core 中工作并使用 iTextSharp，我正在构建 PDF 并将其保存到本地系统。我现在想在浏览器中打开该文件，但似乎无法完成这项工作，因为我在一次尝试中遇到了 FileStream 错误，而在另一次尝试中却什么也没有。

我的逻辑在下面的控制器中。我已经用// region description 替换了不必要的代码。重要的代码（我尝试过的东西）在TODO: Open the file 区域内。

控制器

    [HttpPost]
    public (JsonResult, IActionResult) CreatePDF([FromBody] ReportViewModel model)
    {
        try
        {

            // region Logic code
            using (System.IO.MemoryStream memoryStream = new System.IO.MemoryStream())
            {
                // Create the document
                iTextSharp.text.Document document = new iTextSharp.text.Document();
                // Place the document in the PDFWriter
                iTextSharp.text.pdf.PdfWriter PDFWriter =
                    iTextSharp.text.pdf.PdfWriter.GetInstance(document, memoryStream);

                // region Initialize Fonts

                // Open the document
                document.Open();

                // region Add content to document

                // Close the document
                document.Close();

                #region Create and Write the file
                // Create the directory
                string directory = $"{_settings.Value.ReportDirectory}\\";
                System.IO.Directory.CreateDirectory(System.IO.Path.GetDirectoryName(directory));

                // region Create the fileName

                // Combine the directory and the fileName
                directory = System.IO.Path.Combine(directory, fileName);

                // Create the file
                byte[] content = memoryStream.ToArray();
                using (System.IO.FileStream fs = System.IO.File.Create(directory))
                {
                    fs.Write(content, 0, (int)content.Length);
                }
                #endregion

                #region TODO: Open the file
                // TRY: File(Stream, type) => Newtonsoft.Json.JsonSerializationException:
                // Error getting value from 'ReadTimeout' on 'System.IO.FileStream'.
                // ---> System.InvalidOperationException: Timeouts are supported for this stream.
                System.IO.FileStream fileStream = new System.IO.FileStream(directory, System.IO.FileMode.Open);
                var returnPDF = File(fileStream, contentType: "application/pdf");

                // TRY: File(path, type) => Newtonsoft.Json.JsonSerializationException:
                // Error getting value from 'ReadTimeout' on 'System.IO.FileStream'.
                // ---> System.InvalidOperationException: Timeouts are supported for this stream.
                returnPDF = File(System.IO.File.OpenRead(directory), contentType: "application/pdf" );

                // TRY: File(byte[], type) => Nothing happened
                returnPDF = File(content, contentType: "apllication/pdf");
                #endregion

                return ( Json(new { isError = false }), returnPDF );
            }
        }
        catch (System.Exception ex)
        {
            Serilog.Log.Error($"ReportController.CreatePDF() - {ex}");
            return ( Json(new { isError = true, errorMessage = ex.Message }), null );
        }
    }

参考有用的 Stackoverflow 答案

• Return PDF to the Browser using Asp.net core
• Open PDF in a new tab in browser
• Web api controller method giving exception while serializing the Stream object
• stream.ReadTimeout threw an exception of type System.InvalidOperationException

Answer 1

您可以创建一个 FileContentResult 并将已分配的 byte[] 传递给它，而不是再次从目录加载文件。

return ( Json(new { isError = false }), new FileContentResult(content, "application/pdf"));

请记住，浏览器不会以这种方式下载文件。它将提取响应流但不会下载它，因为它在您的 json 响应中，因此响应内容类型将为 application/json。

您可以改为只返回一个 IActionResult 并这样做：

return new FileContentResult(content, "application/pdf");

如果您坚持拥有“isError”信息，那么您可以另外提供一个 url 而不是 fileresult。为此，您可以在 ConfigureServices(...) 方法中注册 IActionContextAccessor 类。

services.AddSingleton<IActionContextAccessor, ActionContextAccessor>();

提供单独的路由并使用IUrlHelperFactory 生成一个url。

可以在here找到样本。

当响应 isError 等于 false 时，可以在前端以编程方式“点击”此 url。

Answer 2

Action 应该返回单个结果，无论是 PDF 还是 JSON，以便客户端可以适当地处理响应。

我重构了代码，通过将主要逻辑提取到一个单独的函数中，使其更易于阅读。

操作的主要焦点是如何返回响应。

[HttpPost]
public IActionResult CreatePDF([FromBody] ReportViewModel model) {
    try {
        // region Logic code
        byte[] content = CreateFile(model);
        return File(content, contentType: "application/pdf");
    } catch (System.Exception ex) {
        Serilog.Log.Error($"ReportController.CreatePDF() - {ex}");
        return Json(new { isError = true, errorMessage = ex.Message });
    }
}

byte[] CreateFile(ReportViewModel model) {
    using (System.IO.MemoryStream memoryStream = new System.IO.MemoryStream()) {
        // Create the document
        iTextSharp.text.Document document = new iTextSharp.text.Document();
        // Place the document in the PDFWriter
        iTextSharp.text.pdf.PdfWriter PDFWriter =
            iTextSharp.text.pdf.PdfWriter.GetInstance(document, memoryStream);

        // region Initialize Fonts
        // Open the document
        document.Open();
        // region Add content to document
        // Close the document
        document.Close();
        #region Create and Write the file
        // Create the directory
        string directory = $"{_settings.Value.ReportDirectory}\\";            
        System.IO.Directory.CreateDirectory(System.IO.Path.GetDirectoryName(directory));
        // region Create the fileName
        // Combine the directory and the fileName
        directory = System.IO.Path.Combine(directory, fileName);
        // Create the file
        byte[] content = memoryStream.ToArray();
        using (System.IO.FileStream fs = System.IO.File.Create(directory)) {
            fs.Write(content, 0, (int)content.Length);
        }
        #endregion            
        return content;
    }    
}

Answer 3

这略微改编自我的工作代码，但应该适合您的目的。我相信还有一些改进的空间（比如正确处理 MemoryStream），但它简洁、干净，最重要的是，它有效。

不需要额外的序列化，如果不是必需的，也不需要读取/写入文件系统。

控制器

[HttpPost]
public (JsonResult, IActionResult) CreatePDF([FromBody] ReportViewModel model)
{
    try
    {
        return ( Json(new { isError = false }), GetDocument() );
    }

    catch (System.Exception ex)
    {
        Serilog.Log.Error($"ReportController.CreatePDF() - {ex}");
        return (Json(new {isError = true, errorMessage = ex.Message}), null);
    }
}

public FileContentResult GetDocument()
{
    var fc = new MyPdfCreator();
    var document = fc.GetDocumentStream();
    return File(document.ToArray(), "application/pdf", "File Name.pdf");
}

MyPdfCreator

public class MyPdfCreator 
{
    public MemoryStream GetDocumentStream()
    {
        var ms = new MemoryStream();
        var doc = new Document();
        var writer = PdfWriter.GetInstance(doc, ms);
        writer.CloseStream = false;
        doc.Open();
        doc.Add(new Paragraph("Hello World"));
        doc.Close();
        writer.Close();
        return ms;
    }
}