Api-Platform中为资源添加自定义PDF输出路由的最佳实践

// src/Entity/Invoice.php

namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;

#[ORM\Entity]
#[ApiResource(
    // ... 其他配置
    normalizationContext: ['groups' => ['read:invoice']]
)]
class Invoice
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private ?int $id = null;

    // ... 其他属性 (如 $amount, $customer, $issueDate 等)

    public function getId(): ?int
    {
        return $this->id;
    }

    /**
     * 获取此发票PDF文档的URL。
     *
     * @Groups({"read:invoice"})
     */
    public function getDocumentUrl(): string
    {
        // 确保ID不为空，否则抛出异常或返回一个占位符
        if (null === $this->id) {
            throw new \LogicException('Cannot generate document URL for an unsaved invoice.');
        }
        return "/invoices/{$this->id}/document";
    }

    // ... 其他getter/setter
}

// src/Controller/InvoiceDocumentController.php

namespace App\Controller;

use App\Entity\Invoice;
use App\Service\InvoiceDocumentService;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\HttpFoundation\HeaderUtils;

#[AsController]
class InvoiceDocumentController extends AbstractController
{
    private InvoiceDocumentService $invoiceDocumentService;

    public function __construct(InvoiceDocumentService $invoiceDocumentService)
    {
        $this->invoiceDocumentService = $invoiceDocumentService;
    }

    #[Route('/invoices/{id}/document', name: 'api_invoices_get_document', methods: ['GET'])]
    public function __invoke(Invoice $invoice): Response
    {
        // 调用服务生成PDF内容
        $pdfContent = $this->invoiceDocumentService->createDocumentForInvoice($invoice);

        $response = new Response($pdfContent);

        // 设置正确的Content-Type头
        $response->headers->set('Content-Type', 'application/pdf');

        // 可选：设置Content-Disposition头，让浏览器下载文件而不是直接显示
        $disposition = HeaderUtils::make
        ('attachment', sprintf('invoice-%s.pdf', $invoice->getId()));
        $response->headers->set('Content-Disposition', $disposition);

        return $response;
    }
}

// src/Service/InvoiceDocumentService.php

namespace App\Service;

use App\Entity\Invoice;

class InvoiceDocumentService
{
    public function createDocumentForInvoice(Invoice $invoice): string
    {
        // 实际的PDF生成逻辑
        // 例如，使用一个PDF库，根据发票数据生成PDF内容
        // 这是一个示例，实际实现会更复杂

        $html = "<h1>Invoice #{$invoice->getId()}</h1>"
              . "<p>Amount: {$invoice->getAmount()}</p>"
              . "<p>Customer: {$invoice->getCustomer()->getName()}</p>"
              . "<p>Date: {$invoice->getIssueDate()->format('Y-m-d')}</p>";

        // 假设这里调用了一个PDF库（如Dompdf）来从HTML生成PDF
        // $dompdf = new Dompdf();
        // $dompdf->loadHtml($html);
        // $dompdf->render();
        // return $dompdf->output();

        // 为演示目的，返回一个简单的占位符字符串
        return "This is a placeholder PDF content for Invoice #{$invoice->getId()}.";
    }
}

// src/Controller/InvoiceDocumentController.php (更新)

use Symfony\Component\Security\Http\Attribute\IsGranted;

#[AsController]
class InvoiceDocumentController extends AbstractController
{
    // ... 构造函数和属性

    #[Route('/invoices/{id}/document', name: 'api_invoices_get_document', methods: ['GET'])]
    #[IsGranted('VIEW', subject: 'invoice', message: 'You are not authorized to view this invoice document.')]
    public function __invoke(Invoice $invoice): Response
    {
        // ... PDF生成和响应逻辑
    }
}