Httper (tiny 1.4.3 API)

java.lang.Object
- cn.xnatural.app.util.Httper

```
public class Httper
extends Object
```
http 请求客户端

嵌套类概要

嵌套类
限定符和类型	类和说明
`protected static class`	`Httper.FileStream`
`protected static class`	`Httper.Param` 参数
`protected static class`	`Httper.SocketHolder` socket 连接持有

字段概要

字段
限定符和类型	字段和说明
`protected String`	`bodyStr`
`protected Charset`	`charset`
`protected static long`	`checkValidTimeout`
`protected long`	`chunkedLen` 记录chunked的读取状态
`protected int`	`connectTimeout`
`protected String`	`contentType`
`protected Map<String,Object>`	`cookies`
`protected boolean`	`debug`
`protected static String`	`end`
`protected BiConsumer<Throwable,Httper>`	`exHandler`
`protected Function<Map<String,String>,OutputStream>`	`grafting`
`protected int`	`ioExceptionRetryCount`
`protected static org.slf4j.Logger`	`log`
`protected String`	`method`
`protected Map<String,Httper.Param>`	`params`
`protected List<Httper>`	`preReq` 预请求
`protected int`	`readTimeout`
`protected Map<String,String>`	`requestHeader`
`protected Integer`	`respCode`
`Map<String,String>`	`responseHeader`
`protected String`	`result`
`protected BiFunction<OutputStream,Map<String,String>,?>`	`resultHandler`
`protected static Map<String,List<Httper.SocketHolder>>`	`socketCache`
`protected Set<String>`	`toStringType`
`protected String`	`urlStr`

构造器概要

构造器
构造器和说明

Httper(String url)

构造器
构造器和说明
`Httper(String url)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Httper`	`basicAuth(String username, String password)`
`Httper`	`body(String bodyStr)`
`Httper`	`body(String bodyStr, String contentType)`
`static String`	`buildUrl(String urlStr, Map<String,Object> params)` 把查询参数添加到 url 后边
`Httper`	`charset(String charset)`
`static void`	`close()`
`Httper`	`connectTimeout(int timeout)`
`Httper`	`contentType(String contentType)` 设置 content-type
`Httper`	`cookie(String name, Object value)`
`Map<String,Object>`	`cookies()`
`Httper`	`debug()`
`Httper`	`debug(boolean debug)`
`protected long`	`decodeContent(List<ByteBuffer> datas, OutputStream os, Long limit)` 内容解析
`String`	`delete()`
`Httper`	`digestAuth(String username, String password)`
`protected String`	`execute()` 执行 http 请求
`Httper`	`exHandler(BiConsumer<Throwable,Httper> exHandler)`
`Httper`	`fileHandle(Function<String,OutputStream> fileConsumer)` 文件处理: (文件名) -> { 返回文件写入流}
`Httper`	`fileStream(String name, InputStream is, int length, String filename)` 添加文件流参数
`Httper`	`formBody(String bodyStr)`
`String`	`get()`
`protected Httper.SocketHolder`	`getOrCreate(URI uri)` 获取或创建连接
`Integer`	`getResponseCode()`
`Httper`	`header(String name, String value)`
`Httper`	`id(String id)`
`protected int`	`indexOf(ByteBuffer buf, byte[] delim)` 查找分割符所匹配下标
`Httper`	`jsonBody(String jsonStr)`
`String`	`method(String method)`
`Httper`	`param(String name, Object value)` 添加参数
`Httper`	`param(String name, Object value, String contentType)` 添加参数
`String`	`post()`
`protected boolean`	`processChunked(List<ByteBuffer> datas, OutputStream os)` 接收 chunked 数据
`protected boolean`	`processLine(List<ByteBuffer> datas, Consumer<String> lineConsumer)` 处理行数据
`String`	`put()`
`protected String`	`readLine(ByteBuffer buf)` 读一行数据
`Httper`	`readTimeout(int timeout)`
`protected void`	`receive(InputStream is)` 接收响应数据并解析
`Httper`	`resultHandle(BiFunction<OutputStream,Map<String,String>,?> resultHandler)` 处理函数: (结果流, 响应头) -> { 处理 }
`Httper`	`textBody(String bodyStr)`
`Httper`	`toStringType(String contentType)` response content-type 的结果需要转成 String

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

log

protected static final org.slf4j.Logger log

socketCache

protected static final Map<String,List<Httper.SocketHolder>> socketCache

checkValidTimeout

protected static final long checkValidTimeout

end
```
protected static final String end
```
另请参阅:

常量字段值

urlStr
```
protected String urlStr
```

contentType
```
protected String contentType
```

method
```
protected String method
```

bodyStr
```
protected String bodyStr
```

params

protected Map<String,Httper.Param> params

cookies
```
protected Map<String,Object> cookies
```

requestHeader

protected final Map<String,String> requestHeader

responseHeader

public final Map<String,String> responseHeader

connectTimeout
```
protected int connectTimeout
```

readTimeout
```
protected int readTimeout
```

respCode
```
protected Integer respCode
```

debug
```
protected boolean debug
```

ioExceptionRetryCount
```
protected int ioExceptionRetryCount
```

