「Java パッケージガイドライン」の版間の差分
(ページの作成:「Category:パッケージ開発 en:Java package guidelines it:Java Package Guidelines zh-CN:Java Package Guidelines {{Package Guidelines}} This document d...」) |
|||
1行目: | 1行目: | ||
[[Category:パッケージ開発]] |
[[Category:パッケージ開発]] |
||
[[en:Java package guidelines]] |
[[en:Java package guidelines]] |
||
− | [[it:Java |
+ | [[it:Java package guidelines]] |
− | [[zh-CN:Java |
+ | [[zh-CN:Java package guidelines]] |
{{Package Guidelines}} |
{{Package Guidelines}} |
||
+ | この文章では Arch Linux における [[Java]] プログラムのパッケージングについて提唱される標準を定義しています。Java プログラムは依存関係を重ねないようにパッケージ化するのが大変難しいことで有名です。この文章ではそれをなんとか改善する方法を説明します。Java アプリケーションを扱うときは様々な場面に合わせて以下のガイドラインを臨機応変に読み替えてください。 |
||
− | This document defines a proposed standard for packaging [[Java]] programs under Arch Linux. Java programs are notoriously difficult to package cleanly without overlapping dependencies. This document describes a way to remedy this situation. These guidelines are flexible in order to cover the many different scenarios that arise when dealing with Java applications. |
||
==イントロダクション== |
==イントロダクション== |
||
+ | Java パッケージの処理方法について Arch Linux のパッケージ作成者が合意を取ることは不可能です。公式・非公式リポジトリや [[AUR]] に存在する [[PKGBUILD]] では様々な手段が使われています。{{Ic|/opt}} に全てのファイルを配置して、{{Ic|/usr/bin}} にシェルスクリプトを置いたり {{Ic|/etc/profile}} にプロファイルを保存する方法もあれば、{{Ic|/usr/share}} のディレクトリにファイルを配置して {{Ic|/usr/bin}} にスクリプトを置いているのもあります。システムの {{Ic|CLASSPATH}} や {{Ic|PATH}} には多くの不必要なファイルが追加されています。 |
||
− | Arch Linux packagers cannot seem to agree on how to handle Java packages. Various methods are used in [[PKGBUILD]]s across the official and unofficial repositories and in the [[AUR]]. These solutions include placing the whole mess in {{Ic|/opt}} with shell scripts in {{Ic|/usr/bin}} or profiles placed in {{Ic|/etc/profile}}. Others are placed in directories in {{Ic|/usr/share}} with scripts placed in {{Ic|/usr/bin}}. Many add unnecessary files to the system {{Ic|CLASSPATH}} and {{Ic|PATH}}. |
||
==典型的な Java アプリケーションの構造== |
==典型的な Java アプリケーションの構造== |
||
+ | ほとんどの Java のデスクトップアプリケーションは同じような構造をしています。これらのアプリケーションはシステムに依存しない (ただしパッケージに依存する) インストーラーによってインストールされます。大抵は全てを単一のディレクトリにインストールして {{Ic|bin}}, {{Ic|lib}}, {{Ic|jar}}, {{Ic|conf}} などのサブディレクトリが作られます。通常、メインの jar ファイルが存在していて、メインの実行クラスが記述されています。また、Java インタプリタを直接実行しなくてもいいように、メインクラスを実行するためのシェルスクリプトも付属しているのが普通です。シェルスクリプトは様々なディストリビューションで共通して用いられ、別の環境 (例: Cygwin) 用の特殊なケースもカバーするようになっている場合が多く、非常に複雑になっています。 |
||
− | Most Desktop Java applications have a similar structure. They are installed from a system-independent (but package dependent!) installer. This usually installs everything in a single directory with subdirectories called {{Ic|bin}}, {{Ic|lib}}, {{Ic|jar}}, {{Ic|conf}}, etc. There is usually a main jar file containing the main executable classes. A shell script is usually provided to run the main class so users do not have to invoke the Java interpreter directly. This shell script is usually quite complex, as it is generic across distributions and often includes special cases for different systems (e.g., Cygwin). |
||
+ | {{Ic|lib}} ディレクトリには jar ファイルがバンドルされているのが通例で、Java アプリケーションの依存関係を満たすようになっています。(全ての依存パッケージが含まれていることは) プログラムをインストールしたいユーザーにとっては楽ですが、パッケージの開発者にとっては悪夢です。同一の依存パッケージを複数のパッケージがバンドルしていることは無駄に他なりません。Java のデスクトップアプリケーションやライブラリの数が少なかった昔はそこまで大きな問題ではありませんでしたが、Java アプリケーションとライブラリの数が増えるにつれて避けがたい問題になっています。時代は変わったのです。 |
||
− | The {{Ic|lib}} directory often contains bundled jar files that satisfy dependencies of the Java application. This makes it simple for a user to install the program (all dependencies included), but is a package developer's nightmare. It is a waste of space when several packages bundle the same dependency. This was not a big issue in the past when there were fewer desktop Java applications and libraries, and those that existed tended to be very large anyway. Things are different now... |
||
+ | プログラムを実行するのに必要な他のファイルはメインの jar ファイルと同じフォルダに保存されるか、サブディレクトリに保存されるのが普通です。Java プログラムはどこからクラスがロードされたか関知しないので、jar ファイルがあるディレクトリ内から実行しなくてはなりません (シェルスクリプトでディレクトリに {{Ic|cd}} する必要がある)。あるいは、ディレクトリの場所を示す環境変数を設定します。 |
||
− | Other files necessary to run the program are usually stored in the same folder as the main jar file, or a subdirectory thereof. Since Java programs do not know where their classes were loaded from, they usually need to be run from within this directory (i.e. the shell script should {{Ic|cd}} into the directory), or an environment variable is set to indicate the directory's location. |
||
==パッケージング== |
==パッケージング== |
||
68行目: | 68行目: | ||
===依存パッケージ=== |
===依存パッケージ=== |
||
− | Java |
+ | Java パッケージには、必要に応じて、{{Ic|java-runtime}} あるいは {{Ic|java-environment}} を依存パッケージとして指定します。 |
+ | 大抵のパッケージでは、Java で書かれたソフトウェアを実行するのに {{Ic|java-runtime}} が必要になります。{{Ic|java-runtime}} は以下のパッケージに含まれている仮想パッケージです: |
||
− | For most packages, {{Ic|java-runtime}} is what is needed to simply run software written in Java. {{Ic|java-runtime}} is a virtual dependency provided by: |
||
− | * {{Pkg|jre7-openjdk}} ( |
+ | * {{Pkg|jre7-openjdk}} (フリー) |
− | * {{AUR|java-gcj-compat}} ( |
+ | * {{AUR|java-gcj-compat}} (フリー) |
− | * {{AUR|jre}} ( |
+ | * {{AUR|jre}} (ノンフリー) |
+ | Java のソースコードをバイトコードにコンパイルする必要があるパッケージでは {{Ic|java-environment}} (例: JDK) が必須になります。{{Ic|java-environment}} は以下のパッケージに含まれている仮想パッケージです: |
||
− | {{Ic|java-environment}} (e.g. JDK) is needed by packages that will need to compile Java source code into bytecode. {{Ic|java-environment}} is a virtual dependency provided by: |
||
− | * {{Pkg|jdk7-openjdk}} ( |
+ | * {{Pkg|jdk7-openjdk}} (フリー) |
− | * {{AUR|jdk}} ( |
+ | * {{AUR|jdk}} (ノンフリー) |
2016年1月2日 (土) 12:16時点における版
32ビット – CLR – クロス – Eclipse – Electron – Free Pascal – GNOME – Go – Haskell – Java – KDE – カーネル – Lisp – MinGW – Node.js – ノンフリー – OCaml – Perl – PHP – Python – R – Ruby – Rust – VCS – ウェブ – Wine
この文章では Arch Linux における Java プログラムのパッケージングについて提唱される標準を定義しています。Java プログラムは依存関係を重ねないようにパッケージ化するのが大変難しいことで有名です。この文章ではそれをなんとか改善する方法を説明します。Java アプリケーションを扱うときは様々な場面に合わせて以下のガイドラインを臨機応変に読み替えてください。
イントロダクション
Java パッケージの処理方法について Arch Linux のパッケージ作成者が合意を取ることは不可能です。公式・非公式リポジトリや AUR に存在する PKGBUILD では様々な手段が使われています。/opt
に全てのファイルを配置して、/usr/bin
にシェルスクリプトを置いたり /etc/profile
にプロファイルを保存する方法もあれば、/usr/share
のディレクトリにファイルを配置して /usr/bin
にスクリプトを置いているのもあります。システムの CLASSPATH
や PATH
には多くの不必要なファイルが追加されています。
典型的な Java アプリケーションの構造
ほとんどの Java のデスクトップアプリケーションは同じような構造をしています。これらのアプリケーションはシステムに依存しない (ただしパッケージに依存する) インストーラーによってインストールされます。大抵は全てを単一のディレクトリにインストールして bin
, lib
, jar
, conf
などのサブディレクトリが作られます。通常、メインの jar ファイルが存在していて、メインの実行クラスが記述されています。また、Java インタプリタを直接実行しなくてもいいように、メインクラスを実行するためのシェルスクリプトも付属しているのが普通です。シェルスクリプトは様々なディストリビューションで共通して用いられ、別の環境 (例: Cygwin) 用の特殊なケースもカバーするようになっている場合が多く、非常に複雑になっています。
lib
ディレクトリには jar ファイルがバンドルされているのが通例で、Java アプリケーションの依存関係を満たすようになっています。(全ての依存パッケージが含まれていることは) プログラムをインストールしたいユーザーにとっては楽ですが、パッケージの開発者にとっては悪夢です。同一の依存パッケージを複数のパッケージがバンドルしていることは無駄に他なりません。Java のデスクトップアプリケーションやライブラリの数が少なかった昔はそこまで大きな問題ではありませんでしたが、Java アプリケーションとライブラリの数が増えるにつれて避けがたい問題になっています。時代は変わったのです。
プログラムを実行するのに必要な他のファイルはメインの jar ファイルと同じフォルダに保存されるか、サブディレクトリに保存されるのが普通です。Java プログラムはどこからクラスがロードされたか関知しないので、jar ファイルがあるディレクトリ内から実行しなくてはなりません (シェルスクリプトでディレクトリに cd
する必要がある)。あるいは、ディレクトリの場所を示す環境変数を設定します。
パッケージング
Packaging Java applications in Arch is going to take quite a bit more work for packagers than it currently does. The effort will be worth it, however, resulting in a cleaner filesystem and fewer bundled dependencies (as more and more Java libraries are refactored into their own packages, packaging will become easier). The following guidelines should be followed in creating an Arch Linux Java package:
- If a Java library has a generic name, the package name should be prepended with the title
java-
to help distinguish it from other libraries. This is not necessary with uniquely named packages (like JUnit), end-user programs (like Eclipse), or libraries that can be uniquely described with another prefix (like jakarta-commons-collections or apache-ant).
- You do not need to compile Java applications from source. Very little optimization goes into the compile process, as with gcc created binaries. If the source package provides an easy way to build from source go ahead and use it, but if its easier to just grab a binary release of a jar file or an installer you may use that as well.
- Place all jar files (and no other files) distributed with the program in a
/usr/share/java/myprogram
directory. This includes all dependency jar files distributed with the application. However, effort should be made to place common or large dependency libraries into their own packages. This can only happen if the program does not depend on a specific version of a dependency library.
This rule makes it possible to iteratively refactor dependencies. That is, the package and all its dependencies can be placed into one directory at first. After this has been tested, major dependencies can be refactored out one at a time. Note that some applications include bundled dependencies inside the main jar file. That is, they unjar the bundled dependencies and include them in the main jar. Such dependencies are usually very small and there is little point in refactoring them.
- If the program is meant to be run by the user, write a custom shell script that runs the main jar file. This script should be placed in
/usr/bin
. Libraries generally do not require shell scripts. Write the shell script from scratch, rather than using one that is bundled with the program. Remove code that tests for custom environments (like Cygwin), and code that tries to determine ifJAVA_HOME
has been set (Arch does not useJAVA_HOME
, it usesarchlinux-java
to set the/usr/bin/java
symlink).
such script should look like this for jar files:
#!/bin/sh exec /usr/bin/java -jar '/usr/share/java/PROGRAMNAME/PROGRAMNAME.jar' "$@"
and like this for single class files:
#!/bin/sh exec /usr/bin/java '/usr/share/java/PROGRAMNAME/PROGRAMCLASSNAME' "$@"
- Set the
CLASSPATH
using the-cp
option to the Java interpreter unless there is an explicit reason not to (ie: theCLASSPATH
is used as a plugin mechanism). TheCLASSPATH
should include all jar files in the/usr/share/java/myprogram
direcory, as well as jar files that are from dependency libraries that have been refactored to other directories. You can use something like the following code:
for name in /usr/share/java/myprogram/*.jar ; do CP=$CP:$name done CP=$CP:/usr/share/java/dep1/dep1.jar java -cp $CP myprogram.java.MainClass
- Make sure the shell script is executable!
- Other files distributed with the package should be stored in a directory named after the package under
/usr/share
. You may need to set the location of this directory in a variable likeMYPROJECT_HOME
inside the shell script. This guideline assumes that the program expects all files to be in the same directory (as is standard with Java packages). If it seems more natural to put a configuration file elsewhere (for example, logs in/var/log
), then feel free to do so.
Bear in mind that /usr
may be mounted as read-only on some systems. If there are files in the shared directory that need to be written by the application, they may have to be relocated to /etc
, /var
, or the user's home directory.
- As is standard with Arch Linux packages, if the above standards cannot be adhered to without a serious amount of work, the package should be installed in its preferred manner, with the resulting directory located in
/opt
. This is useful for programs that bundle JREs or include customized versions of dependencies, or do other strange or painful tasks.
複数の API 実装
If your package distributes commonly used API implementation(like jdbc driver) you should place the library under /usr/share/java/apiname
. So that applications that allow user to select from various implementations
will know where to look for them. Use this location only for raw library packages. If such a implementation is part of distribution of application, do not place this jar file under common location but use ordinary package structure.
ディレクトリ構造の例
To clarify, here is an example directory structure for a hypothetical program called foo
. Since foo
is a common name, the package is named java-foo
, but notice this is not reflected in the directory structure:
/usr/share/java/foo/
/usr/share/java/foo/foo.jar
/usr/share/java/foo/bar.jar
(included dependency ofjava-foo
)/usr/share/foo/
/usr/share/foo/*.*
(some general files required byjava-foo
)/usr/bin/foo
(executable shell script)
依存パッケージ
Java パッケージには、必要に応じて、java-runtime
あるいは java-environment
を依存パッケージとして指定します。
大抵のパッケージでは、Java で書かれたソフトウェアを実行するのに java-runtime
が必要になります。java-runtime
は以下のパッケージに含まれている仮想パッケージです:
- jre7-openjdk (フリー)
- java-gcj-compatAUR (フリー)
- jreAUR (ノンフリー)
Java のソースコードをバイトコードにコンパイルする必要があるパッケージでは java-environment
(例: JDK) が必須になります。java-environment
は以下のパッケージに含まれている仮想パッケージです:
- jdk7-openjdk (フリー)
- jdkAUR (ノンフリー)