ICE笔记(02)：简单的ICE通信应用-Hello World

简单的ICE通信应用-Hello World

                 参考《Ice分布式程序设计》马维达 译、冯立彬的博客

一、简述

    创建一个非常简单的客户－服务器ice应用。这个应用提供远地打印功能：客户发送要打印的文本给服务器，再由服务器把文本发给打印机。打印程序只是把文本打印到终端，而不是真正的打印机。目的是说明客户怎样与服务器通信。

二、安装ICE

    下载安装包：http://www.zeroc.com/download.html

   1.  安装ice

   2.   配置路径

    测试slice2java命令

 

    配置环境变量：

 

    再次测试slice2java命令，显示如下信息，配置完成。

 

    使用myeclipse开发，创建一个项目名为icetest的java工程，创建包demo、demo.servant、demo.client、demo.server。

 

三、编写Slice 定义

    编写任何Ice 应用的第一步都是要编写一个Slice 定义，其中含有应用所

用的各个接口。我们为我们的打印应用编写了这样的Slice 定义：

module demo {

    interface Printer {

        void printString(string s);

    };

};

    我们把这段文本保存在叫作printer.ice的文件中，存放在src目录下。

 

    我们的Slice 定义含有一个接口，叫作Printer。目前，我们的接口非常简单，只提供了一个操作，叫作printString。printString 操作接受一个串作为它唯一的输入参数；这个串的文本将会出现在（可能在远地的）打印机上。

四、编写使用Java 的Ice 应用

1.    编译printer.ice

    在cmd命令行中进入到printer.ice文件所在的目录

 

    输入命令：slice2java printer.ice    

    （后者）

    slice编译所有ice文件

    E:/Ice-3.3.0/bin/slice2java -I. --output-dir=../src *.ice //生产代码

         E:/Ice-3.3.0/bin/slice2html -I. --output-dir=doc *.ice//生产doc文档，可以忽略

 

slice2java编译器根据这个printer.ice文件定义生成一些Java源文件。我们目前无需关注这些文件的确切内容——它们包含的是编译器生成的代码，与我们在Printer.ice 中定义的Printer接口相对应。

    刷新demo目录，可以看到多出来很多的文件。之所以编译以后生成的java文件存放在demo下，因为我们的printer.ice文件中使用module demo定义了包路径。

 

    导入ice环境运行所需要的jar包，将ice安装目录下的lib目录中的ice.jar包导入到myeclipse环境中

 

 

2. 编写和编译服务器

    要实现我们的Printer接口，我们必须创建一个servant 类。按照惯例，servant 类的名字是它们的接口的名字加上一个I后缀，所以我们的servant类叫作PrinterI，并放在PrinterI.java源文件中，存放在demo.servant包中。

package demo.servant;

import demo._PrinterDisp;

publicclass PrinterI extends _PrinterDisp {

   publicvoid printString(String s, Ice.Current current) {

      System.out.println(s);

   }

}

    PrinterI 类继承自叫作_PrinterDisp 的基类。这个基类由slice2java 编译器生成，是一个抽象类，其中含有一个printString方法，其参数是打印机要打印的串，以及类型为Ice.Current 的对象。我们的printString 方法的实现会简单地把它的参数写到终端。服务器代码的其余部分在一个叫作Server.java的源文件中，存在demo.server包中，下面给出了其完整代码：

