SIP简介，第2部分：SIP SERVLET

例如，MESSAGE可以调用以下方法：

1. service()，传入一个SipServletRequest（必须进行类型转换）以及null
2. doRequest()
3. doMessage()

通常只重写最后一级的方法，除非使用了非标准的SIP消息，或者希望收集有关消息的统计信息。

下面是处理即时消息的代码：

/** 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。最后，它调用一个业务逻辑方法来广播传入的消息。

传入的错误响应消息表明上一个请求失败了。这可能意味着有一个用户被断开了。只需将该用户从列表中移除即可。

成功的响应消息表明上一个MESSAGE消息被即时messenger正确地接收了。因此不再需要该会话，可以将其删除了。通常，MESSAGE消息是以无状态的形式发送的，并不保存消息之间的连接信息。（对于INVITE消息来说，情况不是这样的，它打开一个有状态的会话直到发送BYE。）

其余的代码由helper方法组成。前两个方法向即时messenger发送消息。要发送消息，使用一个工厂创建以下两项：

• 一个SipApplicationSession（稍后将详细介绍）
  
• 一个请求消息
  

此时，可以随心所欲地修改消息。在我们的例子中，我们在有效负载中添加即时消息文本。最后，发送该消息。

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，但标签除外。它不会将一个URL模式映射到servlet，而是（基于字段和子字段的内容）描述一个条件，SIP请求必须满足这个条件才能被映射到servlet。SIP Servlet规范第11节描述了所有的字段、子字段以及用于该映射的条件。

注意，该映射只用于初始请求；同一个会话/对话中的后续请求由处理初始请求的同一servlet处理。

下面是用于ChatRoomServer的XML代码：

   
      ChatRoomServer

      dev2dev.chatroomserver.ChatRoomServer

      
         dev2dev.chatroomserver.name

         
         sip:chatroomname@serveraddress

      
   

   
      ChatRoomServer

      
         
            
               request.uri.user

               
               chatroomname

            
           
             request.method

             MESSAGE

           
         
      
   

代码看起来很复杂，其实并非如此。Servlet映射说明了：

如果请求URI的用户名部分等于chatroomname，则将传入的MESSAGE请求映射到ChatRoomServer Servlet。

该聊天室名称只是一个占位符。在编译过程中，会用实际的聊天室名称替换关键字“chatroomname”。

这么做有什么用呢？您可以将同样的服务部署多次，每次都使用其独有的聊天室名称，而消息可以自动发送到相应的servlet。

构建、打包、部署

需要对SIP servlet进行编译，并将其打包到SAR(Servlet ARchives)文件中。这些文件在功能上等效于WAR文件，结构也相同。参见图2：

图2. SAR文件结构

结果

聊天室应用程序运行之后，试着通过运行两个TextClient实例来访问它。要确保运行在同一机器上的SIP应用程序使用的是不同的端口。下面的例子显示了运行在同一机器上的3个应用程序：

• 运行在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显示了结果。

 

图3. TextClient与ChatRoomServer交互

复杂应用程序

我知道本文中的例子相对于我们通常要构建的应用程序来说有点过于简单了，现实中的大多数SIP应用程序都由大量代码组成。

会话和状态：通常，SIP应用程序是一个状态机(state machine)，其中呼叫或会话都是长时间保持的（有状态的），直到断开。对于SIP servlet，呼叫是由SipApplicationSession表示的，它可以带属性（状态）。在呼叫中，每个会话（呼叫的分支）由SipApplicationSession中的SipSession表示。（两人间的back-to-back会话要使用一个SipApplicationSession和两个SipSession。会议呼叫可能包含更多的SipSession。这些都可以带属性。容器会根据消息的上下文自动提供相应的会话对象。

分层设计：最糟糕的是将所有的代码放入单个的大型SIP servlet。应该按照相对独立的层来设计复杂的应用程序。一个明显的层就是包括连接池的数据库层。也可以包含一个与SIP信令分离的业务逻辑层。另一个方面是有效负载分析，它应该被构建为一个可重用的层。

其他技术：存在许多先进的SIP servlet技术，包括请求代理、重定向和循环、会话超时管理、身份验证、国际化、TCP支持、计时器、会话监听程序以及错误管理。很明显，本文并没有涵盖所有这些方面，但是您可以在SIP Servlet规范中找到相关内容。

例子：可以参见“参考资料”部分，其中有可以帮助您了解更复杂的SIP编程的例子。

结束语

标准促进了互操作性，从而促进了协作。而协作——不管它是用于朋友间的轻松聊天，还是用于重要的文件传输——都是一件好事。

SIP是一个大有前途的电信标准，而SIP Servlet API则是轻松快速地开发服务器端SIP应用程序的极佳方式。在本文中，我们通过一个简单的例子，概述了SIP servlet编程。希望通过本文，能够帮助您在协作的道路上迈出一大步。