org.noear.solon.net.http

Interface HttpUtils

All Known Implementing Classes:

AbstractHttpUtils, JdkHttpUtils, OkHttpUtils

@Preview(value="3.0")
public interface HttpUtils

Http 工具类

Since:

2.8

Author:

noear

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log

Method Summary

Modifier and Type	Method and Description
default HttpUtils	accept(String accept) Accept 头配置
default HttpUtils	body(byte[] bytes) 主体配置
HttpUtils	body(byte[] bytes, String contentType) 主体配置
default HttpUtils	body(InputStream raw) 主体配置
HttpUtils	body(InputStream raw, String contentType) 主体配置
HttpUtils	body(String txt, String contentType) 主体配置
default HttpUtils	bodyJson(String txt) Deprecated. 3.0 bodyOfJson(String)
HttpUtils	bodyOfBean(Object obj) 主体配置（由序列化器决定内容类型）
default HttpUtils	bodyOfJson(String txt) 主体配置
default HttpUtils	bodyOfTxt(String txt) 主体配置
default HttpUtils	bodyRaw(byte[] bytes) Deprecated. 3.0 body(byte[])
default HttpUtils	bodyRaw(byte[] bytes, String contentType) Deprecated. 3.0 body(byte[], String)
default HttpUtils	bodyRaw(InputStream raw) Deprecated. 3.0 body(InputStream)
default HttpUtils	bodyRaw(InputStream raw, String contentType) Deprecated. 3.0 body(byte[], String)
default HttpUtils	bodyTxt(String txt) Deprecated. 3.0 bodyOfTxt(String)
default HttpUtils	bodyTxt(String txt, String contentType) Deprecated. 3.0 body(String, String)
HttpUtils	charset(String charset) 编码配置
default HttpUtils	contentType(String contentType) Content-Type 头配置
HttpUtils	cookie(String name, String value) 小饼配置（替换）
HttpUtils	cookieAdd(String name, String value) 小饼配置（添加）
HttpUtils	cookies(Iterable<org.noear.solon.core.util.KeyValues<String>> cookies) 小饼配置
HttpUtils	cookies(Map cookies) 小饼配置
HttpUtils	data(Iterable<org.noear.solon.core.util.KeyValues<String>> data) 参数配置
HttpUtils	data(Map data) 参数配置
default HttpUtils	data(String name, File file) 参数配置
HttpUtils	data(String name, String value) 参数配置（替换）
HttpUtils	data(String name, String filename, File file) 参数配置
HttpUtils	data(String name, String filename, InputStream inputStream, String contentType) 参数配置
String	delete() delete 请求并返回 body
<T> T	deleteAs(Type type) delete 请求并返回 body
HttpUtils	enablePrintln(boolean enable) 启用打印（专为 tester 服务）
HttpResponse	exec(String method) 执行请求并返回响应
String	execAsBody(String method) 执行请求并返回响应主体
<T> T	execAsBody(String method, Type type) 执行请求并返回响应主体
int	execAsCode(String method) 执行请求并返回代码
default org.reactivestreams.Publisher<ServerSentEvent>	execAsEventStream(String method) Deprecated. 3.1 execAsSseStream(String)
org.reactivestreams.Publisher<String>	execAsLineStream(String method) 执行请求并返回文本行流
org.reactivestreams.Publisher<ServerSentEvent>	execAsSseStream(String method) 执行请求并返回服务端推送事件流
default org.reactivestreams.Publisher<String>	execAsTextStream(String method) Deprecated. 3.1 execAsLineStream(String)
CompletableFuture<HttpResponse>	execAsync(String method) 异步执行请求
default HttpUtils	fill(Consumer<HttpUtils> consumer) 填充自己
String	get() get 请求并返回 body
<T> T	getAs(Type type) get 请求并返回 body
int	head() head 请求并返回 code
HttpUtils	header(String name, String value) 头配置（替换）
HttpUtils	headerAdd(String name, String value) 头配置（添加）
HttpUtils	headers(Iterable<org.noear.solon.core.util.KeyValues<String>> headers) 头配置
HttpUtils	headers(Map headers) 头配置
static HttpUtils	http(String url) 创建
static HttpUtils	http(String service, String path) 创建
static HttpUtils	http(String group, String service, String path) 创建
HttpUtils	multipart(boolean multipart) 是否多部分配置
String	options() options 请求并返回 body
String	patch() patch 请求并返回 body
<T> T	patchAs(Type type) patch 请求并返回 body
String	post() post 请求并返回 body
default String	post(boolean useMultipart) post 请求并返回 body
<T> T	postAs(Type type) post 请求并返回 body
default <T> T	postAs(Type type, boolean useMultipart) post 请求并返回 body
HttpUtils	proxy(Proxy proxy) 代理配置
default HttpUtils	proxy(String host, int port) 代理配置
String	put() put 请求并返回 body
<T> T	putAs(Type type) put 请求并返回 body
org.noear.solon.core.serialize.Serializer	serializer() 获取序列化器
HttpUtils	serializer(org.noear.solon.core.serialize.Serializer serializer) 配置序列化器
HttpUtils	ssl(HttpSslSupplier sslProvider) ssl
HttpUtils	timeout(HttpTimeout timeout) 超时配置
default HttpUtils	timeout(int timeoutSeconds) 超时配置
default HttpUtils	timeout(int connectTimeoutSeconds, int writeTimeoutSeconds, int readTimeoutSeconds) 超时配置
static CharSequence	toQueryString(Map<?,?> map) map 转为 queryString
static CharSequence	toQueryString(Map<?,?> map, String charset) map 转为 queryString
static String	urlEncode(String s) url 编码
static String	urlEncode(String s, String charset) url 编码
HttpUtils	userAgent(String ua) 用户代理配置

