跳至主要內容

HttpClient

通过 VDN 组件的 HttpClient 功能可以方便的同 Web 服务端进行交互，获取和发送数据,

支持 以 GET、POST、PUT 方法访问 http/https 协议

属性

属性说明自动重置
Referer设置请求 Header 的 Referer 属性值，告知服务器访问的来源页面是
UserAgent设置请求的 userAgent 值是
ContentType设置发送内容的类型,
默认：application/x-www-form-urlencoded
预设类型(Constant)：
  • ContentType_URLENCODED ="application/x-www-form-urlencoded"
  • ContentType_JSON ="application/json" //JSON
  • ContentType_XML ="application/xml"  //XML
  • ContentType_TXT ="text/plain"    //纯文本格式
    		• 是
    Accept设定接收服务器端返回的数据的格式（Content-Type）
    默认:空
    同 ContentType 的预设类型    		是
    RtnEncoding设置返回内容的编码方式，组件将根据该设置进行转换
    默认 GB2312
    预设类型:
  • Encoding_UTF8="UTF-8"
  • Encoding_GB2312="GB2312"
  • Encoding_UNICODE="UNICODE"
    		• 是
    KeepCookie保留上次请求的 Cookie
    默认 True
    		是
    CAFile指定 CA 文件,包含 CA 文件的路径及文件名是
    CertType证书类型("PEM","DER","ENG")
    默认： PEM    		是
    CertFile证书文件,包含 Cert 文件的路径及文件名是
    CertPW证书密码是
    SSLKeyType私钥类型("PEM","DER","ENG")
    默认： PEM    		是
    SSLKeyFile私钥文件,包含私钥文件的路径及文件名是
    SSLKeyPW私钥密码是
    ResponseCharset获取 Web 响应的编码方式
    这里获取的是服务器端返回的原始编码方式,通过 HttpClient 获取的是根据 DefEncoding 属性值转换后的编码    		否
    HeaderList获取 Web 响应的 Header 列表否
    CookieList获取 Web 响应的 Cookie 列表否
    ContentLength获取 Web 响应的内容长度否
    hc_autoReset在每次请求之后自动执行 hc_reset 函数重置属性
    默认:True    		否
    hc_Async是否执行异步操作否
    hc_Event异步操作时是否接收事件通知。在异步操作下，只有在异步事件里才能获取返回值。
    触发的事件包括：
  • FileProgress:异步操作进度
  • HttpComplete:异步操作完成，这里可以获取返回值
  • Error:异步操作发生错误时触发
    		• 否
    TokenIdent携带令牌时的 ID 值(For VDN Web API)
    默认 Token    		否
    Token令牌值(For VDN Web API) ,GetToken()函数将自动设置该值否
    ApiURLVDN WebAPI 的范文入口，供 GetToken(...)函数使用，举例:api否
    hc_conTimeout连接超时时间(秒) 0 保持默认否
    hc_timeouthttp 请求总超时时间 0 不计超时否
    hc_autoRelase是否贼每次请求执行之后自动释放 HttpClient 对象
    默认:True
    在 WebApp 等多线程的情况下使用该属性必须设置为 True,在 PB 单线程程序里可以设置为 False,这样可以减少对每个 URL 的重复解析。    		否

    重置

    当 hc_autoReset=True 时,请求完成后将自动执行 hc_reset()函数将属性进行重置，设置为默认值

    函数

    与 HttpClient 相关的函数基本都是以 hc_开头的

    函数中使用的键值是区分大小写的

    函数参数说明
    hc_getstring url Web 服务器的 URL 地址
    string out 服务器返回的内容(Ref)    		以 Get 方式向服务器端请求数据
    返回 1 成功 -1 失败
    hc_poststring url Web 服务器的 URL 地址
    string in  发送给 Web 服务器的内容
    string out 服务器返回的内容(Ref)    		以 Post 方式向服务器端请求数据
    返回 1 成功 -1 失败
    hc_post_jsonstring url Web 服务器的 URL 地址
    string json  发送给 Web 服务器的 JSON
    string out 服务器返回的内容(Ref)    		以 Post 方式向服务器发送 JSON 格式数据;
    等同于先设置 ContentType=ContentType_JSON
    再调用 hc_post(...) 函数
    返回 1 成功 -1 失败
    hc_request_strstring url Web 服务器的 URL 地址
    string in  发送给 Web 服务器的内容
    string out 服务器返回的内容(Ref)    		以指定的方式向服务器请求数据，并进行编码转换
    hc_get、hc_post 调用的都是该函数
    返回 1 成功 -1 失败
    hc_requeststring url Web 服务器的 URL 地址
    blob in  发送给 Web 服务器的内容
    blob out 服务器返回的内容(Ref)    		核心函数,hc_request_str 函数最终都是调用这个函数。
    向服务器端发起请求，并返回数据。

    返回 1 成功 -1 失败
    hc_upfilestring url  服务器 URL 【必须】
    string file 要上传文件的全路径 【必须】
    string name 文件标签名,例如 file 或 t_file 【可选】
    string out  返回内容(ref)【可选】    		上传一个文件到服务器
    hc_upfilestring url 服务器 URL 【必须】
    blob  file 要上传 BLOB 数据 【必须】
    string filename 上传后的文件名 【可选】
    string name 文件标签名,例如 file 或 t_file 【可选】
    string out 返回内容(ref) 【可选】    		上传 Blob 数据到服务器
    hc_setValuevalue string name 标签名
    value string value 值    		设置 form data 值
    配合 hc_post 或 hc_upfile 使用
    hc_setFormstring name 标签名
    string key 属性,不区分大小写
  • NAME 名称(组件根据 name 自动设置)
  • FILE 上传文件路径
  • TYPE 文件类型，例如：image/png
  • BLOB 上传 BLOB 到文件，指明数据长度
  • FILENAME 文件名
  • VALUE 普通的标签值

    • string value 字段值    		设置 form data 的属性值
    可以分多次设置，来完成一个标签的完整值
    例如:
    hc_setform("file1","type","image/png")
    //指明上传那文件的类型
    uo_vdn.hc_setform("file","FILENAME","abc.png")
    //指明上传文件的名称，可以和源文件名称不同
    hc_getCookieestring key 键值分析服务器返回的 CookieList 获取键值对应的值
    无对应值返回空
    hc_setCookiestring key 键值
    string value 值    		设置请求的 Cookie 值
    举例: uo_vdn.hc_setCookie("UID","9999")
    hc_getHeaderstring key 键值分析服务器返回的 HeaderList 获取键值对应的值
    无对应值返回空
    hc_setHeaderstring key 键值
    string value 值    		设置响应的 Header 值
    举例: uo_vdn.hc_setHeader("ABC","123")
    hc_reset无重置 HttpClient 相关的属性值
    当 hc_autoReset=True 请求完成后将自动调用
    GetTokenstring url  (非必选)服务器 URL 地址,不带 API
    string key  服务器端的高级设置中设置的 TokenKey    		从 VDN WebAPI 服务器端获取令牌
    参数 url 只要指明服务器的地址即可
    例如:http://www.xxx.net:8088/
    当初始化了 URL 属性则不需要带有该参数。
    API 子路径由 ApiURL 属性指定。

    示例代码

    示例代码

    位置: Example\PB 演示示例\VDNDemo.pbw

    对象: w_httpClient

    Copyright© 2014-2026 烟台沃森电子软件技术有限公司