Module ngx_http_perl_module

ngx_http_perl_module模块用于在 Perl 中实现位置和变量处理程序,并将 Perl 调用插入 SSI。

默认情况下未构建此模块,应使用--with-http_perl_module配置参数启用它。

Note

此模块要求Perl 5.6.1 或更高版本。 C 编译器应与用于构建 Perl 的编译器兼容。

Known Issues

该模块是实验性的,警告购买者适用。

为了使 Perl 在重新配置期间重新编译已修改的模块,应使用-Dusemultiplicity=yes-Dusethreads=yes参数来构建它。另外,要使 Perl 在运行时泄漏较少的内存,应使用-Dusemymalloc=no参数构建它。要在已经构建的 Perl 中检查这些参数的值(在示例中指定了首选值),请运行:

$ perl -V:usemultiplicity -V:usemymalloc
usemultiplicity='define';
usemymalloc='n';

请注意,在使用新的-Dusemultiplicity=yes-Dusethreads=yes参数重建 Perl 之后,所有二进制 Perl 模块也必须重建-它们将仅停止使用新的 Perl。

每次重新配置后,主进程和然后的工作进程的大小都有可能增加。如果主进程增长到不可接受的大小,则可以应用live upgrade过程,而无需更改可执行文件。

当 Perl 模块执行长时间运行的操作(例如解析域名,连接到另一台服务器或查询数据库)时,将不会处理分配给当前工作进程的其他请求。因此,建议仅执行具有可预测且执行时间短的操作,例如访问本地文件系统。

Example Configuration

http {

    perl_modules perl/lib;
    perl_require hello.pm;

    perl_set $msie6 '

        sub {
            my $r = shift;
            my $ua = $r->header_in("User-Agent");

            return "" if $ua =~ /Opera/;
            return "1" if $ua =~ / MSIE [6-9]\.\d+/;
            return "";
        }

    ';

    server {
        location / {
            perl hello::handler;
        }
    }

perl/lib/hello.pm模块:

package hello;

use nginx;

sub handler {
    my $r = shift;

    $r->send_http_header("text/html");
    return OK if $r->header_only;

    $r->print("hello!\n
"); if (-f $r->filename or -d _) { $r->print($r->uri, " exists!\n"); } return OK; } 1; __END__

Directives

Syntax: perl module::function|'sub { ... }';
Default:
Context: location , limit_except

为给定位置设置一个 Perl 处理程序。

Syntax: perl_modules path;
Default:
Context: http

为 Perl 模块设置附加路径。

Syntax: perl_require module;
Default:
Context: http

定义将在每次重新配置期间加载的模块的名称。可以存在多个perl_require指令。

Syntax: perl_set $variable module::function|'sub { ... }';
Default:
Context: http

为指定的变量安装一个 Perl 处理程序。

从 SSI 调用 Perl

调用 Perl 的 SSI 命令具有以下格式:

<!--# perl sub="module::function" arg="parameter1" arg="parameter2" ...
-->

$ r 请求对象方法

package hello;

use nginx;

sub handler {
    my $r = shift;

    if ($r->request_method ne "POST") {
        return DECLINED;
    }

    if ($r->has_request_body(\&post)) {
        return OK;
    }

    return HTTP_BAD_REQUEST;
}

sub post {
    my $r = shift;

    $r->send_http_header;

    $r->print("request_body: \"", $r->request_body, "\"
"); $r->print("request_body_file: \"", $r->request_body_file, "\"
\n"); return OK; } 1; __END__

$r->internal_redirect(uri)

Note

从 1.17.2 版开始,该方法接受转义的 URI,并支持重定向到命名位置。

package hello;

use nginx;

sub handler {
    my $r = shift;

    $r->discard_request_body;
    $r->variable("var", "OK");
    $r->sleep(1000, \&next);

    return OK;
}

sub next {
    my $r = shift;

    $r->send_http_header;
    $r->print($r->variable("var"));

    return OK;
}

1;

__END__
首页