red5简介及基础知识

• 简介

 

Red5的主要功能和Macromedia公司的FMS类似，提供基于Flash的流媒体服务的一款基于Java的开源流媒体服务器。它由Java语言编写，使用RTMP作为流媒体传输协议，这与FMS完全兼容。它具有流化FLV、MP3文件，实时录制客户端流为FLV文件，共享对象，实时视频播放、Remoting等功能。用Red5替换FMS后,客户端不用更改可正常运行。

提供red5相关的链接：

官网：http://www.red5.org/

下载地址：http://www.red5.org/downloads/

相关实例：http://trac.red5.org/wiki/Examples

相关文档：http://trac.red5.org/wiki/Documentation

 

 

 

• 运行部署实例

目前red5最高版本是1.0RC1，我用的是0.9.1Final版，red5具体使用例子网上有很多，在这我推荐一个网址，作者做了一个red5入门的视频，非常适合新手入门： http://plter.com/archives/524

 

注：如果red5还未入门，不建议看后面的内容。

• ApplicationAdapter类

ApplicationAdapter类是MultiThreadedApplicationAdapter的子类。ApplicationAdapter使用单线程的方式进行方法调用的消息出来，所以其性能不如MultiThreadedApplicationAdapter。MultiThreadedApplicationAdapter类，是Red5应用程序的基础类。它提供了操作SharedObjects 和 streams的方法，还有连接和服务列表，是一个应用程序基本的Iscope。通常应用开发，一般会继承ApplicationAdapter类。

在开发中，我们经常会接触如下几个方法，这些方法都是通过MultiThreadedApplicationAdapter实现：

Java代码  

1. //Red5应用程序启动时自动执行此方法  
2. public boolean appStart(IScope arg0)  

 //Red5应用程序停止时自动执行此方法

Java代码  

1. public void appStop(IScope arg0)  

 //flex客户端连接项目时自动运行的方法

Java代码  

1. public boolean appConnect(IConnection arg0, Object[] arg1)  

 //flex客户端与服务器断开连接时触发的方法

Java代码  

1. public void appDisconnect(IConnection arg0)  

 //flex客户端与服务器连接时运行，与appConnect比较类似

Java代码  

1. public boolean appJoin(IClient arg0, IScope arg1)  

 //flex客户端与服务器断开时运行，与appDisconnect类似

Java代码  

1. public void appLeave(IClient arg0, IScope arg1)  

 

 

• Red5关键API

Red5提供了很多接口供开发人员进行二次开发：

IConnection：连接对象。每个连接都有一个关联的客户端和域。连接可能是持续型、轮询型、或短暂型。建立此接口的目的，是为了给不同的子类，如 RTMPConnection，RemotingConnection，AJAXConnection， HttpConnection 等，提供基础通用的方法。它提供getClient()方法来获取客服端对象。

IScope ：每个Red5应用程序至少有一个域，用来搭建处理器、环景、服务器之间的连接。域可以构成树形结构，所有客户端都可以作为其节点共享域内的对象（比如流和数据）。所有的客服端(client)通过连接(connection)连接到域中。对于单一域，每个连接对应一个客服端，每个客服端对应一个id，简单的应用，操作就针对一个id和一个连接进行。

IServiceCapableConnection ：获取有效连接。代码中先获取到连接实例，然后判断是否是有效连接并强制类型转换，之后调取客户端相应函数。

IClient ：客户端对象代表某单一客户端。一个客户端可以和同一主机下不同的域分别建立连接。客户端对象和HTTP session 很相像。可以使用IClientRegistry.newClient(Object[])方法来创建IClient对象。

ApplicationAdapter：ApplicationAdapter是应用层级的IScope。若要处理流进程，需实现 IStreamAwareScopeHandler接口中的相应处理方法。ApplicationAdapter还提供了有效的事件处理机制，来进行截取流、确认用户等操作。同时，其子类中引入的方法均可在客户端通过 NetConnection 调取。在Aodbe 的FMS 中必须在服务器端维护客户端对象，与之相较，Red5 为您的远程请求提供了更加方便快捷的操作方法。

 

 

 

• 简单实例

【flex客户端连接red5服务器】

 

Actionscript提供了NetConnection与服务器连接，连接之后可以调用red5的方法，也可以指定client对象供red5调用。

下面这段代码是连接red5中某个自己创建的项目，并且通过事件监听连接状况：

Java代码  

1. //创建NetConnection实例  
2. var netConn:NetConnection = new NetConnection();  
3. //指定rtmp地址，并且向服务器传递一个参数值"hello"  
4. netConn.connect("rtmp://localhost/chatroom","hello");  
5. //添加NetStatus事件监听连接  
6. netConn.addEventListener(NetStatusEvent.NET_STATUS,function connStatus(e:NetStatusEvent):void{  
7.                         switch(e.info.code){  
8.                             //连接成功  
9.                             case "NetConnection.Connect.Success":  
10.                                 l_connStatus.text = "连接成功";  
11.                                 break;  
12.                             //服务器断开  
13.                             case "NetConnection.Connect.Closed":  
14.                                 l_connStatus.text = "连接断开";  
15.                                 break;  
16.                             //能连上，但被拒绝访问  
17.                             case "NetConnection.Connect.Failed":  
18.                                 l_connStatus.text = "连接拒绝";  
19.                                 break;  
20.                             default:  
21.                                 break;  
22.                         }  
23.                     });  

把这段代码放到flex事件中，当触发事件时就会连接red5.

 

 

【客户端调用服务器方法】

客户端调用服务器方法非常常用，有时你会主动向服务器获取视频资源，或者向服务器发送消息信息。

