Java util jar create jar file

Работаем с JAR-архивами.

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

1. Для начала нам нужно создать объект класса java.util.jar.JarFile (далее JarFile), и указать для него имя просматриваемого jar-файла.
2. Затем, создаём объект класса java.util.jar.JarEntry (далее JarEntry) и указываем для него имя файла, который необходимо извлечь.
3. Для объекта JarFile создаём поток ввода с помощью метода getInputStream(). В качестве аргумента передадим ему объект JarEntry.
4. Ну а далее, работаем с потоками стандартным образом, используя методы read() и write().

У нас должно получиться что-то вроде:

JarFile jarFile = new JarFile ( «some_jar_file.jar» ) ;
JarEntry jarEntry = new JarEntry ( «something.smth» ) ;
InputStream in = jarFile.getInputStream ( jarEntry ) ;
FileOutputStream out = new FileOutputStream ( jarEntry.getName ()) ;
int t;
while (( t = in.read ()) != — 1 )
out.write ( t ) ;

Конечно же не забываем включить обработку исключения IOException. Не правда ли, элементарно? Но что делать, если мы не знаем, что содержится в jar-архиве? Подумав немного над этим вопросом, я ознакомился с классом ZipFile. Ведь JarFile является его наследником. У класса ZipFile есть метод entries(), который возвращает объект интерфейса Enumeration, содержащий имена всех файлов, входящих в архив. Но так как пользоваться этим объектом, мягко говоря, неудобно, то имеет смысл перенести всё содержимое в объект класса Vector. Получаем что-то типа:

Enumeration entries;
Vector v;
int vc= 0 ;
/*
* Vector capacity – количество элементов в векторе v. Почему-то, метод
* v.capacity() выдаёт большее число, чем на самом деле. Разбираться с этим не
* стал 🙂
*/
entries=jarFile.entries () ;
while ( entries.hasMoreElements ()) vect.add ( entries.nextElement ()) ;
vc++;
>

Замечу сразу, что я писал программу для Java 1.5. Для Java 1.4 и более ранних версий работа с объектами Enumeration и Vector была бы немного другой, немного более трудной. Спасибо Sun Microsystems за облегчение и без того тяжкой участи программистов! 🙂 Ну а теперь, имея список содержимого jar-архива, мы спокойно можем распаковывать его, не забывая создавать подкаталоги, содержащиеся в архиве. Для этого используем метод mkdir() класса File. Назовём наш метод extract(). Он может иметь следующий вид:

public void extract () <
File tmpfile;
/*
* создаём временный объект, который будет создавать каталоги
*/
JarEntry tmpentry; /* создаём временную ссылку на файл в архиве */
FileOutputStream out; /* это и так понятно */
InputStream in; /* и это тоже */
int t; /* переменная для копирования файла */
try <
/*
* создаём цикл для извлечения файлов из архива. Вот нам и пригодилась
* переменная vc
*/
for ( int i = 0 ; i ) <
/*
* берём из вектора имя очередного файла или каталога
*/
tmpentry = vect.get ( i ) ;
tmpfile = new File ( tmpentry.getName ()) ;
/* если tmpfile – каталог, */
if ( tmpentry.isDirectory ()) <
/* то создаём его */
if ( !tmpfile.mkdir ()) <
System.out.println ( «Can’t create directory: »
+ tmpfile.getName ()) ;
/*
* если он не создаётся,
*/
return ; /* выходим из функции */
>
>
/*
* ну а если tmpfile – не каталог, а файл, то спокойно извлекаем его
*/
else <
in = jarFile.getInputStream ( tmpentry ) ;
out = new FileOutputStream ( tmpfile ) ;
while (( t = in.read ()) != — 1 )
out.write ( t ) ;
/*
* лучше потоки ввода и вывода закрывать, иначе наша программа
*/
out.close () ;
/*
* может не сосем корректно работать (некоторые файлы могут
* теряться)
*/
in.close () ;
>
>
>
/* обрабатываем исключение */
catch ( IOException e ) <
System.out.println ( e.getMessage ()) ;
e.printStackTrace () ; /* это, по-моему, не совсем обязательно */
System.exit ( 0 ) ;
>
>

Ура товарищи, мы это сделали! Аналогичным образом можно работать и с zip-архивами. Необходимо только поменять JarFile и JarEntry на ZipFile и ZipEntry соответственно. На основе этого можно сделать что-нибудь более сложное и подходящее под какие-то конкретные цели. Алгоритм может быть и более оптимально построен. В статье он не совсем оптимален для пущей наглядности.

Источник

Creating a JAR File

The basic format of the command for creating a JAR file is:

jar cf jar-file input-file(s) 

The options and arguments used in this command are:

