AbstractHttpUtils (solon-net-httputils 3.7.1 API)

java.lang.Object
- org.noear.solon.net.http.impl.AbstractHttpUtils

All Implemented Interfaces:

HttpUtils

Direct Known Subclasses:

JdkHttpUtils, OkHttpUtils
```
public abstract class AbstractHttpUtils
extends Object
implements HttpUtils
```
Http 工具基类

Since:

3.0

Author:

noear

Field Summary

Fields
Modifier and Type	Field and Description
`protected Charset`	`_charset`
`protected org.noear.solon.core.util.MultiMap<String>`	`_cookies`
`protected boolean`	`_enablePrintln`
`protected org.noear.solon.core.util.MultiMap<HttpUploadFile>`	`_files`
`protected org.noear.solon.core.util.MultiMap<String>`	`_headers`
`protected boolean`	`_multipart`
`protected org.noear.solon.core.util.MultiMap<String>`	`_params`
`protected Proxy`	`_proxy`
`protected org.noear.solon.core.serialize.Serializer`	`_serializer`
`protected HttpSslSupplier`	`_sslSupplier`
`protected HttpTimeout`	`_timeout`
`protected String`	`_url`

Constructor Summary

Constructors
Constructor and Description

AbstractHttpUtils(String url)

Constructors
Constructor and Description
`AbstractHttpUtils(String url)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Charset`	`charset()`
`HttpUtils`	`charset(String charset)` 编码配置
`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)` 设置请求 cookies
`HttpUtils`	`data(Iterable<org.noear.solon.core.util.KeyValues<String>> data)` 参数配置
`HttpUtils`	`data(Map data)` 设置表单数据
`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)` 执行请求并返回代码
`org.reactivestreams.Publisher<String>`	`execAsLineStream(String method)` 执行请求并返回文本行流
`org.reactivestreams.Publisher<ServerSentEvent>`	`execAsSseStream(String method)` 执行请求并返回服务端推送事件流
`CompletableFuture<HttpResponse>`	`execAsync(String method)` 异步执行请求
`protected abstract HttpResponse`	`execDo(String method, CompletableFuture<HttpResponse> future)`
`String`	`get()` get 请求并返回 body
`<T> T`	`getAs(Type type)` get 请求并返回 body
`static String`	`getLocationUrl(String refererUrl, String location)` 获取转发的新地址
`protected String`	`getRequestCookieString(org.noear.solon.core.util.MultiMap<String> cookies)`
`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)` 设置请求头
`protected static boolean`	`isRedirected(int responseCode)`
`HttpUtils`	`multipart(boolean multipart)` 是否多部分配置
`String`	`options()` options 请求并返回 body
`String`	`patch()` patch 请求并返回 body
`<T> T`	`patchAs(Type type)` patch 请求并返回 body
`String`	`post()` post 请求并返回 body
`<T> T`	`postAs(Type type)` post 请求并返回 body
`HttpUtils`	`proxy(Proxy proxy)` 代理配置
`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)` 超时配置
`protected org.noear.solon.core.util.MultiMap<String>`	`tryInitCookies()`
`protected org.noear.solon.core.util.MultiMap<HttpUploadFile>`	`tryInitFiles()`
`protected org.noear.solon.core.util.MultiMap<String>`	`tryInitHeaders()`
`protected org.noear.solon.core.util.MultiMap<String>`	`tryInitParams()`
`HttpUtils`	`userAgent(String ua)` 用户代理配置

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.noear.solon.net.http.HttpUtils
accept, body, body, body, body, body, bodyJson, bodyOfBean, bodyOfJson, bodyOfTxt, bodyRaw, bodyRaw, bodyRaw, bodyRaw, bodyTxt, bodyTxt, contentType, data, execAsEventStream, execAsTextStream, fill, http, http, http, post, postAs, proxy, timeout, timeout, toQueryString, toQueryString, urlEncode, urlEncode

- Field Detail
  - _enablePrintln
```
protected boolean _enablePrintln
```
  - _proxy