NetConnection的call(command:String,responder:Responder,...arguments)用于调用服务器方法，

command  指定被调用的服务器的方法名

responder 可选对象，用于处理服务器的返回值，这是回调的形式，所以需要实例化Responder对象，然后在对象体内创建一个方法获取服务器返回值，如果没有返回值，则方法参数为空即可。

arguments 可选参数，当在远程应用程序服务器上执行  command 参数中指定的方法时，这些参数将被传递给该方法

 

下面这段代码介绍向服务器发送消息的方法：

Java代码  

1. /** 
2.              * 发送消息 
3.              * */  
4.             protected function sendMsg():void  
5.             {  
6.                 netConn.call("sendMessage",new Responder(function result():void{  
7.                 }),uName,txt_msg.text);  
8.             }  

 服务器必须有一个sendMessage方法，并且带两个参数，以获取客户端传入的参数值：

Java代码  

1. public void sendMessage(String userName,String message){  
2.    ....  
3. }  

 因为当前方法没有返回值，所以Responder内的result方法参数为空，假如sendMessage方法返回String，则需要把Responder改成这样：

Java代码  

1. new Responder(function result(str:String):void{  
2.    ....  
3. })  

 

 

【服务器调用客户端】

比如一个会议系统，某个客户端下线，服务器必须及时通知其它客户端该客户下线的通知，所以必须主动访问客户端。

客户端为了允许服务器调用，需要在NetConnnection中指定client属性，该属性就是指定服务器能访问客户端的对象范围，可以指定某个方法，也就是服务器只能访问那个方法，也可以把整个mxml对象都指定为client，这样服务器就可以访问mxml对象内的元素了。

通常指定client是在连接服务器的时候：

Xml代码  

1. //指定连接client，方便red5调用当前客户端的方法  
2. netConn.client = this;  

 在flex中创建一个普通的方法：

Java代码  

1. /** 
2.              * 【供red5调用的方法】 
3.              * 客户端与red5连接时，red5向客户端返回的消息 
4.              * */  
5.             public function connection_msg(str:String):void{  
6.                 Alert.show(str);  
7.             }  

 

red5服务器端需要IServiceCapableConnection.invoke调用客户端，它是IConnection的子接口，所以只要找到IConnection就可以调用IServiceCapableConnection了：

invoke(String str,Object[] objs)方法第一个参数表示客户端的方法名，第二个参数表示客户端方法中必须传入的参数值。

Java代码  

1. public boolean appConnect(IConnection arg0, Object[] arg1) {  
2.     callClient(arg0,"通知客户端连接成功");  
3.     return super.appConnect(arg0, arg1);  
4. }  
5.   
6. /** 
7.      * Function  : red5调用客户端connection_msg方法，返回相应信息 
8.      * @author   : bless<505629625@qq.com> 
9.      * @param conn 
10.      * @param str 
11.      */  
12.     private void callClient(IConnection conn,String str){  
13.         if(conn instanceof IServiceCapableConnection){  
14.             IServiceCapableConnection sc = (IServiceCapableConnection) conn;  
15.             sc.invoke("connection_msg", new Object[]{str});  
16.         }  
17.     }  

 

 

【通知其它在线用户】

通过IConnection.getScope()获取域中其它用户，再一次迭代通知每一个域中的客户

Java代码  

1. public boolean appConnect(IConnection arg0, Object[] arg1) {  
2.      //通知其它用户该用户上线  
3.      notifyAppConnect(arg0.getScope(),"用户A上线啦");  
4. }  
5.   
6. /** 
7.      * Function  : 通知其它客户，用户上线信息 
8.      * @author   : bless<505629625@qq.com> 
9.      * @param scope 
10.      */  
11.     private void notifyAppConnect(IScope scope,String userName){  
12.         //遍历所有链接到服务器的客户端  
13.         Collection<Set<IConnection>> col = scope.getConnections();  
14.         for (Set<IConnection> set : col) {  
15.             for (IConnection iConnection : set) {  
16.                 //通知有所客户端上线用户信息  
17.                 if(iConnection instanceof IServiceCapableConnection){  
18.                     IServiceCapableConnection sc = (IServiceCapableConnection) iConnection;  
19.                     sc.invoke("otherConnection_msg", new Object[]{userName});  
20.                 }  
21.             }  
22.         }  
23.     }  

 

【服务器指定计划任务】

计划任务可以让服务器定时循环做一些事，比如定时向客户端发送消息提示之类的。

MultiThreadedApplicationAdapter.addScheduledJob(int interval, IScheduledJob job)

interval表示多少毫秒运行一次该计划，但是是毫秒哦

job是IScheduledJob接口，你必须实现IScheduledJob接口

比较常用的方式是在当前服务器核心类实现IScheduledJob接口并且重写execute(ISchedulingService arg0)方法：

Java代码  

1. public class HelloRed5 extends ApplicationAdapter implements IScheduledJob{  
2.           public boolean appStart(IScope arg0) {  
3.         System.out.println("启动 appStart");  
4.         //添加计划任务  
5.         this.addScheduledJob(10000, this);  
6.         return super.appStart(arg0);  
7.       }  
8.             
9.            /** 
10.      * IScheduledJob接口实现方法 
11.      */  
12.     @Override  
13.     public void execute(ISchedulingService arg0)  
14.             throws CloneNotSupportedException {  
15.                 //运行定时任务的实际方法  
16.         callEvery(this.getScope(),"运行下计划任务...");  
17.     }  
18. }  

 

 

把这几种交互方式和基本概念掌握清楚，就能编写一个简单的聊天程序了。