Field Detail

log

static final org.slf4j.Logger log

Method Detail

http

static HttpUtils http(String service,
                      String path)

创建

http

static HttpUtils http(String group,
                      String service,
                      String path)

创建

http

static HttpUtils http(String url)

创建

serializer

HttpUtils serializer(org.noear.solon.core.serialize.Serializer serializer)

配置序列化器

serializer

org.noear.solon.core.serialize.Serializer serializer()

获取序列化器

enablePrintln

HttpUtils enablePrintln(boolean enable)

启用打印（专为 tester 服务）

proxy

HttpUtils proxy(Proxy proxy)

代理配置

ssl

HttpUtils ssl(HttpSslSupplier sslProvider)

ssl

proxy

default HttpUtils proxy(String host,
                        int port)

代理配置

timeout

default HttpUtils timeout(int timeoutSeconds)

超时配置

timeout

default HttpUtils timeout(int connectTimeoutSeconds,
                          int writeTimeoutSeconds,
                          int readTimeoutSeconds)

超时配置

timeout

HttpUtils timeout(HttpTimeout timeout)

超时配置

multipart

HttpUtils multipart(boolean multipart)

是否多部分配置

userAgent

HttpUtils userAgent(String ua)

用户代理配置

charset

HttpUtils charset(String charset)

编码配置

headers

HttpUtils headers(Map headers)

头配置

headers

HttpUtils headers(Iterable<org.noear.solon.core.util.KeyValues<String>> headers)

头配置

header

HttpUtils header(String name,
                 String value)

头配置（替换）

headerAdd

HttpUtils headerAdd(String name,
                    String value)

头配置（添加）

contentType

default HttpUtils contentType(String contentType)

Content-Type 头配置

accept

default HttpUtils accept(String accept)

Accept 头配置

cookies

HttpUtils cookies(Map cookies)

小饼配置

cookies

HttpUtils cookies(Iterable<org.noear.solon.core.util.KeyValues<String>> cookies)

小饼配置

cookie

HttpUtils cookie(String name,
                 String value)

小饼配置（替换）

cookieAdd

HttpUtils cookieAdd(String name,
                    String value)

小饼配置（添加）

data

HttpUtils data(Map data)

参数配置

data

HttpUtils data(Iterable<org.noear.solon.core.util.KeyValues<String>> data)

参数配置

data

HttpUtils data(String name,
               String value)

参数配置（替换）

data

HttpUtils data(String name,
               String filename,
               InputStream inputStream,
               String contentType)

参数配置

data

HttpUtils data(String name,
               String filename,
               File file)

参数配置

data

default HttpUtils data(String name,
                       File file)

参数配置

bodyOfTxt

default HttpUtils bodyOfTxt(String txt)

主体配置

bodyOfJson

default HttpUtils bodyOfJson(String txt)

主体配置

bodyOfBean

HttpUtils bodyOfBean(Object obj)
              throws HttpException

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

Throws:

HttpException

body

HttpUtils body(String txt,
               String contentType)

主体配置

body

HttpUtils body(byte[] bytes,
               String contentType)

主体配置

body

default HttpUtils body(byte[] bytes)

主体配置

