要编写全文解析器插件，请在插件源文件中包含以下头文件。根据插件的功能和要求，可能还需要其他 MySQL 或通用头文件。

#include <mysql/plugin.h>

plugin.h 定义了 MYSQL_FTPARSER_PLUGIN 服务器插件类型以及声明插件所需的数据结构。

为插件库文件设置库描述符。

此描述符包含服务器插件的通用插件描述符。对于全文解析器插件，类型必须为 MYSQL_FTPARSER_PLUGIN。这是标识插件在创建 FULLTEXT 索引时在 WITH PARSER 子句中合法使用的值。（此子句中没有其他插件类型是合法的。）

例如，包含名为 simple_parser 的单个全文解析器插件的库的库描述符如下所示

mysql_declare_plugin(ftexample)
{
  MYSQL_FTPARSER_PLUGIN,      /* type                            */
  &simple_parser_descriptor,  /* descriptor                      */
  "simple_parser",            /* name                            */
  "Oracle Corporation",       /* author                          */
  "Simple Full-Text Parser",  /* description                     */
  PLUGIN_LICENSE_GPL,         /* plugin license                  */
  simple_parser_plugin_init,  /* init function (when loaded)     */
  simple_parser_plugin_deinit,/* deinit function (when unloaded) */
  0x0001,                     /* version                         */
  simple_status,              /* status variables                */
  simple_system_variables,    /* system variables                */
  NULL,
  0
}
mysql_declare_plugin_end;

name 成员 (simple_parser) 指示在诸如 INSTALL PLUGIN 或 UNINSTALL PLUGIN 的语句中用于引用插件的名称。这也是 SHOW PLUGINS 或 INFORMATION_SCHEMA.PLUGINS 显示的名称。

有关更多信息，请参阅 第 4.4.2.1 节，“服务器插件库和插件描述符”.

设置类型特定的插件描述符。

库描述符中的每个通用插件描述符都指向一个类型特定的描述符。对于全文解析器插件，类型特定的描述符是 plugin.h 文件中 st_mysql_ftparser 结构的实例

struct st_mysql_ftparser
{
  int interface_version;
  int (*parse)(MYSQL_FTPARSER_PARAM *param);
  int (*init)(MYSQL_FTPARSER_PARAM *param);
  int (*deinit)(MYSQL_FTPARSER_PARAM *param);
};

如结构定义所示，描述符具有接口版本号并包含指向三个函数的指针。

接口版本号使用符号指定，符号的形式为：MYSQL_xxx_INTERFACE_VERSION。对于全文解析器插件，符号是 MYSQL_FTPARSER_INTERFACE_VERSION。在源代码中，您将在 include/mysql/plugin_ftparser.h 中找到为全文解析器插件定义的实际接口版本号。当前接口版本号是 0x0101。

init 和 deinit 成员应该指向一个函数，或者如果不需要该函数，则设置为 0。 parse 成员必须指向执行解析的函数。

在 simple_parser 声明中，该描述符由 &simple_parser_descriptor 指示。该描述符指定全文插件接口的版本号（如 MYSQL_FTPARSER_INTERFACE_VERSION 所示），以及插件的解析、初始化和反初始化函数

static struct st_mysql_ftparser simple_parser_descriptor=
{
  MYSQL_FTPARSER_INTERFACE_VERSION, /* interface version      */
  simple_parser_parse,              /* parsing function       */
  simple_parser_init,               /* parser init function   */
  simple_parser_deinit              /* parser deinit function */
};

全文解析器插件在两种不同的上下文中使用：索引和搜索。在这两种上下文中，服务器在处理导致调用插件的每个 SQL 语句的开始和结束时调用初始化和反初始化函数。但是，在语句处理期间，服务器以特定于上下文的的方式调用主解析函数

通用插件描述符中的插件声明具有指向初始化和反初始化函数的 init 和 deinit 成员，类型特定的插件描述符也指向它。但是，这两对函数具有不同的用途，并且由于不同的原因而被调用

插件描述符中命名的每个接口函数都应该返回零表示成功，或者返回非零表示失败，并且它们都接收一个指向包含解析上下文的 MYSQL_FTPARSER_PARAM 结构的 arguments。该结构具有以下定义

