简介

网络协议栈介绍：

网络协议栈模块作为电话子系统可裁剪部件，主要分为HTTP和socket模块；

Http接口架构图

 

socket接口架构图

 

目录

/foundation/communication/netstack
├─figures                            # 架构图
├─frameworks                         # 接口实现
│  ├─js                              # JS API实现
│  │   ├─builtin                     # 小型系统JS API实现
│  │   │   ├── http_request          # http请求实现目录
│  │   │   └── test                  # 测试代码
│  │   └─napi                        # 标准系统JS API实现
│  │       ├─fetch                   # fetch API
│  │       ├─http                    # http API
│  │       ├─socket                  # socket API
│  │       ├─tls                     # tls socket API
│  │       └─websocket               # websocket API
│  └─native                          # native接口
│    └─tls_socket                    # tls socket native实现
├─interfaces                         # 接口定义
│  ├─innerkits                       # native接口
│  │  └─tls_socket                   # tls socket native接口
│  └─kits                            # JS接口
│     └─js                           # 本地.d.ts文件
├─test                               # 测试代码目录
└─utils                              # 公共功能
   ├─common_utils                    # 共通库目录
   ├─log                             # 日志实现目录
   └─napi_utils                      # 公用NAPI代码目录

 

接口说明

Http接口说明

