com.feilong.net.http.HttpRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2008 feilong
*
* 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 com.feilong.net.http;
import static com.feilong.core.CharsetType.UTF8;
import static com.feilong.net.http.HttpMethodType.GET;
import java.util.Map;
import com.feilong.core.net.ParamUtil;
import com.feilong.net.UriProcessor;
/**
* http 请求信息.
*
* @author feilong
* @see "org.apache.http.HttpRequest"
* @since 1.2.0
*/
public class HttpRequest{
/**
* 伪造的 useragent.
*
* @since 1.5.0
*/
public static final String DEFAULT_USER_AGENT = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.21 (KHTML, like Gecko) Chrome/19.0.1042.0 Safari/535.21";
//---------------------------------------------------------------
/** 请求的uri地址. */
private String uri;
/** 请求method 类型,默认 {@link HttpMethodType#GET}. */
private HttpMethodType httpMethodType = GET;
//---------------------------------------------------------------
/** http 请求 key-value 参数map. */
private Map paramMap;
/** 请求头信息. */
private Map headerMap;
//---------------------------------------------------------------
/**
* 请求正文,比如 webservice 可以传递 xml/json数据体.
*
* @see HTTP_message_body
* @since 1.10.0
*/
private String requestBody;
/**
* 二进制数据:请求体可以包含二进制数据，如文件、图像、音频等。
*
* 这些数据通常以字节流的形式传递。.
*
* @since 4.0.1
*/
private RequestByteArrayBody requestByteArrayBody;
//---------------------------------------------------------------
/**
* 是否uri trim.
*
* 有时候程序员在配置uri 的时候,会误操作 uri 前后会多出空格, 这样会导致一些功能不work,要排查好久,
* 理论上uri前后是没有空格的, 所以默认为true ,会自动去除前后的空格;
* 如果真的有特殊需求, 可以设置为false
*
*
* @since 3.0.10
*/
private boolean isTrimUri = true;
//---------------------------------------------------------------
/**
* The Constructor.
*
* @since 1.5.4
*/
public HttpRequest(){
super();
}
/**
* Instantiates a new http request.
*
* @param uri
* the uri
* @since 1.10.4
*/
public HttpRequest(String uri){
super();
this.uri = uri;
}
/**
* Instantiates a new http request.
*
* @param uri
* the uri
* @param httpMethodType
* the http method type
* @since 1.11.0
*/
public HttpRequest(String uri, HttpMethodType httpMethodType){
super();
this.uri = uri;
this.httpMethodType = httpMethodType;
}
/**
* The Constructor.
*
* @param uri
* the uri
* @param paramMap
* http 请求 key-value 参数map
* @param httpMethodType
* the http method type
* @since 1.5.4
*/
public HttpRequest(String uri, Map paramMap, HttpMethodType httpMethodType){
super();
this.uri = uri;
this.paramMap = paramMap;
this.httpMethodType = httpMethodType;
}
/**
* The Constructor.
*
* @param uri
* the uri
* @param paramMap
* http 请求 key-value 参数map
* @param httpMethodType
* 不区分大小写, 比如get,Get,GET都可以,但是需要对应 {@link HttpMethodType}的支持的枚举值
* @since 1.5.4
*/
public HttpRequest(String uri, Map paramMap, String httpMethodType){
super();
this.uri = uri;
this.paramMap = paramMap;
this.httpMethodType = HttpMethodType.getByMethodValueIgnoreCase(httpMethodType);
}
//---------------------------------------------------------------
/**
* 完整的请求路径.
*
* @return the full encoded url
*/
public String getFullEncodedUrl(){
return ParamUtil.addParameterSingleValueMap(getUri(), paramMap, UTF8);
}
//---------------------------------------------------------------
/**
* 获得 请求的uri地址.
*
*
* 如果uri是null,将返回empty
* 如果uri中有空格,将会替换成%20
*
*
* @return the 请求的uri地址
* @see 增加自动转义-请求参数放在路径中的配置
* @see HttpClient uri 中如果有空格会报错
*/
public String getUri(){
return UriProcessor.process(uri, isTrimUri);
}
/**
* 设置 请求的uri地址.
*
* @param uri
* the new 请求的uri地址
*/
public void setUri(String uri){
this.uri = uri;
}
//---------------------------------------------------------------
/**
* 获得 请求method 类型,默认 {@link HttpMethodType#GET}.
*
* @return the httpMethodType
*/
public HttpMethodType getHttpMethodType(){
return httpMethodType;
}
/**
* 设置 请求method 类型,默认 {@link HttpMethodType#GET}.
*
* @param httpMethodType
* the httpMethodType to set
*/
public void setHttpMethodType(HttpMethodType httpMethodType){
this.httpMethodType = httpMethodType;
}
//---------------------------------------------------------------
/**
* 获得 http 请求 key-value 参数map.
*
* @return http 请求 key-value 参数map
*/
public Map getParamMap(){
return paramMap;
}
/**
* 设置 http 请求 key-value 参数map.
*
* @param paramMap
* http 请求 key-value 参数map
*/
public void setParamMap(Map paramMap){
this.paramMap = paramMap;
}
//---------------------------------------------------------------
/**
* 获得 请求头 信息.
*
* @return the headerMap
*/
public Map getHeaderMap(){
return headerMap;
}
/**
* 设置 请求头 信息.
*
* @param headerMap
* the headerMap to set
*/
public void setHeaderMap(Map headerMap){
this.headerMap = headerMap;
}
//---------------------------------------------------------------
/**
* 获得 请求正文,比如 webservice 可以传递 xml/json数据体.
*
* @return the requestBody
* @see HTTP_message_body
* @since 1.10.0
*/
public String getRequestBody(){
return requestBody;
}
/**
* 设置 请求正文,比如 webservice 可以传递 xml/json数据体.
*
* @param requestBody
* the requestBody to set
* @see HTTP_message_body
* @since 1.10.0
*/
public void setRequestBody(String requestBody){
this.requestBody = requestBody;
}
//---------------------------------------------------------------
/**
* 是否uri trim.
*
*
* 有时候程序员在配置uri 的时候,会误操作 uri 前后会多出空格, 这样会导致一些功能不work,要排查好久,
* 理论上uri前后是没有空格的, 所以默认为true ,会自动去除前后的空格;
* 如果真的有特殊需求, 可以设置为false
*
*
* @param isTrimUri
* the isTrimUri to set
* @since 3.0.10
*/
public void setIsTrimUri(boolean isTrimUri){
this.isTrimUri = isTrimUri;
}
/**
* 是否uri trim.
*
*
* 有时候程序员在配置uri 的时候,会误操作 uri 前后会多出空格, 这样会导致一些功能不work,要排查好久,
* 理论上uri前后是没有空格的, 所以默认为true ,会自动去除前后的空格;
* 如果真的有特殊需求, 可以设置为false
*
*
* @return the isTrimUri
* @since 3.0.10
*/
public boolean getIsTrimUri(){
return isTrimUri;
}
/**
* 获得 二进制数据:请求体可以包含二进制数据，如文件、图像、音频等。 这些数据通常以字节流的形式传递。.
*
* @return the requestByteArrayBody
* @since 4.0.1
*/
public RequestByteArrayBody getRequestByteArrayBody(){
return requestByteArrayBody;
}
/**
* 设置 二进制数据:请求体可以包含二进制数据，如文件、图像、音频等。 这些数据通常以字节流的形式传递。.
*
* @param requestByteArrayBody
* the requestByteArrayBody to set
* @since 4.0.1
*/
public void setRequestByteArrayBody(RequestByteArrayBody requestByteArrayBody){
this.requestByteArrayBody = requestByteArrayBody;
}
}