SIP 简介,第 2 部分:SIP Servlet



 作者:Emmanuel Proulxb8H思考者日记网-束洋洋个人博客

摘要

会话发起协议 (SIP) 是一种重要的信令协议,电信行业正在迅速采用这种协议以构建下一代应用程序。Java 是 SIP 开发的杰出平台,尤其是在进行服务器端开发时。与 HTTP servlet 相似,SIP Servlet API 可以使 SIP 服务的开发变得更轻松。本文将介绍 SIP servlet 技术,并提供一个带有注释的示例。b8H思考者日记网-束洋洋个人博客

简介

即时消息传递正在改变人们的生活。它是一种非常有价值的工具,结合了电子邮件、互联网电话以及文件传输应用程序的优点。我甚至可以看到谁在线、谁在忙碌。当然,人们也可以用它来长时间地进行不创造任何效益的聊天。但它也使我能够在上司与客户会谈的过程中为他提供必要的关键信息。b8H思考者日记网-束洋洋个人博客

因此,市面上出现如此之多的不同种类的即时消息传递应用程序也就不足为怪了。有这么多的选择总是件好事,不是吗?但如果我使用的应用程序与上司使用的不同,情况又会如何?我将陷入大麻烦,因为大多数此类应用程序都使用专用协议。b8H思考者日记网-束洋洋个人博客

SIP 为我们带来了福音。SIP 很有可能成为标准的即时消息传递协议。b8H思考者日记网-束洋洋个人博客

在本文中,我将开发一个简单的 SIP 应用程序 — 一个允许 SIP 即时消息传递程序彼此联系并互相传播消息的聊天室服务器端。b8H思考者日记网-束洋洋个人博客

SIP SIMPLE

SIMPLE 是 SIP 即时消息传递和在线状态利用扩展 (SIP Instant Messaging and Presence Leveraging Extension) 的缩写,这是一个工作组,也是一组 SIP 扩展。其中的一个扩展是 MESSAGE 消息。可以用它来发送包含文本和二进制内容的任何组合的即时消息。这种消息使用起来极为简单,因此我决定利用它来开发我们的第一个 SIP 应用程序。b8H思考者日记网-束洋洋个人博客

TextClient

为了测试我们的应用程序,我提供了一个简单的 SIP 即时消息传递应用程序。(请参见本文结尾处的“下载”部分。)这个应用程序向其他消息传递程序或服务器发送 MESSAGE 消息。用户界面包括客户端地址、好友地址的输入域、文本消息和提交按钮。图 1 显示了正在运行的 TextClient。b8H思考者日记网-束洋洋个人博客

图 1 b8H思考者日记网-束洋洋个人博客
图 1. 运行中的 TextClientb8H思考者日记网-束洋洋个人博客

要启动 TextClient,请使用以下命令:b8H思考者日记网-束洋洋个人博客

java -jar textclient.jar dev2dev.textclient.TextClient username portb8H思考者日记网-束洋洋个人博客

该命令使用 JAIN SIP API 参考实现作为一个 SIP 协议栈。我们提供了该工具的源代码,如果您希望了解更多信息,我建议您读一下源代码。b8H思考者日记网-束洋洋个人博客

ChatRoomServer

下面是我们示例的需求:b8H思考者日记网-束洋洋个人博客

聊天室是一个虚拟空间,多个即时消息传递应用程序可以在其中进行交互。进入聊天室的消息将广播给聊天室中的所有其他人。换言之,所有用户都能看到所有消息。这意味着,在消息到达我们的服务器应用程序时,用户地址将被添加到一个列表中。然后,消息将发送给该列表中的所有用户。b8H思考者日记网-束洋洋个人博客

此外,还可以实现“命令”。命令以正斜杠 (/) 开头,不会被广播,而是由服务器自己处理来实现特殊功能。我将实现的命令包括:b8H思考者日记网-束洋洋个人博客

  • /join:默默地进入一个聊天室,不广播任何消息。
  • /who:输出该聊天室内所有用户的列表。
  • /quit:离开聊天室,不再有消息传入。

