Bu sayfa, Cloud Translation API ile çevrilmiştir.

File System Observer API kaynak denemesi

Thomas Steiner

Hem File System Access API hem de Origin Private File System API, geliştiricilerin kullanıcının cihazındaki dosya ve dizinlere erişmesine olanak tanır. İlki, geliştiricilerin normal, kullanıcı tarafından görülebilen dosya sisteminde okuma ve yazma yapmasına olanak tanır. İkincisi ise her sitenin kökenine özel olan ve belirli performans avantajları sunan, kullanıcıdan gizli özel bir dosya sistemi açar. Geliştiriciler her iki durumda da dosya ve dizinlerle FileSystemHandle nesneleri aracılığıyla etkileşim kurar. Daha açık belirtmek gerekirse, dosyalar için FileSystemFileHandle, dizinler için FileSystemDirectoryHandle nesneleri kullanılır. Şimdiye kadar, dosya sistemlerinden birinde bir dosya veya dizinde yapılan değişikliklerden haberdar olmak için bir tür anket yapılması ve lastModified zaman damgasının ya da dosya içeriğinin karşılaştırılması gerekiyordu.

Chrome 129'dan itibaren kaynak denemesinde olan File System Observer API, bu durumu değiştirir ve değişiklikler olduğunda geliştiricilerin otomatik olarak uyarı almasını sağlar. Bu kılavuzda, özelliğin işleyiş şekli ve nasıl denemeniz gerektiği açıklanmaktadır.

Kullanım alanları

Dosya sistemiyle ilgili olası değişikliklerden hemen haberdar edilmesi gereken uygulamalarda File System Observer API'yi kullanın.

