DataSnap 2009 系列之二 （方法篇）

（方法篇）

    在过去客户端要调用远程服务器的方法需要通过在TLB里添加接口并且在服务器对象中实现，在DataSnap 2009中调用远程服务器的方法是基于delphi的RTTI机制的，想要一个类允许被远程调用需要做以下两点：

    1.把该类和DSServerClass连接在一起

    注意：DSServerClass必须设置要导出的类 否则会出现SOnGetClassNotSet的异常信息

    2.该类必须使用$MethodInfo编译指令生成详细的RTTI信息

    所以我们使用向导添加的ServerModule 不需要再手动添加$MethodInfo开关，同样我们也可以不用继承自 TDSServerModule来实现我们的ServerClass，只要从TPersistent继承一个类 并且用{$MethodInfo ON}和{$MethodInfo OFF}包围就可以输出成员函数到客户端。

　　注意：要输出的成员函数必须声明为public

　　客户端调用可以使用两种方法：

　　1.使用SqlServerMethod组件

　　通过设置其ServerMethodName属性来进行远程调用 使用Params属性来传递参数和结果值

　　2.使用本地代理类

　　选中SQLConnection组件，在右键菜单中单击Generate Datasnap client classe 生成代理类单元。

    下面我们通过一个简单的DEMO来展示DataSnap 2009的远程方法调用，我们在服务端定义了4个输出的成员函数：

[delphi]  view plain copy print ?

1. TSM = class(TDSServerModule)  
2. public  
3. 　 function Hello(Message: String): String;  
4. 　 function VariantMethod(Value: OleVariant): OleVariant;  
5. 　 function StreamMethod: TStream;  
6. 　 function VarOutMethod(out OutParam: OleVariant; var VarParam: OleVariant): string;  
7. end;  

由于在DataSnap内部是使用TDBXValue来管理参数列表的，所以使用string等delphi语言自带的类型将会进行相应的映射。使用TDBXValue也是效率最高的，以下是可以作为参数使用的TDBXValue列表。

TDBXWideStringValue
TDBXAnsiStringValue
TDBXInt16Value
TDBXInt32Value
TDBXInt64Value
TDBXSingleValue
TDBXDoubleValue
TDBXBcdValue
TDBXTimeValue
TDBXDateValue
TDBXTimeStampValue
TDBXBooleanValue
TDBXReaderValue
TDBXStreamValue

我们分别使用SqlServerMethod和代理类完成对服务端Hello方法的调用

[delphi]  view plain copy print ?

1. SqlServerMethod.ServerMethodName := 'TSM.Hello';  
2. SqlServerMethod.Params[0].AsString := Name.Text;  
3. SqlServerMethod.ExecuteMethod;  
4. Memo.Lines.Add('Use SqlServerMethod: ' + SqlServerMethod.Params[1].AsString);  

    这里参数使用了索引值进行访问传递的顺序是从左到右添加到Params列表 返回值是在列表的最后一个位置，同样也可以使用 ParamByName(参数名称).Value的形式传递参数 返回值的名称默认是'ReturnParameter'。使用代理类调用的方法和调用本地方法区别不大 因为远程调用的具体过程已经被代理类封装可以看下代理类中生成的Hello方法。

[delphi]  view plain copy print ?

1. function TSMClient.Hello(Message: string): string;  
2. begin  
3. 　 if FHelloCommand = nil then  
4. 　 begin  
5. 　　　 FHelloCommand := FDBXConnection.CreateCommand;  
6. 　　　 FHelloCommand.CommandType := TDBXCommandTypes.DSServerMethod;  
7. 　　　 FHelloCommand.Text := 'TSM.Hello';  
8. 　　　 FHelloCommand.Prepare;  
9. 　 end;  
10. 　 FHelloCommand.Parameters[0].Value.SetWideString(Message);  
11. 　 FHelloCommand.ExecuteUpdate;  
12. 　 Result := FHelloCommand.Parameters[1].Value.GetWideString;  
13. end;  

　　我们看到代理类使用了比SqlServerMethod更低级的DBXCommand进行了封装 以更友好的方式给我们使用

[delphi]  view plain copy print ?

