EJB 工作原理

EJB 工作原理   首先，我想先说说RMI的工作原理，因为EJB毕竟是基于RMI的嘛。废话就不多讲了，RMI的本质就是实现在不同JVM之间的调用，工作原理图如下：






它的实现方法就是在两个JVM中各开一个Stub和Skeleton，二者通过socket通信来实现参数和返回值的传递。

有关RMI的例子代码网上可以找到不少，但绝大部分都是通过extend the interface java.rmi.Remote实现，已经封装的很完善了，不免使人有雾里看花的感觉。下面的例子是我在《Enterprise JavaBeans》里看到的，虽然很粗糙，但很直观，利于很快了解它的工作原理。

1. 定义一个Person的接口，其中有两个business method, getAge() 和getName()

代码:
public interface Person {
    public int getAge() throws Throwable;
    public String getName() throws Throwable;
}


2. Person的实现PersonServer类
代码:
public class PersonServer implements Person {
    int age;
    String name;

    public PersonServer(String name, int age) {
        this.age = age;
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public String getName() {
        return name;
    }
}


3. 好，我们现在要在Client机器上调用getAge()和getName()这两个business method，那么就得编写相应的Stub(Client端)和Skeleton(Server端)程序。这是Stub的实现：
代码:
import java.io.ObjectOutputStream;
import java.io.ObjectInputStream;
import java.net.Socket;

public class Person_Stub implements Person {
    Socket socket;

    public Person_Stub() throws Throwable {
        // connect to skeleton
        socket = new Socket("computer_name", 9000);
    }

    public int getAge() throws Throwable {
        // pass method name to skeleton
        ObjectOutputStream outStream =
            new ObjectOutputStream(socket.getOutputStream());
        outStream.writeObject("age");
        outStream.flush();

        ObjectInputStream inStream =
            new ObjectInputStream(socket.getInputStream());
        return inStream.readInt();
    }

    public String getName() throws Throwable {
        // pass method name to skeleton
        ObjectOutputStream outStream =
            new ObjectOutputStream(socket.getOutputStream());
        outStream.writeObject("name");
        outStream.flush();

        ObjectInputStream inStream =
            new ObjectInputStream(socket.getInputStream());
        return (String)inStream.readObject();
    }
}


注意，Person_Stub和PersonServer一样，都implements Person。它们都实现了getAge()和getName()两个business method，不同的是PersonServer是真的实现，Person_Stub是建立socket连接，并向Skeleton发请求，然后通过Skeleton调用PersonServer的方法，最后接收返回的结果。

4. Skeleton实现
代码:
import java.io.ObjectOutputStream;
import java.io.ObjectInputStream;
import java.net.Socket;
import java.net.ServerSocket;

public class Person_Skeleton extends Thread {
    PersonServer myServer;

    public Person_Skeleton(PersonServer server) {
        // get reference of object server
        this.myServer = server;
    }

    public void run() {
        try {
            // new socket at port 9000
            ServerSocket serverSocket = new ServerSocket(9000);
            // accept stub's request
            Socket socket = serverSocket.accept();

            while (socket != null) {
                // get stub's request
                ObjectInputStream inStream =
                    new ObjectInputStream(socket.getInputStream());
                String method = (String)inStream.readObject();

                // check method name
                if (method.equals("age")) {
                    // execute object server's business method
                    int age = myServer.getAge();
                    ObjectOutputStream outStream =
                        new ObjectOutputStream(socket.getOutputStream());

                    // return result to stub
                    outStream.writeInt(age);
                    outStream.flush();
                }

                if(method.equals("name")) {
                    // execute object server's business method
                    String name = myServer.getName();
                    ObjectOutputStream outStream =
                        new ObjectOutputStream(socket.getOutputStream());

                    // return result to stub
                    outStream.writeObject(name);
                    outStream.flush();
                }
            }
        } catch(Throwable t) {
            t.printStackTrace();
            System.exit(0);
        }
    }