SIP Servlet API

SIP Servlet API (JSR 116) 是一个服务器端接口,描述了 SIP 组件或服务的容器。这是开发 ChatRoomServer 的理想之选。下载该规范并进行解压缩。生成的文件夹中包含一些库(servlet.jar 和 sipservlet.jar)以及文档。我无法获得运行示例 SIP servlet 的参考实现,因此我想您也不必费心去找它了。b8H思考者日记网-束洋洋个人博客

SIP servlet 最核心的概念是包容。SIP 服务是部署或运行在一个容器或 SIP 应用服务器上的打包 SIP servlet。容器提供了多种可供应用程序利用的服务,如自动重试、消息调度和排队、分流与合并、状态管理。您的应用程序仅包含高级的消息处理和业务逻辑。这使得 SIP 服务的开发轻而易举。b8H思考者日记网-束洋洋个人博客

 b8H思考者日记网-束洋洋个人博客

本文的目标不是要帮助您了解 SIP Servlet API 技术的方方面面。因此我只简要介绍了该 API 和示例代码。有关更多信息,请参见本文结尾处的“参考资料”一节。b8H思考者日记网-束洋洋个人博客

服务器端代码

如果您过去从事过 HTTP servlet 的开发,那么服务器端代码看起来应该非常熟悉。如果您不了解 servlet,那么应该先自行熟悉一下。SIP Servlet 规范是 HTTP Servlet 规范的扩展。语法、容器的行为甚至方法名称都是相似的。b8H思考者日记网-束洋洋个人博客

现在,我将详细分析相关示例。它大体上包含三个部分:b8H思考者日记网-束洋洋个人博客

1. 生命周期方法

在 servlet 启动或者关闭时,容器将调用这些方法b8H思考者日记网-束洋洋个人博客

public class ChatRoomServer extends SipServlet {  
  
/** Context attribute key to store user list. */  
public static String THE_LIST="dev2dev.chatroomserver.userList";  
  
/** Init parameter key to retrieve the chat room's address. */  
public static String THE_NAME="dev2dev.chatroomserver.name";  
  
/** This chat room server's address, retrieved from the init params. */  
public String serverAddress;  
  
/** This is called by the container when starting up the service. */  
public void init() throws ServletException {  
    super.init();  
    getServletContext().setAttribute(THE_LIST,new ArrayList());  
    serverAddress = getServletConfig().getInitParameter(THE_NAME);  
}  
  
/** This is called by the container when shutting down the service. */  
public void destroy() {  
    try  
    {  
        sendToAll(serverAddress, "Server is shutting down -- goodbye!");  
    } catch (Throwable e)  
    { //ignore all errors when shutting down.  
        e.printStackTrace();  
    }  
    super.destroy();  
}  
...  

在初始化方法中,我创建一个所有会话共享的全局(上下文范围)属性。这是用户的列表。我还检索了这个聊天室的地址(servlet 参数)以备将来使用。b8H思考者日记网-束洋洋个人博客

2. 消息处理方法

SIP servlet 与 HTTP servlet 略有不同。对于 HTTP servlet,您处理传入的请求,并发出响应消息。而对于 SIP servlet,您可以同时发送和接收请求和响应。下面将说明具体方法。b8H思考者日记网-束洋洋个人博客

收到消息(请求和响应)时,容器将调用以下方法。容器按照下面图标中的顺序调用这些方法,您也可以改写这些方法来根据消息的类型处理消息:b8H思考者日记网-束洋洋个人博客

void service(ServletRequest, ServletResponse)如果您对其进行改写,不要忘记调用 super.service()。默认实现调用以下方法之一:
void doRequest(SipServletRequest)如果您对其进行改写,不要忘记调用 super.doRequest()。默认实现调用以下方法之一: void doResponse(SipServletResponse)如果您对其进行改写,不要忘记调用 super.doResponse()。默认实现调用以下方法之一:
以下请求方法之一(自解释):
  • doAck(SipServletRequest)
  • doBye(SipServletRequest)
  • doCancel(SipServletRequest)
  • doInfo(SipServletRequest)
  • doInvite(SipServletRequest)
  • doMessage(SipServletRequest)
  • doNotify(SipServletRequest)
  • doOptions(SipServletRequest)
  • doPrack(SipServletRequest)
  • doRegister(SipServletRequest)
  • doRequest(SipServletRequest)
  • doResponse(SipServletResponse)
  • doSubscribe(SipServletRequest)
以下响应方法之一:
  • doProvisionalResponse(SipServletResponse) — 对应于 1xx 类响应消息。
  • doSuccessResponse(SipServletResponse) — 对应于 2xx 类响应消息。
  • doRedirectResponse(SipServletResponse) — 对应于 3xx 类响应消息。
  • doErrorResponse(SipServletResponse) — 对应于 4xx、5xx 和 6xx 类响应消息。

例如,一条 MESSAGE 消息可能会调用以下方法:b8H思考者日记网-束洋洋个人博客

