在大部分的情况下,我们不会限制用户输入文件路径的时候一定要使用绝对路径还是相对路径。但是在程序处理的过程中,或是需要输出一些 Log 信息的时候,我们可能就必须要将路径通通都使用绝对路径来处理了。Rust 编程语言标准函数库中的 fs 模块,以及 Path 和 PathBuf 结构体,虽然有提供 canonicalize 函数或方法,是可以取得文件的绝对路径没错,但使用起来有一些严重的限制。

使用 canonicalize 取得文件的绝对路径

如以下程序,可以印出目前工作目录的上层目录中的 myfile.txt 文件的绝对路径。

use std::path::Path;

fn main(){
    let path = Path::new("../myfile.txt");

    println!("{:?}", path.canonicalize().unwrap());
}

请注意,Path 和 PathBuf 结构体的 canonicalize 方法,实际上是去调用 fs 模块的 canonicalize 函数,这个函数会回传一个 Result 枚举。此时问题来了,在什么情况下这个 Result 枚举会是 Err 变体呢?当目标文件不存在的时候就会是 Err 变体(ErrorKind 为 NotFound)。换句话说,Rust 编程语言标准函数库所提供的取得文件绝对路径之功能,目标文件必须要是存在的状态才能进行。而且如果该目标文件是一个捷径或称符号链接(symbolic link)的话,canonicalize 函数还会强制地去取得其对应的实体文件路径。

那么要如何单纯地去将一个文件相对路径解析成绝对路径,而不去管该路径的文件究竟是什么呢?

Path Absolutize

「Path Absolutize」是笔者开发的套件,可以有效地解析文件路径中的点 . 或是点点 ..,并根据目前工作目录,将其转换成绝对路径。

Crates.io

Cargo.toml

path-absolutize = "*"

使用方法

使用 use 关键字来将 path_absolutize 这个 crate 底下的 Absolutize 特性给引用到当前的程序范围下,Path 和 PathBuf 结构体就会拥有 absolutize 和 absolutize_virtually 方法了!这两个方法都可以将相对路径转成绝对路径。

absolutize

absolutize 方法的转换规则如下:

  • 如果路径不是以 . 或 .. 开头,则 . 会被忽略,.. 表示为上一层节点。

    use std::path::Path;
        
    use path_absolutize::*;
        
    let p = Path::new("/path/to/./123/../456");
        
    assert_eq!("/path/to/456", p.absolutize().unwrap().to_str().unwrap());
  • 如果路径是以 . 或 .. 开头,则 . 表示目前的工作目录路径,.. 表示目前的工作目录的上一层目录。如果目前的工作目录是根目录,其上一层目录也依然还是根目录。

    use std::path::Path;
    use std::env;
        
    use path_absolutize::*;
        
    let p = Path::new("../path/to/123/456");
    
    let cwd = env::current_dir().unwrap();
        
    let cwd_parent = cwd.parent();
        
    match cwd_parent {
       Some(cwd_parent) => {
           assert_eq!(Path::join(&cwd_parent, Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
       }
       None => {
           assert_eq!(Path::join(Path::new("/"), Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
       }
    }
  • 原路径如果是一个不是以 . 或 .. 开头的相对路径,其等同于以 . 作为路径开头。

    use std::path::Path;
    use std::env;
        
    use path_absolutize::*;
        
    let p = Path::new("path/../../to/123/456");
    
    let cwd = env::current_dir().unwrap();
        
    let cwd_parent = cwd.parent();
        
    match cwd_parent {
       Some(cwd_parent) => {
           assert_eq!(Path::join(&cwd_parent, Path::new("to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
       }
       None => {
           assert_eq!(Path::join(Path::new("/"), Path::new("to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
       }
    }
  • 原路径如果是有包含 .. 的绝对路径,不论原路径中的 .. 有多少个,转换出来的绝对路径均不会向上超出根目录。

    use std::path::Path;
    
    use path_absolutize::*;
    
    let p = Path::new("/path/to/../../../../123/456/./777/..");
    
    assert_eq!("/123/456", p.absolutize().unwrap().to_str().unwrap());
absolutize_virtually

absolutize_virtually 方法可以特别限制转换出来的绝对路径必须在哪层节点之下。与「absolutize」方法相比有个最大的差异在于,原路径如果是一个不是以 . 或 .. 开头的相对路径,并不会预设是在目前的工作目录下,而是会设在另外传给 absolutize_virtually 方法的路径节点之下。这个另外传进的路径就像是虚拟的根目录一样,不论原路径中的 .. 有多少个,转换出来的虚拟绝对路径均不会向上超出这个另外传进的路径。

use std::path::Path;
    
use path_absolutize::*;
    
let p = Path::new("path/to/../../../../123/456");
    
assert_eq!("/virtual/root/123/456", p.absolutize_virtually("/virtual/root").unwrap().to_str().unwrap());
缓存

预设的情况下,每次 absolutize 和 absolutize_virtually 方法在运行的时候,都会去创建新的 PathBuf 实体来表示目前的工作目录。这样的作法会有明显的开支。虽然这样可以让我们在程序运行阶段于任意时间点安全地让程序本身(例如使用 std::env::set_current_dir 方法)或是借由外部控制(例如使用 gdb 去调用 chdir)去修改程序目前的工作目录,但在大多数的情况下我们并不需要这样的功能。

为了让路径的解析更有效率,这个 crate 还提供了三种方式来缓存目前的工作目录。

once_cell_cache

激活 once_cell_cache 特色可以让这个 crate 使用 once_cell 来缓存目前的工作目录。这种缓存方式是线程安全的(thread-safe),但一旦目前的工作目录被缓存了,在程序运行阶段之后就无法再被改变了。

[dependencies.path-absolutize]
version = "*"
features = ["once_cell_cache"]
lazy_static_cache

激活 lazy_static_cache 特色可以让这个 crate 使用 lazy_static 来缓存目前的工作目录。这种缓存方式是线程安全的(thread-safe),但一旦目前的工作目录被缓存了,在程序运行阶段之后就无法再被改变了。

[dependencies.path-absolutize]
version = "*"
features = ["lazy_static_cache"]
unsafe_cache

激活 unsafe_cache 特色可以让这个 crate 使用一个可变的全域静态变量来缓存目前的工作目录。这种缓存方式允许程序本身去改变程序目前的工作目录,但并不是线程安全的。

您需要使用 update_cwd 函数来初始化目前的工作目录,这个函数也应该要在目前的工作目录被改变后被调用。

[dependencies.path-absolutize]
version = "*"
features = ["unsafe_cache"]
use std::path::Path;

use path_absolutize::*;

unsafe {
    update_cwd();
}

let p = Path::new("./path/to/123/456");

println!("{}", p.absolutize().unwrap().to_str().unwrap());

std::env::set_current_dir("/").unwrap();

unsafe {
    update_cwd();
}

println!("{}", p.absolutize().unwrap().to_str().unwrap());
Path Absolutize 有跨操作系统吗?

上面貌似都是以 Unix-like 操作系统(如 Linux、macOS)的文件路径来举例,那如果是要用在 Windows 操作系统呢?别担心,「Path Absolutize」也是有支持 Windows 操作系统的,使用方式也完全一样!例如:

use std::path::Path;
    
use path_absolutize::*;

let p = Path::new(r".\path\to\123\456");
	
assert_eq!(Path::join(std::env::current_dir().unwrap().as_path(), Path::new(r"path\to\123\456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());