npm包socket-req使用教程

前言

在前后端分离的开发模式中，前端需要与后端不断地进行通信。而socket技术则是实现双向通信的一种重要工具。本文主要介绍npm包socket-req的使用教程。

socket-req介绍

socket-req是一个可以用于浏览器和Node.js的客户端的socket请求库。它使用了Promise API和xhr post请求机制，可以让您更容易地往您的socket服务器发送请求，并获取服务器回馈的响应。

安装

使用npm包管理器安装socket-req：

npm install socket-req

使用方法

初始化

在使用socket-req之前，我们需要先初始化。

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

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

其中，各参数含义如下：

• domain: 填写您的socket服务器域名。
• port: 填写您的socket服务器端口号。
• path: 填写您的socket服务器的路径，默认为/socket.io。
• protocol: 填写您的socket服务器使用的协议，例如http、https等。
• token: 可选参数，填写您的身份认证token。

发送请求

socket-req提供了两个方法来发送请求：

1. sendMsg

import { sendMsg } from 'socket-req';

sendMsg('request code').then((res) => console.log(res));

其中，request code为您的请求信息。

2. emit

import { emit } from 'socket-req';

emit('request code', (res) => {
  console.log(res);
});

其中，第一个参数request code为您的请求信息，第二个参数为回调函数，可选。

连接状态

socket-req提供了以下的连接状态供使用者进行监听，并进行适当的逻辑处理。

disconnected

import { onSocketStateChange, socketState } from 'socket-req';

onSocketStateChange((state) => {
  if (state === socketState.disconnected) {
    console.log('socket状态已经断开');
  }
});

reconnecting

import { onSocketStateChange, socketState } from 'socket-req';

onSocketStateChange((state) => {
  if (state === socketState.reconnecting) {
    console.log('socket正尝试重新连接');
  }
});

connected

import { onSocketStateChange, socketState } from 'socket-req';

onSocketStateChange((state) => {
  if (state === socketState.connected) {
    console.log('socket已连接');
  }
});

示例

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

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

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

结语

socket-req是一个可以方便地实现与socket服务器进行通讯的npm包。通过阅读本文使用教程，您已经可以轻松上手使用socket-req了。希望本文能对有需要的读者有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005664d81e8991b448e26e7