Ruby 预定义全局变量与常量完全指南：从 `$!` 到 `DATA` 的源码级剖析

Ruby 预定义全局变量与常量完全指南从$!到DATA的源码级剖析【免费下载链接】rubyThe Ruby Programming Language项目地址: https://gitcode.com/GitHub_Trending/ru/ruby本指南以 doc/language/globals.md 为骨架系统梳理 Ruby 语言内置的全部预定义全局变量如$!、$~、$/、$LOAD_PATH等与预定义全局常量如STDIN、ARGV、RUBY_VERSION、DATA等逐一说明其含义、初始值、可写性、重置时机并结合当前仓库的 C 源码ruby.c、io.c、process.c、load.c与标准库 lib/English.rb 揭示这些特殊变量的底层实现与别名机制。读完本文你将能熟练运用这些全局变量编写脚本、调试异常、处理命令行输入输出并理解-0/-a/-F/-l/-p/-d/-v等命令行选项是如何映射到这些变量的。一、概述什么是预定义全局变量与常量Ruby 解释器在启动时预定义了一组全局变量以$开头和全局常量全大写。它们承载着运行时最核心的状态最近一次异常、最近一次正则匹配结果、标准输入输出流、进程信息、加载路径、调试开关等。其中一部分变量带有「密码般」的符号名如$!、$~、$/Ruby 提供名为 English 的标准库为它们提供可读的英文别名如$ERROR_INFO、$LAST_MATCH_INFO、$INPUT_RECORD_SEPARATOR。启用方式只有一行require English在 lib/English.rb 中这些别名全部通过alias关键字实现例如alias $ERROR_INFO $! alias $LAST_MATCH_INFO $~ alias $INPUT_RECORD_SEPARATOR $/ alias $OUTPUT_RECORD_SEPARATOR $\ alias $PROCESS_ID $$ alias $CHILD_STATUS $? alias $ARGV $* alias $MATCH $ alias $PREMATCH $ alias $POSTMATCH $ alias $LAST_PAREN_MATCH $从源码可以确认English模块本身只是一个占位声明module English end if false见 lib/English.rb真正起作用的就是文件顶层的这些alias语句。加载该库后两种写法完全等价。阅读表格的方法原文档为每个变量给出了五列属性列含义Variable符号形式的变量名\Englishrequire English后可用的英文别名Contains变量实际保存的内容Initially程序启动时的初始值Read-Only是否只读只读变量无法在程序中赋值Reset By哪些操作会重置/更新该变量下文将按「异常、匹配数据、分隔符、流、进程、调试、其他、已废弃」的顺序逐一详解。二、异常相关$!与$$!$ERROR_INFO$!保存由Kernel#raise设置的 Exception 对象初始为nil只读。在rescue块中它指向当前捕获的异常begin raise RuntimeError.new(Boo!) rescue RuntimeError p $! end输出#RuntimeError: Boo!英文别名$ERROR_INFO由 lib/English.rb 定义。$$ERROR_POSITION$等价于$!.backtrace返回由回溯位置组成的数组begin raise RuntimeError.new(Boo!) rescue RuntimeError pp $.take(4) end输出类似[(irb):338:in top (required), /snap/ruby/317/lib/ruby/3.2.0/irb/workspace.rb:119:in eval, ...]英文别名$ERROR_POSITION。在 lib/English.rb 中注明它是线程局部的thread local。底层实现上这两个变量与解释器维护的「当前异常」状态紧密相关在 eval.c 中可以看到当ruby_debug为真且当前异常信息非 nil 时解释器会把每个被 raise 的异常打印到$stderr——这正是$DEBUG相关行为的实现位置详见下文「调试相关」。三、匹配数据$~、$、$、$、$、$1…$n这组变量保存当前作用域内最近一次成功的模式匹配的信息被统称为「匹配数据」。它们具有线程局部与帧frame局部的特性。详细的正则匹配语义可参考 doc/language/regexp/methods.rdoc 中的 Global Variables 一节。变量English 别名内容可写$~$LAST_MATCH_INFO由匹配生成的 MatchData 对象否$$MATCH匹配到的子串否$$PREMATCH匹配位置左侧的子串否$$POSTMATCH匹配位置右侧的子串否$$LAST_PAREN_MATCH最后匹配到的分组否$n无第 n 个分组匹配到的内容是$1、$2等数字变量没有 English 别名且原文档明确它们是只读的Read-Only Yes。lib/English.rb 对这些变量做了额外说明值得注意$、$、$、$1–$9全部由$~派生而来**对$~ 赋值会同步改变这些派生变量的值**$保存编号最高的那个分组的内容例如cat ~ /(c|a)(t|z)/之后$为t这些变量都是当前作用域局部local to the current scope且只读的。四、记录分隔符$/与$\$/$INPUT_RECORD_SEPARATOR别名$RS、$-0输入记录分隔符初始为换行符\n。gets等读取方法依据它来确定「一条记录」的边界若设为nilgets将一次性读取整个文件。它由命令行选项-0设置且除命令行选项之外将其设为非 nil 值已被标记为废弃deprecated。-0的具体规则见 doc/language/options.md无参数时记录分隔符为0x00参数为0时分隔符为空串参数在1..0377八进制时分隔符为对应字符参数为其他八进制值时分隔符为nil。实际效果$ ruby -0 -e p $/ \x00 $ ruby -00 -e p $/ $ ruby -012 -e p $/ \n $ ruby -015 -e p $/ \r $ ruby -0377 -e p $/ \xFF $ ruby -0400 -e p $/ nil英文别名$INPUT_RECORD_SEPARATOR、$RS见 lib/English.rb。符号名$-0与$/等价。$\$OUTPUT_RECORD_SEPARATOR别名$ORS输出记录分隔符初始为nil。当命令行选项-l给出时会把$/的值复制给它。它被追加到print、IO#write等每次输出的末尾默认nil表示不加任何文本。同样的除命令行选项之外将其设为非 nil 值已被废弃。英文别名$OUTPUT_RECORD_SEPARATOR、$ORS见 lib/English.rb。五、标准流$stdin、$stdout、$stderr、$、$、$.、$_$stdin/$stdout/$stderr当前的可重定向的标准输入、输出、错误流初始值分别为STDIN、STDOUT、STDERR$stdin # #IO:STDIN $stdout # #IO:STDOUT $stderr # #IO:STDERR这三个变量是可写的程序中可以重新赋值以重定向输出。它们的底层实现在 io.c$stdin、$stdout、$stderr通过rb_define_virtual_variable注册了 getter/setter并且被标记为 ractor 局部变量rb_gvar_ractor_local同时$与$stdout共享同一组 getter/setter。$$DEFAULT_INPUT指向「默认输入」的只读变量若ARGF非空则指向ARGF否则指向$stdin。英文别名$DEFAULT_INPUT。正如 lib/English.rb 所注释的它支持大量类似File对象的方法gets、each_line、filename、lineno、read、seek等并且是只读的。$$DEFAULT_OUTPUT默认输出流初始为$stdout是Kernel#print与Kernel#printf的目的地。英文别名$DEFAULT_OUTPUT见 lib/English.rb。在 io.c 中它与$stdout共用同一实现因此给$stdout赋值会同步影响$。$.$INPUT_LINE_NUMBER / $NR最近一次读取的流中的输入位置行号初始为 0由某些读取方法重置。英文别名$INPUT_LINE_NUMBER、$NR。$_$LAST_READ_LINE最近一次读取的流返回的字符串行初始为nil。Kernel中许多字符串相关方法默认以$_为操作对象。它在 lib/English.rb 中被注明是当前作用域局部、线程局部的变量在 io.c 中$_通过虚拟变量注册并被标记为 ractor 局部且动态装箱rb_gvar_box_dynamic。六、进程信息$0、$*、$$、$?、$LOAD_PATH、$LOADED_FEATURES$0$PROGRAM_NAME初始为正在执行的脚本名可在程序中重新赋值例如修改进程标题。底层实现在 ruby.c$0与$PROGRAM_NAME都通过rb_define_hooked_variable挂到rb_progname上setter 为set_arg0同时Process.setproctitle也提供了等价能力ruby.c。$*$ARGV指向 ARGV 数组命令行参数只读。英文别名$ARGV。注意 lib/English.rb 的补充这个数组是被 Ruby 解释器处理过参数之后的剩余部分解释器自身的选项已被移除。$$$PROCESS_ID / $PID当前进程的进程 ID与Process.pid相同只读。在 process.c 中被标记为 ractor 局部变量。英文别名$PROCESS_ID、$PID。$?$CHILD_STATUS初始为nil之后保存为最近一个退出的子进程创建的Process::Status对象线程局部、只读。底层实现在 process.c$?通过虚拟变量get_CHILD_STATUS读取而子进程退出状态由rb_last_status_setprocess.c写入例如rb_syswait等系统调用路径见 process.c。英文别名$CHILD_STATUS。$LOAD_PATH$:、$-I被Kernel#load与Kernel#require搜索的路径数组初始为 Ruby 默认值只读数组中元素本身冻结见 load.c。它有一个非常实用的单例方法$LOAD_PATH.resolve_feature_path(feature)实现于 load.c 的rb_resolve_feature_path返回结果有三种[:rb, path]path是将被加载的 Ruby 文件路径[:so, path]path是将被加载的共享对象.so文件路径nil不存在该 feature。示例$LOAD_PATH.resolve_feature_path(timeout) # [:rb, /snap/ruby/317/lib/ruby/3.2.0/timeout.rb] $LOAD_PATH.resolve_feature_path(date_core) # [:so, /snap/ruby/317/lib/ruby/3.2.0/x86_64-linux/date_core.so] $LOAD_PATH.resolve_feature_path(foo) # nil$LOADED_FEATURES$已加载文件的路径数组初始为 Ruby 默认值只读。在 load.c 中通过get_LOADED_FEATURES虚拟变量实现require 成功加载新 feature 时会向其中追加路径若数组被冻结则抛出错误见 load.c。$LOADED_FEATURES.take(10) # [enumerator.so, thread.rb, fiber.so, rational.so, complex.so, ruby2_keywords.rb, /snap/ruby/317/lib/ruby/3.2.0/x86_64-linux/enc/encdb.so, /snap/ruby/317/lib/ruby/3.2.0/x86_64-linux/enc/trans/transdb.so, /snap/ruby/317/lib/ruby/3.2.0/x86_64-linux/rbconfig.rb, /snap/ruby/317/lib/ruby/3.2.0/rubygems/compatibility.rb]七、调试相关$FILENAME、$DEBUG、$VERBOSE$FILENAMEARGF.filename方法的返回值即当前正在读取的命令行文件名命令行无文件参数时为-只读。$DEBUG别名$-d初始为true当且仅当命令行选项-d或--debug被给出否则为false可在运行程序中被设置为任意布尔值为true时每个被 raise 的异常都会被打印到$stderr。这一行为在 eval.c 与 ruby.c 中均有体现RTEST(ruby_debug)判断。底层实现在 ruby.c$DEBUG与$-d共享debug_getter/debug_setter并标记为 ractor 局部ruby.c。$VERBOSE别名$-v、$-w初始为true当命令行选项-v或-w被给出否则为false可在运行程序中被设为任意值或nil为true时启用 Ruby 警告为nil时禁用警告包括Kernel#warn的输出。底层实现在 ruby.c$VERBOSE、$-v、$-w共享verbose_getter/verbose_settersetter 会把任意真值归一化为Qtrue另有$-W只读通过opt_W_getter将 verbose 状态映射为整数nil → 0、false → 1、true → 2ruby.c。八、其他变量$-F、$-a、$-i、$-l、$-p、$F这组变量与命令行选项一一对应其中$-p、$-l、$-a在 ruby.c 中被标记为 ractor 局部变量。变量对应选项内容与说明$-F$;-FString#split的默认字段分隔符必须是 String 或 Regexp除命令行选项外设置为非 nil 已被废弃。英文别名$FS、$FIELD_SEPARATOR$-a-a是否给出-a只读$-i-i-i选项给出的扩展名无则nil是ARGF.inplace_mode的别名$-l-l是否设置-l只读$-p-p是否给出-p只读$F-a-n/-p若给出-a在每次-l/-p循环开始时把$_按$-F拆分得到的数组赋给它关于-F的字段分隔语义doc/language/options.md 说明其参数即为split使用的输入字段分隔符。值得留意的是 lib/English.rb 还提供了$;的两个可读别名$FS与$FIELD_SEPARATOR原文档未列入 English 表属于标准库额外提供的别名。九、已废弃的变量$与$,$原用于「是否区分大小写」的开关早已废弃$,print/Array#join参数之间的输出分隔串默认nil不加任何文本亦已废弃。标准库中仍保留了它的别名$OFS、$OUTPUT_FIELD_SEPARATOR见 lib/English.rb。十、预定义全局常量流常量STDIN、STDOUT、STDERR标准输入、输出、错误流分别是$stdin、$stdout、$stderr的默认值STDIN # #IO:STDIN STDOUT # #IO:STDOUT STDERR # #IO:STDERR环境常量ENV、ARGF、ARGV、TOPLEVEL_BINDING常量内容ENV当前环境变量名与值的 HashARGF命令行给出的多个文件的虚拟拼接未给文件、给出-或全部读完后回退到$stdinARGV给定的命令行参数数组在 ruby.c 中通过rb_define_global_const(ARGV, rb_argv)定义TOPLEVEL_BINDING顶层作用域的 BindingENV.take(5) # [[COLORTERM, truecolor], [DBUS_SESSION_BUS_ADDRESS, unix:path/run/user/1000/bus], [DESKTOP_SESSION, ubuntu], [DISPLAY, :0], [GDMSESSION, ubuntu]] TOPLEVEL_BINDING # #Binding:0x00007f58da0da7c0版本常量RUBY_*这些常量描述当前 Ruby 解释器自身的版本与构建信息全部由 version.c 提供常量内容示例Ruby 3.2.2RUBY_VERSION版本号3.2.2RUBY_RELEASE_DATE发布日期2023-03-30RUBY_PLATFORM平台标识x86_64-linuxRUBY_PATCHLEVEL补丁级别开发版为-153RUBY_REVISIONGit 提交哈希e51014f9c05aa65cbf203442d37fef7c12390015RUBY_COPYRIGHT版权字符串ruby - Copyright (C) 1993-2023 Yukihiro MatsumotoRUBY_ENGINE实现名称rubyRUBY_ENGINE_VERSION实现版本3.2.2RUBY_DESCRIPTION完整描述ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux]从源码看这些常量的数据源定义在 version.cRUBY_REVISION在非发布构建中为HEADruby_version、ruby_release_date、ruby_platform、ruby_patchlevel分别是各常量的 C 层数据version.c而RUBY_DESCRIPTION则由这些片段拼装而成version.c。因此不同构建环境或开发版下这些常量的实际值会与文档示例不同这是正常的。嵌入数据常量DATADATA当且仅当程序中包含__END__行时被定义。此时DATA是一个 File 对象内容为__END__之后的所有行且读取位置定位在首行p DATA DATA.each_line { |line| p line } __END__ Foo Bar Baz输出#File:t.rb Foo\n Bar\n Baz\n这是 Ruby 脚本内嵌数据self-contained data section的经典用法常用于小工具的测试数据或模板。十一、速查总表综合以上内容全部预定义全局变量一览含 English 别名类别变量English 别名只读异常$!$ERROR_INFO是异常$$ERROR_POSITION是匹配$~$LAST_MATCH_INFO否匹配$$MATCH否匹配$$PREMATCH否匹配$$POSTMATCH否匹配$$LAST_PAREN_MATCH否匹配$1…$n无是分隔符$/、$-0$INPUT_RECORD_SEPARATOR、$RS否分隔符$\$OUTPUT_RECORD_SEPARATOR、$ORS否流$stdin/$stdout/$stderr无否流$$DEFAULT_INPUT是流$$DEFAULT_OUTPUT否流$.$INPUT_LINE_NUMBER、$NR否流$_$LAST_READ_LINE否进程$0$PROGRAM_NAME否进程$*$ARGV是进程$$$PROCESS_ID、$PID是进程$?$CHILD_STATUS是进程$LOAD_PATH$:、$-I无是进程$LOADED_FEATURES$无是调试$FILENAME无是调试$DEBUG$-d无否调试$VERBOSE$-v、$-w无否其他$-F$;$FS、$FIELD_SEPARATOR否其他$-a无是其他$-i无否其他$-l无是其他$-p无是其他$F无否废弃$、$,$OFS、$OUTPUT_FIELD_SEPARATOR—如需进一步了解这些变量与命令行选项-0、-F、-a、-i、-l、-p、-d、-v、-w的对应关系可查阅 doc/language/options.md正则匹配相关变量的完整语义可参考 doc/language/regexp/methods.rdoc英文别名的完整清单见 lib/English.rb。【免费下载链接】rubyThe Ruby Programming Language项目地址: https://gitcode.com/GitHub_Trending/ru/ruby创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考