```
protected Proxy _proxy
```
  - _sslSupplier
```
protected HttpSslSupplier _sslSupplier
```
  - _url
```
protected String _url
```
  - _charset
```
protected Charset _charset
```
  - _headers
```
protected org.noear.solon.core.util.MultiMap<String> _headers
```
  - _cookies
```
protected org.noear.solon.core.util.MultiMap<String> _cookies
```
  - _params
```
protected org.noear.solon.core.util.MultiMap<String> _params
```
  - _files
```
protected org.noear.solon.core.util.MultiMap<HttpUploadFile> _files
```
  - _multipart
```
protected boolean _multipart
```
  - _timeout
```
protected HttpTimeout _timeout
```
  - _serializer
```
protected org.noear.solon.core.serialize.Serializer _serializer
```
- Constructor Detail
  - AbstractHttpUtils
```
public AbstractHttpUtils(String url)
```
- Method Detail
  - serializer
```
public HttpUtils serializer(org.noear.solon.core.serialize.Serializer serializer)
```
    Description copied from interface: HttpUtils
    
    配置序列化器
    
    Specified by:
    
    serializer in interface HttpUtils
  - serializer
```
public org.noear.solon.core.serialize.Serializer serializer()
```
    Description copied from interface: HttpUtils
    
    获取序列化器
    
    Specified by:
    
    serializer in interface HttpUtils
  - enablePrintln
```
public HttpUtils enablePrintln(boolean enable)
```
    Description copied from interface: HttpUtils
    
    启用打印（专为 tester 服务）
    
    Specified by:
    
    enablePrintln in interface HttpUtils
  - proxy
```
public HttpUtils proxy(Proxy proxy)
```
    Description copied from interface: HttpUtils
    
    代理配置
    
    Specified by:
    
    proxy in interface HttpUtils
  - ssl
```
public HttpUtils ssl(HttpSslSupplier sslProvider)
```
    Description copied from interface: HttpUtils
    
    ssl
    
    Specified by:
    
    ssl in interface HttpUtils
  - timeout
```
public HttpUtils timeout(HttpTimeout timeout)
```
    Description copied from interface: HttpUtils
    
    超时配置
    
    Specified by:
    
    timeout in interface HttpUtils
  - multipart
```
public HttpUtils multipart(boolean multipart)
```
    Description copied from interface: HttpUtils
    
    是否多部分配置
    
    Specified by:
    
    multipart in interface HttpUtils
  - userAgent
```
public HttpUtils userAgent(String ua)
```
    Description copied from interface: HttpUtils
    
    用户代理配置
    
    Specified by:
    
    userAgent in interface HttpUtils
  - charset
```
public HttpUtils charset(String charset)
```
    Description copied from interface: HttpUtils
    
    编码配置
    
    Specified by:
    
    charset in interface HttpUtils
  - charset
```
public Charset charset()
```
  - headers
```
public HttpUtils headers(Map headers)
```
    设置请求头
    
    Specified by:
    
    headers in interface HttpUtils
  - headers
```
public HttpUtils headers(Iterable<org.noear.solon.core.util.KeyValues<String>> headers)
```
    Description copied from interface: HttpUtils
    
    头配置
    
    Specified by:
    
    headers in interface HttpUtils
  - header
```
public HttpUtils header(String name,
                        String value)
```
    设置请求头
    
    Specified by:
    
    header in interface HttpUtils
  - headerAdd
```
public HttpUtils headerAdd(String name,
                           String value)
```
    添加请求头
    
    Specified by:
    
    headerAdd in interface HttpUtils
  - cookies
```
public HttpUtils cookies(Map cookies)
```
    设置请求 cookies
    
    Specified by:
    
    cookies in interface HttpUtils
  - cookies
```
public HttpUtils cookies(Iterable<org.noear.solon.core.util.KeyValues<String>> cookies)
```
    Description copied from interface: HttpUtils
    
    小饼配置
    
    Specified by:
    
    cookies in interface HttpUtils
  - cookie
