Работа с файлами и папками

Концепция работы с файлами в Java включает две составляющие:

• Работа с файлами и папками с помощью объектов типа File.

Обеспечивает работу с именами файлов (проверка существования файла или папки с заданным именем, нахождение абсолютного пути по относительному и наоборот, проверка и установка атрибутов файлов и папок).

• Работа потоками ввода-вывода.

Обеспечивает работу не только с файлами, но и с памятью, а также различными устройствами ввода-вывода.

Работа с файлами и папками с помощью объектов типа File

Объекты типа File могут рассматриваться как абстракции, инкапсулирующие работу с именами файлов и папок. При этом папка рассматривается как разновидность файла, обладающая особыми атрибутами.

Создание объекта типа File осуществляется с помощью конструкторов, имеющих следующие варианты:

File(”Имя папки”)

File(”Имя файла”)

File(”Имя папки”,”Имя файла”).

При этом имена могут быть как короткими (локальными), без указания пути к файлу или папке, так и длинными (абсолютными), с указанием пути. В приведённой далее таблице файлы (папки) ищутся по имени в соответствии с правилами поиска файлов в операционной системе. Для платформы Windows^® вместо символа ”\” в строках, соответствующих путям, должна использоваться последовательность ”\\”.

Важнейшие файловые операции, инкапсулированные классом File:

Пример работы с файловыми объектами:

File f1=new File(".."); // "." , "/" , "C:/../"

System.out.println("getAbsolutePath(): "+f1.getAbsolutePath());

try{

System.out.println("getCanonicalPath(): "+f1.getCanonicalPath());

}

catch(Exception e){

System.out.println("Исключение от getCanonicalPath() ");

};

System.out.println("exists(): "+f1.exists());

System.out.println("canRead(): "+f1.canRead());

System.out.println("canWrite(): "+f1.canWrite());

Выбор файлов и папок с помощью файлового диалога

При работе с файлами в подавляющем большинстве приложений требуется вызов файлового диалога. В нашем приложении из палитры компонентов (правое верхнее окно среды разработки) перетащим на экранную форму JLabel (“Метка”) – первый компонент в палитре Swing. А затем повторим эту операцию ещё раз. В первой метке мы будем показывать имя выбранного файла, а во второй – путь к этому файлу.

Для того, чтобы вызвать файловый диалог, назначим обработчик события пункту файлового меню openMenuItem (“Открыть...”) – подузел [JFrame]/menuBar[JMenu]/fileMenu[JMenu]/openMenuItem[JMenuItem]. Двойной щелчок по узлу openMenuItem приводит к автоматическому созданию заготовки обработчика openMenuItemActionPerformed и открытию редактора исходного кода.

Сначала мы создаём в приложении объект типа JFileChooser, соответствующий файловому диалогу. Если в начале записать import javax.swing.*, что желательно, то в соответствующих местах кода не потребуется квалификация javax.swing. Но в данном примере импорт не сделан намеренно для того, чтобы было видно, где используются классы данного пакета.

javax.swing.JFileChooser fileChooser=new javax.swing.JFileChooser();

Добавим в обработчик необходимый код:

private void openMenuItemActionPerformed(java.awt.event.ActionEvent evt) {

if(fileChooser.showOpenDialog(null)!= fileChooser.APPROVE_OPTION){

System.out.println("Отказались от выбора");

return;

};

System.out.println("Нажали Open");

jLabel1.setText(fileChooser.getSelectedFile().getName());

jLabel2.setText(fileChooser.getSelectedFile().getParent());

}

В первой строке обработчика вызывается метод fileChooser.showOpenDialog(openMenuItem). Он показывает диалог на экране. В качестве параметра должен быть задан родительский компонент – в этом качестве мы используем пункт меню openMenuItem. Сравнение с переменной класса APPROVE_OPTION позволяет выяснить, была ли выбрана кнопка Open - “Открыть”.

Следует обратить внимание на характерный приём – выход из подпрограммы с помощью оператора return в случае, когда не был осуществлён выбор файла. Неопытные программисты написали бы данный фрагмент кода таким образом:

if(fileChooser.showOpenDialog(openMenuItem)== fileChooser.APPROVE_OPTION){

System.out.println("Нажали Open");

jLabel1.setText(fileChooser.getSelectedFile().getName());

jLabel2.setText(fileChooser.getSelectedFile().getParent());

}

else

System.out.println("Отказались от выбора");

