Swing/ClassLoader のバックアップの現在との差分(No.5)

  • 追加された行はこの色です。
  • 削除された行はこの色です。
TITLE:ClassLoaderでリソースのURLを取得
#navi(../)
*ClassLoaderでリソースのURLを取得 [#m9a3a824]
>編集者:[[Terai Atsuhiro>terai]]~
作成日:2006-05-22~
更新日:&lastmod;
---
category: swing
folder: ClassLoader
title: ClassLoaderでリソース(URL)を取得
tags: [ClassLoader, Resource, URL]
author: aterai
pubdate: 2006-05-22T09:59:23+09:00
description: クラスパスからのエントリ(相対パス風)を使って、ClassLoaderからURLを取得します。
image: https://lh3.googleusercontent.com/_9Z4BYR88imo/TQTI-UTFN-I/AAAAAAAAATo/6sdQoVO0Kc4/s800/ClassLoader.png
---
* 概要 [#summary]
クラスパスからのエントリ(相対パス風)を使って、`ClassLoader`から`URL`を取得します。

#contents
#download(https://lh3.googleusercontent.com/_9Z4BYR88imo/TQTI-UTFN-I/AAAAAAAAATo/6sdQoVO0Kc4/s800/ClassLoader.png)

**概要 [#yd94964b]
リソースをクラスパス相対パスで指定し、ClassLoaderを使ってURLを取得します。
* サンプルコード [#sourcecode]
#code(link){{
URL url = getClass().getClassLoader().getResource("example/test.png");
// URL url = Thread.currentThread().getContextClassLoader().getResource("example/test.png");
// URL url = getClass().getResource("test.png");
JLabel icon = new JLabel(new ImageIcon(url));
JLabel path = new JLabel(url.toString());
}}

#screenshot
* 解説 [#explanation]
`ClassLoader`を使用して、位置に依存しない方法でリソース(`URL`)を取得します。

**サンプルコード [#jcd0714c]
- 例えば`new ImageIcon(String filename)`のようにファイルパスを文字列で指定した場合、このファイルパスが位置(カレントディレクトリ)に依存しているため、実行時に別のディレクトリから起動したり、`jar`ファイルにまとめたりするとファイルが参照できなくなる

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

上記のサンプルに添付しているバッチファイルでは、クラスパスは次のように設定しています。
 java -classpath ".\target\classes" example.MainPanel

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

#code{{
 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());
getClass().getClassLoader().getResource("example/test.png");
// ただし、getClass().getClassLoader().getResource("./example/test.png");
// だとjar内にパッケージした場合で失敗する
}}
-&jnlp;
-&jar;
-&zip;

**解説 [#fc02caf2]
ClassLoaderを使用した場合、クラスパスからの相対パス与えることで、リソースのURLを取得することができます。
----
`ClassLoader`からでは無く、`Class#getResource`メソッドを使う方法もあります。この場合、エントリ名がメソッド内で以下のように変換されます。

例えば、.\target\classes\example\test.pngにある画像ファイルのURLを相対パスで取得する場合を考えます。
- 相対パス風(頭に`/`が付かない)の場合
-- `.`が`/`に変換された、`modified_package_name`が名前の前に補完される
-- 例えば、`com.example.Test`クラスなら、`com/example/`
-- このサンプルでは`example.MainPanel`クラスなので、`example/`が補完されて、`example/test.png`になる

上記のサンプルを添付のバッチファイルから実行したときのクラスパスは、次のように設定しています。
 java -classpath ".\target\classes" example.MainPanel
#code{{
ClassLoader#getResourceメソッドを使用する場合は、以下のようにクラスパスからの相対パス(/区切り)を引数にします。
 getClass().getClassLoader().getResource("example/test.png");
 //getClass().getClassLoader().getResource("./example/test.png");
 //だとjar内にパッケージした時うまくいかない。
getClass().getResource("test.png"); //or MainPanel.class.getResource("test.png");
// getClass().getClassLoader().getResource("example/test.png");と同じ
}}

ClassLoaderからでは無く、Class#getResourceメソッドを使う場合、modified_package_name(このサンプルではパッケージのexampleになる)が補完されるので、以下のように指定します。
- 絶対パス風(頭に`/`が付く)の場合
-- `modified_package_name`は補完せず、頭の`/`は削除される

#code{{
 getClass().getResource("test.png");
getClass().getResource("/test.png");
// getClass().getClassLoader().getResource("test.png");と同じ
// 上記の相対パスと同じリソースを取得する場合は、
// getClass().getResource("/example/test.png");としなくてはならない
}}

どちらを使用しても取得できるURLは同じになります。また、上記のように、相対パスで指定しておけば、ファイルがjar内にあっても、Web上でも、ローカルディレクトリの中にあってもURLを取得することができます。
----
クラスパス上に同名のリソースが複数存在する場合は、最初に見つかったものが使用されます。

相対パスで示したファイルが、クラスパス上に複数存在する場合は、最初に見つかったものが使用されます。
+src.zipをダウンロードして適当な場所に展開する
+c:\temp\example\test.png という画像ファイルを別途用意する
+1.で展開したフォルダにあるrun.batの6行目(クラスパス)を以下のように変更
 set LOCALCLASSPATH=c:\temp;.\target\classes
+ant でコンパイルして、修正したrun.batで実行
- `src.zip`をダウンロードして適当な場所に展開する
- `c:\temp\example\test.png`という画像ファイルを別途用意する
- 展開したフォルダにある`run.bat`のクラスパスを以下のように変更(`c:\temp`を最初に追加)

この場合、src.zipに元々入っていた「適当な場所/test.png」ではなく、「file:/C/temp/example/test.png」というURLがgetResourceで取得できます。
#code{{
set MAIN_CLASS=example.MainPanel
rem set CLASSPATH=.\target\classes
set CLASSPATH=c:\temp;.\target\classes
}}

//**参考リンク
**コメント [#z19691a0]
- `ant`などでコンパイルして、修正した`run.bat`で実行

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

* 参考リンク [#reference]
- [https://docs.oracle.com/javase/jp/8/docs/technotes/guides/lang/resources.html 位置に依存しない方法でのリソースへのアクセス]
- [https://docs.oracle.com/javase/tutorial/uiswing/components/icon.html#getresource Loading Images Using getResource]

* コメント [#comment]
#comment
- 「クラスパスからのパス」などの意味が分かり辛いので、[https://docs.oracle.com/javase/jp/8/docs/api/java/net/JarURLConnection.html JarURLConnection (Java Platform SE 8)]を参考にして「パス」を「エントリ」に変更してみました。 -- &user(aterai); &new{2008-02-15 (金) 18:04:14};
- `.jar`ファイルのクラスで -- &user(kind); &new{2012-03-02 (金) 14:04:06};
-- 見落としてました。最近なんか重いので途切れてしまったのでしょうか。 -- &user(aterai); &new{2012-03-05 (月) 16:26:35};

#comment