程序包 com.ajaxjs.util.http_request

类 Post

java.lang.Object

com.ajaxjs.util.http_request.Base

com.ajaxjs.util.http_request.Post

所有已实现的接口:

HttpConstants

public class Post
extends Base
implements HttpConstants

POST 或 PUT 请求

作者:

Frank Cheung

字段概要

字段

修饰符和类型	字段	说明
static String	BOUNDARY

从类继承的字段 com.ajaxjs.util.http_request.Base

ERR_MSG

从接口继承的字段 com.ajaxjs.util.http_request.model.HttpConstants

CONTENT_TYPE, DELETE, GET, POST, PUT

构造器概要

构造器

构造器	说明
Post()

方法概要

修饰符和类型	方法	说明
static ResponseEntity	any(String method, String url, Object params, Consumer<HttpURLConnection> fn)	向指定 URL 发送指定方法的请求并返回响应
static Map<String,Object>	api(String url)	调用 API 请求指定的 URL 并返回结果。
static Map<String,Object>	api(String url, Object params)	POST API，返回 JSON
static Map<String,Object>	api(String url, Object params, Consumer<HttpURLConnection> fn)	POST API，返回 JSON
static Map<String,Object>	apiJsonBody(String url, Object params, Consumer<HttpURLConnection> fn)	使用POST方法向指定URL发送JSON格式的数据，并返回服务器的响应。
static Map<String,String>	apiXML(String url, Object params)	POST API，返回 XML
static Map<String,String>	apiXML(String url, Object params, Consumer<HttpURLConnection> fn)	POST API，返回 XML
static String	download(String url, Consumer<HttpURLConnection> fn, String saveDir, String newFileName)	下载二进制文件
static ResponseEntity	multiPOST(String url, Map<String,Object> data)	多段上传
static ResponseEntity	post(String url, Object params)	POST 请求
static ResponseEntity	post(String url, Object params, Consumer<HttpURLConnection> fn)	POST 请求
static Map<String,Object>	postFile(String url, String fieldName, String fileName, byte[] file, Consumer<HttpURLConnection> fn)	以POST方法上传文件
static ResponseEntity	put(String url, Object params)	PUT 请求
static ResponseEntity	put(String url, Object params, Consumer<HttpURLConnection> fn)	PUT 请求
static Map<String,Object>	putApi(String url, Object params)	PUT API 请求，返回 JSON
static Map<String,Object>	putApi(String url, Object params, Consumer<HttpURLConnection> fn)	PUT API 请求，返回 JSON
static Map<String,Object>	putJsonBody(String url, Object params, Consumer<HttpURLConnection> fn)	使用PUT方法向指定URL发送JSON格式的数据，并返回服务器响应。
static void	showPic(String url, Consumer<HttpURLConnection> fn, javax.servlet.http.HttpServletResponse response)	显示图片流到浏览器
static byte[]	toFromData(Map<String,Object> data)	Map 转换为 byte

从类继承的方法 com.ajaxjs.util.http_request.Base

connect, connect, initHttpConnection

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

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

字段详细资料

BOUNDARY

public static String BOUNDARY

构造器详细资料

Post

public Post()

方法详细资料

any

public static ResponseEntity any(String method,
                                 String url,
                                 Object params,
                                 Consumer<HttpURLConnection> fn)

向指定 URL 发送指定方法的请求并返回响应

参数:

method - 请求的方法类型，如 GET、POST

url - 请求的 URL

params - 请求的参数

fn - 用于配置 HttpURLConnection 的 Consumer

返回:

响应的 ResponseEntity 对象

post

public static ResponseEntity post(String url,
                                  Object params,
                                  Consumer<HttpURLConnection> fn)

POST 请求

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

fn - 自定义 HTTP 头的时候可设置，可选的

返回:

响应消息体

post

public static ResponseEntity post(String url,
                                  Object params)

POST 请求

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

返回:

响应消息体

put

public static ResponseEntity put(String url,
                                 Object params,
                                 Consumer<HttpURLConnection> fn)

PUT 请求

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

fn - 自定义 HTTP 头的时候可设置，可选的

返回:

响应消息体

put

public static ResponseEntity put(String url,
                                 Object params)

PUT 请求

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

返回:

响应消息体

putApi

public static Map<String,Object> putApi(String url,
                                              Object params,
                                              Consumer<HttpURLConnection> fn)

