13.6 OS库 (OS Library)

文档摘要

13.6 OS库 (OS Library) Lua OS 库 (OS Library) 详解与实践 Lua 语言以其轻量级、高效和可嵌入性而著称，其标准库是其强大功能的重要组成部分。标准库提供了各种各样的功能，涵盖了字符串处理、数学运算、输入输出、表操作等等。其中，OS 库 (OS Library) 专门用于提供与操作系统交互的功能，允许 Lua 脚本执行系统命令、操作文件、获取时间信息以及进行其他系统级别的操作。请注意： OS 库的功能依赖于底层操作系统，因此在不同的操作系统上，某些函数的行为可能会有所不同。编写跨平台脚本时，务必考虑到这种差异。：执行系统命令函数是 OS 库中最核心，也是最强大的函数之一。它允许 Lua 脚本执行一个操作系统命令，并返回命令的退出状态码。

13.6 OS库 (OS Library)

Lua OS 库 (OS Library) 详解与实践

Lua 语言以其轻量级、高效和可嵌入性而著称，其标准库是其强大功能的重要组成部分。标准库提供了各种各样的功能，涵盖了字符串处理、数学运算、输入输出、表操作等等。其中，OS 库 (OS Library) 专门用于提供与操作系统交互的功能，允许 Lua 脚本执行系统命令、操作文件、获取时间信息以及进行其他系统级别的操作。

请注意： OS 库的功能依赖于底层操作系统，因此在不同的操作系统上，某些函数的行为可能会有所不同。编写跨平台脚本时，务必考虑到这种差异。

1. `os.execute (command)`：执行系统命令

os.execute 函数是 OS 库中最核心，也是最强大的函数之一。它允许 Lua 脚本执行一个操作系统命令，并返回命令的退出状态码。这使得 Lua 脚本能够调用外部程序、执行 shell 命令，从而扩展 Lua 的功能边界。

函数定义:


os.execute (command)

参数:

command: 一个字符串，表示要执行的操作系统命令。

返回值:

如果命令执行成功，返回 true 以及命令的退出状态码。
如果命令执行失败，返回 nil 以及一个描述错误信息的字符串。

代码实践与详解:

1.1 执行简单的系统命令:

假设我们要在 Linux/macOS 系统上列出当前目录下的文件，或者在 Windows 系统上显示当前目录下的文件列表。我们可以使用 os.execute 函数调用系统命令 ls (Linux/macOS) 或 dir (Windows)。


-- 判断操作系统类型
local os_name = os.type()
local command = ""
if os_name == "windows" then
    command = "dir"
elseif os_name == "linux" or os_name == "macosx" then
    command = "ls -l" -- 使用 -l 参数显示详细信息
else
    print("不支持的操作系统类型: " .. os_name)
    return
end
local status, exitcode = os.execute(command)
if status then
    print("命令执行成功，退出状态码:", exitcode)
else
    print("命令执行失败，错误信息:", exitcode)
end

代码解释:

os.type() 函数用于获取当前操作系统类型，返回值可能是 "windows", "linux", "macosx", "freebsd", "openbsd", "solaris", "bsd"。
我们根据操作系统类型选择不同的命令 (dir 或 ls -l)。
os.execute(command) 执行命令，并将返回值赋值给 status 和 exitcode。
status 是一个布尔值，表示命令是否执行成功。
exitcode 是命令的退出状态码。通常，退出状态码为 0 表示命令执行成功，非 0 值表示命令执行失败或出现错误。
我们根据 status 的值判断命令执行结果，并打印相应的消息和退出状态码或错误信息。

1.2 执行带有参数的命令:

os.execute 可以执行带有参数的命令。例如，我们可以使用 ping 命令测试网络连接。


local host = "www.google.com"
local command = "ping -c 3 " .. host -- Linux/macOS 下 ping 3 次
-- Windows 下可以使用 "ping -n 3 " .. host
local status, exitcode = os.execute(command)
if status then
    print("Ping 命令执行成功，退出状态码:", exitcode)
else
    print("Ping 命令执行失败，错误信息:", exitcode)
end

代码解释:

我们构建了 ping 命令，并拼接了主机名 host 作为参数。
-c 3 (Linux/macOS) 或 -n 3 (Windows) 参数指定 ping 的次数。
os.execute 执行带有参数的命令。

1.3 获取命令的输出结果 (需要配合其他方法):

os.execute 函数本身 不直接返回命令的输出结果，它只返回命令的退出状态码。如果需要获取命令的输出结果，通常需要借助 I/O 重定向 和 文件操作。

例如，我们可以将命令的输出重定向到一个临时文件，然后 Lua 脚本读取该文件的内容。


local temp_file = os.tmpname() -- 生成一个临时文件名
local command = "ls -l > " .. temp_file -- 将 ls 命令的输出重定向到临时文件
local status, exitcode = os.execute(command)
if status then
    print("命令执行成功，退出状态码:", exitcode)
    local file = io.open(temp_file, "r")
    if file then
        local output = file:read("*all") -- 读取整个文件内容
        file:close()
        os.remove(temp_file) -- 删除临时文件
        print("命令输出结果:\n" .. output)
    else
        print("无法打开临时文件: " .. temp_file)
    end
else
    print("命令执行失败，错误信息:", exitcode)
end

代码解释:

os.tmpname() 生成一个唯一的临时文件名。
我们修改 command，使用 > 符号将 ls -l 命令的输出重定向到临时文件 temp_file。
执行 os.execute 后，如果命令成功，我们使用 io.open 打开临时文件，以只读模式 ("r")。
file:read("*all") 读取整个文件的内容。
file:close() 关闭文件。
os.remove(temp_file) 删除临时文件，清理资源。
打印命令的输出结果。

安全注意事项:

避免执行来自不可信来源的命令: os.execute 函数非常强大，但也存在安全风险。如果命令字符串来自用户输入或不可信的外部来源，可能会导致 命令注入攻击。攻击者可以构造恶意的命令字符串，利用 os.execute 在系统上执行任意代码。
谨慎处理用户输入: 在使用 os.execute 执行命令时，务必对用户输入进行严格的验证和过滤，避免将用户输入直接拼接到命令字符串中。可以使用参数化或转义等方法来防止命令注入。
最小权限原则: Lua 脚本应该以最小权限运行，避免授予不必要的系统权限，以降低安全风险。

2. `os.remove (filename)`：删除文件

os.remove 函数用于删除指定的文件。

函数定义:


os.remove (filename)

参数:

filename: 一个字符串，表示要删除的文件名。

返回值:

如果文件删除成功，返回 true。
如果文件删除失败，返回 nil 以及一个描述错误信息的字符串。

代码实践与详解:

2.1 删除文件:


local filename = "test.txt"
-- 创建一个测试文件
local file = io.open(filename, "w")
if file then
    file:write("This is a test file.")
    file:close()
    print("文件 '" .. filename .. "' 创建成功。")
else
    print("文件 '" .. filename .. "' 创建失败。")
    return
end
local status, err = os.remove(filename)
if status then
    print("文件 '" .. filename .. "' 删除成功。")
else
    print("文件 '" .. filename .. "' 删除失败，错误信息:", err)
end

代码解释:

我们首先创建一个名为 "test.txt" 的测试文件。
os.remove(filename) 尝试删除文件。
根据返回值 status 判断文件是否删除成功，并打印相应的消息和错误信息。

2.2 处理文件不存在的情况:

如果尝试删除不存在的文件，os.remove 会返回 nil 和错误信息。


local filename = "non_existent_file.txt"
local status, err = os.remove(filename)
if status then
    print("文件 '" .. filename .. "' 删除成功。")
else
    print("文件 '" .. filename .. "' 删除失败，错误信息:", err)
end

代码解释:

由于 "non_existent_file.txt" 文件不存在，os.remove 返回 nil 和错误信息，提示 "No such file or directory" (或类似的错误信息，具体取决于操作系统)。

注意事项:

os.remove 只能删除文件，不能删除目录。要删除目录，需要使用其他方法（例如，在某些操作系统上可以使用 os.execute 调用 rmdir 或 rm -r 命令，但跨平台性较差）。
删除文件是一个不可逆的操作，请谨慎使用 os.remove 函数。

3. `os.rename (oldname, newname)`：重命名文件

