利用DataSnap的回调功能在客户端显示服务器方法的执行进度
如果DataSnap服务器方法的执行时间比较长,这时候可能需要在客户端用进度条显示当前服务器方法的执行进度。要实现这种需求,现在可以利用DataSnap的回调功能,此功能是从Delphi 2010版本开始被引入的。
要实现回调,服务器方法需要暴露给客户端一个或多个类型为TDBXCallback的参数。例如:
...
{$METHODINFO ON}
TServerMethods1 = class(TComponent)
private
{ Private declarations }
public
{ Public declarations }
function LongTimeRunFunc(InitCallback, ProgCallback: TDBXCallback): boolean;
end;
{$METHODINFO OFF}
...
LongTimeRunFunc方法带有两个回调参数,InitCallback用来初始化客户端TProgressBar的设置,ProgCallback根据当前方法的执行进度,设置客户端TProgressBar.Position的属性。
implementation
...
function TServerMethods1.LongTimeRunFunc(InitCallback, ProgCallback: TDBXCallback): boolean;
var
Max: Integer;
I: Integer;
begin
Max := Random(120) + 1;
InitCallback.Execute(TJSONNumber.Create(Max)).Free;
for I := 0 to Max do
begin
ProgCallback.Execute(TJSONNumber.Create(I)).Free;
sleep(1000);
end;
Result := True;
end;
...
LongTimeRunFunc函数生成一个随机数,表示将执行的秒数。InitCallback和ProgCallback在execute时,将等待客户端执行完毕才继续。
而客户端这边的代码,需要申明两个继承自TDBXCallback(抽象类)的类,并且重载Execute方法,
...
TInitCallback = class(TDBXCallback)
function Execute(const Arg: TJSONValue): TJSONValue; override;
end;
TProgCallback = class(TDBXCallback)
function Execute(const Arg: TJSONValue): TJSONValue; override;
end;
...
implementation
...
function TProgCallback.Execute(const Arg: TJSONValue): TJSONValue;
begin
with Form2 do
begin
ProgressBar1.Position := TJSONNumber(Arg).AsInt;
btnStart.Enabled := (TJSONNumber(Arg).AsInt = ProgressBar1.Max);
end;
//刷新屏幕
Application.ProcessMessages;
Result := TJSONNull.Create;
end;
function TInitCallback.Execute(const Arg: TJSONValue): TJSONValue;
begin
with Form2 do
begin
ProgressBar1.Max := TJSONNumber(Arg).AsInt;
ProgressBar1.Step := 5;
Edit1.Text := '总时长:' + TJSONNumber(Arg).ToString + '秒';
btnStart.Enabled := False;
end;
Result := TJSONNull.Create;
end;
procedure TForm2.btnStartClick(Sender: TObject);
begin
ClientModule1.ServerMethods1Client.LongTimeRunFunc(InitCallback, ProgCallback);
end;
Initialization
InitCallback := TInitCallback.Create;
ProgCallback := TProgCallback.Create;
...