charset
```
protected Charset charset
```

exHandler

protected BiConsumer<Throwable,Httper> exHandler

grafting

protected Function<Map<String,String>,OutputStream> grafting

toStringType

protected final Set<String> toStringType

resultHandler

protected BiFunction<OutputStream,Map<String,String>,?> resultHandler

chunkedLen
```
protected transient long chunkedLen
```
记录chunked的读取状态

result
```
protected String result
```

preReq
```
protected final List<Httper> preReq
```
预请求

构造器详细资料
- Httper
```
public Httper(String url)
```

方法详细资料

close
```
public static void close()
```

get
```
public String get()
```

fileHandle

public Httper fileHandle(Function<String,OutputStream> fileConsumer)

文件处理: (文件名) -> { 返回文件写入流}

resultHandle

public Httper resultHandle(BiFunction<OutputStream,Map<String,String>,?> resultHandler)

处理函数: (结果流, 响应头) -> { 处理 }

post
```
public String post()
```

put
```
public String put()
```

delete
```
public String delete()
```

method
```
public String method(String method)
```

contentType
```
public Httper contentType(String contentType)
```
设置 content-type

参数:

contentType - application/json, multipart/form-data, application/x-www-form-urlencoded, text/plain

toStringType
```
public Httper toStringType(String contentType)
```
response content-type 的结果需要转成 String

jsonBody

public Httper jsonBody(String jsonStr)

textBody

public Httper textBody(String bodyStr)

formBody

public Httper formBody(String bodyStr)

body
```
public Httper body(String bodyStr)
```

body

public Httper body(String bodyStr,
                   String contentType)

readTimeout

public Httper readTimeout(int timeout)

connectTimeout

public Httper connectTimeout(int timeout)

debug
```
public Httper debug()
```

debug
```
public Httper debug(boolean debug)
```

charset

public Httper charset(String charset)

id
```
public Httper id(String id)
```

param

public Httper param(String name,
                    Object value)

添加参数

参数:: name - 参数名; value - 支持 File

param

public Httper param(String name,
                    Object value,
                    String contentType)

添加参数

参数:: name - 参数名; value - 支持 File; contentType - 参数类型，只有是multipart/form-data才生效

fileStream

public Httper fileStream(String name,
                         InputStream is,
                         int length,
                         String filename)

添加文件流参数

参数:: name - 参数名; is - 文件流; length - 流长度必须 > 0; filename - 文件名

header

public Httper header(String name,
                     String value)

digestAuth

public Httper digestAuth(String username,
                         String password)

basicAuth

public Httper basicAuth(String username,
                        String password)

cookie

public Httper cookie(String name,
                     Object value)

exHandler

public Httper exHandler(BiConsumer<Throwable,Httper> exHandler)

cookies
```
public Map<String,Object> cookies()
```

getResponseCode
```
public Integer getResponseCode()
```

getOrCreate

protected Httper.SocketHolder getOrCreate(URI uri)
                                   throws Exception

获取或创建连接

抛出:: Exception

execute
```
protected String execute()
```
执行 http 请求

返回:

http请求结果

receive

protected void receive(InputStream is)
                throws Exception

接收响应数据并解析

抛出:: Exception

processLine

protected boolean processLine(List<ByteBuffer> datas,
                              Consumer<String> lineConsumer)

处理行数据

返回:: true: 已处理

processChunked

protected boolean processChunked(List<ByteBuffer> datas,
                                 OutputStream os)
                          throws Exception

接收 chunked 数据

返回:: true: 结束
抛出:: Exception

decodeContent

protected long decodeContent(List<ByteBuffer> datas,
                             OutputStream os,
                             Long limit)
                      throws Exception

内容解析

参数:: os - 输出纯内容(已经处理好的); limit - 限制读取长度, null: 不限制
返回:: 长度
抛出:: Exception

readLine
```
protected String readLine(ByteBuffer buf)
```
读一行数据

返回:

null: 不足一行数据

indexOf
```
protected int indexOf(ByteBuffer buf,
                      byte[] delim)
```
查找分割符所匹配下标

参数:

buf - 字节流

delim - 分隔符

返回:

下标位置

buildUrl

public static String buildUrl(String urlStr,
                              Map<String,Object> params)

把查询参数添加到 url 后边

参数:: urlStr - url; params - 参数
返回:: 完整url

类 Httper

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

log

socketCache

checkValidTimeout

end

urlStr

contentType

method

bodyStr

params

cookies

requestHeader

responseHeader

connectTimeout

readTimeout

respCode

debug

ioExceptionRetryCount

charset

exHandler

grafting

toStringType

resultHandler

chunkedLen

result

preReq

构造器详细资料

Httper

方法详细资料

close

get

fileHandle

resultHandle

post

put

delete

method

contentType

toStringType

jsonBody

textBody

formBody

body

body

readTimeout

connectTimeout

debug

debug

charset

id

param

param

fileStream

header

digestAuth

basicAuth

cookie

exHandler

cookies

getResponseCode

getOrCreate

execute

receive

processLine

processChunked

decodeContent

readLine

indexOf

buildUrl