body

HttpUtils body(InputStream raw,
               String contentType)

主体配置

body

default HttpUtils body(InputStream raw)

主体配置

get

String get()
    throws HttpException

get 请求并返回 body

Throws:

HttpException

getAs

<T> T getAs(Type type)
     throws HttpException

get 请求并返回 body

Throws:

HttpException

post

String post()
     throws HttpException

post 请求并返回 body

Throws:

HttpException

postAs

<T> T postAs(Type type)
      throws HttpException

post 请求并返回 body

Throws:

HttpException

post

default String post(boolean useMultipart)
             throws HttpException

post 请求并返回 body

Throws:

HttpException

postAs

default <T> T postAs(Type type,
                     boolean useMultipart)
              throws HttpException

post 请求并返回 body

Throws:

HttpException

put

String put()
    throws HttpException

put 请求并返回 body

Throws:

HttpException

putAs

<T> T putAs(Type type)
     throws HttpException

put 请求并返回 body

Throws:

HttpException

patch

String patch()
      throws HttpException

patch 请求并返回 body

Throws:

HttpException

patchAs

<T> T patchAs(Type type)
       throws HttpException

patch 请求并返回 body

Throws:

HttpException

delete

String delete()
       throws HttpException

delete 请求并返回 body

Throws:

HttpException

deleteAs

<T> T deleteAs(Type type)
        throws HttpException

delete 请求并返回 body

Throws:

HttpException

options

String options()
        throws HttpException

options 请求并返回 body

Throws:

HttpException

head

int head()
  throws HttpException

head 请求并返回 code

Throws:

HttpException

execAsBody

String execAsBody(String method)
           throws HttpException

执行请求并返回响应主体

Throws:

HttpException

execAsBody

<T> T execAsBody(String method,
                 Type type)
          throws HttpException

执行请求并返回响应主体

Throws:

HttpException

execAsCode

int execAsCode(String method)
        throws HttpException

执行请求并返回代码

Throws:

HttpException

execAsLineStream

org.reactivestreams.Publisher<String> execAsLineStream(String method)

执行请求并返回文本行流

execAsTextStream

@Deprecated
default org.reactivestreams.Publisher<String> execAsTextStream(String method)

Deprecated. 3.1 execAsLineStream(String)

执行请求并返回文本流

execAsSseStream

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

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

execAsEventStream

@Deprecated
default org.reactivestreams.Publisher<ServerSentEvent> execAsEventStream(String method)

Deprecated. 3.1 execAsSseStream(String)

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

exec

HttpResponse exec(String method)
           throws HttpException

执行请求并返回响应

Throws:

HttpException

execAsync

CompletableFuture<HttpResponse> execAsync(String method)

异步执行请求

fill

default HttpUtils fill(Consumer<HttpUtils> consumer)

填充自己

bodyTxt

@Deprecated
default HttpUtils bodyTxt(String txt,
                                      String contentType)

Deprecated. 3.0 body(String, String)

主体配置

bodyTxt

@Deprecated
default HttpUtils bodyTxt(String txt)

Deprecated. 3.0 bodyOfTxt(String)

主体配置

bodyJson

@Deprecated
default HttpUtils bodyJson(String txt)

Deprecated. 3.0 bodyOfJson(String)

主体配置

bodyRaw

@Deprecated
default HttpUtils bodyRaw(byte[] bytes,
                                      String contentType)

Deprecated. 3.0 body(byte[], String)

主体配置

bodyRaw

@Deprecated
default HttpUtils bodyRaw(byte[] bytes)

Deprecated. 3.0 body(byte[])

主体配置

bodyRaw

@Deprecated
default HttpUtils bodyRaw(InputStream raw)

Deprecated. 3.0 body(InputStream)

主体配置

bodyRaw

@Deprecated
default HttpUtils bodyRaw(InputStream raw,
                                      String contentType)

Deprecated. 3.0 body(byte[], String)

主体配置

urlEncode

static String urlEncode(String s)
                 throws IOException

url 编码

Throws:

IOException

urlEncode

static String urlEncode(String s,
                        String charset)
                 throws UnsupportedEncodingException

url 编码

Throws:

UnsupportedEncodingException

toQueryString

static CharSequence toQueryString(Map<?,?> map)
                           throws IOException

map 转为 queryString

Throws:

IOException

toQueryString

static CharSequence toQueryString(Map<?,?> map,
                                  String charset)
                           throws IOException

map 转为 queryString

Throws:

IOException