openresty扫描代码全局变量

迷南。 2022-06-17 05:28 185阅读 0赞

在OpenResty中需要避免全局变量的使用，为此春哥写了一个perl工具，可以扫描openresty lua代码的全局变量：

[https://github.com/openresty/openresty-devel-utils/blob/master/lua-releng][https_github.com_openresty_openresty-devel-utils_blob_master_lua-releng]

#!/usr/bin/env perl
    
    use strict;
    use warnings;
    
    use Getopt::Std;
    
    my (@luas, @tests);
    
    my %opts;
    getopts('Lse', \%opts) or die "Usage: lua-releng [-L] [-s] [-e] [files]\n";
    
    my $silent = $opts{s};
    my $stop_on_error = $opts{e};
    my $no_long_line_check = $opts{L};
    
    my $check_lua_ver = "luac -v | awk '{print\$2}'| grep 5.1";
    my $output = `$check_lua_ver`;
    if ($output eq '') {
        die "ERROR: lua-releng ONLY supports Lua 5.1!\n";
    }
    
    if ($#ARGV != -1) {
        @luas = @ARGV;
    
    } else {
        @luas = map glob, qw{ *.lua lib/*.lua lib/*/*.lua lib/*/*/*.lua lib/*/*/*/*.lua lib/*/*/*/*/*.lua };
        if (-d 't') {
            @tests = map glob, qw{ t/*.t t/*/*.t t/*/*/*.t };
        }
    }
    
    for my $f (sort @luas) {
        process_file($f);
    }
    
    for my $t (@tests) {
        blank(qq{grep -H -n --color -E '\\--- ?(ONLY|LAST)' $t});
    }
    # p: prints a string to STDOUT appending \n
    # w: prints a string to STDERR appending \n
    # Both respect the $silent value
    sub p { print "$_[0]\n" if (!$silent) }
    sub w { warn  "$_[0]\n" if (!$silent) }
    
    # blank: runs a command and looks at the output. If the output is not
    # blank it is printed (and the program dies if stop_on_error is 1)
    sub blank {
        my ($command) = @_;
        if ($stop_on_error) {
            my $output = `$command`;
            if ($output ne '') {
                die $output;
            }
        } else {
            system($command);
        }
    }
    
    my $version;
    sub process_file {
        my $file = shift;
        # Check the sanity of each .lua file
        open my $in, $file or
            die "ERROR: Can't open $file for reading: $!\n";
        my $found_ver;
        while (<$in>) {
            my ($ver, $skipping);
            if (/(?x) (?:_VERSION|version) \s* = .*? ([\d\.]*\d+) (.*? SKIP)?/) {
                my $orig_ver = $ver = $1;
                $found_ver = 1;
                $skipping = $2;
                $ver =~ s{^(\d+)\.(\d{3})(\d{3})$}{join '.', int($1), int($2), int($3)}e;
                w("$file: $orig_ver ($ver)");
                last;
    
            } elsif (/(?x) (?:_VERSION|version) \s* = \s* ([a-zA-Z_]\S*)/) {
                w("$file: $1");
                $found_ver = 1;
                last;
            }
    
            if ($ver and $version and !$skipping) {
                if ($version ne $ver) {
                    die "$file: $ver != $version\n";
                }
            } elsif ($ver and !$version) {
                $version = $ver;
            }
        }
        if (!$found_ver) {
            w("WARNING: No \"_VERSION\" or \"version\" field found in `$file`.");
        }
        close $in;
    
        p("Checking use of Lua global variables in file $file...");
        p("\top no.\tline\tinstruction\targs\t; code");
        blank("luac -p -l $file | grep -E '[GS]ETGLOBAL' | grep -vE '\\<(require|type|tostring|error|ngx|ndk|jit|setmetatable|getmetatable|string|table|io|os|print|tonumber|math|pcall|xpcall|unpack|pairs|ipairs|assert|module|package|coroutine|[gs]etfenv|next|rawget|rawset|rawlen|select)\\>'");
        unless ($no_long_line_check) {
            p("Checking line length exceeding 80...");
            blank("grep -H -n -E --color '.{81}' $file");
        }
    }

**用法相当简单**

（1）将代码保存成**lua-releng**文件

（2）更改**lua-releng**的权限，**chmod 777 lua-releng**

（3）假设有一个**源码**文件为**test.lua**

（4）执行.**/lua-releng test.lua**，则会扫描**test.lua**文件的全局变量，并在屏幕打印结果

原文出自：[http://blog.csdn.net/daiyudong2020/article/details/70226814][http_blog.csdn.net_daiyudong2020_article_details_70226814]

End;

[https_github.com_openresty_openresty-devel-utils_blob_master_lua-releng]: https://github.com/openresty/openresty-devel-utils/blob/master/lua-releng
[http_blog.csdn.net_daiyudong2020_article_details_70226814]: http://blog.csdn.net/daiyudong2020/article/details/70226814