  1. service(),传入一个 SipServletRequest(您必须进行类型转换)和 null
  2. doRequest()
  3. doMessage()

通常只重写最后一级的方法,除非使用了非标准 SIP 消息或者您希望收集有关消息的统计数据。b8H思考者日记网-束洋洋个人博客

现在,对于处理我们的即时消息的代码:b8H思考者日记网-束洋洋个人博客

/** This is called by the container when a MESSAGE message arrives. */  
protected void doMessage(SipServletRequest request) throws  
        ServletException, IOException {  
  
    request.createResponse(SipServletResponse.SC_OK).send();  
  
    String message = request.getContent().toString();  
    String from = request.getFrom().toString();  
  
    //A user asked to quit.  
    if(message.equalsIgnoreCase("/quit")) {  
        sendToUser(from, "Bye");  
        removeUser(from);  
        return;  
    }  
  
    //Add user to the list  
    if(!containsUser(from)) {  
        sendToUser(from, "Welcome to chatroom " + serverAddress +  
                ". Type '/quit' to exit.");  
        addUser(from);  
    }  
  
    //If the user is joining the chat room silently, no message  
    //to broadcast, return.  
    if(message.equalsIgnoreCase("/join")) {  
        return;  
    }  
  
    //We could implement more IRC commands here,  
    //see http://www.mirc.com/cmds.html  
    sendToAll(from, message);  
}  
  
/** 
 * This is called by the container when an error is received 
 * regarding a sent message, including timeouts. 
 */  
protected void doErrorResponse(SipServletResponse response)  
        throws ServletException, IOException {  
    super.doErrorResponse(response);  
    //The receiver of the message probably dropped off. Remove  
    //the receiver from the list.  
    String receiver = response.getTo().toString();  
    removeUser(receiver);  
}  
  
/** 
 * This is called by the container when a 2xx-OK message is 
 * received regarding a sent message. 
 */  
protected void doSuccessResponse(SipServletResponse response)  
        throws ServletException, IOException {  
    super.doSuccessResponse(response);  
    //We created the app session, we have to destroy it too.  
    response.getApplicationSession().invalidate();  
}  

在一条 MESSAGE 消息到达时,将调用第一个方法。它首先回复一条 200 OK 消息,表明已经收到了消息。随后将处理服务器命令,如/join。最后,它调用一个业务逻辑方法来广播传入的消息。b8H思考者日记网-束洋洋个人博客

传入的错误响应消息表明上一个请求失败了。这可能意味着一名用户断开了连接。只需从列表中删除该用户即可。b8H思考者日记网-束洋洋个人博客

成功响应消息则意味着即时消息传递程序已经正确接收了上一条 MESSAGE 消息。我们不再需要会话,因此我们将丢弃它。通常情况下,MESSAGE 消息是以无状态的形式发送的,消息之间不会保留连接信息。(对于 INVITE 消息来说,情况并非如此,它会打开一个有状态的会话,直至发送 BYE 为止。)b8H思考者日记网-束洋洋个人博客

3. 业务逻辑代码

代码的其余部分由 helper 方法组成。前两种方法将消息外发至即时消息传递程序。要发送一条消息,请使用工厂来创建:b8H思考者日记网-束洋洋个人博客