```
public HttpUtils cookie(String name,
                        String value)
```
    Description copied from interface: HttpUtils
    
    小饼配置（替换）
    
    Specified by:
    
    cookie in interface HttpUtils
  - cookieAdd
```
public HttpUtils cookieAdd(String name,
                           String value)
```
    Description copied from interface: HttpUtils
    
    小饼配置（添加）
    
    Specified by:
    
    cookieAdd in interface HttpUtils
  - data
```
public HttpUtils data(Map data)
```
    设置表单数据
    
    Specified by:
    
    data in interface HttpUtils
  - data
```
public HttpUtils data(Iterable<org.noear.solon.core.util.KeyValues<String>> data)
```
    Description copied from interface: HttpUtils
    
    参数配置
    
    Specified by:
    
    data in interface HttpUtils
  - data
```
public HttpUtils data(String name,
                      String value)
```
    设置表单数据
    
    Specified by:
    
    data in interface HttpUtils
  - data
```
public HttpUtils data(String name,
                      String filename,
                      InputStream inputStream,
                      String contentType)
```
    Description copied from interface: HttpUtils
    
    参数配置
    
    Specified by:
    
    data in interface HttpUtils
  - data
```
public HttpUtils data(String name,
                      String filename,
                      File file)
```
    Description copied from interface: HttpUtils
    
    参数配置
    
    Specified by:
    
    data in interface HttpUtils
  - get
```
public String get()
           throws HttpException
```
    Description copied from interface: HttpUtils
    
    get 请求并返回 body
    
    Specified by:
    
    get in interface HttpUtils
    
    Throws:
    
    HttpException
  - getAs
```
public <T> T getAs(Type type)
            throws HttpException
```
    Description copied from interface: HttpUtils
    
    get 请求并返回 body
    
    Specified by:
    
    getAs in interface HttpUtils
    
    Throws:
    
    HttpException
  - post
```
public String post()
            throws HttpException
```
    Description copied from interface: HttpUtils
    
    post 请求并返回 body
    
    Specified by:
    
    post in interface HttpUtils
    
    Throws:
    
    HttpException
  - postAs
```
public <T> T postAs(Type type)
             throws HttpException
```
    Description copied from interface: HttpUtils
    
    post 请求并返回 body
    
    Specified by:
    
    postAs in interface HttpUtils
    
    Throws:
    
    HttpException
  - put
```
public String put()
           throws HttpException
```
    Description copied from interface: HttpUtils
    
    put 请求并返回 body
    
    Specified by:
    
    put in interface HttpUtils
    
    Throws:
    
    HttpException
  - putAs
```
public <T> T putAs(Type type)
            throws HttpException
```
    Description copied from interface: HttpUtils
    
    put 请求并返回 body
    
    Specified by:
    
    putAs in interface HttpUtils
    
    Throws:
    
    HttpException
  - patch
```
public String patch()
             throws HttpException
```
    Description copied from interface: HttpUtils
    
    patch 请求并返回 body
    
    Specified by:
    
    patch in interface HttpUtils
    
    Throws:
    
    HttpException
  - patchAs
```
public <T> T patchAs(Type type)
              throws HttpException
```
    Description copied from interface: HttpUtils
    
    patch 请求并返回 body
    
    Specified by:
    
    patchAs in interface HttpUtils
    
    Throws:
    
    HttpException
  - delete
```
public String delete()
              throws HttpException
```
    Description copied from interface: HttpUtils
    
    delete 请求并返回 body
    
    Specified by:
    
    delete in interface HttpUtils
    
    Throws:
    
    HttpException
  - deleteAs
```
public <T> T deleteAs(Type type)
               throws HttpException
```
    Description copied from interface: HttpUtils
    
    delete 请求并返回 body
    
    Specified by:
    
    deleteAs in interface HttpUtils
    
    Throws:
    
    HttpException
  - options
```
public String options()
               throws HttpException
```
    Description copied from interface: HttpUtils
    
    options 请求并返回 body
    
    Specified by:
    
    options in interface HttpUtils
    
    Throws:
    
    HttpException
  - head