os.rename 函数用于重命名文件或目录。

函数定义:


os.rename (oldname, newname)

参数:

oldname: 一个字符串，表示旧的文件名或目录名。
newname: 一个字符串，表示新的文件名或目录名。

返回值:

如果重命名成功，返回 true。
如果重命名失败，返回 nil 以及一个描述错误信息的字符串。

代码实践与详解:

3.1 重命名文件:


local old_filename = "old_file.txt"
local new_filename = "new_file.txt"
-- 创建一个旧文件
local file = io.open(old_filename, "w")
if file then
    file:write("This is the old file.")
    file:close()
    print("文件 '" .. old_filename .. "' 创建成功。")
else
    print("文件 '" .. old_filename .. "' 创建失败。")
    return
end
local status, err = os.rename(old_filename, new_filename)
if status then
    print("文件 '" .. old_filename .. "' 重命名为 '" .. new_filename .. "' 成功。")
else
    print("文件重命名失败，错误信息:", err)
end

代码解释:

我们首先创建一个名为 "old_file.txt" 的旧文件。
os.rename(old_filename, new_filename) 将文件重命名为 "new_file.txt"。
根据返回值 status 判断重命名是否成功，并打印相应的消息和错误信息。

3.2 重命名目录 (取决于操作系统):

在某些操作系统上，os.rename 也可以用于重命名目录。


-- 创建一个旧目录 (假设目录名为 "old_dir")
os.execute("mkdir old_dir") -- 使用 os.execute 创建目录，跨平台性需要考虑
local old_dirname = "old_dir"
local new_dirname = "new_dir"
local status, err = os.rename(old_dirname, new_dirname)
if status then
    print("目录 '" .. old_dirname .. "' 重命名为 '" .. new_dirname .. "' 成功。")
else
    print("目录重命名失败，错误信息:", err)
end
-- 清理目录 (删除重命名后的目录)
os.execute("rmdir new_dir") -- 或 "rm -r new_dir" 在 Linux/macOS 上

代码解释:

我们使用 os.execute("mkdir old_dir") 创建一个名为 "old_dir" 的目录 (需要注意跨平台性，可能需要根据操作系统选择不同的命令)。
os.rename(old_dirname, new_dirname) 尝试重命名目录。
成功后，我们使用 os.execute("rmdir new_dir") 删除重命名后的目录 (同样需要考虑跨平台性)。

注意事项:

os.rename 的行为可能因操作系统而异，特别是在处理目录重命名方面。
如果新的文件名或目录名已经存在，os.rename 的行为也可能不同，有些系统可能会覆盖已存在的文件或目录，有些系统则会返回错误。

4. `os.getenv (varname)`：获取环境变量

os.getenv 函数用于获取指定名称的环境变量的值。

函数定义:


os.getenv (varname)

参数:

varname: 一个字符串，表示环境变量的名称。

返回值:

如果环境变量存在，返回环境变量的值 (字符串)。
如果环境变量不存在，返回 nil。

代码实践与详解:

4.1 获取常见的环境变量:


local path_env = os.getenv("PATH") -- 获取 PATH 环境变量 (Linux/macOS)
-- Windows 下可以使用 os.getenv("Path") (注意大小写)
if path_env then
    print("PATH 环境变量的值:\n" .. path_env)
else
    print("PATH 环境变量未设置。")
end
local home_env = os.getenv("HOME") -- 获取 HOME 环境变量 (Linux/macOS)
-- Windows 下可以使用 os.getenv("USERPROFILE")
if home_env then
    print("HOME 环境变量的值:\n" .. home_env)
else
    print("HOME 环境变量未设置。")
end

代码解释:

os.getenv("PATH") 获取名为 "PATH" 的环境变量的值。在 Linux/macOS 系统中，PATH 环境变量存储了可执行程序的搜索路径。
os.getenv("HOME") 获取名为 "HOME" 的环境变量的值。在 Linux/macOS 系统中，HOME 环境变量存储了用户的家目录。
我们检查返回值是否为 nil，判断环境变量是否存在，并打印相应的值或提示信息.
注意大小写敏感性: 环境变量名称的大小写敏感性取决于操作系统。在 Linux/macOS 系统中，环境变量名称通常是大小写敏感的。在 Windows 系统中，环境变量名称通常是大小写不敏感的，但建议保持与系统默认大小写一致。

