无论是 Unix-like 操作系统(如 Linux、macOS)或是 Windows 操作系统的文件路径,皆有支持点 . 与点点 .. 的功能。. 被用来表示「目前路径的节点」或是「目前的工作目录」,例如 /path/./to 或是 ./path/to;.. 则被用来表示「目前路径的节点的上一层节点」或是「目前的工作目录的上一层目录」,例如 /path/../to 或是 ../path/to。在程序处理的过程中,或是需要输出一些 Log 信息的时候,我们也许会需要去有效地解析路径中的 . 与 ..,目的是使路径更简单,就能更容易处理与辨别。而在这个单纯情况下,我们不一定是要将该路径转成「绝对路径」,也可能会希望被移除 . 与 .. 后的路径同样能够是「相对路径」。

在这篇文章中,介绍了使用 Rust 编程语言标准函数库提供的 canonicalize 函数或是「Path Absolutize」套件的方式,来将一个路径的 . 与 .. 有效移除并转成绝对路径。如果我们并不想强制将路径转成绝对路径,则可以使用「Path Dedot」这个套件。

Path Dedot

「Path Dedot」是笔者开发的套件,可以单纯有效地解析文件路径中的 . 或是 ..。事实上,「Path Absolutize」套件就是使用「Path Dedot」套件来做 . 与 .. 的解析。

Crates.io

Cargo.toml

path-dedot = "*"

使用方法

使用 use 关键字来将 path_dedot 这个 crate 底下的 ParseDot 特性给引用到当前的程序范围下,Path 和 PathBuf 结构体就会拥有 parse_dot 方法了!这个方法可以将路径转换成没有 . 与 .. 的路径。

转换规则如下:

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

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

    use std::path::Path;
    use std::env;
    
    use path_dedot::*;
    
    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.parse_dot().unwrap().to_str().unwrap());
       }
       None => {
          assert_eq!(Path::join(Path::new("/"), Path::new("path/to/123/456")).to_str().unwrap(), p.parse_dot().unwrap().to_str().unwrap());
       }
    }
  • 原路径如果是一个不是以 . 或 .. 开头的相对路径,不论原路径中的 .. 有多少个,转换出来的路径均不会向上超出这个原路径。

    use std::path::Path;
    
    use path_dedot::*;
    
    let p = Path::new("path/to/../../../../123/456/./777/..");
    
    assert_eq!("123/456", p.parse_dot().unwrap().to_str().unwrap());
  • 原路径如果是有包含 .. 的绝对路径,不论原路径中的 .. 有多少个,转换出来的绝对路径均不会向上超出根目录。

    use std::path::Path;
    
    use path_dedot::*;
    
    let p = Path::new("/path/to/../../../../123/456/./777/..");
    
    assert_eq!("/123/456", p.parse_dot().unwrap().to_str().unwrap());
缓存

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

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

once_cell_cache

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

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

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

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

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

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

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

use path_dedot::*;

unsafe {
    update_cwd();
}

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

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

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

unsafe {
    update_cwd();
}

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

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

use std::path::Path;
use std::env;
    
use path_dedot::*;

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