Posted by terai at 2006-05-22

ClassLoaderでリソース(URL)を取得

クラスパスからのエントリ(相対パス風)を使って、ClassLoaderからURLを取得します。

Swing/ClassLoader screenshot

サンプルコード 

URL url = getClass().getClassLoader().getResource("example/test.png");
//URL url = getClass().getResource("test.png");
JLabel icon = new JLabel(new ImageIcon(url));
JLabel path = new JLabel(url.toString());

解説

ClassLoaderを使用して、位置に依存しない方法でリソース(URL)を取得します。

以下、".\target\classes\example\test.png"にある画像ファイルのURLをクラスパスからのエントリ(相対パス風)を使って取得する場合を考えます。

上記のサンプルに添付しているバッチファイルでは、クラスパスは次のように設定しています。

java -classpath ".\target\classes" example.MainPanel

ClassLoader#getResourceメソッドを使用する場合は、以下のようにクラスパスからのエントリを使用します。このエントリは、相対パス風で頭に/は付けず、/区切りで記述します。

getClass().getClassLoader().getResource("example/test.png");
//ただし、getClass().getClassLoader().getResource("./example/test.png");
//だとjar内にパッケージした時うまくいかない。

ClassLoaderからでは無く、Class#getResourceメソッドを使う方法もあります。この場合、エントリ名がメソッド内で以下のように変換されます。

  • 相対パス風(頭に/が付かない)の場合
    • "." が "/" に変換された、modified_package_nameが名前の前に補完される
    • 例えば、com.example.Testクラスなら、"com/example/"
    • このサンプルではexample.MainPanelクラスなので、"example/"が補完されて、"example/test.png"になる 
      getClass().getResource("test.png");
//getClass().getClassLoader().getResource("example/test.png");と同じ
  • 絶対パス風(頭に/が付く)の場合
    • modified_package_nameは補完せず、頭の "/" は削除される 
      getClass().getResource("/test.png");
//getClass().getClassLoader().getResource("test.png");と同じ
//上記の相対パスと同じリソースを取得する場合は、
//getClass().getResource("/example/test.png");としなくてはならない

クラスパス上に同じエントリ名のリソースが複数存在する場合は、最初に見つかったものが使用されます。

  1. src.zipをダウンロードして適当な場所に展開する
  2. c:\temp\example\test.png という画像ファイルを別途用意する
  3. 1.で展開したフォルダにあるrun.batの6行目(クラスパス)を以下のように変更 
    set LOCALCLASSPATH=c:\temp;.\target\classes
  4. ant でコンパイルして、修正したrun.batで実行

この場合、src.zipに元々入っていた「適当な場所/test.png」ではなく、「file:/C:/temp/example/test.png」というURLがgetResourceで取得できます。

参考リンク

コメント

  • 「クラスパスからのパス」などの意味が分かり辛いので、JarURLConnection (Java Platform SE 6)を参考にして「パス」を「エントリ」に変更してみました。 -- terai 2008-02-15 (金) 18:04:14