На первый взгляд принципиальной разницы нет. Но при усовершенствовании программы код, соответствующий выбору файла с помощью диалога, заметно разрастётся, а код, соответствующий отказу от выбора, останется тем же. В результате практически весь код обработчика во втором варианте кода окажется вложенным в оператор if – а это может быть несколько страниц кода. В таком коде трудно разбираться. В первом варианте оператор if обладает небольшой областью действия, что позволяет легко разобраться с относящимся к нему кодом.

Можно было бы перенести строку

javax.swing.JFileChooser fileChooser=new javax.swing.JFileChooser()

в обработчик события. В этом случае при каждом нажатии пункта меню “Файл/Открыть…” создавался бы новый объект-диалог. Такой код был бы работоспособен. Но создание диалога является относительно долгим процессом, требующим большого количества ресурсов операционной системы. Поэтому лучше создавать в приложении глобальную переменную, которой назначен диалог. Помимо прочего это позволяет в повторно открываемом диалоге оказываться в той же папке, где происходил последний выбор файла.

Перед вызовом диалога можно программно установить папку, в которой он будет открываться:

File folder=…;

fileChooser.setCurrentDirectory(folder);

Диалог сохранения файла открывается аналогичным образом – showSaveDialog.

Практически всегда при использовании файловых диалогов требуется задавать фильтр, по которому просматриваются файлы. В подавляющем большинстве случаев требуется определённое расширение в имени файла. К сожалению, компонент JFileChooser до сих пор не поддерживает встроенной возможности настраивать фильтр – для этого требуется создание специального класса. Приведём пример простейшего такого класса:

package java_gui_example;

import java.io.*;

public class SimpleFileFilter extends javax.swing.filechooser.FileFilter {

String ext;

SimpleFileFilter(String ext){

this.ext=ext;

}

public boolean accept(File f){

if(f==null)

return false;

if(f.isDirectory()){

return true ;

}

else

return (f.getName().endsWith(ext));

}

/**

* Описание фильтра, возникающее в строке фильтра

* @see FileView#getName

*/

public String getDescription(){

return "Text files (.txt)";

}

}

Использование приведённого класса следующее: задаётся глобальная переменная

javax.swing.filechooser.FileFilter fileFilter=new SimpleFileFilter(".txt");

После чего она используется в обработчике события:

fileChooser.addChoosableFileFilter(fileFilter);

Данный оператор добавляет фильтр в выпадающий список возможных фильтров (масок) файлового диалога. Если добавляется уже существующий фильтр, операция добавления игнорируется.

По умолчанию показывается последний из добавленных фильтров. Если требуется показать другой фильтр, который уже был добавлен в список фильтров диалога, требуется вызвать оператор

fileChooser.setFileFilter(fileFilter);

Он делает добавленный фильтр текущим, то есть видимым при открытии диалога.

Кроме стандартных диалогов открытия и сохранения файлов имеется возможность вызова диалога с дополнительными программно задаваемыми элементами - с помощью метода showCustomDialog.

Также имеется возможность выбирать несколько файлов. Для этого до вызова диалога требуется задать разрешение на такой выбор:

fileChooser.setMultiSelectionEnabled(true);

Получение массива выбранных файлов после вызова диалога идёт следующим образом:

java.io.File[] files = fileChooser.getSelectedFiles();

if (files != null && files.length > 0) {

String filenames = "";

for (int i=0; i<files.length; i++) {

filenames = filenames + "\n" + files[i].getPath();

}

}

Имеется возможность выбора папки (директории), а не файла. В этом случае следует задать режим, когда позволяется выбирать только папки

fileChooser.setFileSelectionMode(fileChooser.DIRECTORIES_ONLY);

либо и файлы, и папки

fileChooser.setFileSelectionMode(fileChooser.FILES_AND_DIRECTORIES);

Возврат в обычный режим:

fileChooser.setFileSelectionMode(fileChooser.FILES_ONLY);

Для того, чтобы в выбранной папке просмотреть список файлов в папке, с которой связана переменная File folder, используется вызов вида

String[] filenames= folder.list(filter);

Получается массив строк с короткими именами файлов. Используется переменная filter, тип которой является классом, реализующим интерфейс java.io.FilenameFilter. О том, что такое интерфейсы, будет рассказано в отдельном разделе. Пример простейшего такого класса SimpleFilenameFilter:

package java_gui_example;

import java.io.*;

public class SimpleFilenameFilter implements FilenameFilter{

String ext;

public SimpleFilenameFilter(String ext) {

this.ext=ext;

}

public boolean accept(File dir,String fileName){

return ext==""||fileName.endsWith(ext);

}

}

