MySQL自定义函数(User Define Function)开发实例——发送TCP/UDP消息

开发背景

当数据库中某个字段的值改为特定值时，实时发送消息通知到其他系统。

实现思路

监控数据库中特定字段值的变化可以用数据库触发器实现。还需要实现一个自定义的函数，接收一个字符串参数，然后将这个字符传通过udp消息发送到指定端口。

在触发器中执行这个自定义函数并在其他系统中监听指定端口的消息。从而实现数据库内容变化通知到其他系统的功能。

开发前准备

MySQL自定义函数仅支持C/C++开发，所以需要一些C/C++的基础。

这里以在Windows系统使用Visual Studio2022开发进行介绍。

添加依赖项libmysql.lib、ws2_32.lib，引入头文件"mysql.h"  <ws2tcpip.h>

自定义函数我这里取名为SendG，使用方式为SendG('abcde')

MySQL自定义函数设计说明

提前说明：本文只介绍满足前面提到的需要的情况下涉及到的自定义函数设计方法。

这里要涉及两个方法

bool SendG_init(UDF_INIT* init, UDF_ARGS* args, char* message)   这个后缀_init方法顾名思义是一个初始函数

void SendG(UDF_INIT* init, UDF_ARGS* args, char* result, unsigned long* length, char* is_null, char* error) 主体函数

当我们每次调用SendG('abcde') 时会先调用 _init后缀的函数，然后才会调用主体函数中的业务逻辑。因此我们可以在SendG_init函数中检查参数是否正确，在SendG函数中执行具体的业务逻辑。

函数的命名是固定的必须取名为 xxxx_init和xxxx

至于UDF_INIT   UDF_ARGS等结构的使用方法则不用担心，MySQL的头文件中有详细介绍，基本一看就大概知道怎么用，例如以下是UDF_ARGS的定义：

本文会用到arg_count、arg_type、lengths这几个字段，他们的命名结合上面的注释就可以知道具体含义，这里不在啰嗦。

具体实现代码

#include "pch.h"
#include "mysql.h"
#include <ws2tcpip.h>
extern "C" {
    __declspec(dllexport)
        bool SendG_init(UDF_INIT* tinit, UDF_ARGS* args, char* message) {
        if (args->arg_count != 1) {
            char ms[]{ "Only one parameter is accepted in the call to udf 'SendG'" };
            memcpy_s(message, sizeof(ms), ms, sizeof(ms));
            return true;
        }
        else if (args->arg_type[0] != STRING_RESULT) {
            char ms[]{ "Only string parameters are accepted in the call to udf 'SendG'" };
            memcpy_s(message, sizeof(ms), ms, sizeof(ms));
            return true;
        }
        return false;
    }
    __declspec(dllexport)
        void SendG(UDF_INIT* tinit, UDF_ARGS* args, char* result, unsigned long* length, char* is_null, char* error) {
        SOCKET sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
        sockaddr_in RecvAddr{};
        RecvAddr.sin_family = AF_INET;
        RecvAddr.sin_port = htons(54321);
        inet_pton(AF_INET, "127.0.0.1", &RecvAddr.sin_addr);
        *is_null = 1;
        sendto(sock, args->args[0], args->lengths[0], 0, (SOCKADDR*)&RecvAddr, sizeof(RecvAddr));
        closesocket(sock);
    }
}

我们在SendG_init中检查参数的数量和类型是否正确，SendG_init的返回true代表有错误，返回false才表示没问题。参数错误时向message写入具体的错误提示，帮助调用者正确使用我们的函数。

然后会执行SendG主体函数，这里创建一个SOCKET使用UDP协议将传入的字符串发送给本机的54321端口，最后关闭SOCKET。

这里需要注意两点：

1、函数必须使用extern "C"导出C语言标准的函数

2、在这个例子中SendG方法是不需要有执行结果的，所以它的返回值类型是void，其次因为没有返回值所以这里必须使用*is_null=1允许方法返回NULL。如果有返回值则正常返回具体的类型，可选的返回值类型在Item_result中定义（init中检查参数类型时就用到了）它与UDF_ARGS在同一个头文件中，这里就不具体展开了。

自定义函数的注册与卸载

首先将生成的dll放在MySQL的plugin目录中，可使用select @@plugin_dir查询。然后使用CREATE FUNCTION SendG RETURNS string SONAME 'SUDP.dll'  向数据库注册函数

现在执行select SendG('abcde')就会向54321端口发送abcde了（可以改写 SendG让它接受两个参数，把端口号作为第二个参数，这样SendG函数的功能就更加灵活了）

卸载使用 DROP FUNCTION SendG;

总结

MySQL的UDF提供了开发自定义函数的功能，实际在这里可以执行我们自己写的任意代码，别说发UDP/TCP消息了就是发邮件都行。