pomelo-baidu-client
v1.0.2
Published
pomelo百度小程序客户端
Downloads
12
Maintainers
Readme
pomelo-baidu-client
pomelo 客户端的百度小程序实现
安装
npm install pomelo-baidu-client
或者使用单文件版,移步releases
单文件版无需使用 npm,支持 AMD/CMD 等打包方式,可以直接 require
使用
const pomelo = require("pomelo-baidu-client");
// 普通模式,用于生产环境,会生成wss://example.com/ws/3005类似的地址,需要nginx支持
pomelo.init(
{
host: host,
port: port
},
function() {
console.log("success");
}
);
// 调试模式,用于本地开发,生成普通链接ws://example.com:3005
pomelo.init(
{
host: host,
port: port,
debugMode: true
},
function() {
console.log("success");
}
);
// 浏览器调试模式,用于本地开发,使用浏览器原生WebSocket,生成普通链接ws://example.com:3005
pomelo.init(
{
host: host,
port: port,
debugMode: true,
browserWS: true
},
function() {
console.log("success");
}
);
// 如果需要多个连接实例,可以用newInstance方法生成
const pomelo2 = pomelo.newInstance();
具体使用方法见官方的websocket版本客户端说明
额外增加的功能:
全局监听消息(排除已用 request 设置回调的消息)
pomelo.on("onMessage", data => {
console.log("onMessage", data);
});
特别说明
百度仅支持 wss 连接(https)并且不支持自定义端口号,因此在服务器端进行额外的处理
例如以下代码:
pomelo.init({
host: "example.com",
port: 3005
});
实际上连接的是wss://example.com/ws/3005/
需要在服务器端将以上连接转换为ws://example.com:3005
这里提供 nginx 的例子:
server
{
listen 443 ssl http2 default_server;
listen [::]:443 ssl http2 default_server;
server_name example.com;
ssl on;
#证书文件
ssl_certificate /etc/ssl/certs/ssl-cert.crt;
#私钥文件
ssl_certificate_key /etc/ssl/private/ssl-cert.key;
ssl_session_timeout 5m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
ssl_ciphers AESGCM:ALL:!DH:!EXPORT:!RC4:+HIGH:!MEDIUM:!LOW:!aNULL:!eNULL;
ssl_prefer_server_ciphers on;
location /ws/3005/ {
proxy_pass http://127.0.0.1:3005;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
}
License
MIT © Wang Sijie