在NestJS项目中处理XML文件上传时，Multer是最常用的中间件选择，它能够高效处理multipart/form-data格式的数据，轻松完成文件接收和临时存储。下面我们一步步实现完整的集成流程。
前置准备
首先需要安装必要的依赖包，除了NestJS核心依赖外，还需要安装Multer以及NestJS提供的Multer集成包，同时如果需要解析XML内容，还需要安装xml2js库。
# 安装Multer相关依赖 npm install @nestjs/platform-express multer # 安装XML解析依赖 npm install xml2js # 安装类型声明（如果使用TypeScript） npm install -D @types/multer @types/xml2js
配置Multer存储规则
Multer默认会将上传的文件存储在内存中，我们也可以自定义存储规则，比如指定文件保存路径、重命名文件等。这里我们先创建一个Multer的配置工厂，用于处理XML文件的上传限制和存储逻辑。
import { MulterOptions } from '@nestjs/platform-express/multer/interfaces/multer-options.interface';
import * as multer from 'multer';
import * as path from 'path';
// 配置Multer选项
export const multerConfig: MulterOptions = {
// 存储配置，这里使用磁盘存储
storage: multer.diskStorage({
// 指定文件存储目录
destination: (req, file, cb) => {
cb(null, path.join(__dirname, '../uploads/xml'));
},
// 自定义文件名，避免重名
filename: (req, file, cb) => {
const uniqueSuffix = Date.now() + '-' + Math.round(Math.random() * 1e9);
// 保留原文件扩展名
const ext = path.extname(file.originalname);
cb(null, `${file.fieldname}-${uniqueSuffix}${ext}`);
},
}),
// 文件过滤，只允许上传XML文件
fileFilter: (req, file, cb) => {
if (file.mimetype === 'text/xml' || file.originalname.endsWith('.xml')) {
cb(null, true);
} else {
cb(new Error('只允许上传XML格式的文件'), false);
}
},
// 限制文件大小，这里设置为10MB
limits: {
fileSize: 10 * 1024 * 1024,
},
};
在NestJS模块中注册配置
接下来需要在对应的模块中导入MulterModule，并传入我们刚才配置的选项，这样控制器中就可以使用Multer提供的相关装饰器了。
import { Module } from '@nestjs/common';
import { MulterModule } from '@nestjs/platform-express';
import { XmlUploadController } from './xml-upload.controller';
import { XmlUploadService } from './xml-upload.service';
import { multerConfig } from './multer.config';
@Module({
imports: [
// 注册MulterModule，传入配置
MulterModule.register(multerConfig),
],
controllers: [XmlUploadController],
providers: [XmlUploadService],
})
export class XmlUploadModule {}
编写上传控制器
在控制器中我们使用@UploadedFile装饰器来接收上传的单个XML文件，如果是多个文件可以使用@UploadedFiles装饰器。这里我们先实现单个XML文件的上传接口。
import { Controller, Post, UploadedFile, UseInterceptors, Body } from '@nestjs/common';
import { FileInterceptor } from '@nestjs/platform-express';
import { XmlUploadService } from './xml-upload.service';
@Controller('xml-upload')
export class XmlUploadController {
constructor(private readonly xmlUploadService: XmlUploadService) {}
@Post('single')
// 使用FileInterceptor拦截器，参数对应前端上传时的字段名，这里设为xmlFile
@UseInterceptors(FileInterceptor('xmlFile'))
async uploadSingleXml(@UploadedFile() file: Express.Multer.File) {
// 调用服务层方法处理上传的XML文件
const result = await this.xmlUploadService.parseXmlFile(file);
return {
code: 200,
message: 'XML文件上传并解析成功',
data: result,
};
}
}
解析XML文件内容
上传成功后，我们需要读取XML文件的内容并解析成JSON格式方便后续处理，这里使用xml2js库来实现解析逻辑，相关逻辑放在服务层。
import { Injectable } from '@nestjs/common';
import * as fs from 'fs';
import * as xml2js from 'xml2js';
import { promisify } from 'util';
@Injectable()
export class XmlUploadService {
// 将xml2js的parseString方法转成Promise形式
private parseXml = promisify(xml2js.parseString);
async parseXmlFile(file: Express.Multer.File) {
// 读取上传的XML文件内容
const fileContent = fs.readFileSync(file.path, 'utf-8');
try {
// 解析XML内容为JSON
const parsedResult = await this.parseXml(fileContent);
// 解析成功后可以删除临时存储的文件，避免占用磁盘空间
fs.unlinkSync(file.path);
return parsedResult;
} catch (error) {
// 解析失败时也删除临时文件
if (fs.existsSync(file.path)) {
fs.unlinkSync(file.path);
}
throw new Error(`XML解析失败: ${error.message}`);
}
}
}
前端上传示例
前端可以使用FormData对象来上传XML文件，下面是简单的原生JavaScript上传示例，字段名需要和后端控制器中FileInterceptor的参数保持一致。
async function uploadXml() {
const fileInput = document.getElementById('xmlFileInput');
const file = fileInput.files[0];
if (!file) {
alert('请选择XML文件');
return;
}
const formData = new FormData();
// 字段名需要和后端FileInterceptor('xmlFile')的参数一致
formData.append('xmlFile', file);
try {
const response = await fetch('http://127.0.0.1:3000/xml-upload/single', {
method: 'POST',
body: formData,
});
const result = await response.json();
console.log('上传结果:', result);
} catch (error) {
console.error('上传失败:', error);
}
}
常见问题处理
- 如果上传时提示文件类型不允许，需要检查fileFilter的配置，确认前端上传的XML文件的mimetype或者扩展名是否符合规则。
- 如果遇到文件大小超限的错误，可以调整Multer配置中limits.fileSize的值，单位是字节。
- 如果解析XML时出现编码问题，可以在读取文件时指定对应的编码格式，或者在xml2js解析时设置explicitCharkey等参数调整解析规则。
- 生产环境中建议对上传的文件路径做更严格的控制，避免目录遍历等安全问题，同时可以对上传的XML内容做合法性校验，防止恶意文件上传。