Node.js path-Modul: path.join vs. path.resolve

path.join() verbindet Pfadsegmente mit dem richtigen Trennzeichen und räumt .. und doppelte Schrägstriche auf, lässt das Ergebnis aber relativ, wenn du mit einem relativen Segment angefangen hast. path.resolve() macht dieselbe Arbeit von rechts nach links und gibt immer einen absoluten Pfad zurück: Es startet beim aktuellen Arbeitsverzeichnis, und jedes absolute Segment unterwegs beginnt den Pfad neu. Nimm join, um einen Pfad zu bauen, und resolve, wenn du einen absoluten brauchst.

const path = require('path');

console.log(path.join('users', 'ada', 'notes.txt'));
console.log(path.join('users', 'ada', '..', 'grace', 'todo.txt'));
console.log(path.join('/srv/app/', '/public/', 'index.html'));
console.log(path.join('src', '', 'lib//utils.js'));

Es hat users/ada/notes.txt ausgegeben, dann users/grace/todo.txt (das .. hat ada entfernt), dann /srv/app/public/index.html und src/lib/utils.js: Überzählige Schrägstriche und leere Segmente sind weg. join behandelt /public/ nie als Neuanfang; es ist einfach das nächste Segment.

path.join vs. path.resolve

Der Unterschied zeigt sich, wenn ein Segment mit / beginnt oder wenn das erste Segment relativ ist:

const path = require('path');

console.log('join:   ', path.join('/srv/app', '/public', 'img'));
console.log('resolve:', path.resolve('/srv/app', '/public', 'img'));

console.log('join:   ', path.join('/srv/app', '../logs'));
console.log('resolve:', path.resolve('/srv/app', '../logs'));

const rel = path.join('public', 'index.html');
const abs = path.resolve('public', 'index.html');
console.log(rel, path.isAbsolute(rel));
console.log(path.isAbsolute(abs), path.relative(process.cwd(), abs));

Mit /public in der Mitte hat join /srv/app/public/img erzeugt, während resolve alles davor verworfen und /public/img erzeugt hat; .. haben beide gleich behandelt. Die letzten beiden Zeilen zeigen, dass join public/index.html relativ gelassen hat, während resolve es absolut gemacht hat, indem es den aktuellen Ordner davorgesetzt hat.

basename, dirname, extname und parse

Diese Funktionen nehmen einen Pfad auseinander. Sie schauen nur auf den String: Die Datei muss nicht existieren.

const path = require('path');

const file = '/home/ada/photos/cat.final.jpg';

console.log(path.basename(file));
console.log(path.basename(file, '.jpg'));
console.log(path.dirname(file));
console.log(path.extname(file));
console.log(JSON.stringify(path.parse(file)));

Es hat cat.final.jpg, cat.final, /home/ada/photos und .jpg ausgegeben: extname nimmt nur den Teil nach dem letzten Punkt. path.parse gibt alles auf einmal zurück (root, dir, base, ext, name), und path.format macht aus so einem Objekt wieder einen String.

__dirname und __filename

In einer CommonJS-Datei ist __dirname der absolute Pfad des Ordners, der die Datei enthält, und __filename die Datei selbst. Ein relativer Pfad wie 'data.json' ist relativ dazu, wo der Nutzer node gestartet hat, und das bricht, sobald jemand dein Skript aus einem anderen Ordner startet. Bau Pfade stattdessen aus __dirname:

const fs = require('fs');
const path = require('path');

const configPath = path.join(__dirname, 'config.json');

fs.writeFileSync(configPath, '{ "theme": "dark" }'); // setup
const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));

console.log(path.basename(configPath), config.theme);
console.log(path.relative(__dirname, __filename));

Es hat config.json dark und index.js ausgegeben. Die vollständigen Pfade sind auf jedem Rechner anders, genau deshalb baust du sie mit path.join(__dirname, ...), statt sie abzutippen.

__dirname in ES-Modulen: import.meta.dirname

ES-Module haben kein __dirname; wer es benutzt, bekommt ReferenceError: __dirname is not defined in ES module scope. Seit Node.js 20.11 ersetzen import.meta.dirname und import.meta.filename sie:

import path from 'node:path';

const dataFile = path.join(import.meta.dirname, 'data', 'users.json');

console.log(path.basename(import.meta.filename));
console.log(path.relative(import.meta.dirname, dataFile));

Es hat index.js und data/users.json ausgegeben. In Node.js-Versionen vor 20.11 leitest du den Ordner aus der Modul-URL ab: path.dirname(fileURLToPath(import.meta.url)), mit fileURLToPath aus node:url.

Warum du Pfade nicht mit Strings zusammensetzt

'data' + '/' + file funktioniert unter macOS und Linux und scheitert dann unter Windows, wo das Trennzeichen \ ist, und es tut nichts gegen .., doppelte oder fehlende Schrägstriche. path nutzt die Regeln des Systems, auf dem es läuft. Das Windows-Ergebnis siehst du auf jedem Rechner mit path.win32:

const path = require('path');

path.posix.join('users', 'ada', 'notes.txt'); // 'users/ada/notes.txt'
path.win32.join('users', 'ada', 'notes.txt'); // 'users\\ada\\notes.txt'
path.sep;                                     // '/' on macOS and Linux, '\\' on Windows

Übergib das Ergebnis von path.join an fs.readFile, und derselbe Code liest die Datei auf jedem System.

Häufige Fehler

Erwarten, dass extname doppelte Endungen kennt. path.extname('archive.tar.gz') ist '.gz', und eine Dotfile wie .env hat gar keine Endung: path.extname('.env') ist ''. Prüf das Ende des Namens selbst, wenn die ganze Endung wichtig ist.

Sich darauf verlassen, dass join einen Nutzer in einem Ordner hält. path.join('/srv/app', '../../etc/passwd') ist '/etc/passwd'. Bevor du eine Datei liest, die eine Anfrage benennt, löse den Pfad auf und prüf, dass er noch mit deinem Ordner beginnt.