类型接口功能说明
ohos.net.socketfunction createHttp(): HttpRequest返回一个HttpRequest对象
ohos.net.http.HttpRequeston(type: "headerReceive", callback: AsyncCallback<Object>): void监听收到Http头的事件
ohos.net.http.HttpRequestonce(type: "headerReceive", callback: Callback<Object>): void监听收到Http头的事件，只监听一次
ohos.net.http.HttpRequestoff(type: "headerReceive", callback: AsyncCallback<Object>): void取消监听收到Http头的事件
ohos.net.http.HttpRequeston(type: "headerReceive", callback: Callback<Object>): void监听收到Http头的事件
ohos.net.http.HttpRequestonce(type: "headerReceive", callback: Callback<Object>): void监听收到Http头的事件，只监听一次
ohos.net.http.HttpRequestoff(type: "headerReceive", callback: Callback<Object>): void取消监听收到Http头的事件
ohos.net.http.HttpRequestrequest(url: string, callback: AsyncCallback<HttpResponse>): void用GET方法请求一个域名，调用callback
ohos.net.http.HttpRequestrequest(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpResponse>): void请求一个域名，options中携带请求参数，调用callback
ohos.net.http.HttpRequestrequest(url: string, options?: HttpRequestOptions: Promise<HttpResponse>请求一个域名，options中携带请求参数(可选)，返回Promise

 

HttpRequestOptions

发起请求可选参数的类型和取值范围。

参数类型必填说明
methodRequestMethod否请求方式，默认为GET。
extraDatastring6+ | Object6+ | ArrayBuffer8+否发送请求的额外数据，默认无此字段。
- 当HTTP请求为POST、PUT等方法时，此字段为HTTP请求的content，以UTF-8编码形式作为请求体。6+
- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时，此字段为HTTP请求参数的补充。开发者需传入Encode编码后的string类型参数，Object类型的参数无需预编码，参数内容会拼接到URL中进行发送；ArrayBuffer类型的参数不会做拼接处理。6+
expectDataType9+HttpDataType否指定返回数据的类型，默认无此字段。如果设置了此参数，系统将优先返回指定的类型。
usingCache9+boolean否是否使用缓存，默认为true。
priority9+number否优先级，范围[1,1000]，默认是1。
headerObject否HTTP请求头字段。默认{'Content-Type': 'application/json'}。
readTimeoutnumber否读取超时时间。单位为毫秒（ms），默认为60000ms。
设置为0表示不会出现超时情况。
connectTimeoutnumber否连接超时时间。单位为毫秒（ms），默认为60000ms。
usingProtocol9+HttpProtocol否使用协议。默认值由系统自动指定。
usingProxy10+boolean | Object否是否使用HTTP代理，默认为false，不使用代理。
- 当usingProxy为布尔类型true时，使用默认网络代理。
- 当usingProxy为object类型时，使用指定网络代理。
caPath10+string否如果设置了此参数，系统将使用用户指定路径的CA证书，否则将使用系统预设CA证书。

 

RequestMethod

HTTP 请求方法。

method 的合法值说明
OPTIONSHTTP 请求 OPTIONS。
GETHTTP 请求 GET。
HEADHTTP 请求 HEAD。
POSTHTTP 请求 POST。
PUTHTTP 请求 PUT。
DELETEHTTP 请求 DELETE。
TRACEHTTP 请求 TRACE。
CONNECTHTTP 请求 CONNECT。

 

ResponseCode

发起请求返回的响应码。

变量值说明
OK200请求成功。一般用于GET与POST请求。
CREATED201已创建。成功请求并创建了新的资源。
ACCEPTED202已接受。已经接受请求，但未处理完成。
NOT_AUTHORITATIVE203非授权信息。请求成功。
NO_CONTENT204无内容。服务器成功处理，但未返回内容。
RESET205重置内容。
PARTIAL206部分内容。服务器成功处理了部分GET请求。
MULT_CHOICE300多种选择。
MOVED_PERM301永久移动。请求的资源已被永久的移动到新URI，返回信息会包括新的URI，浏览器会自动定向到新URI。
MOVED_TEMP302临时移动。
SEE_OTHER303查看其它地址。
NOT_MODIFIED304未修改。
USE_PROXY305使用代理。
BAD_REQUEST400客户端请求的语法错误，服务器无法理解。
UNAUTHORIZED401请求要求用户的身份认证。
PAYMENT_REQUIRED402保留，将来使用。
FORBIDDEN403服务器理解请求客户端的请求，但是拒绝执行此请求。
NOT_FOUND404服务器无法根据客户端的请求找到资源（网页）。
BAD_METHOD405客户端请求中的方法被禁止。
NOT_ACCEPTABLE406服务器无法根据客户端请求的内容特性完成请求。
PROXY_AUTH407请求要求代理的身份认证。
CLIENT_TIMEOUT408请求时间过长，超时。
CONFLICT409服务器完成客户端的PUT请求是可能返回此代码，服务器处理请求时发生了冲突。
GONE410客户端请求的资源已经不存在。
LENGTH_REQUIRED411服务器无法处理客户端发送的不带Content-Length的请求信息。
PRECON_FAILED412客户端请求信息的先决条件错误。
ENTITY_TOO_LARGE413由于请求的实体过大，服务器无法处理，因此拒绝请求。
REQ_TOO_LONG414请求的URI过长（URI通常为网址），服务器无法处理。
UNSUPPORTED_TYPE415服务器无法处理请求的格式。
INTERNAL_ERROR500服务器内部错误，无法完成请求。
NOT_IMPLEMENTED501服务器不支持请求的功能，无法完成请求。
BAD_GATEWAY502充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。
UNAVAILABLE503由于超载或系统维护，服务器暂时的无法处理客户端的请求。
GATEWAY_TIMEOUT504充当网关或代理的服务器，未及时从远端服务器获取请求。
VERSION505服务器请求的HTTP协议的版本。

 

HttpResponse

request方法回调函数的返回值类型。

参数名类型必填说明
resultstring | Object |ArrayBuffer8+是Http请求根据响应头中Content-type类型返回对应的响应格式内容：
- application/json：返回JSON格式的字符串，如需Http响应具体内容，需开发者自行解析
- application/octet-stream：ArrayBuffer
- 其他：string
responseCodeResponseCode | number是回调函数执行成功时，此字段为ResponseCode。若执行失败，错误码将会从AsyncCallback中的err字段返回。错误码如下：
- 200：通用错误
- 202：参数错误
- 300：I/O错误
headerObject是发起http请求返回来的响应头。当前返回的是JSON格式字符串，如需具体字段内容，需开发者自行解析。常见字段及解析方式如下：
- Content-Type：header['Content-Type']；
- Status-Line：header['Status-Line']；
- Date：header.Date/header['Date']；
- Server：header.Server/header['Server']；
cookies8+string是服务器返回的 cookies。

 

HttpDataType

http的数据类型。

名称值说明
STRING0字符串类型。
OBJECT1对象类型。
ARRAY_BUFFER2二进制数组类型。

 

HttpProtocol

http协议版本

名称说明
HTTP1_1协议http1.1
HTTP2协议http2

示例

import http from "@ohos.net.http"
let httpRequest = http.createHttp()
httpRequest.request("www.example.com", function (err, data) {
    console.log(JSON.stringify(err))
    console.log(JSON.stringify(data))
})

 

socket接口说明

类型接口功能说明
ohos.net.socketfunction constructUDPSocketInstance(): UDPSocket返回一个UDPSocket对象
ohos.net.socketfunction constructUDPSocketInstance(): TCPSocket返回一个TCPSocket对象
ohos.net.socketfunction constructTLSSocketInstance(): TLSSocket返回一个TLSSocket对象
ohos.net.socket.UDPSocketbind(address:NetAddress, callback: AsyncCallback<void>): void绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketbind(address: NetAddress): Promise<void>绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方式作为异步方法。
ohos.net.socket.UDPSocketsend(options: UDPSendOptions, callback: AsyncCallback<void>): void通过UDPSocket连接发送数据。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketsend(options: UDPSendOptions): Promise<void>通过UDPSocket连接发送数据。使用Promise方式作为异步方法。
ohos.net.socket.UDPSocketclose(callback: AsyncCallback<void>): void关闭UDPSocket连接。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketclose(): Promise<void>关闭UDPSocket连接。使用Promise方式作为异步方法。
ohos.net.socket.UDPSocketgetState(callback: AsyncCallback<SocketStateBase>): void获取UDPSocket状态。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketgetState(): Promise<SocketStateBase>获取UDPSocket状态。使用Promise方式作为异步方法。
ohos.net.socket.UDPSocketsetExtraOptions(options: UDPExtraOptions, callback: AsyncCallback<void>): void设置UDPSocket连接的其他属性。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketsetExtraOptions(options: UDPExtraOptions): Promise<void>设置UDPSocket连接的其他属性。使用Promise方式作为异步方法。
ohos.net.socket.UDPSocketon(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketoff(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void取消订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketon(type: 'listening' | 'close', callback: Callback<void>): void订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketoff(type: 'listening' | 'close', callback?: Callback<void>): void取消订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketon(type: 'error', callback?: ErrorCallback): void订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
ohos.net.socket.UDPSocketoff(type: 'error', callback?: ErrorCallback): void取消订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketbind(address: NetAddress, callback: AsyncCallback<void>): void绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方法作为异步方法。
ohos.net.socket.TCPSocketbind(address NetAddress): Promise<void>绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。
ohos.net.socket.TCPSocketconnect(options: TCPConnectOptions, callback: AsyncCallback<void>): void连接到指定的IP地址和端口。使用callback方法作为异步方法。
ohos.net.socket.TCPSocketconnect(options: TCPConnectOptions): Promise<void>连接到指定的IP地址和端口。使用Promise方法作为异步方法。
ohos.net.socket.TCPSocketsend(options: TCPSendOptions, callback: AsyncCallback<void>): void通过TCPSocket连接发送数据。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketsend(options: TCPSendOptions): Promise<void>通过TCPSocket连接发送数据。使用Promise方式作为异步方法。
ohos.net.socket.TCPSocketclose(callback: AsyncCallback<void>): void关闭TCPSocket连接。使用Promise方式作为异步方法。
ohos.net.socket.TCPSocketclose(): Promise<void>关闭TCPSocket连接。使用Promise方式作为异步方法。
ohos.net.socket.TCPSocketgetRemoteAddress(callback: AsyncCallback<NetAddress>): void获取对端Socket地址。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketgetRemoteAddress(): Promise<NetAddress>获取对端Socket地址。使用Promise方式作为异步方法。
ohos.net.socket.TCPSocketgetState(callback: AsyncCallback<SocketStateBase>): void获取TCPSocket状态。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketgetState(): Promise<SocketStateBase>获取TCPSocket状态。使用Promise方式作为异步方法。
ohos.net.socket.TCPSocketsetExtraOptions(options: TCPExtraOptions, callback: AsyncCallback): void设置TCPSocket连接的其他属性。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketsetExtraOptions(options: TCPExtraOptions): Promise设置TCPSocket连接的其他属性。使用Promise方式作为异步方法。
ohos.net.socket.TCPSocketon(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketoff(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void取消订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketon(type: 'connect' | 'close', callback: Callback): void订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketoff(type: 'connect' | 'close', callback: Callback): void取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketon(type: 'error', callback?: ErrorCallback): void订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
ohos.net.socket.TCPSocketoff(type: 'error', callback?: ErrorCallback): void取消订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
ohos.net.socket.TLSSocketconnect(options: TLSConnectOptions, callback: AsyncCallback<void>): void在TLSSocket上进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，使用callback方式作为异步方法。
ohos.net.socket.TLSSocketconnect(options: TLSConnectOptions): Promise<void>在TLSSocket上进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，使用Promise方式作为异步方法。
ohos.net.socket.TLSSocketgetCertificate(callback: AsyncCallback<X509CertRawData>): void在TLSSocket通信连接之后，获取本地的数字证书，使用callback方式作为异步方法。
ohos.net.socket.TLSSocketgetCertificate():Promise<X509CertRawData>在TLSSocket通信连接之后，获取本地的数字证书，使用Promise方式作为异步方法。
ohos.net.socket.TLSSocketgetRemoteCertificate(callback: AsyncCallback<X509CertRawData>): void在TLSSocket通信连接之后，获取对等方的数字证书，使用callback方式作为异步方法。
ohos.net.socket.TLSSocketgetRemoteCertificate(): Promise<X509CertRawData>在TLSSocket通信连接之后，获取对等方的数字证书，使用Promise方式作为异步方法。
ohos.net.socket.TLSSocketgetProtocol(callback: AsyncCallback<string>): void在TLSSocket通信连接之后，获取通信的协议，使用callback方式作为异步方法。
ohos.net.socket.TLSSocketgetProtocol(): Promise<string>在TLSSocket通信连接之后，获取通信的协议，使用Promise方式作为异步方法。
ohos.net.socket.TLSSocketgetCipherSuite(callback: AsyncCallback<Array<string>>): void在TLSSocket通信连接之后，获取通信双方支持的加密套件，使用callback方式作为异步方法。
ohos.net.socket.TLSSocketgetCipherSuite(): Promise<Array<string>>在TLSSocket通信连接之后，获取通信双方支持的加密套件，使用Promise方式作为异步方法。
ohos.net.socket.TLSSocketgetSignatureAlgorithms(callback: AsyncCallback<Array<string>>): void在TLSSocket通信连接之后，获取通信双方支持的签名算法，使用callback方式作为异步方法。
ohos.net.socket.TLSSocketgetSignatureAlgorithms(): Promise<Array<string>>在TLSSocket通信连接之后，获取通信双方支持的签名算法，使用Promise方式作为异步方法。
ohos.net.socket.TLSSocketsend(data: string, callback: AsyncCallback<void>): void在TLSSocket通信连接之后，向服务端发送消息，使用callback方式作为异步方法。
ohos.net.socket.TLSSocketsend(data: string): Promise<void>在TLSSocket通信连接之后，向服务端发送消息，使用Promise方式作为异步方法。

 

NetAddress

目标地址信息。

参数名类型必填说明
addressstring是本地绑定的ip地址。
portnumber否端口号 ，范围0~65535。如果不指定系统随机分配端口。
familynumber否网络协议类型，可选类型：
- 1：IPv4
- 2：IPv6
默认为1。

 

UDPSendOptions

UDPSocket发送参数。

参数名类型必填说明
datastring是发送的数据。
addressNetAddress是目标地址信息。

 

UDPExtraOptions

UDPSocket连接的其他属性。

参数名类型必填说明
broadcastboolean否是否可以发送广播。默认为false。
receiveBufferSizenumber否接收缓冲区大小（单位：Byte）。
sendBufferSizenumber否发送缓冲区大小（单位：Byte）。
reuseAddressboolean否是否重用地址。默认为false。
socketTimeoutnumber否套接字超时时间，单位毫秒（ms）。

 

 

SocketStateBase

Socket的状态信息。

参数名类型必填说明
isBoundboolean是是否绑定。
isCloseboolean是是否关闭。
isConnectedboolean是是否连接。

 

SocketRemoteInfo

Socket的连接信息。

参数名类型必填说明
addressstring是本地绑定的ip地址。
familystring是网络协议类型，可选类型：
- IPv4
- IPv6
默认为IPv4。
portnumber是端口号，范围0~65535。
sizenumber是服务器响应信息的字节长度。

 

TCPConnectOptions

TCPSocket连接的参数。

参数名类型必填说明
addressNetAddress是绑定的地址以及端口。
timeoutnumber否超时时间，单位毫秒（ms）。

 

TCPSendOptions

TCPSocket发送请求的参数。

参数名类型必填说明
datastring是发送的数据。
encodingstring否字符编码(UTF-8，UTF-16BE，UTF-16LE，UTF-16，US-AECII，ISO-8859-1)，默认为UTF-8。

 

TCPExtraOptions

TCPSocket连接的其他属性。

参数名类型必填说明
keepAliveboolean否是否保持连接。默认为false。
OOBInlineboolean否是否为OOB内联。默认为false。
TCPNoDelayboolean否TCPSocket连接是否无时延。默认为false。
socketLingerObject是socket是否继续逗留。
- on：是否逗留（true：逗留；false：不逗留）。
- linger：逗留时长，单位毫秒（ms），取值范围为0~65535。
当入参on设置为true时，才需要设置。
receiveBufferSizenumber否接收缓冲区大小（单位：Byte）。
sendBufferSizenumber否发送缓冲区大小（单位：Byte）。
reuseAddressboolean否是否重用地址。默认为false。
socketTimeoutnumber否套接字超时时间，单位毫秒（ms）。

 

TLSConnectOptions

TLS连接的操作。

参数名类型说明
addressNetAddress网关地址。
secureOptionsTLSSecureOptionsTLS安全相关操作。
ALPNProtocolsArray<string>ALPN协议。

 

TLSSecureOptions

TLS安全相关操作。

参数名类型说明
castring | Array<string>ca证书。
certstring本地数字证书。
keystring本地数字证书私钥。
passwdstring密码。
protocolsProtocol | Array<Protocol>;协议名。
useRemoteCipherPreferboolean优先使用对等方的密码套件。
signatureAlgorithmsstring设置签名算法。
cipherSuitestring加密套件。

 

X509CertRawData

参数名类型说明
dataUint8Array证书内容。
encodingFormatnumber编码格式pem。

 

Protocol

TLS通信的协议。

protocol 的合法值说明
TLSv12使用TLSv1.2协议通信。
TLSv13使用TLSv1.3协议通信。

示例

import socket from "@ohos.net.socket"
let tcp = socket.constructTCPSocketInstance()
tcp.on("message", function (data) {
  console.log(JSON.stringify(data))
})
tcp.bind({
  address: "127.0.0.1",
  family: 1,
  port: 0
})
tcp.connect({
  address: {
    address: "127.0.0.1",
    family: 1,
    port: 8888
  }
})
tcp.send({
  data: "Hello World"
})

let udp = socket.constructUDPSocketInstance()
udp.bind({
  address: "127.0.0.1",
  family: 1,
  port: 0
})
udp.send({
  address: {
    address: "127.0.0.1",
    family: 1,
    port: 9999
  },
  data: "Hello World"
})

let tls = socket.constructTLSSocketInstance();
let Protocol = socket.Protocol;
let options = {
            ALPNProtocols: ["spdy/1", "http/1.1"],
            address: {
                address: "xxxx",
                port: "xxxx",
                family: 1,
            },
            secureOptions: {
                key: "xxxx",
                cert: "xxxx",
                ca: ["xxxx"],
                passwd: "123456",
                protocols: [Protocol.TLSv12],
                useRemoteCipherPrefer: true,
                signatureAlgorithms: rsa_pss_rsae_sha256:ECDSA+SHA25,
                cipherSuite: AES256-SHA256,
            },
};
tls.connect(options).then(data => {
  console.info(data);
}).catch(err => {
  console.error(err);
});
tls.getProtocol((err, data) => {
  if (err) {
    console.log("getProtocol callback error = " + err);
  } else {
    console.log("getProtocol callback = " + data);
  }
});
let data = "Hello Word";
tls.send(data, (err, data) => {
  if (err) {
    console.log("send callback error = " + err);
  } else {
    console.log("send callback = " + data);
  }
});

 

Logo
欢迎加入Laval社区

社区规范：仅讨论OpenHarmony相关问题。

更多推荐

通知栏时间显示异常

概述 在某些系统版本中，设备系统时间设置为 12 小时制，下午 13:00 发起一条通知，通知栏中显示的时间却是 01:00。这是一个时间格式转换的 bug——系统按 24 小时制处理了时间，但没有根据用户的 12 小时制设置做格式化，导致下午 13点被错误地显示为 01 点。 说明 这个问题的根源在于时间格式化时没有读取系统的时间制式配置。HarmonyOS 中获取系统时间格式的接口是

avatar Laval社区

【直播】OpenHarmony富对富-镜像投屏(miracast)

直播地址：https://meeting.tencent.com/dm/np3ya04A1lRc

avatar Laval社区

WSL2 Ubuntu 22.04 开发环境配置指南

WSL2 Ubuntu 22.04 开发环境配置指南 在上一期文章中，我们已经完成了 WSL（Windows Subsystem for Linux）的安装以及 Ubuntu 22.04 操作系统的安装。本期将继续深入，对刚安装好的 Ubuntu 环境进行一系列基础配置，包括新建用户、设置默认登录用户、修改主机名、查看安装位置、切换镜像源、资源配置以及 pyenv 安装等，帮助你将 WSL 环境

avatar Laval社区