org.noear.solon.net.http.impl

类 AbstractHttpUtils

java.lang.Object

org.noear.solon.net.http.impl.AbstractHttpUtils

所有已实现的接口:

HttpUtils

直接已知子类:

JdkHttpUtils, OkHttpUtils

public abstract class AbstractHttpUtils
extends java.lang.Object
implements HttpUtils

Http 工具基类

从以下版本开始:

3.0

字段概要

字段

限定符和类型	字段和说明
protected HttpStream	_bodyRaw
protected java.nio.charset.Charset	_charset
protected MultiMap<java.lang.String>	_cookies
protected boolean	_enablePrintln
protected MultiMap<HttpUploadFile>	_files
protected MultiMap<java.lang.String>	_headers
protected boolean	_multipart
protected MultiMap<java.lang.String>	_params
protected java.net.Proxy	_proxy
protected Serializer	_serializer
protected HttpTimeout	_timeout
protected java.lang.String	_url

构造器概要

构造器

构造器和说明
AbstractHttpUtils(java.lang.String url)

方法概要

限定符和类型	方法和说明
HttpUtils	body(byte[] bytes, java.lang.String contentType) 主体配置
HttpUtils	body(java.io.InputStream raw, java.lang.String contentType) 主体配置
HttpUtils	body(java.lang.String txt, java.lang.String contentType) 设置 BODY txt 及内容类型
HttpUtils	bodyOfBean(java.lang.Object obj) 主体配置（由序列化器决定内容类型）
HttpUtils	charset(java.lang.String charset) 编码配置
HttpUtils	cookie(java.lang.String name, java.lang.String value) 小饼配置（替换）
HttpUtils	cookieAdd(java.lang.String name, java.lang.String value) 小饼配置（添加）
HttpUtils	cookies(java.lang.Iterable<KeyValues<java.lang.String>> cookies) 小饼配置
HttpUtils	cookies(java.util.Map cookies) 设置请求 cookies
HttpUtils	data(java.lang.Iterable<KeyValues<java.lang.String>> data) 参数配置
HttpUtils	data(java.util.Map data) 设置表单数据
HttpUtils	data(java.lang.String name, java.lang.String value) 设置表单数据
HttpUtils	data(java.lang.String name, java.lang.String filename, java.io.File file) 参数配置
HttpUtils	data(java.lang.String name, java.lang.String filename, java.io.InputStream inputStream, java.lang.String contentType) 参数配置
java.lang.String	delete() delete 请求并返回 body
<T> T	deleteAs(java.lang.reflect.Type type) delete 请求并返回 body
HttpUtils	enablePrintln(boolean enable) 启用打印（专为 tester 服务）
HttpResponse	exec(java.lang.String method) 执行请求，返回响应对象（需要自己做关闭处理）
java.lang.String	execAsBody(java.lang.String method) 执行请求并返回响应主体
<T> T	execAsBody(java.lang.String method, java.lang.reflect.Type type) 执行请求并返回响应主体
int	execAsCode(java.lang.String method) 执行请求并返回代码
org.reactivestreams.Publisher<java.lang.String>	execAsLineStream(java.lang.String method) 执行请求并返回文本行流
org.reactivestreams.Publisher<ServerSentEvent>	execAsSseStream(java.lang.String method) 执行请求并返回服务端推送事件流
java.util.concurrent.CompletableFuture<HttpResponse>	execAsync(java.lang.String method) 异步执行请求
protected abstract HttpResponse	execDo(java.lang.String method, java.util.concurrent.CompletableFuture<HttpResponse> future)
java.lang.String	get() get 请求并返回 body
<T> T	getAs(java.lang.reflect.Type type) get 请求并返回 body
protected java.lang.String	getRequestCookieString(MultiMap<java.lang.String> cookies)
int	head() head 请求并返回 code
HttpUtils	header(java.lang.String name, java.lang.String value) 设置请求头
HttpUtils	headerAdd(java.lang.String name, java.lang.String value) 添加请求头
HttpUtils	headers(java.lang.Iterable<KeyValues<java.lang.String>> headers) 头配置
HttpUtils	headers(java.util.Map headers) 设置请求头
protected static boolean	isRedirected(int responseCode)
HttpUtils	multipart(boolean multipart) 是否多部分配置
java.lang.String	options() options 请求并返回 body
java.lang.String	patch() patch 请求并返回 body
<T> T	patchAs(java.lang.reflect.Type type) patch 请求并返回 body
java.lang.String	post() post 请求并返回 body
<T> T	postAs(java.lang.reflect.Type type) post 请求并返回 body
HttpUtils	proxy(java.net.Proxy proxy) 代理配置
java.lang.String	put() put 请求并返回 body
<T> T	putAs(java.lang.reflect.Type type) put 请求并返回 body
Serializer	serializer() 获取序列化器
HttpUtils	serializer(Serializer serializer) 配置序列化器
HttpUtils	timeout(HttpTimeout timeout) 超时配置
protected MultiMap<java.lang.String>	tryInitCookies()
protected MultiMap<HttpUploadFile>	tryInitFiles()
protected MultiMap<java.lang.String>	tryInitHeaders()
protected MultiMap<java.lang.String>	tryInitParams()
HttpUtils	userAgent(java.lang.String ua) 用户代理配置

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.noear.solon.net.http.HttpUtils

