如何仅捕获FireDAC连接上的mysql_real_query?
我在DELphi上使用TFDMoniCustomClientLink建立了FireDac连接。我只需要捕获mysqL_real_query。我尝试启用和禁用所有EventKind,但是我找不到实现此目的的方法。我发现更接近的是仅启用ekVendor,但它提供的信息比mysqL_real_query多得多。
编辑:
mysql_real_query是TFDMoniCustomClienteLink生成的日志文本文件的一部分。本节显示在数据库上执行的sql。我在此找到的唯一参考文献是:http://docwiki.embarcadero.com/Libraries/Berlin/en/FireDAC.Phys.MySQLWrapper.TMySQLLib.mysql_real_query和此处https://dev.mysql.com/doc/refman/5.7/en/mysql-real-query.html。
TFDMoniCustomClientLink的OnOutput事件中的代码:
procedure TDmConnX.FDMonitorOutput(ASender: TFDMoniClientLinkBase;
const AClassName, AObjName, AMessage: string);
var
lstLog: TStringList;
sFile: ShortString;
begin
lstLog := TStringList.Create;
try
sFile := 'C:\log.txt';
if FileExists(sFile) then
lstLog.LoadFromFile(sFile);
lstLog.Add(AMessage);
lstLog.SaveToFile(sFile);
finally
lstLog.Free;
end;
end;
生成的日志文件:
. mysql_get_client_info [Ver="5.1.37"]
. mysql_init
. mysql_options [option=1, arg=0]
. mysql_real_connect [host="127.0.0.1", user="user", passwd="***", db="banco", port=3306, clientflag=198158]
. mysql_get_server_info [Ver="5.1.73-community"]
. mysql_real_query [q="SET SQL_AUTO_IS_NULL = 0
. mysql_insert_id [res=0]
. mysql_real_query [q="SHOW VARIABLES LIKE 'lower_case_table_names'
. mysql_store_result
. mysql_fetch_row [res=$06530BE8]
. mysql_fetch_lengths [res=$06530BE8]
. mysql_free_result [res=$06530BE8]
. mysql_get_server_info [Ver="5.1.73-community"]
. mysql_get_client_info [Ver="5.1.37"]
. mysql_character_set_name [res="latin1"]
. mysql_get_host_info [res="127.0.0.1 via TCP/IP"]
. mysql_get_server_info [Ver="5.1.73-community"]
. mysql_get_client_info [Ver="5.1.37"]
. mysql_character_set_name [res="latin1"]
我只需要捕获SQL,消除事件“。mysql_real_query [q =“”
我希望可以进行一些配置更改,以便仅导出实际的SQL,而无需使用这些部分,因此我不需要检查字符串中的模式。
最佳答案
随附的跟踪监视器无法执行您想做的事情。这是因为FireDAC的跟踪不是为自定义条目开发的,并且如您所正确识别的那样,mysql_real_query API函数的调用按ekVendor事件类型进行了分类,因此,除了解析消息本身,这是丑陋的方式。因此,让我们尝试以另一种方式。
1.阅读传递给DBMS的SQL命令
这个问题尚不清楚,但是您已经在注释中确认,您实际上只想记录传递给DBMS的SQL命令。如果您失去使用跟踪监视器的可能性,则可以在准备好后从Text属性(实际上在Checking the SQL Command Text一章中介绍)读取SQL命令。
如果引发EFDDBEngineException异常,则可以从其SQL属性读取SQL命令(在上述章节中也有介绍)。
2.拦截特定的DBMS API函数
如果您希望不改变FireDAC源地监视特定API函数调用的想法,则可以为驱动程序的OnDriverCreated事件编写处理程序,在其中拦截您感兴趣的函数,存储原始指针并执行所需的操作(包括在您拦截函数主体中调用原始存储函数)。例如,对于mysql_real_query函数,可能是这样的:
uses
FireDAC.Phys.MySQLWrapper, FireDAC.Phys.MySQLCli;
var
OrigRealQuery: TPrcmysql_real_query;
function MyRealQueryIntercept(mysql: PMYSQL; const q: my_pchar; length: my_ulong): Integer;
{$IFDEF MSWINDOWS} stdcall {$ELSE} cdecl {$ENDIF};
begin
{ ← do whatever you need before the original function call }
Result := OrigRealQuery(mysql, q, length); { ← call the original function }
{ ← do whatever you need after the original function call }
end;
procedure TForm1.FDPhysMySQLDriverLink1DriverCreated(Sender: TObject);
var
CliLib: TMySQLLib;
begin
CliLib := TMySQLLib(TFDPhysMySQLDriverLink(Sender).DriverIntf.CliObj);
OrigRealQuery := CliLib.mysql_real_query; { ← store the original function }
CliLib.mysql_real_query := MyRealQueryIntercept; { ← replace current with intercept }
end;
但这是非常特定的方法,并且会花费额外的函数调用开销。
3.编写自己的跟踪监视器
跟踪监视器不像以前那样灵活,但是仍然可以编写自己的方法并接收传递给Notify方法的信息,而不是连接消息(但是,您必须知道跟踪通知参数的含义) )。
这是我由TFDMoniCustomClientLink类精心制作的一个示例(但这对使用的RTTI不利,但是您可以自己对其进行调整):
unit FireDAC.Moni.Extended;
interface
uses
System.SysUtils, System.Classes, System.Rtti, FireDAC.Stan.Intf, FireDAC.Moni.Base;
type
IFDMoniClientNotifyHandler = interface(IFDMoniClientOutputHandler)
['{32F21585-F9CC-4C41-A7DF-10B8C1B98006}']
procedure HandleNotify(AKind: TFDMoniEventKind; AStep: TFDMoniEventStep;
ASender: TObject; const AMsg: string; const AArgs: TArray<TValue>);
end;
TFDMoniExtendedClient = class(TFDMoniClientBase, IFDMoniCustomClient)
private
FSynchronize: Boolean;
function GetSynchronize: Boolean;
procedure SetSynchronize(AValue: Boolean);
protected
procedure Notify(AKind: TFDMoniEventKind; AStep: TFDMoniEventStep;
ASender: TObject; const AMsg: string; const AArgs: array of const); override;
public
destructor Destroy; override;
end;
TFDMoniNotifyEvent = procedure(ASender: TObject; AKind: TFDMoniEventKind;
AStep: TFDMoniEventStep; const AMsg: string; const AArgs: TArray<TValue>) of object;
TFDMoniExtendedClientLink = class(TFDMoniClientLinkBase, IFDMoniClientNotifyHandler)
private
FOnNotify: TFDMoniNotifyEvent;
FExClient: IFDMoniCustomClient;
function GetSynchronize: Boolean;
procedure SetSynchronize(AValue: Boolean);
procedure SetOnNotify(AValue: TFDMoniNotifyEvent);
protected
function GetMoniClient: IFDMoniClient; override;
procedure HandleNotify(AKind: TFDMoniEventKind; AStep: TFDMoniEventStep;
ASender: TObject; const AMsg: string; const AArgs: TArray<TValue>); virtual;
public
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
property ExClient: IFDMoniCustomClient read FExClient;
published
property Tracing;
property Synchronize: Boolean read GetSynchronize write SetSynchronize default False;
property OnNotify: TFDMoniNotifyEvent read FOnNotify write SetOnNotify;
end;
implementation
uses
FireDAC.Stan.Factory;
type
TFDMoniExtendedClientMsg = class
private
FMsg: string;
FArgs: TArray<TValue>;
FKind: TFDMoniEventKind;
FStep: TFDMoniEventStep;
FSender: TObject;
FClient: IFDMoniCustomClient;
protected
procedure DoNotify; virtual;
public
constructor Create(const AClient: IFDMoniCustomClient; ASender: TObject;
AKind: TFDMoniEventKind; AStep: TFDMoniEventStep; const AMsg: string;
const AArgs: TArray<TValue>);
end;
{ TFDMoniExtendedClientMsg }
constructor TFDMoniExtendedClientMsg.Create(const AClient: IFDMoniCustomClient;
ASender: TObject; AKind: TFDMoniEventKind; AStep: TFDMoniEventStep;
const AMsg: string; const AArgs: TArray<TValue>);
var
I: Integer;
begin
inherited Create;
FMsg := AMsg;
SetLength(FArgs, Length(AArgs));
for I := Low(FArgs) to High(FArgs) do
FArgs[I] := AArgs[I];
FKind := AKind;
FStep := AStep;
FSender := ASender;
FClient := AClient;
end;
procedure TFDMoniExtendedClientMsg.DoNotify;
var
Handler: IFDMoniClientNotifyHandler;
begin
if Supports(FClient.OutputHandler, IFDMoniClientNotifyHandler, Handler) then
Handler.HandleNotify(FKind, FStep, FSender, FMsg, FArgs);
Destroy;
end;
{ TFDMoniExtendedClient }
destructor TFDMoniExtendedClient.Destroy;
begin
SetTracing(False);
inherited;
end;
function TFDMoniExtendedClient.GetSynchronize: Boolean;
begin
Result := FSynchronize;
end;
procedure TFDMoniExtendedClient.SetSynchronize(AValue: Boolean);
begin
FSynchronize := AValue;
end;
procedure TFDMoniExtendedClient.Notify(AKind: TFDMoniEventKind; AStep: TFDMoniEventStep;
ASender: TObject; const AMsg: string; const AArgs: array of const);
var
InArray: TArray<TValue>;
Payload: TFDMoniExtendedClientMsg;
Handler: IFDMoniClientNotifyHandler;
begin
if Supports(GetOutputHandler, IFDMoniClientNotifyHandler, Handler) then
begin
InArray := ArrayOfConstToTValueArray(AArgs);
if TThread.CurrentThread.ThreadID = MainThreadID then
Handler.HandleNotify(AKind, AStep, ASender, AMsg, InArray)
else
begin
Payload := TFDMoniExtendedClientMsg.Create(Self, ASender, AKind, AStep, AMsg, InArray);
TThread.Queue(nil, Payload.DoNotify);
end;
end;
inherited;
end;
{ TFDMoniExtendedClientLink }
constructor TFDMoniExtendedClientLink.Create(AOwner: TComponent);
begin
inherited;
FExClient := MoniClient as IFDMoniCustomClient;
end;
destructor TFDMoniExtendedClientLink.Destroy;
begin
FExClient := nil;
inherited;
end;
function TFDMoniExtendedClientLink.GetSynchronize: Boolean;
begin
Result := FExClient.Synchronize;
end;
procedure TFDMoniExtendedClientLink.SetSynchronize(AValue: Boolean);
begin
FExClient.Synchronize := AValue;
end;
procedure TFDMoniExtendedClientLink.SetOnNotify(AValue: TFDMoniNotifyEvent);
begin
if (TMethod(FOnNotify).Code <> TMethod(AValue).Code) or
(TMethod(FOnNotify).Data <> TMethod(AValue).Data) then
begin
if Assigned(AValue) then
MoniClient.OutputHandler := Self as IFDMoniClientNotifyHandler
else
MoniClient.OutputHandler := nil;
FOnNotify := AValue;
end;
end;
function TFDMoniExtendedClientLink.GetMoniClient: IFDMoniClient;
var
Client: IFDMoniCustomClient;
begin
FDCreateInterface(IFDMoniCustomClient, Client);
Result := Client as IFDMoniClient;
end;
procedure TFDMoniExtendedClientLink.HandleNotify(AKind: TFDMoniEventKind;
AStep: TFDMoniEventStep; ASender: TObject; const AMsg: string; const AArgs: TArray<TValue>);
begin
if Assigned(FOnNotify) and not (csDestroying in ComponentState) then
FOnNotify(Self, AKind, AStep, AMsg, AArgs);
end;
var
Factory: TFDFactory;
initialization
Factory := TFDSingletonFactory.Create(TFDMoniExtendedClient, IFDMoniCustomClient);
finalization
FDReleaseFactory(Factory);
end.
重要的是,当使用这样的类时,您不得在项目中包括FireDAC.Moni.Custom模块,否则IFDMoniCustomClient接口将为其他类注册(这是因为mbCustom类型的MonitorBy连接参数的跟踪监视器是由为IFDMoniCustomClient接口注册的类创建;这是在上述单元的初始化块中完成的操作)。
使用的简化示例:
uses
System.Rtti, FireDAC.Moni.Extended;
type
TForm1 = class(TForm)
FDPhysMySQLDriverLink1: TFDPhysMySQLDriverLink;
procedure FormCreate(Sender: TObject);
procedure FormDestroy(Sender: TObject);
procedure FDPhysMySQLDriverLink1DriverCreated(Sender: TObject);
private
FMonitor: TFDMoniExtendedClientLink;
procedure MonitorNotify(ASender: TObject; AKind: TFDMoniEventKind;
AStep: TFDMoniEventStep; const AMsg: string; const AArgs: TArray<TValue>);
end;
implementation
procedure TForm1.FormCreate(Sender: TObject);
begin
FMonitor := TFDMoniExtendedClientLink.Create(nil);
FMonitor.OnNotify := MonitorNotify;
FMonitor.EventKinds := [ekVendor];
FMonitor.Tracing := True;
end;
procedure TForm1.FormDestroy(Sender: TObject);
begin
FMonitor.Free;
end;
procedure TForm1.MonitorNotify(ASender: TObject; AKind: TFDMoniEventKind;
AStep: TFDMoniEventStep; const AMsg: string; const AArgs: TArray<TValue>);
begin
if (AKind = ekVendor) and (AStep = esProgress) and (AMsg = 'mysql_real_query') and
(Length(AArgs) >= 1) and (AArgs[1].IsType<string>)
then
ShowMessage(AArgs[1].AsType<string>);
end;
这种方法也非常适合您的需求,并且会花费新RTTI的额外开销,但这就是您可以优化的方法。