  • 一个 SipApplicationSession(稍后将详细介绍)
  • 一条请求消息

此时,我们可以随心所欲地修改消息。在我们的例子中,我们在有效负载中添加了即时消息文本。最后,我们发送这条消息。b8H思考者日记网-束洋洋个人博客

private void sendToAll(String from, String message)  
        throws ServletParseException, IOException {  
    SipFactory factory = (SipFactory)getServletContext().  
        getAttribute("javax.servlet.sip.SipFactory");  
  
    List list = (List)getServletContext().getAttribute(THE_LIST);  
    Iterator users = list.iterator();  
    while (users.hasNext()) { //Send this message to all on the list.  
        String user = (String) users.next();  
  
        SipApplicationSession session =  
            factory.createApplicationSession();  
        SipServletRequest request = factory.createRequest(session,  
                "MESSAGE", serverAddress, user);  
        String msg = from + " sent message: n" + message;  
        request.setContent(msg.getBytes(), "text/plain");  
        request.send();  
    }  
}  
  
private void sendToUser(String to, String message)  
        throws ServletParseException, IOException {  
    SipFactory factory = (SipFactory)getServletContext().  
        getAttribute("javax.servlet.sip.SipFactory");  
    SipApplicationSession session = factory.createApplicationSession();  
    SipServletRequest request = factory.createRequest(session,  
            "MESSAGE", serverAddress, to);  
    request.setContent(message.getBytes(), "text/plain");  
    request.send();  
}  
  
private boolean containsUser(String from) {  
    List list = (List)getServletContext().getAttribute(THE_LIST);  
    return list.contains(from);  
}  
  
private void addUser(String from) {  
    List list = (List)getServletContext().getAttribute(THE_LIST);  
    list.add(from);  
}  
  
private void removeUser(String from) {  
    List list = (List)getServletContext().getAttribute(THE_LIST);  
    list.remove(from);  
}  
  
}  

部署描述文件

处理 HTTP servlet 时,必须编写 web.xml 部署描述文件。而在 SIP servlet 环境中,对应的文件是 sip.xml,我们在其中列出 SIP servlet、初始化参数和映射(哪个 SIP servlet 将处理哪条 SIP 消息)。我非常乐意提供有关这个文件的语法的更多信息的链接,但唯一可用的数据就是 SIP Servlet 规范第 15.5 节中的 DTD。其语法类似于 web.xml,但 <servlet-mapping> 标记例外。它不会将一个 URL 模式映射到 servlet,而是(基于域和子域的内容)描述一个条件,SIP 请求必须满足这个条件才能被映射到 servlet。SIP Servlet 规范的第 11 节描述了此映射使用的所有域、子域和条件。b8H思考者日记网-束洋洋个人博客

请注意,此映射只用于初始请求,同一个会话/对话中的后续请求由处理初始请求的 servlet 处理。b8H思考者日记网-束洋洋个人博客

ChatRoomServer 需要的 XML 代码如下:b8H思考者日记网-束洋洋个人博客

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE sip-app  
   PUBLIC "-//Java Community Process//DTD SIP Application 1.0//EN"  
   "http://www.jcp.org/dtd/sip-app_1_0.dtd">  
<sip-app>  
   <servlet>  
      <servlet-name>ChatRoomServer</servlet-name>  
      <servlet-class>dev2dev.chatroomserver.ChatRoomServer</servlet-class>  
      <init-param>  
         <param-name>dev2dev.chatroomserver.name</param-name>  
         <!-- This will be replaced by the build script -->  
         <param-value>sip:chatroomname@serveraddress</param-value>  
      </init-param>  
   </servlet>  
  
   <servlet-mapping>  
      <servlet-name>ChatRoomServer</servlet-name>  
      <pattern>  
         <and>  
            <equal>  
               <var>request.uri.user</var>  
               <!-- This will be replaced by the build script -->  
               <value>chatroomname</value>  
            </equal>  
           <equal>  
             <var>request.method</var>  
             <value>MESSAGE</value>  
           </equal>  
         </and>  
      </pattern>  
   </servlet-mapping>  
  
