Laravel/Lumen 通过Response Facade下载XML文件报错如何解决

问题根因 #

你遇到的两个问题都是响应输出前存在多余内容+响应头格式错误导致的：

• 「XML declaration allowed only at the start of the document」错误，是因为下载的XML文件首行XML声明前存在不可见的空白字符、换行或者其他多余输出，不符合XML规范
• 文件末尾标签缺失、开头多出>符号，是响应头格式错误导致输出被截断，同时多余输出被写入了文件开头

解决方法 #

1. 修正响应头格式 #

Laravel的response()->download()方法要求传入的headers为键值对格式，你当前的写法是错误的，会导致响应头输出异常，修改为如下写法：

$file = base_path('storage/app/xml').'/locations.xml';
$headers = [
    'Content-Type' => 'text/xml'
];

2. 清空输出缓冲再返回响应 #

在返回下载响应前清空所有之前的输出，避免控制器、引用文件中多余的空格、换行被写入文件开头：

// 清空输出缓冲
ob_end_clean();
return response()->download($file, 'LocationReport.xml', $headers);

3. 排查PHP文件多余输出 #

检查所有路由、控制器以及引用的公共文件：

• 确保所有PHP文件的<?php标签前没有任何空格、换行
• 不要在PHP文件末尾添加?>结束标签（Laravel官方规范也明确要求不添加，避免末尾多余字符输出）
• 移除下载逻辑前所有echo、var_dump、print_r等调试输出代码

4. 备选方案：直接输出文件内容 #

如果上述方法仍未解决，可以跳过download方法，直接读取文件内容返回，可控性更高：

$file = base_path('storage/app/xml').'/locations.xml';
$headers = [
    'Content-Type' => 'text/xml',
    'Content-Disposition' => 'attachment; filename="LocationReport.xml"'
];
ob_end_clean();
return response(file_get_contents($file), 200, $headers);

内容的提问来源于stack exchange，提问作者Adeel Shahid