public class Server {  
    public static void main(String[] args) {  
        int status = 0;  
        Ice.Communicator ic = null;  
        try {  
            //初使化连接，args可以传一些初使化参数，如连接超时时间，初使化客户连接池的数量等  
            ic = Ice.Util.initialize(args);  
            //创建名为SimplePrinterAdapter的适配器，并要求适配器使用缺省的协议(TCP/IP侦听端口为10000的请求)  
            Ice.ObjectAdapter adapter = ic.createObjectAdapterWithEndpoints("SimplePrinterAdapter", "default -p 10000");  
            //实例化一个PrinterI对象，为Printer接口创建一个服务对象  
            Ice.Object object = new PrinterI();  
            //将服务单元增加到适配器中，并给服务对象指定名称为SimplePrinter，该名称用于唯一确定一个服务单元  
            adapter.add(object, Ice.Util.stringToIdentity("SimplePrinter"));  
            //激活适配器，这样做的好处是可以等到所有资源就位后再触发  
            adapter.activate();  
            //让服务在退出之前，一直持续对请求的监听  
            ic.waitForShutdown();  
        } catch (Ice.LocalException e) {  
            e.printStackTrace();  
            status = 1;  
        } catch (Exception e) {  
            System.err.println(e.getMessage());  
            status = 1;  
        }  
        if (ic != null) {  
            // Clean up  
            //  
            try {  
                ic.destroy();  
            } catch (Exception e) {  
                System.err.println(e.getMessage());  
                status = 1;  
            }  
        }  
        System.exit(status);  
    }  
}  

 

 

    注意这段代码的总体结构：

publi cclassServer {

   public static void main(String[] args) {

      int status = 0;

      Ice.Communicator ic = null;

      try {

         // Server implementation here...

      } catch (Ice.LocalException e) {

         e.printStackTrace();

         status = 1;

      } catch (Exception e) {

         System.err.println(e.getMessage());

         status = 1;

      } finally {

         if (ic != null)

            ic.destroy();

      }

      System.exit(status);

   }

}

    main 的主体含有一个try 块，我们把所有的服务器代码都放在其中；然后是两个catch 处理器。第一个处理器捕捉Ice run time 可能抛出的所有异常，其意图是，如果代码在任何地方遇到意料之外的Ice 运行时异常，栈会一直退回到main，打印出异常，然后把失败返回给操作系统。第二个处理器捕捉串常量，其意图是，如果我们在代码某处遇到致命错误，我们可以简单地抛出带有出错消息的串文本。这也会使栈退回到main，打印出出错消息，然后把失败返回给操作系统。

    这段代码会在退出之前销毁通信器（如果曾经成功创建过）。要使Icerun time正常结束，这样做是必需的：程序必须调用它所创建的任何通信器的destroy；否则就会产生不确定的行为。我们把对destroy 的调用放进finally 块，这样，不管前面的try 块中发生什么异常，通信器都保证会正确销毁。

    我们的try块的主体含有实际的服务器代码：

ic = Ice.Util.initialize(args);

Ice.ObjectAdapter adapter = ic.createObjectAdapterWithEndpoints(

               "SimplePrinterAdapter", "default -p 10000");

Ice.Object object = new PrinterI();

adapter.add(object, Ice.Util.stringToIdentity("SimplePrinter"));

adapter.activate();

ic.waitForShutdown();

    这段代码包含了以下步骤：

 

1.我们调用Ice.Util.initialize初始化Ice run time （我们之所以把args 传给这个调用，是因为服务器可能有run time 感兴趣的命令行参数；就这个例子而言，服务器不需要任何命令行参数）。对initialize的调用返回的是一个通信器Ice.Communicator引用，这个引用是Ice run time的主句柄。

 

2.我们调用通信器Communicator实例上的createObjectAdapterWithEndpoints，创建一个对象适配器。我们传入的参数是"SimplePrinterAdapter"（适配器的名字）和"default -p 10000"，后者是要适配器用缺省协议（TCP/IP）在端口10000 处侦听到来的请求。

 

3.这时，服务器端run time 已经初始化，我们实例化一个PrinterI 对象，为我们的Printer接口创建一个servant。

 

4.调用适配器的add，告诉它有了一个新的servant ；传给add 的参数是我们刚才实例化的servant，再加上一个标识符。在这里，"SimplePrinter" 串是servant 的名字（如果我们有多个打印机，每个打印机都会有不同的名字，更正确的说法是，都会有不同的对象标识）。

 

5.接下来，我们调用适配器的activate 方法激活适配器（适配器一开始是在扣留（holding）状态创建的；如果适配器处在扣留状态，服务器端run time 就会停止从对应的传输端点读取数据，不接受客户发送的连接请求。这种做法在下面这样的情况下很有用：如果我们有多个servant，它们共享同一个适配器，而在所有servant 实例化之前我们不想处理请求）。一旦适配器被激活，服务器就会开始处理来自客户的请求。

 