    public static void main(String args []) {
        // new object server
        PersonServer person = new PersonServer("Richard", 34);

        Person_Skeleton skel = new Person_Skeleton(person);
        skel.start();
    }
}


Skeleton类 extends from Thread，它长驻在后台运行，随时接收client发过来的request。并根据发送过来的key去调用相应的business method。

5. 最后一个，Client的实现
代码:
public class PersonClient {
    public static void main(String [] args) {
        try {
            Person person = new Person_Stub();
            int age = person.getAge();
            String name = person.getName();
            System.out.println(name + " is " + age + " years old");
        } catch(Throwable t) {
            t.printStackTrace();
        }
    }
}


Client的本质是，它要知道Person接口的定义，并实例一个Person_Stub，通过Stub来调用business method，至于Stub怎么去和Server沟通，Client就不用管了。

注意它的写法：
Person person = new Person_Stub();
而不是
Person_Stub person = new Person_Stub();

为什么？因为要面向接口编程嘛，呵呵。

关于RMI，我想说的就这么多了。下面介绍EJB各个类     EJB类一览   本人没有用过Weblogic，这里就结合WebSphere来讲讲各个类的调用关系吧。

假定我们要创建一个读取User信息的SessionBean，需要我们写的有3个文件：
1. UserServiceHome.java
Home接口

2. UserService.java
Remote接口

3. UserServiceBean.java
Bean实现

WSAD最终会生成10个class。其它7个是什么呢？我们一个一个数过来：

4. _UserServiceHome_Stub.java
这个当然就是Home接口在Client端(动态加载)的Stub类了，它implements UserServiceHome。

5. _EJSRemoteStatelessUserServiceHome_a940aa04_Tie.java
Home接口在Server端的Skeleton类，"a940aa04"应该是随机生成的，所有其他的相关class名里都会有这个标志串，Tie是Corba对Skeleton的叫法。

6. EJSRemoteStatelessUserServiceHome_a940aa04.java
Home接口在Server端的实现，当然，它也implements UserServiceHome。

7. EJSStatelessUserServiceHomeBean_a940aa04.java
由#6调用，create _UserService_Stub。(为什么#6不能直接create _UserService_Stub呢？后面再讲。)

8. _UserService_Stub.java
Remote接口在Client端(动态加载)的Stub类。它implements UserService。

9. _EJSRemoteStatelessUserService_a940aa04_Tie.java
Remote接口在Server端的Skeleton类。

10. EJSRemoteStatelessUserService_a940aa04.java
Remote接口在Server端的实现，当然，它也implements UserService。并且，它负责调用UserServiceBean——也就是我们所写的Bean实现类——里面的business method。

那么，各个类之间的调用关系到底是怎么样的呢？简单的说，就是两次RMI循环。  