Пример с показом файлов, содержащихся в выбранной папке, в компонент jTextArea1 (текстовая область) типа JTextArea, позволяющий показывать произвольное число строк:

String[] filenamesArray;

File folder=fileChooser.getSelectedFile();

SimpleFilenameFilter filter=new SimpleFilenameFilter("");

String filenames = "";

if(folder.isDirectory()){

filenamesArray=folder.list(filter);

for (int i=0; i<filenamesArray.length; i++) {

filenames = filenames + "\n" + filenamesArray[i];

};

jTextArea1.setText(filenames);

}

Аналогичный пример вывода выбранных в диалоге имён в режиме “мультиселект”, позволяющем отмечать несколько файлов и/или папок:

java.io.File[] files = fileChooser.getSelectedFiles();

if (files != null && files.length > 0) {

String filenames = "";

for (int i=0; i<files.length; i++) {

filenames = filenames + "\n" + files[i].getPath();

};

jTextArea1.setText(filenames);

};

Работа с потоками ввода-вывода

Стандартные классы Java, инкапсулирующие работу с данными (оболочечные классы для числовых данных, классы String и StringBuffer, массивы и т.д.), не обеспечивают поддержку чтения этих данных из файлов или запись их в файл. Вместо этого используется весьма гибкая и современная, но не очень простая технология использования потоков (Streams).

Поток представляет накапливающуюся последовательность данных, поступающих из какого-то источника. Порция данных может быть считана из потока, при этом она из потока изымается. В потоке действует принцип очереди – “первым вошёл, первым вышел”.

В качестве источника данных потока может быть использован как стационарный источник данных (файл, массив, строка), так и динамический – другой поток. При этом в ряде случаев выход одного потока может служить входом другого. Поток можно представить себе как трубу, через которую перекачиваются данные, причём часто в таких “трубах” происходит обработка данных. Например, поток шифрования шифрует данные, полученные на входе, и при считывании из потока передаёт их в таком виде на выход. А поток архивации сжимает по соответствующему алгоритму входные данные и передаёт их на выход. “Трубы” потоков можно соединять друг с другом – выход одного со входом другого. Для этого в качестве параметра конструктора потока задаётся имя переменной, связанной с потоком - источником данных для создаваемого потока.

Буферизуемые потоки имеют хранящийся в памяти промежуточный буфер, из которого считываются выходные данные потока. Наличие такого буфера позволяет повысить производительность операций ввода-вывода, а также осуществлять дополнительные операции – устанавливать метки (маркеры) для какого-либо элемента, находящегося в буфере потока и даже делать возврат считанных элементов в поток (в пределах буфера).

Абстрактный класс InputStream (“входной поток”) инкапсулирует модель входных потоков, позволяющих считывать из них данные. Абстрактный класс OutputStream (“выходной поток”) - модель выходных потоков, позволяющих записывать в них данные. Абстрактные методы этих классов реализованы в классах-потомках.

Методы класса InputStream:

Все методы класса InputStream, кроме markSupported и mark, возбуждают исключение IOException – оно возникает при ошибке чтения данных.

Методы класса OutputStream:

Все методы этого класса возбуждают IOException в случае ошибки записи.

Не все классы потоков являются потомками InputStream/OutputStream. Для чтения строк (в виде массива символов) используются потомки абстрактного класса java.io.Reader (“читатель”). В частности, для чтения из файла – класс FileReader. Аналогично, для записи строк используются классы- потомки абстрактного класса java.io.Writer (“писатель”). В частности, для записи массива символов в файл– класс FileWriter.

Имеется ещё один важный класс для работы с файлами, не входящий в иерархии InputStream/OutputStream и Reader/ Writer. Это класс RandomAccessFile (“файл с произвольным доступом”), предназначенный для чтения и записи данных в произвольном месте файла. Такой файл с точки зрения класса RandomAccessFile представляет массив байт, сохранённых на внешнем носителе. Класс RandomAccessFile не является абстрактным, поэтому можно создавать его экземпляры.

Все операции чтения и записи начинаются с позиции, задаваемой файловым указателем перед началом операции. После каждой такой операции файловый указатель сдвигается к концу файла на число позиций (байт), соответствующее типу считанных данных. В случае, когда во время записи файловый указатель выходит за конец файла, размер файла автоматически увеличивается.

Важнейшие методы класса RandomAccessFile:

Все методы класса RandomAccessFile, кроме getChannel(), возбуждают исключение IOException – оно возникает при ошибке записи или ошибке доступа к данным.

В конструкторе класса требуется указать два параметра. Первый – имя файла или файловую переменную, второй – строку с модой доступа к файлу. Имеются следующие варианты:

• "r"- от read,- “только читать”

• "rw"- от read and write,- “читать и писать”

• "rws"- от read and write synchronously,- “читать и писать с поддержкой синхронизации” (см. далее раздел про потоки, Threads)

• "rwd"- от read and write to device,- “читать и писать с поддержкой синхронизации устройства” (см. далее раздел про потоки, Threads)

Например:

java.io.RandomAccessFile rf1=new java.io.RandomAccessFile("q.txt","r");

java.io.RandomAccessFile rf2=new java.io.RandomAccessFile(file,"rw");

Рассмотрим примеры, иллюстрирующие работу с потоками.

Пример чтения текста из файла:

File file;

javax.swing.JFileChooser fileChooser=new javax.swing.JFileChooser();

javax.swing.filechooser.FileFilter fileFilter=new SimpleFileFilter(".txt");

private void openMenuItemActionPerformed(java.awt.event.ActionEvent evt) {

fileChooser.addChoosableFileFilter(fileFilter);

if(fileChooser.showOpenDialog(null)!=fileChooser.APPROVE_OPTION){

return;//Нажали Cancel

};

file = fileChooser.getSelectedFile();

try{

InputStream fileInpStream=new FileInputStream(file);

int size=fileInpStream.available();

fileInpStream.close();

char[] buff=new char[size];

Reader fileReadStream=new FileReader(file);

int count=fileReadStream.read(buff);

jTextArea1.setText(String.copyValueOf(buff));

javax.swing.JOptionPane.showMessageDialog(null,

"Прочитано "+ count+" байт");

fileReadStream.close();

} catch(Exception e){

javax.swing.JOptionPane.showMessageDialog(null,

"Ошибка чтения из файла \n"+file.getAbsolutePath());

}

}

Переменной fileInpStream , которая будет использована для работы потока FileInputStream , мы задаём тип InputStream . Это очень характерный приём при работе с потоками, позволяющий при необходимости заменять в дальнейшем входной поток с FileInputStream на любой другой без изменения последующего кода. После выбора имени текстового файла с помощью файлового диалога мы создаём файловый поток:

fileInpStream=new FileInputStream(file);

Функция fileInpStream.available()возвращает число байт, которые можно считать из файла. После её использования поток fileInpStream нам больше не нужен, и мы его закрываем. Поток FileReader не поддерживает метод available() , поэтому нам пришлось использовать поток типа FileInputStream.

Массив buff используется в качестве буфера, куда мы считываем весь файл.

Если требуется читать файлы большого размера, используют буфер фиксированной длины и в цикле считывают данные из файла блоками, равными длине буфера, до тех пор, пока число считанных байт не окажется меньше размера буфера. Это означает, что мы дошли до конца файла. В таком случае выполнение цикла следует прекратить. При такой организации программы нет необходимости вызывать метод available() и использовать поток типа FileInputStream.

В операторе

Reader fileReadStream=new FileReader(file);

используется тип Reader, а не FileReader, по той же причине, что до этого мы использовали InputStream , а не FileInputStream.

строки правильно работает только для ANSI

Построчное чтение из файла осуществляется аналогично, но содержимое блока try следует заменить на следующий код:

FileReader filReadStream=new FileReader(file);

BufferedReader bufferedIn=new BufferedReader(filReadStream);

String s="",tmpS="";

while((tmpS=bufferedIn.readLine())!=null)

s+=tmpS+"\n";

jTextArea1.setText(s);

bufferedIn.close();

Пример записи текста в файл очень похож на пример чтения, но гораздо проще, так как не требуется вводить промежуточные буферы и потоки:

private void saveAsMenuItemActionPerformed(java.awt.event.ActionEvent evt) {

fileChooser.addChoosableFileFilter(fileFilter);

if(fileChooser.showSaveDialog(null)!=fileChooser.APPROVE_OPTION){

return;//Нажали Cancel

};

file = fileChooser.getSelectedFile();

try{

Writer filWriteStream=new FileWriter(file);

filWriteStream.write(jTextArea1.getText() );

filWriteStream.close();

} catch(Exception e){

javax.swing.JOptionPane.showMessageDialog(null,

"Ошибка записи в файл \n"+file.getAbsolutePath());

}

}