typedef struct st_mysql_ftparser_param
{
  int (*mysql_parse)(struct st_mysql_ftparser_param *,
                     char *doc, int doc_len);
  int (*mysql_add_word)(struct st_mysql_ftparser_param *,
                        char *word, int word_len,
                        MYSQL_FTPARSER_BOOLEAN_INFO *boolean_info);
  void *ftparser_state;
  void *mysql_ftparam;
  struct charset_info_st *cs;
  char *doc;
  int length;
  int flags;
  enum enum_ftparser_mode mode;
} MYSQL_FTPARSER_PARAM;

结构成员的用途如下

如果解析器在布尔模式下调用，则 param->mode 值将为 MYSQL_FTPARSER_FULL_BOOLEAN_INFO。解析器用于将标记信息传递到服务器的 MYSQL_FTPARSER_BOOLEAN_INFO 结构如下所示

typedef struct st_mysql_ftparser_boolean_info
{
  enum enum_ft_token_type type;
  int yesno;
  int weight_adjust;
  char wasign;
  char trunc;
  int position;
  /* These are parser state and must be removed. */
  char prev;
  char *quot;
} MYSQL_FTPARSER_BOOLEAN_INFO;

解析器应按如下方式填写结构成员

插件不应使用 MYSQL_FTPARSER_BOOLEAN_INFO 结构的 prev 和 quot 成员。

设置插件接口函数。

库描述符中的通用插件描述符指定了服务器在加载和卸载插件时应调用的初始化和反初始化函数。对于 simple_parser，这些函数不执行任何操作，只是返回零以指示它们成功

static int simple_parser_plugin_init(void *arg __attribute__((unused)))
{
  return(0);
}

static int simple_parser_plugin_deinit(void *arg __attribute__((unused)))
{
  return(0);
}

由于这些函数实际上没有执行任何操作，因此可以省略它们，并在插件声明中为它们分别指定 0。

用于 simple_parser 的类型特定插件描述符指定了服务器在使用插件时调用的初始化、反初始化和解析函数。对于 simple_parser，初始化和反初始化函数不执行任何操作

static int simple_parser_init(MYSQL_FTPARSER_PARAM *param
                              __attribute__((unused)))
{
  return(0);
}

static int simple_parser_deinit(MYSQL_FTPARSER_PARAM *param
                                __attribute__((unused)))
{
  return(0);
}

同样，由于这些函数不执行任何操作，因此可以省略它们，并在插件描述符中为它们分别指定 0。

主解析函数 simple_parser_parse() 充当内置全文解析器的替代，因此它需要将文本分割成单词并将每个单词传递到服务器。解析函数的第一个参数是指向包含解析上下文的结构的指针。此结构有一个 doc 成员，它指向要解析的文本，以及一个 length 成员，它指示文本的长度。插件执行的简单解析将非空空白字符运行视为单词，因此它通过以下方式识别单词

static int simple_parser_parse(MYSQL_FTPARSER_PARAM *param)
{
  char *end, *start, *docend= param->doc + param->length;

  for (end= start= param->doc;; end++)
  {
    if (end == docend)
    {
      if (end > start)
        add_word(param, start, end - start);
      break;
    }
    else if (isspace(*end))
    {
      if (end > start)
        add_word(param, start, end - start);
      start= end + 1;
    }
  }
  return(0);
}

当解析器找到每个单词时，它将调用一个函数 add_word() 将单词传递到服务器。 add_word() 只是一个辅助函数；它不是插件接口的一部分。解析器将解析上下文指针传递给 add_word()，以及指向单词的指针和长度值

static void add_word(MYSQL_FTPARSER_PARAM *param, char *word, size_t len)
{
  MYSQL_FTPARSER_BOOLEAN_INFO bool_info=
    { FT_TOKEN_WORD, 0, 0, 0, 0, 0, ' ', 0 };

  param->mysql_add_word(param, word, len, &bool_info);
}

对于布尔模式解析， add_word() 将 bool_info 结构的成员填写，如前面关于 st_mysql_ftparser_boolean_info 结构的讨论中所述。

设置状态变量。对于 simple_parser 插件，以下状态变量数组设置了一个状态变量，其值为静态文本，另一个状态变量的值存储在一个长整型变量中

long number_of_calls= 0;