  第一个RMI循环   先来看看Client端的程序是怎么写的：

代码:
try {
    InitialContext ctx = new InitialContext();

    //第一步
    UserServiceHome home =
        (UserServiceHome) PortableRemoteObject.narrow(
            ctx.lookup(JNDIString),
            UserServiceHome.class);

    //home: _UserServiceHome_Stub
    System.out.println(home.toString());

    //第二步
    UserService object = home.create();

    //ojbect: _UserService_Stub
    System.out.println(object.toString());

    //第三步
    int userId = 1;
    UserInfo ui = object.getUserInfo(userId);
}


在第一步之后，我们得到了一个UserServiceHome(interface)定义的对象home，那么，home到底是哪个class的instance呢？用debug看一下，知道了home原来就是_UserServiceHome_Stub的实例。

从第二步开始，就是我们的关注所在，虽然只有简单的一行代码，
UserService object = home.create();
但是他背后的系统是怎么运做的呢？我们进入代码来看吧：

1. 调用home.create()
代码:
UserServiceHome home;
UserService obj = home.create();


2. 实际是调用_UserServiceHome_Stub.create()，在这个方法里面，Stub向Skeleton发送了一个create的字串：
代码:
org.omg.CORBA.portable.OutputStream out = _request("create", true);
in = (org.omg.CORBA_2_3.portable.InputStream)_invoke(out);


3. Server端的Skeleton接收Stub发来的request，并调用相应的方法：
代码:
_EJSRemoteStatelessUserServiceHome_a940aa04_Tie._invoke() {
    ......
    switch (method.length()) {
        case 6:
            if (method.equals("create")) {
                return create(in, reply);
            }
        ......
    }
}


代码:
_EJSRemoteStatelessUserServiceHome_a940aa04_Tie.create() {
    EJSRemoteStatelessUserServiceHome_a940aa04 target = null;
    result = target.create();
    org.omg.CORBA.portable.OutputStream out = reply.createReply();
    Util.writeRemoteObject(out,result);
    return out;
}


4. Skeleton调用的是UserServiceHome的Server端实现类的create方法
代码:
EJSRemoteStatelessUserServiceHome_a940aa04.create() {
    UserService _EJS_result;
    _EJS_result = EJSStatelessUserServiceHomeBean_a940aa04.create();
}


5. #4又调用EJSStatelessUserServiceHomeBean_a940aa04.create()
代码:
    UserService result = super.createWrapper(new BeanId(this, null));


至此，我们终于结束了第一个RMI循环，并得到了Remote接口UserService的Stub类_UserService_Stub，就是#5里面的result。

这里有一个问题，为什么#4不直接create _UserService_Stub，而又转了一道#5的手呢？因为#4 extends from EJSWrapper，它没有能力create Stub，因此必须借助#5，which extends from EJSHome，这样才可以生成一个Stub。如果不是为了生成这个Stub，应该可以不走#5这一步。       第二个RMI循环   OK, now we got the object which is instanceOf _UserService_Stub, and implements UserService

现在我们的Client端走到第三步了：
UserInfo ui = object.getUserInfo(userId);

继续看代码，开始第二个RMI循环：

1. 调用object.getUserInfo()
代码:
UserService object;
object.getUserInfo(userId);


2. 实际是调用_UserService_Stub.getUserInfo(int arg0)，在这个方法里面，Stub向Skeleton发送了一个getUserInfo的字串和arg0这个参数：

代码:
org.omg.CORBA.portable.OutputStream out = _request("getUserInfo", true);
out.write_long(arg0);
in = (org.omg.CORBA_2_3.portable.InputStream)_invoke(out);


3. Server端的Skeleton接收Stub发来的request，并调用相应的方法：
代码:
_EJSRemoteStatelessUserService_a940aa04_Tie._invoke() {
    switch (method.charAt(5))
    {
        case 83:
            if (method.equals("getUserInfo")) {
                return getUserInfo(in, reply);
            }
        ......
    }
}

_EJSRemoteStatelessUserService_a940aa04_Tie.getUserInfo() {
    EJSRemoteStatelessUserService_a940aa04 target = null;
    int arg0 = in.read_long();
    UserDTO result = target.getUserInfo(arg0);
    org.omg.CORBA_2_3.portable.OutputStream out = reply.createReply();
    out.write_value(result,UserDTO.class);
    return out;
}


4. Skeleton调用的是UserService的Server端实现类的getUserInfo方法
代码:
EJSRemoteStatelessUserService_a940aa04.getUserInfo() {
    UserServiceBean _EJS_beanRef = container.preInvoke(this, 0, _EJS_s);
    _EJS_result = _EJS_beanRef.getUserInfo(id);
}


最后的最后，#4终于调用了我们写的UserServiceBean里的getUserInfo方法，这才是我们真正想要去做的事情。

至此，第二个RMI循环也终于结束了。       调用流程图   回顾一下上面的分析，可以很清晰的看到两次RMI循环的过程，下图(见链接)描述了整个流程：

http://www.pbase.com/image/27229257

黄色的1，6，10是程序员要写的，其余是系统生成的。

#1是Home interface, #2和#4都implements 了它。
#6是Remote interface, #7和#9都implements 了它。
#10是Bean实现。