QuickServer开发指南（5）- 客户数据
QuickServer开发指南（5）- 客户数据
既然不能在ClientCommandHandler和ServerAuthenticator类中保存客户数据，我们使用ClientData类的handleCommand()或askAuthorisation()方法来存储所有的客户端信息。
示范一下这个特点有什么用。还是以EchoServer为例，当用户发送"Hello"时，我们给他一个问候。如果用户再发送"Hello"，我们提醒他 已经发了n次"Hello"。接下来定义ClientData类来存储用户名以及他向服务器发送"Hello"的次数。
1. 代码
1. 在EchoServer中创建一个EchoServerData类
|
01
//---- EchoServerData.java ----
02 package echoserver;
03
04
import
org.quickserver.net.server.*;
05
import
java.io.*;
06
07
public class
EchoServerData
implements
ClientData {
08
private int
helloCount;
09
private
String username;
10
11
public void
setHelloCount(
int
count) {
12
helloCount = count;
13
}
14
public int
getHelloCount() {
15
return
helloCount;
16
}
17
18
public void
setUsername(String username) {
19
this
.username = username;
20
}
21
public
String getUsername() {
22
return
username;
23
}
24
}
25
//--- end of code ---
|
2. 告诉QuickServer用这个EchoServerData来做为它的ClientData类。
修改前面创建的EchoServer.java，代码如下：
|
01
package
echoserver;
02
03
import
org.quickserver.net.*;
04
import
org.quickserver.net.server.*;
05
06
import
java.io.*;
07
08
public class
EchoServer {
09
public static void
main(String s[]) {
10
11
String cmd =
"echoserver.EchoCommandHandler"
;
12
String auth =
"echoserver.EchoServerQuickAuthenticator"
;
13
String data =
"echoserver.EchoServerData"
;
14
15
QuickServer myServer =
new
QuickServer(cmd);
16
myServer.setAuthenticator(auth);
17
myServer.setClientData(data);
18
19
myServer.setPort(
4123
);
20
myServer.setName(
"Echo Server v 1.0"
);
21
try
{
22
myServer.startServer();
23
}
catch
(AppException e){
24
System.out.println(
"Error in server : "
+e);
25
}
26
}
27
}
|
上面的代码中，我们将配置信息写入String对象来设置QuickServer。
3. 修改Authenticator类，也就是EchoServerAuthenticator类，让它在ClientData对象中存储用户名。下面是修改后的代码：
|
01
package
echoserver;
02
03
import
org.quickserver.net.server.*;
04
import
java.io.*;
05
06
public class
EchoServerQuickAuthenticator
extends
QuickAuthenticator {
07
08
public boolean
askAuthorisation(ClientHandler clientHandler)
09
throws
IOException {
10
String username = askStringInput(clientHandler,
"User Name :"
);
11
if
(username!=null && username.equalsIgnoreCase(
"QUIT"
)) {
12
sendString(clientHandler,
"Logged out."
);
13
//close the connection
14
clientHandler.closeConnection();
15
return false
;
16
}
17
18
String password = askStringInput(clientHandler,
"Password :"
);
19
20
if
(username==
null
|| password ==
null
)
21
return false
;
22
23
if
(username.equals(password)) {
24
sendString(clientHandler,
"Auth OK"
);
25
//store the username in ClientData
26
EchoServerData data = (EchoServerData)clientHandler.getClientData();
27
data.setUsername(username);
28
return true
;
29
}
else
{
30
sendString(clientHandler,
"Auth Failed"
);
31
return false
;
32
}
33
}
34 } |
4. 修改ClientCommandHandler实现类EchoCommandHandler。如果用户发送"Hello"，给他一个问候。如果他发送多次"Hello"，告诉他已经发送了n次"Hello"。下面是修改后的代码：
|
01
// EchoCommandHandler.java
02
package
echoserver;
03
04
import
java.net.*;
05
import
java.io.*;
06
import
org.quickserver.net.server.ClientCommandHandler;
07
import
org.quickserver.net.server.ClientHandler;
08
09
public class
EchoCommandHandler
implements
ClientCommandHandler {
10
11
public void
gotConnected(ClientHandler handler)
12
throws
SocketTimeoutException, IOException {
13
handler.sendClientMsg(
"+++++++++++++++++++++++++++++++"
);
14
handler.sendClientMsg(
"| Welcome to EchoServer v 1.0 |"
);
15
handler.sendClientMsg(
"| Note: Password = Username |"
);
16
handler.sendClientMsg(
"| Send 'Quit' to exit |"
);
17
handler.sendClientMsg(
"+++++++++++++++++++++++++++++++"
);
18
}
19
public void
lostConnection(ClientHandler handler)
20
throws
IOException {
21
handler.sendSystemMsg(
"Connection lost : "
+
22
handler.getSocket().getInetAddress());
23
}
24
public void
closingConnection(ClientHandler handler)
25
throws
IOException {
26
handler.sendSystemMsg(
"Closing connection : "
+
27
handler.getSocket().getInetAddress());
28
}
29
30
public void
handleCommand(ClientHandler handler, String command)
31
throws
SocketTimeoutException, IOException {
32
if
(command.equals(
"Quit"
)) {
33
handler.sendClientMsg(
"Bye ;-)"
);
34
handler.closeConnection();
35
}
if
(command.equalsIgnoreCase(
"hello"
)) {
36
EchoServerData data = (EchoServerData) handler.getClientData();
37
data.setHelloCount(data.getHelloCount()+
1
);
38
if
(data.getHelloCount()==
1
) {
39
handler.sendClientMsg(
"Hello "
+data.getUsername());
40
}
else
{
41 handler.sendClientMsg("You told Hello "
+data.getHelloCount()+
42 " times. ");
43 }
44 } else
{
45
handler.sendClientMsg(
"Echo : "
+command);
46
}
47
}
48
}
|
5. 编译改好的程序，运行，使用SocketTest测试。登录后，发送"Hello"，系统会给一个问候，再次发送"Hello"，它将告诉你发送了多少次"Hello"。
4.2 创建ClientData池
现在我们知道ClientData可以正常工作了。但是对每一个连接QuickServer的客户端都要创建一个新的ClientData对象，可能会造成性能上的瓶颈，尤其对性能要求较高的服务器来说。
我们可以创建一个ClientData池对象，无论客户端什么时候进行连接，都使用同一个对象。首先实现下面的接口：
org.quickserver.util.pool.PoolableObject
查找QuickServer API文档可以发现PoolableObject只有两个必须实现的方法：
org.apache.commons.pool.PoolableObjectFactory属于通常的工厂方法。
isPoolable()判断对象是否可以成为池对象。
PoolableObjectFactory
org.apache.commons.pool.PoolableObjectFactory接口包含了以下方法：
o void activateObject(Object obj)：重新初始化一个实例。
o void destroyObject(Object obj)：销毁一个不再需要的实例。
o Object makeObject()：创建一个实例。
o void passivateObject(Object obj)：禁止初始化一个实例。
o boolean validateObject(Object obj)：确定一个实例是否安全。
我们可以扩展一个基于无操作的实现来创建可"池"化的对象：
org.apache.commons.pool.BasePoolableObjectFactory
这个类只有一个抽象方法makeObject()和一个validateObject()方法，它只返回true。
我们来创建一个EchoServerPoolableData类。
|
01
//---- EchoServerPoolableData.java ----
02
package
echoserver;
03
04
import
org.quickserver.net.server.*;
05
import
java.io.*;
06
07
public class
EchoServerPoolableData
08
extends
EchoServerData
09
implements
org.apache.commons.pool.PoolableObjectFactory {
10
11
public void
activateObject(Object obj) {
12
}
13
public void
destroyObject(Object obj) {
14
if
(obj==
null
)
return
;
15
passivateObject(obj);
16
obj =
null
;
17
}
18
public
Object makeObject() {
19
return new
EchoServerPoolableData();
20
}
21
public void
passivateObject(Object obj) {
22
EchoServerPoolableData pd = (EchoServerPoolableData)obj;
23
pd.setHelloCount(
0
);
24
pd.setUsername(
null
);
25
}
26
public boolean
validateObject(Object obj) {
27
if
(obj==
null
)
28
return false
;
29
else
30
return true
;
31
}
32
}
33 //--- end of code --- |
这个类扩展了我们的EchoServerData，然后我们实现了org.apache.commons.pool.BasePoolableObjectFactory，这个实现是简单的不需要解释了。
现在我们需要告诉QuickServer使用这个类来代替原来的ClientData类。
myServer.setClientData("echoserver.EchoServerPoolableData");
编译修改的程序，可能会报如下错误：
package org.apache.commons.pool does not exist。
这是因为编译器不知道这个类。可以在环境变量中添加D:\QuickServer\dist\commons-pool.jar包，并在运行时
set classpath=%classpath%;d:\QuickServer\dist\QuickServer.jar; d:\QuickServer\dist\commons-pool.jar;.\（类所在文件夹）即可。