struct st_mysql_show_var simple_status[]=
{
  {"simple_parser_static", (char *)"just a static text", SHOW_CHAR},
  {"simple_parser_called", (char *)&number_of_calls,     SHOW_LONG},
  {0,0,0}
};

通过使用以插件名称开头的状态变量名称，可以使用 SHOW STATUS 轻松显示插件的变量。

mysql> SHOW STATUS LIKE 'simple_parser%';
+----------------------+--------------------+
| Variable_name        | Value              |
+----------------------+--------------------+
| simple_parser_static | just a static text |
| simple_parser_called | 0                  |
+----------------------+--------------------+

要编译和安装插件库文件，请使用 第 4.4.3 节“编译和安装插件库” 中的说明。要使库文件可供使用，请将其安装到插件目录（由 plugin_dir 系统变量命名的目录）中。对于 simple_parser 插件，它在从源代码构建 MySQL 时进行编译和安装。它也包含在二进制发行版中。构建过程会生成一个名为 mypluglib.so 的共享对象库（.so 后缀可能因平台而异）。

要使用插件，请将其注册到服务器。例如，要在运行时注册插件，请使用以下语句，根据需要调整您的平台的 .so 后缀

INSTALL PLUGIN simple_parser SONAME 'mypluglib.so';

有关插件加载的更多信息，请参见 安装和卸载插件。

要验证插件安装，请检查 INFORMATION_SCHEMA.PLUGINS 表或使用 SHOW PLUGINS 语句。请参见 获取服务器插件信息。

测试插件以验证它是否正常工作。

创建一个包含字符串列的表，并将解析器插件与该列上的 FULLTEXT 索引关联起来

mysql> CREATE TABLE t (c VARCHAR(255),
    ->   FULLTEXT (c) WITH PARSER simple_parser
    -> ) ENGINE=MyISAM;
Query OK, 0 rows affected (0.01 sec)

在表中插入一些文本并尝试一些搜索。这应该验证解析器插件是否将所有非空格字符视为单词字符

mysql> INSERT INTO t VALUES
    ->   ('utf8mb4_0900_as_cs is a case-sensitive collation'),
    ->   ('I\'d like a case of oranges'),
    ->   ('this is sensitive information'),
    ->   ('another row'),
    ->   ('yet another row');
Query OK, 5 rows affected (0.02 sec)
Records: 5  Duplicates: 0  Warnings: 0

mysql> SELECT c FROM t;
+--------------------------------------------------+
| c                                                |
+--------------------------------------------------+
| utf8mb4_0900_as_cs is a case-sensitive collation |
| I'd like a case of oranges                       |
| this is sensitive information                    |
| another row                                      |
| yet another row                                  |
+--------------------------------------------------+
5 rows in set (0.00 sec)

mysql> SELECT MATCH(c) AGAINST('case') FROM t;
+--------------------------+
| MATCH(c) AGAINST('case') |
+--------------------------+
|                        0 |
|          1.2968142032623 |
|                        0 |
|                        0 |
|                        0 |
+--------------------------+
5 rows in set (0.00 sec)

mysql> SELECT MATCH(c) AGAINST('sensitive') FROM t;
+-------------------------------+
| MATCH(c) AGAINST('sensitive') |
+-------------------------------+
|                             0 |
|                             0 |
|               1.3253291845322 |
|                             0 |
|                             0 |
+-------------------------------+
5 rows in set (0.01 sec)

mysql> SELECT MATCH(c) AGAINST('case-sensitive') FROM t;
+------------------------------------+
| MATCH(c) AGAINST('case-sensitive') |
+------------------------------------+
|                    1.3109166622162 |
|                                  0 |
|                                  0 |
|                                  0 |
|                                  0 |
+------------------------------------+
5 rows in set (0.01 sec)

mysql> SELECT MATCH(c) AGAINST('I\'d') FROM t;
+--------------------------+
| MATCH(c) AGAINST('I\'d') |
+--------------------------+
|                        0 |
|          1.2968142032623 |
|                        0 |
|                        0 |
|                        0 |
+--------------------------+
5 rows in set (0.01 sec)

对于内置解析器，“case” 和 “insensitive” 都无法像匹配 “case-insensitive” 一样匹配。