• The c option indicates that you want to create a JAR file.
• The f option indicates that you want the output to go to a file rather than to stdout.
• jar-file is the name that you want the resulting JAR file to have. You can use any filename for a JAR file. By convention, JAR filenames are given a .jar extension, though this is not required.
• The input-file(s) argument is a space-separated list of one or more files that you want to include in your JAR file. The input-file(s) argument can contain the wildcard * symbol. If any of the «input-files» are directories, the contents of those directories are added to the JAR archive recursively.

The c and f options can appear in either order, but there must not be any space between them.

This command will generate a compressed JAR file and place it in the current directory. The command will also generate a default manifest file for the JAR archive.

The metadata in the JAR file, such as the entry names, comments, and contents of the manifest, must be encoded in UTF8.

You can add any of these additional options to the cf options of the basic command:

jar cmf jar-file existing-manifest input-file(s) 

Warning: The manifest must end with a new line or carriage return. The last line will not be parsed properly if it does not end with a new line or carriage return.

When you create a JAR file, the time of creation is stored in the JAR file. Therefore, even if the contents of the JAR file do not change, when you create a JAR file multiple times, the resulting files are not exactly identical. You should be aware of this when you are using JAR files in a build environment. It is recommended that you use versioning information in the manifest file, rather than creation time, to control versions of a JAR file. See the Setting Package Version Information section.

An Example

Let us look at an example. A simple TicTacToe applet. You can see the source code of this applet by downloading the JDK Demos and Samples bundle from Java SE Downloads. This demo contains class files, audio files, and images having this structure:

TicTacToe folder Hierarchy

The audio and images subdirectories contain sound files and GIF images used by the applet.

You can obtain all these files from jar/examples directory when you download the entire Tutorial online. To package this demo into a single JAR file named TicTacToe.jar, you would run this command from inside the TicTacToe directory:

jar cvf TicTacToe.jar TicTacToe.class audio images

The audio and images arguments represent directories, so the Jar tool will recursively place them and their contents in the JAR file. The generated JAR file TicTacToe.jar will be placed in the current directory. Because the command used the v option for verbose output, you would see something similar to this output when you run the command:

adding: TicTacToe.class (in=3825) (out=2222) (deflated 41%) adding: audio/ (in=0) (out=0) (stored 0%) adding: audio/beep.au (in=4032) (out=3572) (deflated 11%) adding: audio/ding.au (in=2566) (out=2055) (deflated 19%) adding: audio/return.au (in=6558) (out=4401) (deflated 32%) adding: audio/yahoo1.au (in=7834) (out=6985) (deflated 10%) adding: audio/yahoo2.au (in=7463) (out=4607) (deflated 38%) adding: images/ (in=0) (out=0) (stored 0%) adding: images/cross.gif (in=157) (out=160) (deflated -1%) adding: images/not.gif (in=158) (out=161) (deflated -1%)

You can see from this output that the JAR file TicTacToe.jar is compressed. The Jar tool compresses files by default. You can turn off the compression feature by using the 0 (zero) option, so that the command would look like:

jar cvf0 TicTacToe.jar TicTacToe.class audio images

You might want to avoid compression, for example, to increase the speed with which a JAR file could be loaded by a browser. Uncompressed JAR files can generally be loaded more quickly than compressed files because the need to decompress the files during loading is eliminated. However, there is a tradeoff in that download time over a network may be longer for larger, uncompressed files.

The Jar tool will accept arguments that use the wildcard * symbol. As long as there weren’t any unwanted files in the TicTacToe directory, you could have used this alternative command to construct the JAR file:

Though the verbose output doesn’t indicate it, the Jar tool automatically adds a manifest file to the JAR archive with path name META-INF/MANIFEST.MF. See the Working with Manifest Files: The Basics section for information about manifest files.

In the above example, the files in the archive retained their relative path names and directory structure. The Jar tool provides the -C option that you can use to create a JAR file in which the relative paths of the archived files are not preserved. It’s modeled after TAR’s -C option.

As an example, suppose you wanted to put audio files and gif images used by the TicTacToe demo into a JAR file, and that you wanted all the files to be on the top level, with no directory hierarchy. You could accomplish that by issuing this command from the parent directory of the images and audio directories:

jar cf ImageAudio.jar -C images . -C audio .

The -C images part of this command directs the Jar tool to go to the images directory, and the . following -C images directs the Jar tool to archive all the contents of that directory. The -C audio . part of the command then does the same with the audio directory. The resulting JAR file would have this table of contents:

META-INF/MANIFEST.MF cross.gif not.gif beep.au ding.au return.au yahoo1.au yahoo2.au

By contrast, suppose that you used a command that did not employ the -C option:

jar cf ImageAudio.jar images audio

The resulting JAR file would have this table of contents:

META-INF/MANIFEST.MF images/cross.gif images/not.gif audio/beep.au audio/ding.au audio/return.au audio/yahoo1.au audio/yahoo2.au

Источник