ESP8266 – ESP8266HTTPClient库 – setUserAgent

位置导航: ESP8266库 / ESP8266HTTPClient库 / 本页

说明

ESP8266开发板在通过HTTP发送请求时，我们可以使用此函数设置请求头的User-Agent内容。

User Agent请求头的作用是让服务器能够识别客户端使用的操作系统及版本、客户端设备的CPU类型、浏览器名称和版本、浏览器所用的语言、浏览器所用的插件等。换句话说,就是告诉服务端现在是什么设备在访问服务器。

语法

httpClient.setUserAgent（device_info）

参数

– device_info : 用户自定义的客户端标识
– 参数类型: 字符串或 const char *

返回值

无

示例程序

关于本函数的具体使用方法，请参考以下代码，尤其是代码中高亮的语句部分。

您将以下示例程序的WiFi连接信息修改后并且将本示例程序上传ESP8266开发板后，开发板随即会自动连接WiFi。WiFi连接成功后，ESP8266将会向www.example.com网站服务器发送HTTP请求并通过串口监视器将网站服务器响应信息通过串口监视器显示出来。

以下是本程序控制下，ESP8266发送的HTTP请求信息：

GET / HTTP/1.1
Host: 192.168.0.110
User-Agent: ESP8266
Connection: keep-alive
Accept-Encoding: identity;q=1,chunked;q=0.1,*;q=0
Content-Length: 0

GET / HTTP/1.1

Host: 192.168.0.110

User-Agent: ESP8266

Connection: keep-alive

Accept-Encoding: identity;q=1,chunked;q=0.1,*;q=0

Content-Length: 0

其中User-Agent: ESP8266部分即是通过以下程序中的httpClient.setUserAgent("ESP8266");来实现的。

/**********************************************************************
  项目名称/Project          : 零基础入门学用物联网
  程序名称/Program name     : HTTPClient_setReuse
  团队/Team                : 太极创客团队 / Taichi-Maker (www.taichi-maker.com)
  作者/Author              : Dapenson
  日期/Date（YYYYMMDD）     : 20200325
  程序目的/Purpose          :
  此程序用于演示如何使用ESP8266来向www.example.com网站服务器发送HTTP请求并通过串口
  监视器将网站服务器响应信息通过串口监视器显示出来。
  程序使用了setUserAgent函数来设置请求头中的客户端信息。
  -----------------------------------------------------------------------
  修订历史/Revision History  
  日期/Date    作者/Author      参考号/Ref    修订说明/Revision Description
  20200411      CYNO朔           001        将请求URL改为www.example.com
  -----------------------------------------------------------------------
  本示例程序为太极创客团队制作的《零基础入门学用物联网》中示例程序。
  该教程为对物联网开发感兴趣的朋友所设计和制作。如需了解更多该教程的信息，请参考以下网页：
  http://www.taichi-maker.com/homepage/esp8266-nodemcu-iot/iot-c/esp8266-nodemcu-web-client/http-request/
***********************************************************************/
 #include <ESP8266WiFi.h>
#include <ESP8266HTTPClient.h>
 
// 测试HTTP请求用的URL
#define URL "http://www.example.com"
 
// 设置wifi接入信息(请根据您的WiFi信息进行修改)
const char* ssid = "taichimaker";
const char* password = "12345678";
 
void setup() {
  //初始化串口设置
  Serial.begin(9600);
 
  //设置ESP8266工作模式为无线终端模式
  WiFi.mode(WIFI_STA);
 
  //开始连接wifi
  WiFi.begin(ssid, password);
 
  //等待WiFi连接,连接成功打印IP
  while (WiFi.status() != WL_CONNECTED) {
    delay(1000);
    Serial.print(".");
  }
  Serial.println("");
  Serial.println("WiFi Connected!");
}
 
void loop() {
  // 如果ESP8266连接WiFi则发送HTTP请求
  if ((WiFi.status() == WL_CONNECTED)) {
    esp8266Http();
  }
  
  delay(5000);   // 短暂等待
}
 
