org.dromara.hutool.http.multipart.MultipartFormData Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.http.multipart;
import org.dromara.hutool.core.collection.CollUtil;
import org.dromara.hutool.core.convert.ConvertUtil;
import org.dromara.hutool.core.map.multi.ListValueMap;
import org.dromara.hutool.core.map.multi.MultiValueMap;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
/**
* HttpRequest解析器
* 来自Jodd
*
* @author jodd.org
*/
public class MultipartFormData {
/** 请求参数 */
private final MultiValueMap requestParameters = new ListValueMap<>();
/** 请求文件 */
private final MultiValueMap requestFiles = new ListValueMap<>();
/** 上传选项 */
private final UploadSetting setting;
/** 是否解析完毕 */
private boolean loaded;
// --------------------------------------------------------------------- Constructor start
/**
* 构造
*/
public MultipartFormData() {
this(null);
}
/**
* 构造
*
* @param uploadSetting 上传设定
*/
public MultipartFormData(final UploadSetting uploadSetting) {
this.setting = uploadSetting == null ? new UploadSetting() : uploadSetting;
}
// --------------------------------------------------------------------- Constructor end
/**
* 提取上传的文件和表单数据
*
* @param inputStream HttpRequest流
* @param charset 编码
* @throws IOException IO异常
*/
public void parseRequestStream(final InputStream inputStream, final Charset charset) throws IOException {
setLoaded();
final MultipartRequestInputStream input = new MultipartRequestInputStream(inputStream);
input.readBoundary();
while (true) {
final UploadFileHeader header = input.readDataHeader(charset);
if (header == null) {
break;
}
if (header.isFile == true) {
// 文件类型的表单项
final String fileName = header.fileName;
if (!fileName.isEmpty() && header.contentType.contains("application/x-macbinary")) {
input.skipBytes(128);
}
final UploadFile newFile = new UploadFile(header, setting);
if(newFile.processStream(input)){
putFile(header.formFieldName, newFile);
}
} else {
// 标准表单项
putParameter(header.formFieldName, input.readString(charset));
}
input.skipBytes(1);
input.mark(1);
// read byte, but may be end of stream
final int nextByte = input.read();
if (nextByte == -1 || nextByte == '-') {
input.reset();
break;
}
input.reset();
}
}
// ---------------------------------------------------------------- parameters
/**
* 返回单一参数值，如果有多个只返回第一个
*
* @param paramName 参数名
* @return null未找到，否则返回值
*/
public String getParam(final String paramName) {
final Collection values = getListParam(paramName);
if (CollUtil.isNotEmpty(values)) {
return CollUtil.get(values, 0);
}
return null;
}
/**
* @return 获得参数名集合
*/
public Set getParamNames() {
return requestParameters.keySet();
}
/**
* 获得数组表单值
*
* @param paramName 参数名
* @return 数组表单值
*/
public String[] getArrayParam(final String paramName) {
final Collection listParam = getListParam(paramName);
if(null != listParam){
return listParam.toArray(new String[0]);
}
return null;
}
/**
* 获得集合表单值
*
* @param paramName 参数名
* @return 数组表单值
* @since 5.3.0
*/
public Collection getListParam(final String paramName) {
return requestParameters.get(paramName);
}
/**
* 获取所有属性的集合
*
* @return 所有属性的集合
*/
public Map getParamMap() {
return ConvertUtil.toMap(String.class, String[].class, getParamListMap());
}
/**
* 获取所有属性的集合
*
* @return 所有属性的集合
*/
public MultiValueMap getParamListMap() {
return this.requestParameters;
}
// --------------------------------------------------------------------------- Files parameters
/**
* 获取上传的文件
*
* @param paramName 文件参数名称
* @return 上传的文件， 如果无为null
*/
public UploadFile getFile(final String paramName) {
final UploadFile[] values = getFiles(paramName);
if ((values != null) && (values.length > 0)) {
return values[0];
}
return null;
}
/**
* 获得某个属性名的所有文件
* 当表单中两个文件使用同一个name的时候
*
* @param paramName 属性名
* @return 上传的文件列表
*/
public UploadFile[] getFiles(final String paramName) {
final Collection fileList = getFileList(paramName);
if(null != fileList){
return fileList.toArray(new UploadFile[0]);
}
return null;
}
/**
* 获得某个属性名的所有文件
* 当表单中两个文件使用同一个name的时候
*
* @param paramName 属性名
* @return 上传的文件列表
* @since 5.3.0
*/
public Collection getFileList(final String paramName) {
return requestFiles.get(paramName);
}
/**
* 获取上传的文件属性名集合
*
* @return 上传的文件属性名集合
*/
public Set getFileParamNames() {
return requestFiles.keySet();
}
/**
* 获取文件映射
*
* @return 文件映射
*/
public Map getFileMap() {
return ConvertUtil.toMap(String.class, UploadFile[].class, getFileListValueMap());
}
/**
* 获取文件映射
*
* @return 文件映射
*/
public MultiValueMap getFileListValueMap() {
return this.requestFiles;
}
// --------------------------------------------------------------------------- Load
/**
* 是否已被解析
*
* @return 如果流已被解析返回true
*/
public boolean isLoaded() {
return loaded;
}
// ---------------------------------------------------------------- Private method start
/**
* 加入上传文件
*
* @param name 参数名
* @param uploadFile 文件
*/
private void putFile(final String name, final UploadFile uploadFile) {
this.requestFiles.putValue(name, uploadFile);
}
/**
* 加入普通参数
*
* @param name 参数名
* @param value 参数值
*/
private void putParameter(final String name, final String value) {
this.requestParameters.putValue(name, value);
}
/**
* 设置使输入流为解析状态，如果已解析，则抛出异常
*
* @throws IOException IO异常
*/
private void setLoaded() throws IOException {
if (loaded == true) {
throw new IOException("Multi-part request already parsed.");
}
loaded = true;
}
// ---------------------------------------------------------------- Private method end
}