</sip-app>  

看起来似乎非常复杂,但实际上并非如此。Servlet 映射仅仅表达了以下意思:b8H思考者日记网-束洋洋个人博客

如果请求 URI 的用户名部分等于 chatroomname,则将 MESSAGE 请求映射到 ChatRoomServer Servlet。b8H思考者日记网-束洋洋个人博客

该聊天室名称只是一个占位符。在编译过程中,会用实际的聊天室名称替换关键字“chatroomname”。b8H思考者日记网-束洋洋个人博客

这么做有什么用呢?简而言之,您可以多次部署同一服务,每次都使用唯一的聊天室名称,而消息将自动路由到正确的 servlet。b8H思考者日记网-束洋洋个人博客

编译、打包、部署

需要对 SIP servlet 进行编译,然后将其打包成 SAR 文件 (Servlet ARchive)。这种文件在功能上等效于 WAR 文件,所使用的结构也是相同的。请参见图 2:b8H思考者日记网-束洋洋个人博客

图 2 b8H思考者日记网-束洋洋个人博客
图 2. SAR 文件结构b8H思考者日记网-束洋洋个人博客

最后一步是部署,这取决于您的 SIP 应用服务器。通常需要将 SAR 文件复制到一个部署文件夹中,随后部署应用程序。b8H思考者日记网-束洋洋个人博客

下面的 Ant 脚本可帮助您实现所有这些目标:b8H思考者日记网-束洋洋个人博客

<project name="ChatRoomServer"  default="build"  basedir=".">  
  
    <!-- Change this to specify the name of the chat room. In order to  
         send messages to this chat room, simply deploy just4fun.sar, and  
         use the address sip:just4fun@10.0.2.5060:5060. -->  
    <property name="chatroomname" value="just4fun" />  
  
    <!-- Change this to the address and port of the SIP server. -->  
    <property name="serveraddress" value="10.0.2.69:5060" />  
  
    <!-- Change this to the location of the SAR deployment folder. -->  
    <property name="sar.deployment" value="" />  
  
    <property name="src" value="${basedir}/src" />  
    <property name="lib" value="${basedir}/lib" />  
    <property name="tmp" value="${basedir}/tmp" />  
  
    <path id="classpath">  
        <fileset dir="${lib}"/>  
    </path>  
  
    <target name="build">  
        <mkdir dir="${tmp}"/>  
        <mkdir dir="${tmp}/WEB-INF"/>  
        <mkdir dir="${tmp}/WEB-INF/classes"/>  
        <mkdir dir="${tmp}/WEB-INF/lib"/>  
        <javac debug="true" srcdir="${src}" destdir="${tmp}/WEB-INF/classes">  
            <classpath refid="classpath"/>  
        </javac>  
        <copy todir="${tmp}/WEB-INF" file="${basedir}/sip.xml"/>  
        <replace file="${tmp}/WEB-INF/sip.xml" token="chatroomname" value="${chatroomname}"></replace>  
        <replace file="${tmp}/WEB-INF/sip.xml" token="serveraddress" value="${serveraddress}"></replace>  
        <zip destfile="${basedir}/${chatroomname}.sar">  
            <zipfileset dir="${tmp}"/>  
        </zip>  
        <copy file="${basedir}/${chatroomname}.sar" todir="${sar.deployment}"/>  
    </target>  
  
</project>  

结果

聊天室应用程序运行后,尝试通过运行两个 TextClient 实例来访问它。确保同一台计算机上运行的 SIP 应用程序使用不同的端口。下面的示例显示了同一台计算机上运行的全部三个应用程序:b8H思考者日记网-束洋洋个人博客

  • 运行 ChatRoomServer 的 SIP 应用服务器,地址为 sip:just4fun@10.0.2.69:5060
  • 地址为 sip:snoopy71@10.0.2.69:5061 的 Text client。
  • 地址为 sip:maria119@10.0.2.69:5062 的 Text client。

