刚刚入职新的东家,我的这个项目组用到的是很重量级的框架EJB,以前用的都是MVC,自己就要学习下了,把我自己看的资料和自己的理解写成一篇博文,希望能帮到一些和我一样刚刚接触EJB分布式开发的童鞋。 如果各位有问题,可以email我的邮箱。
zhe-jiang.he@hp.com< 何哲江(中国惠普)>
EJB工作原理学习笔记
1 RMI工作原理
2 websphere实现
3 weblogic实现
4 理解体会
1: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实质上就是生成2个类stub,skeleton来进行参数和返回值的传递,采用值传递方式
//类似于以前写的聊天室程序,被传递的对象应实现java.io.Serializable接口
2:websphere实现
EJB类一览
这里结合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实现。
3:weblogic实现
一个远程对象至少要包括4个class文件:远程对象;远程对象的接口;实现远程接口的对象的stub;对象的ske
leton这4个class文件。
在EJB中则至少要包括10个class:
Bean类,特定App Server的Bean实现类
Bean的remote接口,特定App Server的remote接口实现类,特定App
Server的remote接口的实现类的stub类和skeleton类
Bean的home接口,特定App Server的home接口实现类,特定App
Server的home接口的实现类的stub类和skeleton类
和RMI不同的是,EJB中这10个class真正需要用户编写的只有3个,分别是Bean类和它的remote接口,home接口
,至于其它的7个class到底是怎么生成,被打包在什么地方,或者是否需要更多的类文件,会根据不同的App
Server表现出比较大的差异,不能一概而论。
拿Weblogic的来说吧,Weblogic的Bean实现类,以及两个接口的Weblogic的实现类是在ejbc的时候被打包到EJB
的jar包里面的,这3个class文件可以看到。而home接口和remote接口的Weblogic的实现类的stub类和skeleton
类是在EJB被部署到Weblogic的时候,由Weblogic动态生成stub类和Skeleton类的字节码,因此看不到这4个类
文件。
对于一次客户端远程调用EJB,要经过两个远程对象的多次RMI循环。首先是通过JNDI查找Home接口,获得Home
接口的实现类,这个过程其实相当复杂,首先是找到Home接口的Weblogic实现类,然后创建一个Home接口的Web
logic实现类的stub类的对象实例,将它序列化传送给客户端(注意stub类的实例是在第1次RMI循环中,由服务
器动态发送给客户端的,因此不需要客户端保存Home接口的Weblogic实现类的stub类),最后客户端获得该stu
b类的对象实例(普通的RMI需要在客户端保存stub类,而EJB不需要,因为服务器会把stub类的对象实例发送给
客户端)。
客户端拿到服务器给它的Home接口的Weblogic实现类的stub类对象实例以后,调用stub类的create方法,(在代
码上就是home.create(),但是后台要做很多事情),于是经过第2次RMI循环,在服务器端,Home接口的Weblogic
实现类的skeleton类收到stub类的调用信息后,由它再去调用Home接口的Weblogic实现类的create方法。
在服务端,Home接口的Weblogic实现类的create方法再去调用Bean类的Weblogic实现类的ejbCreate方法,在服
务端创建或者分配一个EJB实例,然后将这个EJB实例的远程接口的Weblogic实现类的stub类对象实例序列化发
送给客户端。
客户端收到remote接口的Weblogic实现类的stub类的对象实例,对该对象实例的方法调用(在客户端代码中实
际上就是对remote接口的调用),将传送给服务器端remote接口的Weblogic实现类的skeleton类对象,而skele
ton类对象再调用相应的remote接口的Weblogic实现类,然后remote接口的Weblogic实现类再去调用Bean类的We
blogic实现类,如此就完成一次EJB对象的远程调用。
看了一遍帖子,感觉还是没有说太清楚,既然写了帖子,就想彻底把它说清楚。
先拿普通RMI来说,有4个class,分别是远程对象,对象的接口,对象的stub类和skeleton类。而对象本身和对
象的stub类同时都实现了接口类。而我们在客户端代码调用远程对象的时候,虽然在代码中操纵接口,实质上
是在操纵stub类,例如:
接口类:Hello
远程对象:Hello_Server
stub类:Hello_Stub
skeleton类:Hello_Skeleton
客户端代码要这样写:
Hello h = new Hello_Stub();
h.getString();
我们不会这样写:
Hello_Stub h = new Hello_Stub();
h.getString();
因为使用接口适用性更广,就算更换了接口实现类,也不需要更改代码。因此客户端需要Hello.class和Hello_
Stub.class这两个文件。但是对于EJB来说,就不需要Hello_Stub.class,因为服务器会发送给它,但是Hello.
class文件客户端是省不了的,必须有。表面上我们的客户端代码在操纵Hello,但别忘记了Hello只是一个接口
,抽象的,实质上是在操纵Hello_Stub。
拿Weblogic上的EJB举例子,10个class分别是:
Bean类:HelloBean (用户编写)
Bean类的Weblogic实现类:HelloBean_Impl (EJBC生成)
Home接口:HelloHome (用户编写)
Home接口的Weblogic实现类 ((Hello Bean))_HomeImpl(EJBC生成)
Home接口的Weblogic实现类的stub类 ((Hello Bean))_HomeImpl_WLStub(部署的时候动态生成字节码)
Home接口的Weblogic实现类的skeleton类 ((Hello Bean))_HomeImpl_WLSkeleton(部署的时候动态生成字节码
)
Remote接口: Hello (用户编写)
Remote接口的Weblogic实现类 ((Hello Bean))_EOImpl(EJBC生成)
Remote接口的Weblogic实现类的stub类 ((Hello Bean))_EOImpl_WLStub(部署的时候动态生成字节码)
Remote接口的Weblogic实现类的skeleton类 ((Hello Bean))_EOImpl_WLSkeleton(部署的时候动态生成字节码
)
客户端只需要Hello.class和HelloHome.class这两个文件。
((Hello Home)) home = (Home) ((Portable Remote Object)).narrow(ctx.lookup("Hello"), ((Hello
Home)).class);
这一行代码是从JNDI获得Home接口,但是请记住!接口是抽象的,那么home这个对象到底是什么类的对象实例
呢?很简单,用toString()输出看一下就明白了,下面一行是输出结果:
((Hello Bean))_HomeImpl_WLStub@18c458
这表明home这个通过从服务器的JNDI树上查找获得的对象实际上是HelloBean_HomeImpl_WLStub类的一个实例。
接下来客户端代码:
Hello h = home.create()
同样Hello只是一个抽象的接口,那么h对象是什么东西呢?打印一下:
((Hello Bean))_EOImpl_WLStub@8fa0d1
原来是HelloBean_EOImpl_WLStub的一个对象实例。
用这个例子来简述一遍EJB调用过程:
首先客户端JNDI查询,服务端JNDI树上Hello这个名字实际上绑定的对象是HelloBean_HomeImpl_WLStub,所以
服务端将创建HelloBean_HomeImpl_WLStub的一个对象实例,序列化返回给客户端。
于是客户端得到home对象,表面上是得到HelloHome接口的实例,实际上是进行了一次远程调用得到了HelloBea
n_HomeImpl_WLStub类的对象实例,别忘记了HelloBean_HomeImpl_WLStub也实现了HelloHome接口。
然后home.create()实质上就是HelloBean_HomeImpl_WLStub.create(),该方法将发送信息给HelloBean_HomeIm
pl_WLSkeleton,而HelloBean_HomeImpl_WLSkeleton接受到信息后,再去调用HelloBean_HomeImpl的create方
法,至此完成第1次完整的RMI循环。
注意在这次RMI循环过程中,远程对象是HelloBean_HomeImpl,远程对象的接口是HelloHome,对象的stub是Hel
loBean_HomeImpl_WLStub,对象的skeleton是HelloBean_HomeImpl_WLSkeleton。
然后HelloBean_HomeImpl再去调用HelloBean_Impl的ejbCreate方法,而HelloBean_Impl的ejbCreate方法将负
责创建或者分配一个Bean实例,并且创建一个HelloBean_EOImpl_WLStub的对象实例。
这一步比较有趣的是,在前一步RMI循环中,远程对象HelloBean_HomeImpl在客户端有一个代理类HelloBean_Ho
meImpl_WLStub,但在这一步,HelloBean_HomeImpl自己却充当了HelloBean_Impl的代理类,只不过HelloBean_
HomeImpl不在客户端,而是在服务端,因此不进行RMI。
然后HelloBean_EOImpl_WLStub的对象实例序列化返回给客户端,这一步也很有趣,上次RMI过程,主角是Hello
Bean_HomeImpl和它的代理类HelloBean_HomeImpl_WLStub,但这这一次换成了HelloBean_EOImpl和它的代理类H
elloBean_EOImpl_WLStub来玩了。
Hello h = home.create();h.helloWorld();
假设Hello接口有一个helloWorld远程方法,那么表面上是在调用Hello接口的helloWorld方法,实际上是在调
用HelloBean_EOImpl_WLStub的helloWorld方法。
然后HelloBean_EOImpl_WLStub的helloWorld方法将发送信息给服务器上的HelloBean_EOImpl_WLSkeleton,而H
elloBean_EOImpl_WLSkeleton收到信息以后,再去调用HelloBean_EOImpl的helloWorld方法。至此,完成第2次
完整的RMI循环过程。
在刚才HelloBean_EOImpl是作为远程对象被调用的,它的代理类是HelloBean_EOImpl_WLStub,但现在HelloBea
n_EOImpl要作为HelloBean_Impl的代理类了。现在HelloBean_EOImpl去调用HelloBean_Impl的helloWorld方法
。注意!HelloBean_Impl继承了HelloBean,而HelloBean中的helloWorld方法是我们亲自编写的代码,现在终
于调用到了我们编写的代码了!
至此,一次EJB调用过程终于完成。在整个过程中,服务端主要要调用的类是HelloBean_Impl, Hello
Bean?_HomeImpl,HelloBean_HomeImpl_WLSkeleton,HelloBean_EOImpl,HelloBean_EOImpl_WLSkeleton。客
户端主要调用的类是HelloBean_HomeImpl_WLStub,HelloBean_EOImpl_WLStub,这两个类在客户端代码中并不
会直接出现,出现在代码中的类是他们的接口HelloHome和Hello,因此客户端需要这两个接口文件,而Stub是
服务器传送给他们的。
4 理解体会
简单讲,就是为了适应分布式开发的需要。
首先,回到我最后给出的流程图。
http://www.pbase.com/nobo123/image/27229257
Client端最原始的冲动,肯定是能直接调用#10.UserServiceBean就爽了。那么第一个问题来了,
Client和Server不在一个JVM里。
这好办,我们不是有RMI吗,好,这个问题就这么解决了:
1. UserServiceBeanInterface.getUserInfo()
2. UserServiceBeanStub
3. UserServiceBeanSkeleton
4. UserServiceBean
用着用着,第二个问题来了,
UserServiceBean只有人用,没人管理,transaction logic, security logic, bean instance pooling logic
这些不得不考虑的问题浮出水面了。
OK,我们想到用一个delegate,EJBObject,来进行所有这些logic的管理。client和EJBObject打交道,EJBObj
ect调用UserServiceBean。
注意,这个EJBObject也是一个Interface,#6.UserService这个interface正是从它extends而来。并且EJBObje
ct所管理的这些logic,正是AppServer的一部分。
现在的流程变为了:
EJBObject
1. UserService.getUserInfo()
2. UserServiceStub
3. UserServiceSkeleton
4. UserServiceImp
5. UserServiceBean
这已经和整幅图里的#6, #7, #8, #9, #10一一对应了。
现在能满足我们的需求了吗?不,第三个问题又来了:
既然是分布式开发,那么我当然没理由只用一个Specified Server,我可能需要用到好几个不同的Server,而
且EJBObject也需要管理呀
OK,为了适应你的需要,我们还得加再一个HomeObject,首先它来决定用哪个Server(当然,是由你用JNDI
String设定的),其次,它来管理EJBObject。
注意,这个EJBHome也是一个Interface,#1.UserServiceHome这个interface正是从它extends而来。并且EJBHo
me管理EJBObject的logic,也是AppServer的一部分。
现在的调用次序是
1. EJBHome.create()
2. EJBHomeStub
3. EJBHomeSkeleton
4. EJBHomeImp(EJSWrapper)
5. EJSHome
得到EJBObject
6. UserService.getUserInfo()
7. UserServiceStub
8. UserServiceSkeleton
9. UserServiceImp
10. UserServiceBean
现在已经完全和流程图的调用顺序一致了。
//EJB的基础是RMI IIOP,原理并不是很难,关键是实现起来比较绕,一个简单的功能要用10个(或更多)类来实现,但每一个都不是多余的。
//EJB的这种模式(或说RMI)完全屏蔽了底层的网络,并很好的实现了对业务代码的保护。