accept, body, body, bodyJson, bodyOfJson, bodyOfTxt, bodyRaw, bodyRaw, bodyRaw, bodyRaw, bodyTxt, bodyTxt, contentType, data, execAsEventStream, execAsTextStream, http, http, http, post, postAs, proxy, timeout, timeout, toQueryString, toQueryString, urlEncode, urlEncode

字段详细资料

_enablePrintln

protected boolean _enablePrintln

_proxy

protected java.net.Proxy _proxy

_url

protected java.lang.String _url

_charset

protected java.nio.charset.Charset _charset

_headers

protected MultiMap<java.lang.String> _headers

_cookies

protected MultiMap<java.lang.String> _cookies

_params

protected MultiMap<java.lang.String> _params

_files

protected MultiMap<HttpUploadFile> _files

_bodyRaw

protected HttpStream _bodyRaw

_multipart

protected boolean _multipart

_timeout

protected HttpTimeout _timeout

_serializer

protected Serializer _serializer

构造器详细资料

AbstractHttpUtils

public AbstractHttpUtils(java.lang.String url)

方法详细资料

serializer

public HttpUtils serializer(Serializer serializer)

从接口复制的说明: HttpUtils

配置序列化器

指定者:

serializer 在接口中 HttpUtils

serializer

public Serializer serializer()

从接口复制的说明: HttpUtils

获取序列化器

指定者:

serializer 在接口中 HttpUtils

enablePrintln

public HttpUtils enablePrintln(boolean enable)

从接口复制的说明: HttpUtils

启用打印（专为 tester 服务）

指定者:

enablePrintln 在接口中 HttpUtils

proxy

public HttpUtils proxy(java.net.Proxy proxy)

从接口复制的说明: HttpUtils

代理配置

指定者:

proxy 在接口中 HttpUtils

timeout

public HttpUtils timeout(HttpTimeout timeout)

从接口复制的说明: HttpUtils

超时配置

指定者:

timeout 在接口中 HttpUtils

multipart

public HttpUtils multipart(boolean multipart)

从接口复制的说明: HttpUtils

是否多部分配置

指定者:

multipart 在接口中 HttpUtils

userAgent

public HttpUtils userAgent(java.lang.String ua)

从接口复制的说明: HttpUtils

用户代理配置

指定者:

userAgent 在接口中 HttpUtils

charset

public HttpUtils charset(java.lang.String charset)

从接口复制的说明: HttpUtils

编码配置

指定者:

charset 在接口中 HttpUtils

headers

public HttpUtils headers(java.util.Map headers)

设置请求头

指定者:

headers 在接口中 HttpUtils

headers