// 发送HTTP请求并且将服务器响应通过串口输出
void esp8266Http(){
 
  //创建 HTTPClient 对象
  HTTPClient httpClient;
 
  //配置请求地址。此处也可以不使用端口号和PATH而单纯的
  httpClient.begin(URL); 
  Serial.print("URL: "); Serial.println(URL);
 
  //设置请求头中的User-Agent
  httpClient.setUserAgent("ESP8266");
 
  //启动连接并发送HTTP请求
  int httpCode = httpClient.GET();
  Serial.print("Send GET request to URL: ");
  Serial.println(URL);
  
  //如果服务器响应OK则从服务器获取响应体信息并通过串口输出
  //如果服务器不响应OK则将服务器响应状态码通过串口输出
  if (httpCode == HTTP_CODE_OK) {
    String responsePayload = httpClient.getString();
    Serial.println("Server Response Payload: ");
    Serial.println(responsePayload);
  } else {
    Serial.println("Server Respose Code：");
    Serial.println(httpCode);
  }
 
  //关闭ESP8266与服务器连接
  httpClient.end();
}

/**********************************************************************

项目名称/Project : 零基础入门学用物联网

程序名称/Program name : HTTPClient_setReuse

团队/Team : 太极创客团队 / Taichi-Maker (www.taichi-maker.com)

作者/Author : Dapenson

日期/Date（YYYYMMDD） : 20200325

程序目的/Purpose :

此程序用于演示如何使用ESP8266来向www.example.com网站服务器发送HTTP请求并通过串口

监视器将网站服务器响应信息通过串口监视器显示出来。

程序使用了setUserAgent函数来设置请求头中的客户端信息。

-----------------------------------------------------------------------

修订历史/Revision History

日期/Date 作者/Author 参考号/Ref 修订说明/Revision Description

20200411 CYNO朔 001 将请求URL改为www.example.com

-----------------------------------------------------------------------

本示例程序为太极创客团队制作的《零基础入门学用物联网》中示例程序。

该教程为对物联网开发感兴趣的朋友所设计和制作。如需了解更多该教程的信息，请参考以下网页：

http://www.taichi-maker.com/homepage/esp8266-nodemcu-iot/iot-c/esp8266-nodemcu-web-client/http-request/

***********************************************************************/

#include <ESP8266WiFi.h>

#include <ESP8266HTTPClient.h>

// 测试HTTP请求用的URL

#define URL "http://www.example.com"

// 设置wifi接入信息(请根据您的WiFi信息进行修改)

const char* ssid = "taichimaker";

const char* password = "12345678";

void setup() {

//初始化串口设置

Serial.begin(9600);

//设置ESP8266工作模式为无线终端模式

WiFi.mode(WIFI_STA);

//开始连接wifi

WiFi.begin(ssid, password);

//等待WiFi连接,连接成功打印IP

while (WiFi.status() != WL_CONNECTED) {

delay(1000);

Serial.print(".");

}

Serial.println("");

Serial.println("WiFi Connected!");

}

void loop() {

// 如果ESP8266连接WiFi则发送HTTP请求

if ((WiFi.status() == WL_CONNECTED)) {

esp8266Http();

}

delay(5000); // 短暂等待

}

// 发送HTTP请求并且将服务器响应通过串口输出

void esp8266Http(){

//创建 HTTPClient 对象

HTTPClient httpClient;

//配置请求地址。此处也可以不使用端口号和PATH而单纯的

httpClient.begin(URL);

Serial.print("URL: "); Serial.println(URL);

//设置请求头中的User-Agent

httpClient.setUserAgent("ESP8266");

//启动连接并发送HTTP请求

int httpCode = httpClient.GET();

Serial.print("Send GET request to URL: ");

Serial.println(URL);

//如果服务器响应OK则从服务器获取响应体信息并通过串口输出

//如果服务器不响应OK则将服务器响应状态码通过串口输出

if (httpCode == HTTP_CODE_OK) {

String responsePayload = httpClient.getString();

Serial.println("Server Response Payload: ");

Serial.println(responsePayload);

} else {

Serial.println("Server Respose Code：");

Serial.println(httpCode);

}

//关闭ESP8266与服务器连接

httpClient.end();

}

说明

语法

参数

返回值

示例程序

相关内容