```
public int head()
         throws HttpException
```
    Description copied from interface: HttpUtils
    
    head 请求并返回 code
    
    Specified by:
    
    head in interface HttpUtils
    
    Throws:
    
    HttpException
  - execAsBody
```
public String execAsBody(String method)
                  throws HttpException
```
    Description copied from interface: HttpUtils
    
    执行请求并返回响应主体
    
    Specified by:
    
    execAsBody in interface HttpUtils
    
    Throws:
    
    HttpException
  - execAsBody
```
public <T> T execAsBody(String method,
                        Type type)
                 throws HttpException
```
    Description copied from interface: HttpUtils
    
    执行请求并返回响应主体
    
    Specified by:
    
    execAsBody in interface HttpUtils
    
    Throws:
    
    HttpException
  - execAsCode
```
public int execAsCode(String method)
               throws HttpException
```
    Description copied from interface: HttpUtils
    
    执行请求并返回代码
    
    Specified by:
    
    execAsCode in interface HttpUtils
    
    Throws:
    
    HttpException
  - execAsLineStream
```
public org.reactivestreams.Publisher<String> execAsLineStream(String method)
```
    Description copied from interface: HttpUtils
    
    执行请求并返回文本行流
    
    Specified by:
    
    execAsLineStream in interface HttpUtils
  - execAsSseStream
```
public org.reactivestreams.Publisher<ServerSentEvent> execAsSseStream(String method)
```
    Description copied from interface: HttpUtils
    
    执行请求并返回服务端推送事件流
    
    Specified by:
    
    execAsSseStream in interface HttpUtils
  - exec
```
public HttpResponse exec(String method)
                  throws HttpException
```
    执行请求，返回响应对象（需要自己做关闭处理）
    
    Specified by:
    
    exec in interface HttpUtils
    
    Throws:
    
    HttpException
  - execAsync
```
public CompletableFuture<HttpResponse> execAsync(String method)
```
    Description copied from interface: HttpUtils
    
    异步执行请求
    
    Specified by:
    
    execAsync in interface HttpUtils
  - execDo
```
protected abstract HttpResponse execDo(String method,
                                       CompletableFuture<HttpResponse> future)
                                throws IOException
```
    Throws:
    
    IOException
  - getRequestCookieString
```
protected String getRequestCookieString(org.noear.solon.core.util.MultiMap<String> cookies)
```
  - tryInitParams
```
protected org.noear.solon.core.util.MultiMap<String> tryInitParams()
```
  - tryInitFiles
```
protected org.noear.solon.core.util.MultiMap<HttpUploadFile> tryInitFiles()
```
  - tryInitCookies
```
protected org.noear.solon.core.util.MultiMap<String> tryInitCookies()
```
  - tryInitHeaders
```
protected org.noear.solon.core.util.MultiMap<String> tryInitHeaders()
```
  - isRedirected
```
protected static boolean isRedirected(int responseCode)
```
  - getLocationUrl
```
public static String getLocationUrl(String refererUrl,
                                    String location)
```
    获取转发的新地址
    
    Parameters:
    
    refererUrl - 参考URL
    
    location - 定位地址

Class AbstractHttpUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.noear.solon.net.http.HttpUtils

Field Detail

_enablePrintln

_proxy

_sslSupplier

_url

_charset

_headers

_cookies

_params

_files

_multipart

_timeout

_serializer

Constructor Detail

AbstractHttpUtils

Method Detail

serializer

serializer

enablePrintln

proxy

ssl

timeout

multipart

userAgent

charset

charset

headers

headers

header

headerAdd

cookies

cookies

cookie

cookieAdd

data

data

data

data

data

get

getAs

post

postAs

put

putAs

patch

patchAs

delete

deleteAs

options

head

execAsBody

execAsBody

execAsCode

execAsLineStream

execAsSseStream

exec

execAsync

execDo

getRequestCookieString

tryInitParams

tryInitFiles

tryInitCookies

tryInitHeaders

isRedirected

getLocationUrl