PUT API 请求，返回 JSON

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

fn - 自定义 HTTP 头的时候可设置，可选的

返回:

响应消息体

putApi

public static Map<String,Object> putApi(String url,
                                              Object params)

PUT API 请求，返回 JSON

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

返回:

响应消息体

api

public static Map<String,Object> api(String url,
                                           Object params,
                                           Consumer<HttpURLConnection> fn)

POST API，返回 JSON

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

fn - 自定义 HTTP 头的时候可设置，可选的

返回:

响应的 JSON，Map 格式

apiJsonBody

public static Map<String,Object> apiJsonBody(String url,
                                                   Object params,
                                                   Consumer<HttpURLConnection> fn)

使用POST方法向指定URL发送JSON格式的数据，并返回服务器的响应。 此方法主要处理JSON数据的序列化和HTTP请求的发送，具体的请求细节可以通过回调函数fn进行定制。 POST JSON as RawBody

参数:

url - 请求的URL地址。

params - 要发送的参数，可以是任何Java对象，将会被序列化为JSON格式。

fn - 一个Consumer接口，用于定制HttpURLConnection的行为，例如设置请求头、请求方法等。

返回:

返回一个Map对象，包含服务器的响应数据。

putJsonBody

public static Map<String,Object> putJsonBody(String url,
                                                   Object params,
                                                   Consumer<HttpURLConnection> fn)

使用PUT方法向指定URL发送JSON格式的数据，并返回服务器响应。 此方法将对象转换为JSON字符串作为请求的正文。 可以通过提供的Consumer接口对HttpURLConnection进行进一步的配置。 PUT JSON as RawBody

参数:

url - 请求的URL地址。

params - 要发送的参数，将被转换为JSON格式。

fn - HttpURLConnection的消费者，用于自定义HTTP请求的配置，如设置请求头等。

返回:

返回一个Map对象，包含服务器的响应数据。

api

public static Map<String,Object> api(String url,
                                           Object params)

POST API，返回 JSON

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

返回:

响应的 JSON，Map 格式

api

public static Map<String,Object> api(String url)

调用 API 请求指定的 URL 并返回结果。

参数:

url - 请求的 URL

返回:

包含 API 响应结果的 Map 对象

apiXML

public static Map<String,String> apiXML(String url,
                                              Object params,
                                              Consumer<HttpURLConnection> fn)

POST API，返回 XML

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

fn - 自定义 HTTP 头的时候可设置，可选的

返回:

响应的 XML，Map 格式

apiXML

public static Map<String,String> apiXML(String url,
                                              Object params)

POST API，返回 XML

参数:

url - 请求目标地址

params - 请求参数，可以是

byte[]、String、Map<String, Object>

类型，实际表示了表单数据 KeyValue 的请求数据

返回:

响应的 XML，Map 格式

toFromData

public static byte[] toFromData(Map<String,Object> data)

Map 转换为 byte

参数:

data - Map

返回:

Map 转换为 byte

multiPOST

public static ResponseEntity multiPOST(String url,
                                       Map<String,Object> data)

多段上传

参数:

url - 请求目标地址

data - 请求数据，若包含 File 对象则表示二进制（文件）数据

返回:

请求之后的响应的内容

postFile

public static Map<String,Object> postFile(String url,
                                                String fieldName,
                                                String fileName,
                                                byte[] file,
                                                Consumer<HttpURLConnection> fn)

以POST方法上传文件

参数:

url - 上传文件的URL

fieldName - 文件字段名

fileName - 文件名

file - 文件内容

fn - 用于设置HTTP连接的回调函数

返回:

上传成功返回文件上传结果的Map，否则返回null

download

public static String download(String url,
                              Consumer<HttpURLConnection> fn,
                              String saveDir,
                              String newFileName)

下载二进制文件

参数:

url - 请求目标地址

fn - 自定义 HTTP 头的时候可设置，可选的

saveDir - 保存的目录

newFileName - 是否有新的文件名，如无请传 null

返回:

下载文件的完整磁盘路径

showPic

public static void showPic(String url,
                           Consumer<HttpURLConnection> fn,
                           javax.servlet.http.HttpServletResponse response)

显示图片流到浏览器

参数:

url - 地址

fn - 处理怎么请求

response - 响应对象