Panduan untuk WatchService di Java NIO2

1. Gambaran keseluruhan

Dalam artikel ini, kita akan meneroka WatchService antara muka API sistem fail Java NIO.2. Ini adalah salah satu ciri yang kurang dikenali dari API IO yang lebih baru yang diperkenalkan di Java 7 di samping antara muka FileVisitor .

Untuk menggunakan antara muka WatchService dalam aplikasi anda, anda perlu mengimport kelas yang sesuai:

import java.nio.file.*;

2. Mengapa Menggunakan WatchService

Contoh biasa untuk memahami apa yang dilakukan oleh perkhidmatan itu sebenarnya adalah IDE.

Anda mungkin menyedari bahawa IDE selalu mengesan perubahan dalam fail kod sumber yang berlaku di luar dirinya. Sebilangan IDE memberitahu anda menggunakan kotak dialog sehingga anda dapat memilih untuk memuat semula file dari sistem fail atau tidak, yang lain hanya mengemas kini fail di latar belakang.

Begitu juga, kerangka kerja yang lebih baru seperti Play juga memuat semula kod aplikasi secara lalai - setiap kali anda melakukan pengeditan dari mana-mana editor.

Aplikasi ini menggunakan fitur yang disebut pemberitahuan perubahan file yang tersedia di semua sistem file .

Pada dasarnya, kita boleh menulis kod untuk meninjau sistem fail untuk perubahan pada fail dan direktori tertentu . Walau bagaimanapun, penyelesaian ini tidak dapat ditingkatkan terutamanya jika fail dan direktori mencapai ratusan dan ribuan.

Di Java 7 NIO.2, WatchService API menyediakan penyelesaian yang dapat diskalakan untuk memantau direktori untuk perubahan. Ia memiliki API yang bersih dan dioptimalkan dengan baik untuk prestasi sehingga kita tidak perlu menerapkan penyelesaian kita sendiri.

3. Bagaimana Perkhidmatan Jam Tangan Berfungsi?

Untuk menggunakan ciri WatchService , langkah pertama adalah membuat instance WatchService menggunakan kelas java.nio.file.FileSystems :

WatchService watchService = FileSystems.getDefault().newWatchService();

Seterusnya, kita harus membuat jalan ke direktori yang ingin kita pantau:

Path path = Paths.get("pathToDir");

Selepas langkah ini, kita harus mendaftarkan jalan dengan perkhidmatan jam tangan. Terdapat dua konsep penting untuk difahami pada tahap ini. The StandardWatchEventKinds kelas dan WatchKey kelas. Lihat kod pendaftaran berikut hanya untuk memahami di mana setiap musim gugur. Kami akan mengikuti ini dengan penjelasan yang sama:

WatchKey watchKey = path.register( watchService, StandardWatchEventKinds...);

Perhatikan hanya dua perkara penting di sini: Pertama, panggilan API pendaftaran laluan mengambil contoh perkhidmatan menonton sebagai parameter pertama diikuti oleh argumen berubah-ubah StandardWatchEventKinds . Kedua, jenis pengembalian proses pendaftaran adalah contoh WatchKey .

3.1. The StandardWatchEventKinds

Ini adalah kelas yang contohnya memberitahu perkhidmatan menonton jenis acara yang perlu ditonton di direktori yang didaftarkan. Terdapat empat kemungkinan peristiwa yang perlu diperhatikan:

  • StandardWatchEventKinds.ENTRY_CREATE - dicetuskan apabila entri baru dibuat di direktori yang ditonton. Ini mungkin disebabkan oleh penciptaan file baru atau penamaan semula file yang ada.
  • StandardWatchEventKinds.ENTRY_MODIFY - dicetuskan apabila entri yang ada di direktori yang ditonton diubah. Semua pengeditan fail mencetuskan peristiwa ini. Di beberapa platform, malah mengubah atribut fail akan mencetuskannya.
  • StandardWatchEventKinds.ENTRY_DELETE - dicetuskan apabila entri dihapus, dipindahkan atau dinamakan semula dalam direktori yang ditonton.
  • StandardWatchEventKinds.OVERFLOW - dicetuskan untuk menunjukkan kejadian yang hilang atau dibuang. Kami tidak akan banyak menumpukan perhatian

3.2. The WatchKey