public HttpUtils headers(java.lang.Iterable<KeyValues<java.lang.String>> headers)

从接口复制的说明: HttpUtils

头配置

指定者:

headers 在接口中 HttpUtils

header

public HttpUtils header(java.lang.String name,
                        java.lang.String value)

设置请求头

指定者:

header 在接口中 HttpUtils

headerAdd

public HttpUtils headerAdd(java.lang.String name,
                           java.lang.String value)

添加请求头

指定者:

headerAdd 在接口中 HttpUtils

cookies

public HttpUtils cookies(java.util.Map cookies)

设置请求 cookies

指定者:

cookies 在接口中 HttpUtils

cookies

public HttpUtils cookies(java.lang.Iterable<KeyValues<java.lang.String>> cookies)

从接口复制的说明: HttpUtils

小饼配置

指定者:

cookies 在接口中 HttpUtils

cookie

public HttpUtils cookie(java.lang.String name,
                        java.lang.String value)

从接口复制的说明: HttpUtils

小饼配置（替换）

指定者:

cookie 在接口中 HttpUtils

cookieAdd

public HttpUtils cookieAdd(java.lang.String name,
                           java.lang.String value)

从接口复制的说明: HttpUtils

小饼配置（添加）

指定者:

cookieAdd 在接口中 HttpUtils

data

public HttpUtils data(java.util.Map data)

设置表单数据

指定者:

data 在接口中 HttpUtils

data

public HttpUtils data(java.lang.Iterable<KeyValues<java.lang.String>> data)

从接口复制的说明: HttpUtils

参数配置

指定者:

data 在接口中 HttpUtils

data

public HttpUtils data(java.lang.String name,
                      java.lang.String value)

设置表单数据

指定者:

data 在接口中 HttpUtils

data

public HttpUtils data(java.lang.String name,
                      java.lang.String filename,
                      java.io.InputStream inputStream,
                      java.lang.String contentType)

从接口复制的说明: HttpUtils

参数配置

指定者:

data 在接口中 HttpUtils

data

public HttpUtils data(java.lang.String name,
                      java.lang.String filename,
                      java.io.File file)

从接口复制的说明: HttpUtils

参数配置

指定者:

data 在接口中 HttpUtils

body

public HttpUtils body(java.lang.String txt,
                      java.lang.String contentType)

设置 BODY txt 及内容类型

指定者:

body 在接口中 HttpUtils

bodyOfBean

public HttpUtils bodyOfBean(java.lang.Object obj)
                     throws HttpException

从接口复制的说明: HttpUtils

主体配置（由序列化器决定内容类型）

指定者:

bodyOfBean 在接口中 HttpUtils

抛出:

HttpException

body

public HttpUtils body(byte[] bytes,
                      java.lang.String contentType)

从接口复制的说明: HttpUtils

主体配置

指定者:

body 在接口中 HttpUtils

body

public HttpUtils body(java.io.InputStream raw,
                      java.lang.String contentType)

从接口复制的说明: HttpUtils

主体配置

指定者:

body 在接口中 HttpUtils

get

public java.lang.String get()
                     throws HttpException

从接口复制的说明: HttpUtils

get 请求并返回 body

指定者:

get 在接口中 HttpUtils

抛出:

HttpException

getAs

public <T> T getAs(java.lang.reflect.Type type)
            throws HttpException

从接口复制的说明: HttpUtils

get 请求并返回 body

指定者:

getAs 在接口中 HttpUtils

抛出:

HttpException

post

public java.lang.String post()
                      throws HttpException

从接口复制的说明: HttpUtils

post 请求并返回 body

指定者:

post 在接口中 HttpUtils

抛出:

HttpException

postAs

public <T> T postAs(java.lang.reflect.Type type)
             throws HttpException

从接口复制的说明: HttpUtils

post 请求并返回 body

指定者:

postAs 在接口中 HttpUtils

抛出:

HttpException

put

public java.lang.String put()
                     throws HttpException

从接口复制的说明: HttpUtils

put 请求并返回 body