1. with TSMClient.Create(SQLConnection.DBXConnection) do  
2. begin  
3. 　 Memo.Lines.Add('Use Proxy: ' + Hello(Name.Text));  
4. 　 Free;  
5. end;  

　　下面我们用TStream返回一个结构体并且在客户端读出

　　服务端部分

[delphi]  view plain copy print ?

1. TName = packed record  
2. 　 FirstName: array[0..99] of Char;  
3. 　 LastName: array[0..99] of Char;  
4. end;  
5. function TSM.StreamMethod: TStream;  
6. var  
7. 　 Name: TName;  
8. begin  
9. 　 Name.FirstName := '爱新觉罗';  
10. 　 Name.LastName := '玄烨';  
11. 　 Result := TMemoryStream.Create;  
12. 　 Result.Seek(0, soFromBeginning);  
13. 　 Result.Write(Name, SizeOf(TName));  
14. 　 Result.Seek(0, soFromBeginning); //返回到客户端的数据是从position开始的  
15. end;  

　　注意：写完数据以后需要定位到头部 否则客户端得到的数据长度为0

客户端部分

[delphi]  view plain copy print ?

1. procedure TMainForm.StreamTestClick(Sender: TObject);  
2. var  
3. 　 Name: TName;  
4. begin  
5. 　 if SQLConnection.Connected　 then  
6. 　 begin  
7. 　　　 with TSMClient.Create(SQLConnection.DBXConnection) do  
8. 　　　 begin  
9. 　　　　　 StreamMethod.ReadBuffer(Name, SizeOf(TName));  
10. 　　　　　 Memo.Lines.Add(Format('(StreamMethod)FirstName: %s LastName: %s',[Name.FirstName, Name.LastName]));  
11. 　　　　　 Free;  
12. 　　　 end;  
13. 　 end;  
14. end;  

　　最后一个函数演示了使用var和out关键字来返回参数，以下是可以使用这两个关键字的标量值类型：

boolean
SmallInt
Integer
Int64
Single
Double
AnsiString
String
TDBXTime
TDBXDate

　　再加上其他的参数类型

TStream
TDataSet
TParams
TDBXReader
TDBXConnection

　　但是在实际测试过程中发现在使用string类型做out和var的参数时 无法使用，跟踪发现源码中ansistring和 string的相关代码已经被注释掉 估计是有BUG存在所以不支持 以后应该可以修复。

　　以下摘自DSReflect单元的 procedure TDSMethodValues.AssignParameterValues(Parameters: TDBXParameterArray);

[delphi]  view plain copy print ?

1. //　　　　　　　 TDBXDataTypes.AnsiStringType:  
2. //　　　　　　　 begin  
3. //　　　　　　　　　 s := Value.GetAnsiString;  
4. //　　　　　　　　　 GetMem(p, SizeOf(Pointer));  
5. //　　　　　　　　　 UniqueString(s);  
6. //　　　　　　　　　 PPointer(p)^ := Pointer(s);  
7. //　　　　　　　　　 FMethodValues[i] := MakeRefVar(varString, p);  
8. //　　　　　　　 end;  
9. //　　　　　　　 TDBXDataTypes.BytesType:  
10. //　　　　　　　 begin  
11. //　　　　　　　　　 SetLength(bytes, value.GetValueSize);  
12. //　　　　　　　　　 Value.GetBytes(0, bytes, 0, Length(Bytes));  
13. //　　　　　　　　　 GetMem(p, Length(bytes));  
14. //　　　　　　　　　 Move(bytes[0], p^, Length(bytes));  
15. //　　　　　　　　　 FMethodValues[i] := MakeRefVar(varByte or varArray, p);  
16. //　　　　　　　 end;  
17. //　　　　　　　 TDBXDataTypes.WideStringType:  
18. //　　　　　　　 begin  
19. //　　　　　　　　　 w := Value.GetWideString;  
20. //　　　　　　　　　 GetMem(p, SizeOf(Pointer));  
21. //　　　　　　　　　 UniqueString(w);  
22. //　　　　　　　　　 PPointer(p)^ := Pointer(w);  
23. //　　　　　　　　　 FMethodValues[i] := MakeRefVar(varUString, p);  
24. //　　　　　　　 end;