4.2 处理环境变量不存在的情况:


local non_existent_env = os.getenv("NON_EXISTENT_ENV_VARIABLE")
if non_existent_env then
    print("NON_EXISTENT_ENV_VARIABLE 环境变量的值:\n" .. non_existent_env)
else
    print("NON_EXISTENT_ENV_VARIABLE 环境变量未设置。")
end

代码解释:

由于 "NON_EXISTENT_ENV_VARIABLE" 环境变量通常不存在，os.getenv 返回 nil。

应用场景:

获取系统配置信息: 环境变量常用于存储系统配置信息，例如程序的安装路径、临时目录、语言设置等。Lua 脚本可以使用 os.getenv 获取这些信息，并根据配置进行相应的操作。
传递配置参数: 可以将一些配置参数通过环境变量传递给 Lua 脚本，而无需硬编码在脚本中，提高脚本的灵活性和可配置性。

5. `os.exit ([code [, close]])`：终止程序执行

os.exit 函数用于立即终止 Lua 程序的执行。

函数定义:


os.exit ([code [, close]])

参数:

code (可选): 一个数字，表示程序的退出状态码。默认为 0，表示正常退出。非 0 值通常表示程序异常退出或发生错误。
close (可选): 一个布尔值，表示是否关闭 Lua 状态机。默认为 false。如果设置为 true，则会关闭 Lua 状态机，释放所有资源。

返回值:

os.exit 函数本身不返回值，因为它会立即终止程序执行。

代码实践与详解:

5.1 正常退出程序:


print("程序开始执行...")
-- ... 一些程序逻辑 ...
print("程序执行到这里，正常退出。")
os.exit() -- 默认退出状态码为 0

代码解释:

os.exit() 不带参数调用时，程序会立即终止，退出状态码为默认值 0，表示程序正常退出。
"程序执行到这里，正常退出。" 这行代码会被打印出来，因为 os.exit() 在打印语句之后调用。

5.2 异常退出程序并设置退出状态码:


local function divide(a, b)
    if b == 0 then
        print("错误: 除数不能为零！")
        os.exit(1) -- 设置退出状态码为 1，表示错误
    end
    return a / b
end
local result = divide(10, 0)
print("计算结果:", result) -- 这行代码不会被执行，因为程序在 divide 函数中已经退出

代码解释:

divide 函数在检测到除数为零时，打印错误信息，并调用 os.exit(1) 终止程序执行，并将退出状态码设置为 1，表示程序因为除零错误而异常退出。
print("计算结果:", result) 这行代码不会被执行，因为程序在 os.exit(1) 处已经立即终止。

5.3 关闭 Lua 状态机:


print("程序开始执行...")
-- ... 一些程序逻辑 ...
print("程序执行到这里，准备退出并关闭 Lua 状态机。")
os.exit(0, true) -- 退出状态码为 0，并关闭 Lua 状态机

代码解释:

os.exit(0, true) 调用时，程序会以退出状态码 0 终止，并且 Lua 状态机会被关闭，释放所有相关的资源。

应用场景:

错误处理和异常退出: 在程序遇到无法处理的错误或异常情况时，可以使用 os.exit 立即终止程序，并设置合适的退出状态码，方便外部程序或脚本判断程序的执行结果。
程序控制流: 在某些情况下，可能需要提前终止程序的执行，例如根据用户输入或某些条件判断提前结束程序流程。

6. `os.date ([format [, time]])` 和 `os.time ([table])`：日期和时间操作

os.date 和 os.time 函数用于处理日期和时间信息。

6.1 os.date ([format [, time]])：格式化日期和时间

os.date 函数用于格式化日期和时间，返回一个包含日期和时间信息的字符串或表。

函数定义:


os.date ([format [, time]])

参数:

format (可选): 一个字符串，表示日期和时间的格式。默认为 "%c"，表示本地化的完整日期和时间格式。
time (可选): 一个数字，表示 Unix 时间戳 (自 1970-01-01 00:00:00 UTC 以来的秒数)。默认为当前时间。

返回值:

如果指定了 format 格式字符串，返回一个格式化后的日期和时间字符串。
如果 format 为 "*t"，返回一个包含日期和时间信息的表，表字段包括: year, month, day, hour, min, sec, wday (星期几，1-7，星期日为 1), yday (一年中的第几天), isdst (是否为夏令时，布尔值)。
如果 format 为 "*!t"，返回一个 UTC 时间的表，格式同 "*t"。
如果 format 为 "*c" 或不指定 format，返回本地化的完整日期和时间字符串。
如果 format 无法识别，返回 nil。

常用格式化字符:

%a: 简写的星期名称 (例如，Sun, Mon, ...)
%A: 完整的星期名称 (例如，Sunday, Monday, ...)
%b: 简写的月份名称 (例如，Jan, Feb, ...)
%B: 完整的月份名称 (例如，January, February, ...)
%c: 本地化的完整日期和时间 (默认格式)
%d: 月份中的第几天 (01-31)
%H: 24 小时制的小时 (00-23)
%I: 12 小时制的小时 (01-12)
%j: 一年中的第几天 (001-366)
%m: 月份 (01-12)
%M: 分钟 (00-59)
%p: 上午或下午 (例如，AM 或 PM)
%S: 秒 (00-59)
%U: 一年中的第几周 (星期日为每周的第一天) (00-53)
%w: 星期几 (0-6，星期日为 0)
%W: 一年中的第几周 (星期一为每周的第一天) (00-53)
%x: 本地化的日期表示 (例如，mm/dd/yy)
%X: 本地化的时间表示 (例如，hh:mm:ss)
%y: 两位数的年份 (00-99)
%Y: 四位数的年份 (例如，2023)
%Z: 时区名称 (如果时区信息可用)
%%: 字符 '%'

代码实践与详解:

6.1.1 获取当前日期和时间 (字符串格式):


local current_datetime = os.date() -- 默认格式 "%c"
print("当前日期和时间 (默认格式):", current_datetime)
local formatted_datetime = os.date("%Y-%m-%d %H:%M:%S") -- 自定义格式
print("当前日期和时间 (自定义格式):", formatted_datetime)

代码解释:

os.date() 不带参数调用时，返回本地化的完整日期和时间字符串 (默认格式 "%c")。
os.date("%Y-%m-%d %H:%M:%S") 使用自定义格式字符串，返回 "YYYY-MM-DD HH:MM:SS" 格式的日期和时间字符串。

6.1.2 获取当前日期和时间 (表格式):


local datetime_table = os.date("*t") -- 返回表格式的日期和时间
print("当前日期和时间 (表格式):")
for k, v in pairs(datetime_table) do
    print(k, "=", v)
end

代码解释:

os.date("*t") 返回一个表，包含日期和时间的各个组成部分 (年、月、日、时、分、秒、星期几等)。
我们遍历表并打印键值对，显示表中的日期和时间信息。

6.1.3 使用指定时间戳格式化日期和时间:


local timestamp = os.time({year=2024, month=1, day=1, hour=0, min=0, sec=0}) -- 获取 2024-01-01 00:00:00 的时间戳
local formatted_date = os.date("%Y-%m-%d", timestamp) -- 格式化指定时间戳的日期
print("2024-01-01 的日期:", formatted_date)

代码解释:

os.time({year=2024, month=1, day=1, hour=0, min=0, sec=0}) 使用表参数创建一个指定日期和时间的时间戳。
os.date("%Y-%m-%d", timestamp) 使用时间戳作为第二个参数，格式化指定时间戳的日期。

6.2 os.time ([table])：获取时间戳

os.time 函数用于获取当前时间的时间戳，或者将一个日期和时间表转换为时间戳。

作者与出处

原作者：灏天文库

来源：灏天文库

原文： https://aiknowledge.cn/collection/159-lua%E8%84%9A%E6%9C%AC%E8%AF%AD%E8%A8%80%E7%BC%96%E7%A8%8B%E5%85%A5%E9%97%A8%E6%95%99%E7%A8%8B

整理：灏天文库整理

由灏天文库平台收录，内容或由平台用户上传，仅供学习交流

13.6 OS库 (OS Library)

文档摘要