指定者:

put 在接口中 HttpUtils

抛出:

HttpException

putAs

public <T> T putAs(java.lang.reflect.Type type)
            throws HttpException

从接口复制的说明: HttpUtils

put 请求并返回 body

指定者:

putAs 在接口中 HttpUtils

抛出:

HttpException

patch

public java.lang.String patch()
                       throws HttpException

从接口复制的说明: HttpUtils

patch 请求并返回 body

指定者:

patch 在接口中 HttpUtils

抛出:

HttpException

patchAs

public <T> T patchAs(java.lang.reflect.Type type)
              throws HttpException

从接口复制的说明: HttpUtils

patch 请求并返回 body

指定者:

patchAs 在接口中 HttpUtils

抛出:

HttpException

delete

public java.lang.String delete()
                        throws HttpException

从接口复制的说明: HttpUtils

delete 请求并返回 body

指定者:

delete 在接口中 HttpUtils

抛出:

HttpException

deleteAs

public <T> T deleteAs(java.lang.reflect.Type type)
               throws HttpException

从接口复制的说明: HttpUtils

delete 请求并返回 body

指定者:

deleteAs 在接口中 HttpUtils

抛出:

HttpException

options

public java.lang.String options()
                         throws HttpException

从接口复制的说明: HttpUtils

options 请求并返回 body

指定者:

options 在接口中 HttpUtils

抛出:

HttpException

head

public int head()
         throws HttpException

从接口复制的说明: HttpUtils

head 请求并返回 code

指定者:

head 在接口中 HttpUtils

抛出:

HttpException

execAsBody

public java.lang.String execAsBody(java.lang.String method)
                            throws HttpException

从接口复制的说明: HttpUtils

执行请求并返回响应主体

指定者:

execAsBody 在接口中 HttpUtils

抛出:

HttpException

execAsBody

public <T> T execAsBody(java.lang.String method,
                        java.lang.reflect.Type type)
                 throws HttpException

从接口复制的说明: HttpUtils

执行请求并返回响应主体

指定者:

execAsBody 在接口中 HttpUtils

抛出:

HttpException

execAsCode

public int execAsCode(java.lang.String method)
               throws HttpException

从接口复制的说明: HttpUtils

执行请求并返回代码

指定者:

execAsCode 在接口中 HttpUtils

抛出:

HttpException

execAsLineStream

public org.reactivestreams.Publisher<java.lang.String> execAsLineStream(java.lang.String method)

从接口复制的说明: HttpUtils

执行请求并返回文本行流

指定者:

execAsLineStream 在接口中 HttpUtils

execAsSseStream

public org.reactivestreams.Publisher<ServerSentEvent> execAsSseStream(java.lang.String method)

从接口复制的说明: HttpUtils

执行请求并返回服务端推送事件流

指定者:

execAsSseStream 在接口中 HttpUtils

exec

public HttpResponse exec(java.lang.String method)
                  throws HttpException

执行请求，返回响应对象（需要自己做关闭处理）

指定者:

exec 在接口中 HttpUtils

抛出:

HttpException

execAsync

public java.util.concurrent.CompletableFuture<HttpResponse> execAsync(java.lang.String method)

从接口复制的说明: HttpUtils

异步执行请求

指定者:

execAsync 在接口中 HttpUtils

execDo

protected abstract HttpResponse execDo(java.lang.String method,
                                       java.util.concurrent.CompletableFuture<HttpResponse> future)
                                throws java.io.IOException

抛出:

java.io.IOException

getRequestCookieString

protected java.lang.String getRequestCookieString(MultiMap<java.lang.String> cookies)

tryInitParams

protected MultiMap<java.lang.String> tryInitParams()

tryInitFiles

protected MultiMap<HttpUploadFile> tryInitFiles()

tryInitCookies

protected MultiMap<java.lang.String> tryInitCookies()

tryInitHeaders

protected MultiMap<java.lang.String> tryInitHeaders()

isRedirected

protected static boolean isRedirected(int responseCode)