图 3 显示了结果。b8H思考者日记网-束洋洋个人博客

图 3 b8H思考者日记网-束洋洋个人博客
图 3. TextClient 与 ChatRoomServer 交互b8H思考者日记网-束洋洋个人博客

复杂应用程序

我相信,与您在现实中要构建的应用程序相比,本文中的示例只是小菜一碟。实际上,大多数 SIP 应用程序所包含的代码都远超过我们的示例。b8H思考者日记网-束洋洋个人博客

会话和状态:通常,SIP 应用程序是一个状态机,其中长期维护着(有状态的)呼叫或会话,直至连接断开为止。对于 SIP servlet 来说,呼叫是使用 SipApplicationSession 表示的,其中可包含属性(状态)。在一次呼叫中,每个对话(呼叫的组成部分)都是使用SipApplicationSession 内的 SipSession 表示的。(两个人之间的一个背对背会话可能蕴含一个 SipApplicationSession 和两个SipSession。一次会议呼叫可能包含多个 SipSession。)它们也能包含属性。容器将根据消息的上下文自动提供正确的会话对象。b8H思考者日记网-束洋洋个人博客

分层设计:最糟糕的莫过于将所有代码纳入一个庞大的 SIP servlet 中。您需要利用相对独立的分层来设计复杂的应用程序。显而易见,其中的一个分层就是包括连接池的数据库层。但您可能还希望分出一个独立于 SIP 信令的业务逻辑层。另外一个方面是有效负载分析,这应该被构建为可重用层。b8H思考者日记网-束洋洋个人博客

其他技术:目前有许多高级 SIP servlet 技术,其中包括请求代理、重定向和循环、会话超时管理、身份验证、国际化、TCP 支持、计时器、会话监听器和错误管理。显然,本文的篇幅不足以涵盖所有这些主题,但您可以在 SIP Servlet 规范中找到有关这些主题的信息。b8H思考者日记网-束洋洋个人博客

示例:请参见参考资料部分,其中提供的几个示例可帮助您进一步了解复杂 SIP 编程。b8H思考者日记网-束洋洋个人博客

总结

各种标准促进了互操作性,而互操作性又促进了协作。无论是与好友谈天说地,还是传输一个重要的文件,协作总是好事。b8H思考者日记网-束洋洋个人博客

SIP 是一种非常有前景的电信标准,而 SIP Servlet API 则是一种轻松快捷开发服务器端 SIP 应用程序的出色方法。在本文中,您已经通过一个简单示例了解了 SIP servlet 编程的大体情况。希望这篇文章能帮助您踏上协作之路。b8H思考者日记网-束洋洋个人博客

下载

  • TextClient 应用程序
  • ChatRoomServer 应用程序

其他阅读材料

Emmanuel Proulx 是 J2EE 和 SIP 方面的专家。他是经过认证的 WebLogic Server 工程师。b8H思考者日记网-束洋洋个人博客

 

(转载本站文章请注明作者和出处 思考者日记网|束洋洋个人博客 ,请勿用于任何商业用途)

『访问 思考者日记网404页面 寻找遗失儿童』

告知
  •     本站90%以上文章均属原创,部分转载已加上原作者出处。 如需转载本站文章请您务必保留本站出处!
  •     打广告评论者请自重,请为广大网友提供一个健康干净的网络空间。
  •  感谢主机屋提供网站空间;
  •  感谢万网阿里云提供域名解析;
  •  感谢EmpireCMS提供CMS系统;
  •  感谢bootstrap展示本站前端页面;
  •  感谢Glyphicons Halflings提供字体;
  •  感谢大家一直以来对本站的喜爱,感谢大家!
近期文章 建议与反馈

 

网友评论
我也来说两句
点击显示

 

点击显示弹幕