需求描述很简单:Android 发送数据到 Web 网页上。
系统: Ubuntu 14.04 + apache2 + php5 + Android 4.4
思路是 socket + 消息队列 + 服务器发送事件,下面的讲解步骤为 Android 端,服务器端,前端。重点是在于 PHP 进程间通信。
Android 端比较直接,就是一个 socket 程序。需要注意的是,如果直接在活动主线程里面创建 socket 会报一个 android.os.NetworkOnMainThreadException, 因此最好的方法是开个子线程来创建 socket,代码如下
private Socket socket = null; private boolean connected = false; private PrintWriter out; private BufferedReader br; private void buildSocket(){ if(socket != null) return; try { socket = new Socket("223.3.68.101",54311); //IP地址与端口号 out = new PrintWriter( new BufferedWriter( new OutputStreamWriter( socket.getOutputStream())), true); br = new BufferedReader( new InputStreamReader(socket.getInputStream())); } catch (IOException e) { e.printStackTrace(); } connected = true; }
然后是发送消息
public void sendMsg(String data){ if(!connected || socket == null) return; synchronized (socket) { try { out.println(data); } catch (Exception e) { e.printStackTrace(); } } }
完成后还需要关闭 socket
private void closeSocket(){ if( socket == null) return; try { socket.close(); out.close(); br.close(); } catch (IOException e) { e.printStackTrace(); } socket = null; connected = false; }
注意这些方法都不要在主线程执行。
下面是服务器 PHP 端。
首先要运行一个进程来接收信息。
function buildSocket($msg_queue){ $address = "223.3.68.101"; $port = 54321; if (($sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) === false){ echo "socket_create() failed:" . socket_strerror(socket_last_error()) . "/n"; die; } echo "socket create\n"; if (socket_set_block($sock) == false){ echo "socket_set_block() faild:" . socket_strerror(socket_last_error()) . "\n"; die; } if (socket_bind($sock, $address, $port) == false){ echo "socket_bind() failed:" . socket_strerror(socket_last_error()) . "\n"; die; } if (socket_listen($sock, 4) == false){ echo "socket_listen() failed:" . socket_strerror(socket_last_error()) . "\n"; die; } echo "listening\n"; if (($msgsock = socket_accept($sock)) === false) { echo "socket_accept() failed: reason: " . socket_strerror(socket_last_error()) . "\n"; die; } $buf = socket_read($msgsock, 8192); while(true){ if(strlen($buf) > 1) handleData($buf,$msg_queue); //见后文 $buf = socket_read($msgsock, 8192); //看情况 break 掉 } socket_close($msgsock); }
也比较简单。这个进程是独立运行的,那么打开网页请求数据,需要从另一段脚本接入,下面就需要用到进程间通信,我选择消息队列,也就是上面的 $msg_queue 变量。
脚本主程序这么写。
$msg_queue_key = ftok(__FILE__,'socket'); //__FILE__ 指当前文件名字 $msg_queue = msg_get_queue($msg_queue_key); //获取已有的或者新建一个消息队列 buildSocket($msg_queue); socket_close($sock);
其中的 ftok() 函数就是生成一个队列的 key,以区分。
那么handleData() 的任务就是把收到的消息放到队列里面去
function handleData($dataStr, $msg_queue){ msg_send($msg_queue,1,$dataStr); }
Socket 进程脚本骨架
<?php //socket.php 服务器进程 function buildSocket($msg_queue){ } function handleData($dataStr, $msg_queue){ } set_time_limit(0); $msg_queue_key = ftok(__FILE__,'socket'); $msg_queue = msg_get_queue($msg_queue_key); buildSocket($msg_queue); socket_close($sock); ?>
这样一来,其他进程就可以通过 key 找到这个队列,从里面读取消息了。使用这样可读
function redFromQueue($message_queue){ msg_receive($message_queue, 0, $message_type, 1024, $message, true, MSG_IPC_NOWAIT); echo $message."\n\n"; } $msg_queue_key = ftok("socket.php", 'socket'); //第一个变量为上方socket进程的文件名。 $msg_queue = msg_get_queue($msg_queue_key, 0666); while(true){ $msg_queue_status = msg_stat_queue($msg_queue); //获取消息队列的状态 if($msg_queue_status["msg_qnum"] == 0) //如果此时消息队列为空,那么跳过,否则会读取空行。 continue; redFromQueue($msg_queue); }
现在就差最后一步,如何主动把数据发往前端?这要用到 HTML5 的新特性:服务器发送事件(要使用较新的非 IE 浏览器,具体查看这里)。直接看JS代码
var source = new EventSource("php/getData.php"); //Web 服务器路径 source.onmessage = function(event){ //消息事件回调 var resData = event.data; document.getElementById("res").innerHTML=resData; };
那么这个 getData.php 就是上面那个从消息队列获取数据的脚本。只是为了让它被识别为服务器事件,需要加一点格式上的说明,具体如下。
<?php //getData.php,提供给 Web 请求使用。 //声明文档类型 header('Content-Type: text/event-stream'); header('Cache-Control: no-cache'); function redFromQueue($message_queue){ msg_receive($message_queue, 0, $message_type, 1024, $message, true, MSG_IPC_NOWAIT); echo "data:".$message."\n\n"; //注意一定要在数据前面加上 “data:” flush(); //立刻 flush 一下 } $msg_queue_key = ftok("socket.php", 'socket'); $msg_queue = msg_get_queue($msg_queue_key, 0666); echo "data:connected\n\n"; flush(); while(true){ $msg_queue_status = msg_stat_queue($msg_queue); if($msg_queue_status["msg_qnum"] == 0) continue; redFromQueue($msg_queue); } ?>
下面就可以开始运行,首先运行服务器
php socket.php
打印了 listening 就可以使用 Android 设备连接了。
然后再用 Web 上 JS 请求 getData 脚本,请求后前台可以不断地获得新的数据。需要注意的是消息队列可能会阻塞(消息量达到上限),再有就是 JS 本身消息机制的限制,因此丢失,延迟等现象频发。
Web 通信的老问题就是稳定性。以前老是怨恨 Web QQ 掉包,其实整个 Web 革命尚未成功。