6.最后，调用waitForShutdown。这个方法挂起发出调用的线程，直到服务器实现终止为止——或者是通过发出一个调用关闭run time，或者是对某个信号作出响应（目前，当我们不再需要服务器时，我们会简单地在命令行上中断它）。

   

 

    注意，尽管这里的代码不算少，但它们对所有的服务器都是一样的。你可以把这些代码放在一个辅助类里，然后就无需再为它费心了（Ice 提供了一个这样的辅助类，叫作Ice.Application）。就实际的应用代码而言，服务器只有几行代码：六行代码定义PrinterI 类，再加上三、四行代码实例化一个PrinterI 对象，并向对象适配器注册它。

 

3.编写和编译客户

    客户代码在Client.java 中，看起来与服务器非常类似。存放在demo.client包下，下面是完整的代码：

 

public class Client {  
    public static void main(String[] args) {  
        int status = 0;  
        Ice.Communicator ic = null;  
        try {  
            //初使化  
            ic = Ice.Util.initialize(args);  
            //传入远程服务单元的名称、网络协议、IP及端口，获取Printer的远程代理，这里使用的stringToProxy方式  
            Ice.ObjectPrx base = ic.stringToProxy("SimplePrinter:default -p 10000");  
            //通过checkedCast向下转换，获取Printer接口的远程，并同时检测根据传入的名称获取的服务单元是否Printer的代理接口，如果不是则返回null对象  
            Demo.PrinterPrx printer = Demo.PrinterPrxHelper.checkedCast(base);  
            if (printer == null) throw new Error("Invalid proxy");  
            //把Hello World传给服务端，让服务端打印出来，因为这个方法最终会在服务端上执行  
            printer.printString("Hello World!");  
        } catch (Ice.LocalException e) {  
            e.printStackTrace();  
            status = 1;  
        } catch (Exception e) {  
            System.err.println(e.getMessage());  
            status = 1;  
        }  
        if (ic != null) {  
            // Clean up  
            //  
            try {  
                ic.destroy();  
            } catch (Exception e) {  
                System.err.println(e.getMessage());  
                status = 1;  
            }  
        }  
        System.exit(status);  
    }  
}  

 

 

 

    注意，总体的代码布局与服务器是一样的,我们用同样的try、catch 以及finally 块处理错误。try 块中的代码所做的事情是：

1.和在服务器中一样，我们调用Ice.initialize初始化Ice runtime。

 

2.下一步是获取远地打印机的代理。我们调用通信器的stringToProxy创建一个代理，所用参数是"SimplePrinter:default -p 10000"。注意，这个串包含的是对象标识和服务器所用的端口号一致。

 

3.stringToProxy 返回的代理的类型是Ice.ObjectPrx，这种类型位于接口和类的继承树的根部。但要实际与我们的打印机交谈，我们需要的是Printer 接口、而不是Object 接口的代理。为此，我们需要调用PrinterPrxHelper.checkedCast 进行向下转换。这个方法会发送一条消息给服务器，实际询问“这是Printer 接口的代理吗？”如果是，这个调用就会返回Printer 的一个代理；如果代理代表的是其他类型的接口，这个调用就会返回一个空代理。

 

4.我们测试向下转换是否成功，如果不成功，就抛出出错消息，终止客户。

 

5.现在，在我们的地址空间里有了一个活的代理，可以调用printString 方法，把享誉已久的 "Hello World!" 串传给它。服务器会在它的终端上打印这个串。

    总体目录结构如下图：

 

4.运行客户和服务器

    直接在myeclipse中，首先运行Server，启动服务器，再运行Client，在服务器终端窗口中，我们会看到打印机产生的"Hello World!"。

五、总结

    本章介绍了一个非常简单（但却完整）的客户和服务器。我们已经看到，编写Ice 应用涉及以下步骤：

1.编写Slice 定义并编译它。

 

2.编写服务器并编译它。

 

3.编写客户并编译它。