Bir projenin dosya sistemi ağacının temsilini gösteren web tabanlı entegre geliştirme ortamları (IDE'ler).
Dosya sistemi değişikliklerini bir sunucuda senkronize eden uygulamalar. Örneğin, SQLite veritabanı dosyası.
Bir çalışandan veya başka bir sekmeden dosya sistemi değişikliklerini ana iş parçacığına bildirmesi gereken uygulamalar.
Örneğin, resimleri otomatik olarak optimize etmek için bir kaynak dizini gözlemleyen uygulamalar.
Dosya değişikliğinin yeniden yüklemeyi tetiklediği HTML tabanlı slaytlar gibi, anında yeniden yükleme özelliğinden yararlanan deneyimler.

File System Observer API'yi kullanma

Özellik algılama

Dosya Sistemi Gözlemcisi API'sinin desteklenip desteklenmediğini görmek için aşağıdaki örnekte gösterildiği gibi bir özellik testi çalıştırın.

if ('FileSystemObserver' in self) {
  // The File System Observer API is supported.
}

Dosya sistemi gözlemcisini başlatma

new FileSystemObserver() işlevini çağırarak ve bağımsız değişken olarak bir callback işlevi sağlayarak bir dosya sistemi gözlemcisi başlatın.

const observer = new FileSystemObserver(callback);

Bir dosyayı veya dizini gözlemlemeye başlama

Bir dosyayı veya dizini gözlemlemeye başlamak için FileSystemObserver örneğinin asenkron observe() yöntemini çağırın. Bu yönteme, seçili dosyanın veya dizinin FileSystemHandle değerini bağımsız değişken olarak gönderin. Bir dizini gözlemlerken, dizinin içindeki değişikliklerden (yani dizinin kendisi ve tüm alt dizinleri ve dosyaları) yinelemeli olarak bilgilendirilmek isteyip istemediğinizi seçmenize olanak tanıyan isteğe bağlı bir options bağımsız değişkeni vardır. Varsayılan seçenek, yalnızca dizinin kendisini ve doğrudan içinde bulunan dosyaları gözlemlemektir.

// Observe a file.
await observer.observe(fileHandle);
// Observe a directory.
await observer.observe(directoryHandle);
// Observe a directory recursively.
await observer.observe(directoryHandle, {recursive: true});

Geri çağırma işlevi

Dosya sisteminde değişiklik olduğunda, dosya sistemi değişikliği records ve observer bağımsız değişkeni ile bir geri çağırma işlevi çağrılır. Örneğin, ilgilendiğiniz tüm dosyalar silindiğinde gözlemcinin bağlantısını kesmek için observer bağımsız değişkenini kullanabilirsiniz (Dosya sistemini gözlemlemeyi durdurma bölümüne bakın).

const callback = (records, observer) => {
  for (const record of records) {
    console.log('Change detected', record);
  }
};

Dosya sistemi değişiklik kaydı

Her dosya sistemi değişiklik kaydı aşağıdaki yapıya sahiptir. Tüm alanlar salt okunur.

root (bir FileSystemHandle): FileSystemObserver.observe() işlevine iletilen tutamaç.
changedHandle (a FileSystemHandle): Dosya sistemi değişikliğinden etkilenen herkese açık tanımlayıcı. Bu alan, "errored", "unknown" ve "disappeared" türü etkinlikler için null olur. Hangi dosya veya dizinin kaybolduğunu görmek için relativePathComponents simgesini kullanın.
relativePathComponents (Array): changedHandle öğesinin root'e göre yolu.
type (a String): Değişikliğin türü. Aşağıdaki türler kullanılabilir:
- "appeared": Dosya veya dizin oluşturuldu ya da root klasörüne taşındı.
- "disappeared": Dosya veya dizin silindi ya da root dışında taşındı.
- "modified": Dosya veya dizin değiştirildi.
- "moved": Dosya veya dizin, root içinde taşındı.
- "unknown": Bu, sıfır veya daha fazla etkinliğin kaçırıldığını gösterir. Geliştiriciler, buna yanıt olarak izlenen dizini yoklamalıdır.
- "errored": Gözlem artık geçerli değil. Bu durumda, dosya sistemini gözlemlemeyi durdurabilirsiniz. Bu değer, kaynak başına maksimum gözlem sayısına ulaşıldığında da gönderilir. Bu sınır, işletim sistemine bağlıdır ve önceden bilinmez. Bu durumda site yeniden denemeye karar verebilir ancak işletim sisteminin yeterli kaynak ayırdığından emin olamaz. Bu değerin gönderildiği başka bir durum da, gözlemlenen herkese açık kullanıcı adı (yani gözlemin kökü) silindiğinde veya taşındığındadır. Bu durumda, önce "disappeared" etkinliği, ardından gözlemin artık geçerli olmadığını belirten bir "errored" etkinliği gönderilir. Son olarak, dizin veya dosya tutamacına ilişkin izin kaldırıldığında bu etkinlik gönderilir.
relativePathMovedFrom (isteğe bağlı bir Array): Taşınan herkese açık kullanıcı adının eski konumu. Yalnızca type "moved" olduğunda kullanılabilir.

Not: İşletim sistemine bağlı olarak, tüm değişiklik etkinlikleri aynı ayrıntı düzeyinde raporlanmayabilir (ör. bir dizinin içeriği yinelemeli olarak değiştiğinde). En iyi durumda web sitesi, değişiklik türünü ve etkilenen yolun herkese açık kullanıcı adını içeren ayrıntılı bir değişiklik kaydı alır. En kötü durumda, web sitesi daha genel bir değişiklik kaydı alır (yani "unknown" değeri olan bir type). Bu durumda, web sitesinin hangi alt öğenin değiştiğini öğrenmek için dizini numaralandırması gerekir. Dizin numaralandırması, belirli aralıklarla değişiklik olup olmadığını kontrol etmek için anket yapılmasına gerek kalmadan isteğe bağlı olarak geri çağırma işlevinden başlatılabileceğinden bu yöntem, ankete kıyasla yine de bir iyileştirmedir.

Bir dosyayı veya dizini gözlemlemeyi durdurma

Bir FileSystemHandle'yi gözlemlemeyi durdurmak için unobserve() yöntemini çağırın ve bağımsız değişken olarak herkese açık kimliği iletin.

observer.unobserve(fileHandle);

Dosya sistemini gözlemlemeyi durdurma

Dosya sistemini gözlemlemeyi durdurmak için FileSystemObserver örneğinin bağlantısını aşağıdaki gibi kesin.

observer.disconnect();

API'yi deneyin

File System Observer API'yi yerel olarak test etmek için about:flags dosyasında #file-system-observer işaretini ayarlayın. API'yi gerçek kullanıcılarla test etmek için kaynak denemesine kaydolun ve Chrome Kaynak Denemeleri kılavuzundaki talimatları uygulayın. Kaynak denemesi, Chrome 129 (11 Eylül 2024) ile Chrome 134 (26 Şubat 2025) arasında geçerli olacaktır.

Demo

File System Observer API'yi yerleşik demo'da çalışırken görebilirsiniz. Kaynak koduna göz atın veya Glitch'te demo kodunu remiksleyin. Demo, gözlemlenen bir dizinde rastgele dosya oluşturur, siler veya değiştirir ve etkinliğini uygulama penceresinin üst kısmına kaydeder. Ardından, uygulama penceresinin alt kısmında değişiklikler gerçekleştikçe bunları günlüğe kaydeder. Bu makaleyi File System Observer API'yi desteklemeyen bir tarayıcıda okuyorsanız demonun ekran görüntüsüne bakın.

Geri bildirim

File System Observer API'nin şekliyle ilgili geri bildiriminiz varsa WHATWG/fs deposundaki 123 numaralı soruna yorum ekleyin.

İlgili bağlantılar

Teşekkür ederiz

Bu doküman Daseul Lee, Nathan Memmott, Etienne Noël ve Rachel Andrew tarafından incelendi.