リフレクションを使用してパッケージ内のすべてのクラスを見付けることができますか？
特定のパッケージ内のすべてのクラスまたはインタフェースを見つけることは可能ですか？ （例えば Package をちょっと見てみると、いいえのように思えるでしょう。）
クラスローダーの動的な性質のため、これは不可能です。クラスローダは、提供できるクラスをVMに伝える必要はありません。代わりに、クラスローダは単にクラスに対する要求を渡し、クラスを返すか例外をスローする必要があります。
しかし、もしあなたがあなた自身のクラスローダーを書いたり、クラスパスを調べてそれがjarだったら、この情報を見つけることは可能です。これはファイルシステムの操作によるものであり、反映ではありません。あなたがこれをするのを助けることができるライブラリさえあるかもしれません。
生成されたクラス、またはリモートで配信されたクラスがある場合、それらのクラスを発見することはできません。
通常の方法では、アクセスする必要のあるクラスをファイルのどこかに登録するか、別のクラスでそれらを参照します。命名に関しては、単に慣例を使用してください。
補遺： The Reflections Library を使うと、現在のクラスパスでクラスを検索できます。これはパッケージ内のすべてのクラスを取得するために使用できます。
Reflections reflections = new Reflections("my.project.prefix");
Set<Class<? extends Object>> allClasses =
reflections.getSubTypesOf(Object.class);
おそらくあなたはオープンソース Reflections library を見てみるべきでしょう。それを使えば、簡単にあなたが望むものを達成することができます。
まず、反射インデックスを設定します（すべてのクラスの検索がデフォルトで無効になっているので、少し面倒です）。
List<ClassLoader> classLoadersList = new LinkedList<ClassLoader>();
classLoadersList.add(ClasspathHelper.contextClassLoader());
classLoadersList.add(ClasspathHelper.staticClassLoader());
Reflections reflections = new Reflections(new ConfigurationBuilder()
.setScanners(new SubTypesScanner(false /* don't exclude Object.class */), new ResourcesScanner())
.setUrls(ClasspathHelper.forClassLoader(classLoadersList.toArray(new ClassLoader[0])))
.filterInputsBy(new FilterBuilder().include(FilterBuilder.prefix("org.your.package"))));
それから、与えられたパッケージの中のすべてのオブジェクトを問い合わせることができます。
Set<Class<?>> classes = reflections.getSubTypesOf(Object.class);
Google Guava 14には、最上位クラスをスキャンするための3つのメソッドを持つ新しいクラス ClassPath が含まれています。
getTopLevelClasses()getTopLevelClasses(String packageName)getTopLevelClassesRecursive(String packageName)
詳しくは ClassPath javadocs を参照してください。
を使うことができます - このメソッド1 それはClassLoaderを使います。
/**
* Scans all classes accessible from the context class loader which belong to the given package and subpackages.
*
* @param packageName The base package
* @return The classes
* @throws ClassNotFoundException
* @throws IOException
*/
private static Class[] getClasses(String packageName)
throws ClassNotFoundException, IOException {
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
assert classLoader != null;
String path = packageName.replace('.', '/');
Enumeration<URL> resources = classLoader.getResources(path);
List<File> dirs = new ArrayList<File>();
while (resources.hasMoreElements()) {
URL resource = resources.nextElement();
dirs.add(new File(resource.getFile()));
}
ArrayList<Class> classes = new ArrayList<Class>();
for (File directory : dirs) {
classes.addAll(findClasses(directory, packageName));
}
return classes.toArray(new Class[classes.size()]);
}
/**
* Recursive method used to find all classes in a given directory and subdirs.
*
* @param directory The base directory
* @param packageName The package name for classes found inside the base directory
* @return The classes
* @throws ClassNotFoundException
*/
private static List<Class> findClasses(File directory, String packageName) throws ClassNotFoundException {
List<Class> classes = new ArrayList<Class>();
if (!directory.exists()) {
return classes;
}
File[] files = directory.listFiles();
for (File file : files) {
if (file.isDirectory()) {
assert !file.getName().contains(".");
classes.addAll(findClasses(file, packageName + "." + file.getName()));
} else if (file.getName().endsWith(".class")) {
classes.add(Class.forName(packageName + '.' + file.getName().substring(0, file.getName().length() - 6)));
}
}
return classes;
}
__________
1 この方法はもともと http://snippets.dzone.com/posts/show/4831 から取られたもので、これは今までのところでリンクされているようにインターネットアーカイブによって archived でした。このスニペットは https://dzone.com/articles/get-all-classes-within-package にもあります。
春
この例はSpring 4用ですが、以前のバージョンでもクラスパススキャナを見つけることができます。
// create scanner and disable default filters (that is the 'false' argument)
final ClassPathScanningCandidateComponentProvider provider = new ClassPathScanningCandidateComponentProvider(false);
// add include filters which matches all the classes (or use your own)
provider.addIncludeFilter(new RegexPatternTypeFilter(Pattern.compile(".*")));
// get matching classes defined in the package
final Set<BeanDefinition> classes = provider.findCandidateComponents("my.package.name");
// this is how you can load the class type from BeanDefinition instance
for (BeanDefinition bean: classes) {
Class<?> clazz = Class.forName(bean.getBeanClassName());
// ... do your magic with the class ...
}
Google Guava
注： バージョン14では、APIはまだ @Beta とマークされているので、本番コードには注意してください。
final ClassLoader loader = Thread.currentThread().getContextClassLoader();
for (final ClassPath.ClassInfo info : ClassPath.from(loader).getTopLevelClasses()) {
if (info.getName().startsWith("my.package.")) {
final Class<?> clazz = info.load();
// do something with your clazz
}
}
こんにちは。私はいつも上記の（そして他のサイトの）解決策に関していくつかの問題を抱えています。
私は、開発者として、API用のアドオンをプログラミングしています。このAPIは、外部ライブラリやサードパーティ製ツールの使用を防ぎます。セットアップは、jarファイルまたはZipファイルのコードと、いくつかのディレクトリに直接配置されているクラスファイルの混在も含まれます。だから私のコードはすべての設定を回避することができなければなりませんでした。多くの調査の結果、私はすべての可能な設定の少なくとも95％でうまくいく方法を思いついた。
次のコードは、基本的にはやり過ぎる方法です。
コード：
このコードは、指定されたパッケージに含まれるすべてのクラスについてそのパッケージをスキャンします。現在のClassLoader内のすべてのクラスに対してのみ機能します。
/**
* Private helper method
*
* @param directory
* The directory to start with
* @param pckgname
* The package name to search for. Will be needed for getting the
* Class object.
* @param classes
* if a file isn't loaded but still is in the directory
* @throws ClassNotFoundException
*/
private static void checkDirectory(File directory, String pckgname,
ArrayList<Class<?>> classes) throws ClassNotFoundException {
File tmpDirectory;
if (directory.exists() && directory.isDirectory()) {
final String[] files = directory.list();
for (final String file : files) {
if (file.endsWith(".class")) {
try {
classes.add(Class.forName(pckgname + '.'
+ file.substring(0, file.length() - 6)));
} catch (final NoClassDefFoundError e) {
// do nothing. this class hasn't been found by the
// loader, and we don't care.
}
} else if ((tmpDirectory = new File(directory, file))
.isDirectory()) {
checkDirectory(tmpDirectory, pckgname + "." + file, classes);
}
}
}
}
/**
* Private helper method.
*
* @param connection
* the connection to the jar
* @param pckgname
* the package name to search for
* @param classes
* the current ArrayList of all classes. This method will simply
* add new classes.
* @throws ClassNotFoundException
* if a file isn't loaded but still is in the jar file
* @throws IOException
* if it can't correctly read from the jar file.
*/
private static void checkJarFile(JarURLConnection connection,
String pckgname, ArrayList<Class<?>> classes)
throws ClassNotFoundException, IOException {
final JarFile jarFile = connection.getJarFile();
final Enumeration<JarEntry> entries = jarFile.entries();
String name;
for (JarEntry jarEntry = null; entries.hasMoreElements()
&& ((jarEntry = entries.nextElement()) != null);) {
name = jarEntry.getName();
if (name.contains(".class")) {
name = name.substring(0, name.length() - 6).replace('/', '.');
if (name.contains(pckgname)) {
classes.add(Class.forName(name));
}
}
}
}
/**
* Attempts to list all the classes in the specified package as determined
* by the context class loader
*
* @param pckgname
* the package name to search
* @return a list of classes that exist within that package
* @throws ClassNotFoundException
* if something went wrong
*/
public static ArrayList<Class<?>> getClassesForPackage(String pckgname)
throws ClassNotFoundException {
final ArrayList<Class<?>> classes = new ArrayList<Class<?>>();
try {
final ClassLoader cld = Thread.currentThread()
.getContextClassLoader();
if (cld == null)
throw new ClassNotFoundException("Can't get class loader.");
final Enumeration<URL> resources = cld.getResources(pckgname
.replace('.', '/'));
URLConnection connection;
for (URL url = null; resources.hasMoreElements()
&& ((url = resources.nextElement()) != null);) {
try {
connection = url.openConnection();
if (connection instanceof JarURLConnection) {
checkJarFile((JarURLConnection) connection, pckgname,
classes);
} else if (connection instanceof FileURLConnection) {
try {
checkDirectory(
new File(URLDecoder.decode(url.getPath(),
"UTF-8")), pckgname, classes);
} catch (final UnsupportedEncodingException ex) {
throw new ClassNotFoundException(
pckgname
+ " does not appear to be a valid package (Unsupported encoding)",
ex);
}
} else
throw new ClassNotFoundException(pckgname + " ("
+ url.getPath()
+ ") does not appear to be a valid package");
} catch (final IOException ioex) {
throw new ClassNotFoundException(
"IOException was thrown when trying to get all resources for "
+ pckgname, ioex);
}
}
} catch (final NullPointerException ex) {
throw new ClassNotFoundException(
pckgname
+ " does not appear to be a valid package (Null pointer exception)",
ex);
} catch (final IOException ioex) {
throw new ClassNotFoundException(
"IOException was thrown when trying to get all resources for "
+ pckgname, ioex);
}
return classes;
}
これらの3つのメソッドはあなたに与えられたパッケージの中のすべてのクラスを見つける能力を提供します。
あなたはこれを次のように使っています：
getClassesForPackage("package.your.classes.are.in");
説明：
メソッドはまず現在のClassLoaderを取得します。その後、そのパッケージを含むすべてのリソースを取得し、これらのURLを繰り返します。それはそれからURLConnectionを作成し、そして私達が持っているURlのタイプを決定します。ディレクトリ（FileURLConnection）またはjarファイルまたはZipファイル内のディレクトリ（JarURLConnection）のどちらでもかまいません。どのような種類の接続があるかによって、2つの異なるメソッドが呼び出されます。
まず、それがFileURLConnectionである場合に何が起こるのかを見てみましょう。
最初に、渡されたファイルが存在し、それがディレクトリかどうかを調べます。その場合は、それがクラスファイルかどうかをチェックします。もしそうなら、Classオブジェクトが作成され、ArrayListに入れられます。それがクラスファイルではなくディレクトリである場合は、単純にそれを繰り返して同じことをします。他のすべてのケース/ファイルは無視されます。
URLConnectionがJarURLConnectionの場合、他のプライベートヘルパーメソッドが呼び出されます。このメソッドは、Zip/jarアーカイブ内のすべてのエントリに対して繰り返します。 1つのエントリがクラスファイルで、パッケージ内にある場合は、Classオブジェクトが作成され、ArrayListに格納されます。
すべてのリソースが解析された後、それ（メインメソッド）は現在のArrayListが知っているように、与えられたパッケージ内のすべてのクラスを含むClassLoaderを返します。
プロセスがいずれかの時点で失敗した場合は、正確な原因に関する詳細な情報を含むClassNotFoundExceptionがスローされます。
追加のライブラリを使用せずに
package test;
import Java.io.DataInputStream;
import Java.io.InputStream;
import Java.net.URL;
import Java.util.ArrayList;
import Java.util.List;
public class Test {
public static void main(String[] args) throws Exception{
List<Class> classes = getClasses(Test.class.getClassLoader(),"test");
for(Class c:classes){
System.out.println("Class: "+c);
}
}
public static List<Class> getClasses(ClassLoader cl,String pack) throws Exception{
String dottedPackage = pack.replaceAll("[/]", ".");
List<Class> classes = new ArrayList<Class>();
URL upackage = cl.getResource(pack);
DataInputStream dis = new DataInputStream((InputStream) upackage.getContent());
String line = null;
while ((line = dis.readLine()) != null) {
if(line.endsWith(".class")) {
classes.add(Class.forName(dottedPackage+"."+line.substring(0,line.lastIndexOf('.'))));
}
}
return classes;
}
}
一般に、クラスローダーはクラスパス上のすべてのクラスをスキャンすることはできません。しかし、通常唯一使用されるクラスローダーはUrlClassLoaderです。そこからディレクトリとjarファイルのリストを取得し（ getURLs を参照）、利用可能なクラスを一覧表示するためにそれらを1つずつ開きます。クラスパススキャンと呼ばれるこのアプローチは、 Scannotation および Reflections で実装されています。
Reflections reflections = new Reflections("my.package");
Set<Class<? extends Object>> classes = reflections.getSubTypesOf(Object.class);
もう1つの方法は、 Java Pluggable Annotation Processing API を使用して、コンパイル時にすべてのアノテーション付きクラスを収集し、ランタイム用にインデックスファイルを構築するアノテーションプロセッサを作成することです。このメカニズムは ClassIndex libraryに実装されています。
// package-info.Java
@IndexSubclasses
package my.package;
// your code
Iterable<Class> classes = ClassIndex.getPackageClasses("my.package");
Javaコンパイラがクラスパス上で見つかったプロセッサを自動的に検出するため、スキャンは完全に自動化されているため、追加の設定は不要です。
私はこの問題を解決するために FastClasspathScanner と書きました。さまざまな種類のクラスパススキャンタスクを処理し、単純なAPIを持ち、さまざまなClassLoaderおよびクラスパス環境で動作し、慎重に並列化されており、高速および低メモリ消費に最適化されています。クラスグラフのGraphVizビジュアライゼーションを生成して、クラスが互いにどのように関連しているかを示すこともできます。
特定のパッケージ内のすべてのクラスまたはインタフェースを見つけるという最初の質問に対しては、次のようにします。
List<String> classNames = new FastClasspathScanner("com.mypackage").scan()
.getNamesOfAllClasses();
これには多くの可能な変形があります - 完全な情報についてはドキュメント（上でリンクされた）を見てください。
これが私のやり方です。私はすべてのサブフォルダ（サブパッケージ）をスキャンし、匿名クラスをロードしようとはしません。
/**
* Attempts to list all the classes in the specified package as determined
* by the context class loader, recursively, avoiding anonymous classes
*
* @param pckgname
* the package name to search
* @return a list of classes that exist within that package
* @throws ClassNotFoundException
* if something went wrong
*/
private static List<Class> getClassesForPackage(String pckgname) throws ClassNotFoundException {
// This will hold a list of directories matching the pckgname. There may be more than one if a package is split over multiple jars/paths
ArrayList<File> directories = new ArrayList<File>();
String packageToPath = pckgname.replace('.', '/');
try {
ClassLoader cld = Thread.currentThread().getContextClassLoader();
if (cld == null) {
throw new ClassNotFoundException("Can't get class loader.");
}
// Ask for all resources for the packageToPath
Enumeration<URL> resources = cld.getResources(packageToPath);
while (resources.hasMoreElements()) {
directories.add(new File(URLDecoder.decode(resources.nextElement().getPath(), "UTF-8")));
}
} catch (NullPointerException x) {
throw new ClassNotFoundException(pckgname + " does not appear to be a valid package (Null pointer exception)");
} catch (UnsupportedEncodingException encex) {
throw new ClassNotFoundException(pckgname + " does not appear to be a valid package (Unsupported encoding)");
} catch (IOException ioex) {
throw new ClassNotFoundException("IOException was thrown when trying to get all resources for " + pckgname);
}
ArrayList<Class> classes = new ArrayList<Class>();
// For every directoryFile identified capture all the .class files
while (!directories.isEmpty()){
File directoryFile = directories.remove(0);
if (directoryFile.exists()) {
// Get the list of the files contained in the package
File[] files = directoryFile.listFiles();
for (File file : files) {
// we are only interested in .class files
if ((file.getName().endsWith(".class")) && (!file.getName().contains("$"))) {
// removes the .class extension
int index = directoryFile.getPath().indexOf(packageToPath);
String packagePrefix = directoryFile.getPath().substring(index).replace('/', '.');;
try {
String className = packagePrefix + '.' + file.getName().substring(0, file.getName().length() - 6);
classes.add(Class.forName(className));
} catch (NoClassDefFoundError e)
{
// do nothing. this class hasn't been found by the loader, and we don't care.
}
} else if (file.isDirectory()){ // If we got to a subdirectory
directories.add(new File(file.getPath()));
}
}
} else {
throw new ClassNotFoundException(pckgname + " (" + directoryFile.getPath() + ") does not appear to be a valid package");
}
}
return classes;
}
この問題を解決する簡単なgithubプロジェクトをまとめました。
https://github.com/ddopson/Java-class-enumerator
ファイルベースのクラスパスとjarファイルの両方で機能するはずです。
プロジェクトをチェックアウトした後に 'make'を実行すると、これが出力されます。
Cleaning...
rm -rf build/
Building...
javac -d build/classes src/pro/ddopson/ClassEnumerator.Java src/test/ClassIShouldFindOne.Java src/test/ClassIShouldFindTwo.Java src/test/subpkg/ClassIShouldFindThree.Java src/test/TestClassEnumeration.Java
Making JAR Files...
jar cf build/ClassEnumerator_test.jar -C build/classes/ .
jar cf build/ClassEnumerator.jar -C build/classes/ pro
Running Filesystem Classpath Test...
Java -classpath build/classes test.TestClassEnumeration
ClassDiscovery: Package: 'test' becomes Resource: 'file:/Users/Dopson/work/other/Java-class-enumeration/build/classes/test'
ClassDiscovery: Reading Directory '/Users/Dopson/work/other/Java-class-enumeration/build/classes/test'
ClassDiscovery: FileName 'ClassIShouldFindOne.class' => class 'test.ClassIShouldFindOne'
ClassDiscovery: FileName 'ClassIShouldFindTwo.class' => class 'test.ClassIShouldFindTwo'
ClassDiscovery: FileName 'subpkg' => class 'null'
ClassDiscovery: Reading Directory '/Users/Dopson/work/other/Java-class-enumeration/build/classes/test/subpkg'
ClassDiscovery: FileName 'ClassIShouldFindThree.class' => class 'test.subpkg.ClassIShouldFindThree'
ClassDiscovery: FileName 'TestClassEnumeration.class' => class 'test.TestClassEnumeration'
Running JAR Classpath Test...
Java -classpath build/ClassEnumerator_test.jar test.TestClassEnumeration
ClassDiscovery: Package: 'test' becomes Resource: 'jar:file:/Users/Dopson/work/other/Java-class-enumeration/build/ClassEnumerator_test.jar!/test'
ClassDiscovery: Reading JAR file: '/Users/Dopson/work/other/Java-class-enumeration/build/ClassEnumerator_test.jar'
ClassDiscovery: JarEntry 'META-INF/' => class 'null'
ClassDiscovery: JarEntry 'META-INF/MANIFEST.MF' => class 'null'
ClassDiscovery: JarEntry 'pro/' => class 'null'
ClassDiscovery: JarEntry 'pro/ddopson/' => class 'null'
ClassDiscovery: JarEntry 'pro/ddopson/ClassEnumerator.class' => class 'null'
ClassDiscovery: JarEntry 'test/' => class 'null'
ClassDiscovery: JarEntry 'test/ClassIShouldFindOne.class' => class 'test.ClassIShouldFindOne'
ClassDiscovery: JarEntry 'test/ClassIShouldFindTwo.class' => class 'test.ClassIShouldFindTwo'
ClassDiscovery: JarEntry 'test/subpkg/' => class 'null'
ClassDiscovery: JarEntry 'test/subpkg/ClassIShouldFindThree.class' => class 'test.subpkg.ClassIShouldFindThree'
ClassDiscovery: JarEntry 'test/TestClassEnumeration.class' => class 'test.TestClassEnumeration'
Tests Passed.
また見なさい 私の他の答え
ええ、あなたがすることができる少数のAPIを使用して、ここに私がそれをするのが好きである方法は、私がHibernateコアを使用していたそして特定のアノテーションでアノテートされるクラスを見つけなければならなかったという問題に直面しました。
これらをカスタムアノテーションにして、どのクラスをピックアップしたいかを指定します。
import Java.lang.annotation.ElementType;
import Java.lang.annotation.Retention;
import Java.lang.annotation.RetentionPolicy;
import Java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface EntityToBeScanned {
}
それからそれをあなたのクラスに印を付けます
@EntityToBeScanned
public MyClass{
}
次のメソッドを持つこのユーティリティクラスを作成してください
public class ClassScanner {
public static Set<Class<?>> allFoundClassesAnnotatedWithEntityToBeScanned(){
Reflections reflections = new Reflections(".*");
Set<Class<?>> annotated = reflections.getTypesAnnotatedWith(EntityToBeScanned.class);
return annotated;
}
}
allFoundClassesAnnotatedWithEntityToBeScanned（） メソッドを呼び出して、クラスの Set を取得します。
以下に示すライブラリが必要になります。
<!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>21.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.javassist/javassist -->
<dependency>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.22.0-CR1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.reflections/reflections -->
<dependency>
<groupId>org.reflections</groupId>
<artifactId>reflections</artifactId>
<version>0.9.10</version>
</dependency>
Reflectionsライブラリを使用しようとしましたが、使用する際に問題がいくつかありました。パッケージのクラスを取得するためだけに含めるべきjarが多すぎました。
私はこの重複した質問で見つけた解決策を投稿するつもりです： パッケージ内のすべてのクラス名を取得する方法？
答えはsp00m によって書かれました。私はそれを機能させるためにいくつかの修正を加えました：
import Java.io.File;
import Java.io.IOException;
import Java.net.URL;
import Java.util.Enumeration;
import Java.util.LinkedList;
import Java.util.List;
public final class ClassFinder {
private final static char DOT = '.';
private final static char SLASH = '/';
private final static String CLASS_SUFFIX = ".class";
private final static String BAD_PACKAGE_ERROR = "Unable to get resources from path '%s'. Are you sure the given '%s' package exists?";
public final static List<Class<?>> find(final String scannedPackage) {
final ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
final String scannedPath = scannedPackage.replace(DOT, SLASH);
final Enumeration<URL> resources;
try {
resources = classLoader.getResources(scannedPath);
} catch (IOException e) {
throw new IllegalArgumentException(String.format(BAD_PACKAGE_ERROR, scannedPath, scannedPackage), e);
}
final List<Class<?>> classes = new LinkedList<Class<?>>();
while (resources.hasMoreElements()) {
final File file = new File(resources.nextElement().getFile());
classes.addAll(find(file, scannedPackage));
}
return classes;
}
private final static List<Class<?>> find(final File file, final String scannedPackage) {
final List<Class<?>> classes = new LinkedList<Class<?>>();
if (file.isDirectory()) {
for (File nestedFile : file.listFiles()) {
classes.addAll(find(nestedFile, scannedPackage));
}
//File names with the $1, $2 holds the anonymous inner classes, we are not interested on them.
} else if (file.getName().endsWith(CLASS_SUFFIX) && !file.getName().contains("$")) {
final int beginIndex = 0;
final int endIndex = file.getName().length() - CLASS_SUFFIX.length();
final String className = file.getName().substring(beginIndex, endIndex);
try {
final String resource = scannedPackage + DOT + className;
classes.add(Class.forName(resource));
} catch (ClassNotFoundException ignore) {
}
}
return classes;
}
}
これを使用するには、この例で説明したsp00nとしてfindメソッドを呼び出すだけです。必要に応じて、クラスのインスタンスの作成を追加しました。
List<Class<?>> classes = ClassFinder.find("com.package");
ExcelReporting excelReporting;
for (Class<?> aClass : classes) {
Constructor constructor = aClass.getConstructor();
//Create an object of the class type
constructor.newInstance();
//...
}
クラスパス内のすべてのクラスローダーエントリを調べる必要があります。
String pkg = "org/Apache/commons/lang";
ClassLoader cl = ClassLoader.getSystemClassLoader();
URL[] urls = ((URLClassLoader) cl).getURLs();
for (URL url : urls) {
System.out.println(url.getFile());
File jar = new File(url.getFile());
// ....
}
エントリがディレクトリの場合は、右のサブディレクトリを調べます。
if (jar.isDirectory()) {
File subdir = new File(jar, pkg);
if (!subdir.exists())
continue;
File[] files = subdir.listFiles();
for (File file : files) {
if (!file.isFile())
continue;
if (file.getName().endsWith(".class"))
System.out.println("Found class: "
+ file.getName().substring(0,
file.getName().length() - 6));
}
}
エントリがファイルで、jarファイルの場合は、Zipエントリを調べてください。
else {
// try to open as Zip
try {
ZipFile Zip = new ZipFile(jar);
for (Enumeration<? extends ZipEntry> entries = Zip
.entries(); entries.hasMoreElements();) {
ZipEntry entry = entries.nextElement();
String name = entry.getName();
if (!name.startsWith(pkg))
continue;
name = name.substring(pkg.length() + 1);
if (name.indexOf('/') < 0 && name.endsWith(".class"))
System.out.println("Found class: "
+ name.substring(0, name.length() - 6));
}
} catch (ZipException e) {
System.out.println("Not a Zip: " + e.getMessage());
} catch (IOException e) {
System.err.println(e.getMessage());
}
}
すべてのクラス名withingパッケージを入手したら、リフレクションを使用してそれらをロードし、それらがクラスなのかインターフェースなのかなどを分析することができます。
ほとんどすべての回答はReflectionsを使用するか、ファイルシステムからクラスファイルを読み込みます。ファイルシステムからクラスを読み込もうとすると、アプリケーションをJARなどにパッケージ化したときにエラーが発生する可能性があります。また、その目的のために別のライブラリを使用したくない場合もあります。
これは純粋なJavaでファイルシステムに依存しない別のアプローチです。
import javax.tools.JavaFileObject;
import javax.tools.StandardJavaFileManager;
import javax.tools.StandardLocation;
import javax.tools.ToolProvider;
import Java.io.File;
import Java.util.ArrayList;
import Java.util.Collection;
import Java.util.Collections;
import Java.util.regex.Pattern;
import Java.util.stream.Collectors;
import Java.util.stream.StreamSupport;
public class PackageUtil {
public static Collection<Class> getClasses(final String pack) throws Exception {
final StandardJavaFileManager fileManager = ToolProvider.getSystemJavaCompiler().getStandardFileManager(null, null, null);
return StreamSupport.stream(fileManager.list(StandardLocation.CLASS_PATH, pack, Collections.singleton(JavaFileObject.Kind.CLASS), false).spliterator(), false)
.map(javaFileObject -> {
try {
final String[] split = javaFileObject.getName()
.replace(".class", "")
.replace(")", "")
.split(Pattern.quote(File.separator));
final String fullClassName = pack + "." + split[split.length - 1];
return Class.forName(fullClassName);
} catch (ClassNotFoundException e) {
throw new RuntimeException(e);
}
})
.collect(Collectors.toCollection(ArrayList::new));
}
}
Java 8は必須ではありません 。ストリームの代わりにforループを使うことができます。そして、あなたはこれのようにそれをテストすることができます
public static void main(String[] args) throws Exception {
final String pack = "Java.nio.file"; // Or any other package
PackageUtil.getClasses(pack).stream().forEach(System.out::println);
}
私はちょうどutilクラスを書いた、それはテストメソッドが含まれています、あなたはチェックをすることができます〜
IteratePackageUtil.Java：
package eric.j2se.reflect;
import Java.util.Set;
import org.reflections.Reflections;
import org.reflections.scanners.ResourcesScanner;
import org.reflections.scanners.SubTypesScanner;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import org.reflections.util.FilterBuilder;
/**
* an util to iterate class in a package,
*
* @author eric
* @date Dec 10, 2013 12:36:46 AM
*/
public class IteratePackageUtil {
/**
* <p>
* Get set of all class in a specified package recursively. this only support lib
* </p>
* <p>
* class of sub package will be included, inner class will be included,
* </p>
* <p>
* could load class that use the same classloader of current class, can't load system packages,
* </p>
*
* @param pkg
* path of a package
* @return
*/
public static Set<Class<? extends Object>> getClazzSet(String pkg) {
// prepare reflection, include direct subclass of Object.class
Reflections reflections = new Reflections(new ConfigurationBuilder().setScanners(new SubTypesScanner(false), new ResourcesScanner())
.setUrls(ClasspathHelper.forClassLoader(ClasspathHelper.classLoaders(new ClassLoader[0])))
.filterInputsBy(new FilterBuilder().includePackage(pkg)));
return reflections.getSubTypesOf(Object.class);
}
public static void test() {
String pkg = "org.Apache.Tomcat.util";
Set<Class<? extends Object>> clazzSet = getClazzSet(pkg);
for (Class<? extends Object> clazz : clazzSet) {
System.out.println(clazz.getName());
}
}
public static void main(String[] args) {
test();
}
}
AleksanderBlomskøld氏の解決策 Mavenを使用している場合、パラメータ化されたテスト@RunWith(Parameterized.class)に対して私はうまくいかなかった。テストは正しく名前が付けられていて、見つかったが実行されていないものもあります。
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running some.properly.named.test.run.with.maven.SomeTest
Tests run: 0, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.123 sec
同様の問題が報告されています ここ 。
私の場合は@Parametersはパッケージ内の各クラスのインスタンスを作成することです。 IDEでローカルに実行した場合、テストはうまくいきました。しかし、Mavenを実行しているとき、AleksanderBlomskøldのソリューションで見つかったクラスはありませんでした。
AleksanderBlomskøldの答えに対するDavidPärssonのコメントに触発された以下の抜粋で動作するようにしました。
Reflections reflections = new Reflections(new ConfigurationBuilder()
.setScanners(new SubTypesScanner(false /* don't exclude Object.class */), new ResourcesScanner())
.addUrls(ClasspathHelper.forJavaClassPath())
.filterInputsBy(new FilterBuilder()
.include(FilterBuilder.prefix(basePackage))));
Set<Class<?>> subTypesOf = reflections.getSubTypesOf(Object.class);
言及する価値がある
あるパッケージの下にあるすべてのクラスのリストを作りたい場合は、次のようにReflectionを使用できます。
List<Class> myTypes = new ArrayList<>();
Reflections reflections = new Reflections("com.package");
for (String s : reflections.getStore().get(SubTypesScanner.class).values()) {
myTypes.add(Class.forName(s));
}
これにより、後で必要に応じてそれらを使用できるクラスのリストが作成されます。
動的クラスローダを使用していない場合は、クラスパスを検索でき、各エントリに対してディレクトリまたはJARファイルを検索できます。
それは可能ですが、Reflectionsのような追加のライブラリがなければ難しいです...
クラス名を取得するための完全な手段を持っていないので、難しいです。
そして、私はClassFinderクラスのコードを取ります。
package play.util;
import Java.io.File;
import Java.io.IOException;
import Java.util.ArrayList;
import Java.util.Enumeration;
import Java.util.List;
import Java.util.jar.JarEntry;
import Java.util.jar.JarFile;
/**
* Created by LINKOR on 26.05.2017 in 15:12.
* Date: 2017.05.26
*/
public class FileClassFinder {
private JarFile file;
private boolean trouble;
public FileClassFinder(String filePath) {
try {
file = new JarFile(filePath);
} catch (IOException e) {
trouble = true;
}
}
public List<String> findClasses(String pkg) {
ArrayList<String> classes = new ArrayList<>();
Enumeration<JarEntry> entries = file.entries();
while (entries.hasMoreElements()) {
JarEntry cls = entries.nextElement();
if (!cls.isDirectory()) {
String fileName = cls.getName();
String className = fileName.replaceAll("/", ".").replaceAll(File.pathSeparator, ".").substring(0, fileName.lastIndexOf('.'));
if (className.startsWith(pkg)) classes.add(className.substring(pkg.length() + 1));
}
}
return classes;
}
}
普通のJava： FindAllClassesUsingPlainJavaReflectionTest.Java
@Slf4j
class FindAllClassesUsingPlainJavaReflectionTest {
private static final Function<Throwable, RuntimeException> asRuntimeException = throwable -> {
log.error(throwable.getLocalizedMessage());
return new RuntimeException(throwable);
};
private static final Function<String, Collection<Class<?>>> findAllPackageClasses = basePackageName -> {
Locale locale = Locale.getDefault();
Charset charset = StandardCharsets.UTF_8;
val fileManager = ToolProvider.getSystemJavaCompiler()
.getStandardFileManager(/* diagnosticListener */ null, locale, charset);
StandardLocation location = StandardLocation.CLASS_PATH;
JavaFileObject.Kind kind = JavaFileObject.Kind.CLASS;
Set<JavaFileObject.Kind> kinds = Collections.singleton(kind);
val javaFileObjects = Try.of(() -> fileManager.list(location, basePackageName, kinds, /* recurse */ true))
.getOrElseThrow(asRuntimeException);
String pathToPackageAndClass = basePackageName.replace(".", File.separator);
Function<String, String> mapToClassName = s -> {
String prefix = Arrays.stream(s.split(pathToPackageAndClass))
.findFirst()
.orElse("");
return s.replaceFirst(prefix, "")
.replaceAll(File.separator, ".");
};
return StreamSupport.stream(javaFileObjects.spliterator(), /* parallel */ true)
.filter(javaFileObject -> javaFileObject.getKind().equals(kind))
.map(FileObject::getName)
.map(fileObjectName -> fileObjectName.replace(".class", ""))
.map(mapToClassName)
.map(className -> Try.of(() -> Class.forName(className))
.getOrElseThrow(asRuntimeException))
.collect(Collectors.toList());
};
@Test
@DisplayName("should get classes recursively in given package")
void test() {
Collection<Class<?>> classes = findAllPackageClasses.apply(getClass().getPackage().getName());
assertThat(classes).hasSizeGreaterThan(4);
classes.stream().map(String::valueOf).forEach(log::info);
}
}
シモンズ：エラーなどを扱うための定型句を簡単にするために、ここではvavrとlombokのライブラリを使っています。
他の実装は にあります。 私のGitHub daggerok/Javaリフレクション - 検索 - 注釈付きクラスまたはメソッドのレポジトリ - /
@ Staale's answer に基づいて、サードパーティのライブラリに頼らないようにするために、最初のパッケージの物理的な場所を調べてファイルシステムアプローチを実装します。
import Java.io.File;
import Java.io.FileFilter;
import Java.util.ArrayList;
...
Class<?>[] foundClasses = new Class<?>[0];
final ArrayList<Class<?>> foundClassesDyn = new ArrayList<Class<?>>();
new Java.io.File(
klass.getResource(
"/" + curPackage.replace( "." , "/")
).getFile()
).listFiles(
new Java.io.FileFilter() {
public boolean accept(Java.io.File file) {
final String classExtension = ".class";
if ( file.isFile()
&& file.getName().endsWith(classExtension)
// avoid inner classes
&& ! file.getName().contains("$") )
{
try {
String className = file.getName();
className = className.substring(0, className.length() - classExtension.length());
foundClassesDyn.add( Class.forName( curPackage + "." + className ) );
} catch (ClassNotFoundException e) {
e.printStackTrace(System.out);
}
}
return false;
}
}
);
foundClasses = foundClassesDyn.toArray(foundClasses);
単に関連するクラスのグループをロードしようとしているだけなら、Springが役に立ちます。
Springは、与えられたインターフェースを実装するすべてのクラスのリストまたはマップを1行のコードでインスタンス化できます。リストまたはマップは、そのインタフェースを実装するすべてのクラスのインスタンスを含みます。
そうは言っても、ファイルシステムからクラスのリストをロードする代わりに、パッケージに関係なく、ロードしたいすべてのクラスに同じインターフェースを実装し、Springを使用してそれらすべてのインスタンスを提供するだけです。こうすることで、どのパッケージに入っているかに関わらず、あなたが望むすべてのクラスをロード（そしてインスタンス化）することができます。
一方、パッケージ内にそれらすべてを含めることが望ましい場合は、そのパッケージ内のすべてのクラスに特定のインタフェースを実装させるだけです。