Kelas ini mewakili pendaftaran direktori dengan perkhidmatan jam tangan. Contohnya dikembalikan kepada kami oleh perkhidmatan jam tangan ketika kami mendaftar direktori dan ketika kami meminta perkhidmatan jam tangan apakah ada peristiwa yang kami daftarkan telah terjadi.

Perkhidmatan jam tangan tidak memberi kami kaedah panggilan balik yang dipanggil setiap kali sesuatu peristiwa berlaku. Kami hanya boleh mengundinya dengan beberapa cara untuk mencari maklumat ini.

Kita boleh menggunakan API tinjauan :

WatchKey watchKey = watchService.poll();

Panggilan API ini kembali dengan segera. Ia mengembalikan kunci jam beratur seterusnya mana-mana yang kejadiannya telah berlaku atau batal sekiranya tidak ada acara yang didaftarkan.

We can also use an overloaded version that takes a timeout argument:

WatchKey watchKey = watchService.poll(long timeout, TimeUnit units);

This API call is similar to the previous one in return value. However, it blocks for timeout units of time to give more time within which an event may occur instead of returning null right away.

Finally, we can use the take API:

WatchKey watchKey = watchService.take();

This last approach simply blocks until an event occurs.

We must note something very important here: when the WatchKey instance is returned by either of the poll or take APIs, it will not capture more events if it's reset API is not invoked:

watchKey.reset();

This means that the watch key instance is removed from the watch service queue every time it is returned by a poll operation. The reset API call puts it back in the queue to wait for more events.

The most practical application of the watcher service would require a loop within which we continuously check for changes in the watched directory and process accordingly. We can use the following idiom to implement this:

WatchKey key; while ((key = watchService.take()) != null) { for (WatchEvent event : key.pollEvents()) { //process } key.reset(); }

We create a watch key to store the return value of the poll operation. The while loop will block until the conditional statement returns with either a watch key or null.

When we get a watch key, then the while loop executes the code inside it. We use the WatchKey.pollEvents API to return a list of events that have occurred. We then use a for each loop to process them one by one.

After all the events are processed, we must call the reset API to enqueue the watch key again.

4. Directory Watching Example

Since we have covered the WatchService API in the previous subsection and how it works internally and also how we can use it, we can now go ahead and look at a complete and practical example.

For portability reasons, we are going to watch for activity in the user home directory, which should be available on all modern operating systems.

The code contains only a few lines of code so we will just keep it in the main method:

public class DirectoryWatcherExample { public static void main(String[] args) { WatchService watchService = FileSystems.getDefault().newWatchService(); Path path = Paths.get(System.getProperty("user.home")); path.register( watchService, StandardWatchEventKinds.ENTRY_CREATE, StandardWatchEventKinds.ENTRY_DELETE, StandardWatchEventKinds.ENTRY_MODIFY); WatchKey key; while ((key = watchService.take()) != null) { for (WatchEvent event : key.pollEvents()) { System.out.println( "Event kind:" + event.kind() + ". File affected: " + event.context() + "."); } key.reset(); } } }

And that is all we really have to do. Now you can run the class to start watching a directory.

When you navigate to the user home directory and perform any file manipulation activity like creating a file or directory, changing contents of a file or even deleting a file, it will all be logged at the console.

For instance, assuming you go to user home, right click in space, select `new – > file` to create a new file and then name it testFile. Then you add some content and save. The output at the console will look like this:

Event kind:ENTRY_CREATE. File affected: New Text Document.txt. Event kind:ENTRY_DELETE. File affected: New Text Document.txt. Event kind:ENTRY_CREATE. File affected: testFile.txt. Event kind:ENTRY_MODIFY. File affected: testFile.txt. Event kind:ENTRY_MODIFY. File affected: testFile.txt.

Feel free to edit the path to point to any directory you want to watch.

5. Conclusion

Dalam artikel ini, kami telah menjelajahi beberapa fitur yang jarang digunakan yang tersedia di Java 7 NIO.2 - API sistem fail, terutama antara muka WatchService .

Kami juga berjaya melalui langkah-langkah membina aplikasi menonton direktori untuk menunjukkan kefungsiannya.

Dan, seperti biasa, kod sumber penuh untuk contoh yang digunakan dalam artikel ini terdapat dalam projek Github.