WebSocket是一種網(wǎng)絡(luò)通訊協(xié)議，很多網(wǎng)絡(luò)開(kāi)發(fā)工作者都需要它。本文介紹在OpenHarmony上WebSocket協(xié)議的使用方法。
??想了解更多關(guān)于開(kāi)源的內(nèi)容，請(qǐng)?jiān)L問(wèn)：??
??51CTO 開(kāi)源基礎(chǔ)軟件社區(qū)??
??https://ost.51cto.com??
WebSocket是一種網(wǎng)絡(luò)通訊協(xié)議，很多網(wǎng)絡(luò)開(kāi)發(fā)工作者都需要它。本文介紹在OpenHarmony上WebSocket協(xié)議的使用方法。
WebSocket有什么不同
很多人會(huì)問(wèn)，有了HTTP協(xié)議，尤其是RESTFul接口，為什么還需要使用WebSocket？它能帶來(lái)什么好處呢？那是因?yàn)镠TTP協(xié)議有一個(gè)缺陷，通訊只能由客戶(hù)端發(fā)起。簡(jiǎn)單舉例，我們的天氣應(yīng)用程序需要查詢(xún)天氣就需要客戶(hù)端向服務(wù)器請(qǐng)求數(shù)據(jù)，服務(wù)器查詢(xún)后返回結(jié)果。但是如果天氣有變化，客戶(hù)端是無(wú)法收到服務(wù)端推送過(guò)來(lái)的消息，所以只能定時(shí)調(diào)用或者用戶(hù)手動(dòng)刷新。
這種單向請(qǐng)求導(dǎo)致需要雙向通訊的應(yīng)用只能在客戶(hù)端采用輪詢(xún)的手段來(lái)實(shí)現(xiàn)，引申出來(lái)的問(wèn)題就是效率低，服務(wù)端負(fù)載大。所以就誕生了WebSocket。
WebSocket簡(jiǎn)介
WebSocket協(xié)議誕生于2008年，2011年成為國(guó)際標(biāo)準(zhǔn)，所有瀏覽器都支持。它最大的特點(diǎn)就是雙向平等對(duì)話，屬于服務(wù)器推送技術(shù)的一種。
特點(diǎn)：
- 在TCP協(xié)議上層，服務(wù)器端的實(shí)現(xiàn)比較容易。
- 與HTTP協(xié)議有著良好的兼容性。默認(rèn)端口也是80和443，并且握手階段采用 HTTP 協(xié)議，因此握手時(shí)不容易屏蔽，能通過(guò)各種 HTTP 代理服務(wù)器。
- 數(shù)據(jù)格式比較輕量，性能開(kāi)銷(xiāo)小，通信高效。
- 可發(fā)送文本，也可發(fā)送二進(jìn)制數(shù)據(jù)。
- 沒(méi)有同源限制，客戶(hù)端可以與任意服務(wù)器通信。
- 協(xié)議標(biāo)識(shí)符是ws（如果加密，則為wss），服務(wù)器網(wǎng)址就是URL。
WebSocket在OpenHarmony上的實(shí)現(xiàn)
WebSocket在OpenHarmony上的使用
- 導(dǎo)入d.ts文件
//導(dǎo)入websocket接口
import webSocket from '@ohos.net.webSocket'
//websocket的基本接口函數(shù)
connect(url: string, callback: AsyncCallback<boolean>): void;
send(data: string | ArrayBuffer, callback: AsyncCallback<boolean>): void;
close(callback: AsyncCallback<boolean>): void;
- 基本的websocket流程
let promise = socket.connect(url)
promise.then((value) => {
Logger.info(TAG, `connect success`)
}).catch((err) => {
Logger.info(TAG, `connect fail, error:${JSON.stringify(err)}`)
})
socket.on('open', (err, value) => {
prompt.showToast({ message: '連接成功', duration: 1500 })
})
socket.on('message', (err, value) => {
Logger.info(TAG, `on message, value = ${value}`)
})
Framework層的實(shí)現(xiàn)
- Napi接口實(shí)現(xiàn)。
//foundation/communication/netstack/frameworks/js/napi/websocket/websocket_module/src/websocket_module.cpp
std::initializer_list<napi_property_descriptor> properties = {
DECLARE_NAPI_FUNCTION(WebSocket::FUNCTION_CONNECT, WebSocket::Connect),
DECLARE_NAPI_FUNCTION(WebSocket::FUNCTION_SEND, WebSocket::Send),
DECLARE_NAPI_FUNCTION(WebSocket::FUNCTION_CLOSE, WebSocket::Close),
DECLARE_NAPI_FUNCTION(WebSocket::FUNCTION_ON, WebSocket::On),
DECLARE_NAPI_FUNCTION(WebSocket::FUNCTION_OFF, WebSocket::Off),
};
ModuleTemplate::DefineClass(env, exports, properties, INTERFACE_WEB_SOCKET);
- 異步執(zhí)行動(dòng)作。
//foundation/communication/netstack/frameworks/js/napi/websocket/async_work/src/websocket_async_work.cpp
//初始化libwebsocket需要的callback
static const lws_protocols LWS_PROTOCOLS[] = {
{"lws-minimal-client", WebSocketExec::LwsCallback, 0, 0},
{nullptr, nullptr, 0, 0}, // this line is needed
};
//填裝websocket上下文信息
static inline void FillContextInfo(lws_context_creation_info &info)
{
info.options = LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT;
info.port = CONTEXT_PORT_NO_LISTEN;
info.protocols = LWS_PROTOCOLS;
info.fd_limit_per_thread = FD_LIMIT_PER_THREAD;
}
void WebSocketAsyncWork::ExecConnect(napi_env env, void *data)
{
BaseAsyncWork::ExecAsyncWork<ConnectContext, WebSocketExec::ExecConnect>(env, data);
}
void WebSocketAsyncWork::ExecSend(napi_env env, void *data)
{
BaseAsyncWork::ExecAsyncWork<SendContext, WebSocketExec::ExecSend>(env, data);
}
void WebSocketAsyncWork::ExecClose(napi_env env, void *data)
{
BaseAsyncWork::ExecAsyncWork<CloseContext, WebSocketExec::ExecClose>(env, data);
}
- 執(zhí)行結(jié)果日志打印。
//正確連接
I C015b0/NetMgrSubsystem: NETSTACK [connect_context.cpp 43] ConnectContext NapiUtils::GetValueType(GetEnv(), params[1]) == napi_function
I C015b0/NetMgrSubsystem: NETSTACK [module_template.h 61] js params parse OK ? 1
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 471] begin connect, parse url
E C015b0/NetsysNativeService: [HookSocket-(netsys_sock_client.cpp:45)]musl create socket failed
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 228] start service
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 533] ConnectCallback connect success
//錯(cuò)誤連接
I C015b0/NetMgrSubsystem: NETSTACK [connect_context.cpp 43] ConnectContext NapiUtils::GetValueType(GetEnv(), params[1]) == napi_function
I C015b0/NetMgrSubsystem: NETSTACK [module_template.h 61] js params parse OK ? 1
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 471] begin connect, parse url
E C015b0/NetsysNativeService: [HookSocket-(netsys_sock_client.cpp:45)]musl create socket failed
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 358] LwsCallbackClientConnectionError DNS NXDOMAIN
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 427] LwsCallbackWsiDestroy
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 515] ExecConnect websocket connect failed
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 433] LwsCallbackProtocolDestroy
I C015b0/NetMgrSubsystem: NETSTACK [websocket_exec.cpp 530] ConnectCallback connect failed
小結(jié)
OpenHarmony目前已支持WebSocket調(diào)用，通過(guò)回調(diào)函數(shù)返回調(diào)用結(jié)果。
??想了解更多關(guān)于開(kāi)源的內(nèi)容，請(qǐng)?jiān)L問(wèn)：??
??51CTO 開(kāi)源基礎(chǔ)軟件社區(qū)??
??https://ost.51cto.com??
