jacodb
1.4.5 Release
JacoDB - это чистая библиотека Java, которая позволяет получить информацию о Java Bytecode за пределами процесса JVM и хранить ее в базе данных. В то время как Java Reflection позволяет проверять код во время выполнения, JacoDB делает то же самое для байт -кода, хранящегося в файловой системе.
JacoDB использует ASM Framework для чтения и анализа Java Bytecode.
Информация о классах, иерархиях, аннотациях, методах, полях и их использовании хранится в базе данных SQLite-либо в памяти, либо настойчивой. Постоянные данные могут быть повторно использованы между перезапуску. Доступ к постоянному хранилищу из нескольких процессов одновременно не поддерживается.
Градл:
implementation(group = " org.jacodb " , name = " jacodb-api " , version = " 1.2.0 " )
implementation(group = " org.jacodb " , name = " jacodb-core " , version = " 1.2.0 " )
implementation(group = " org.jacodb " , name = " jacodb-analysis " , version = " 1.2.0 " )или
Maven:
< dependencies >
< dependency >
< groupId >org.jacodb</ groupId >
< artifactId >jacodb-core</ artifactId >
< verison >1.2.0</ verison >
</ dependency >
< dependency >
< groupId >org.jacodb</ groupId >
< artifactId >jacodb-api</ artifactId >
< verison >1.2.0</ verison >
</ dependency >
< dependency >
< groupId >org.jacodb</ groupId >
< artifactId >jacodb-analysis</ artifactId >
< verison >1.2.0</ verison >
</ dependency >
</ dependencies >API имеет два уровня: тот, который представляет в файловой системе ( байт -код и классы ) и тот, который появляется во время выполнения ( типы ).
class : класс с методами, полями и т. Д. Оба уровня связаны с JcClasspath . Вы не можете изменить классы , полученные из чистого байт -кода. Типы могут быть построены вручную путем замены дженериков.
public static void getStringFields () throws Exception {
JcDatabase database = JacoDB . async ( new JcSettings (). useProcessJavaRuntime ()). get ();
JcClassOrInterface clazz = database . asyncClasspath ( emptyList ()). get (). findClassOrNull ( "java.lang.String" );
System . out . println ( clazz . getDeclaredFields ());
}Котлин
val database = jacodb {
useProcessJavaRuntime()
}
val clazz = database.classpath().findClassOrNull( " java.lang.String " )Более сложные примеры:
Ява
class Example {
public static MethodNode findNormalDistribution () throws Exception {
File commonsMath32 = new File ( "commons-math3-3.2.jar" );
File commonsMath36 = new File ( "commons-math3-3.6.1.jar" );
File buildDir = new File ( "my-project/build/classes/java/main" );
JcDatabase database = JacoDB . async (
new JcSettings ()
. useProcessJavaRuntime ()
. persistent ( "/tmp/compilation-db/" + System . currentTimeMillis ()) // persist data
). get ();
// Let's load these three bytecode locations
database . asyncLoad ( Arrays . asList ( commonsMath32 , commonsMath36 , buildDir ));
// This method just refreshes the libraries inside the database. If there are any changes in libs then
// the database updates data with the new results.
database . asyncLoad ( Collections . singletonList ( buildDir ));
// Let's assume that we want to get bytecode info only for `commons-math3` version 3.2.
JcClassOrInterface jcClass = database . asyncClasspath ( Arrays . asList ( commonsMath32 , buildDir ))
. get (). findClassOrNull ( "org.apache.commons.math3.distribution.NormalDistribution" );
System . out . println ( jcClass . getDeclaredMethods (). size ());
System . out . println ( jcClass . getAnnotations (). size ());
System . out . println ( JcClasses . getConstructors ( jcClass ). size ());
// At this point the database read the method bytecode and return the result.
return jcClass . getDeclaredMethods (). get ( 0 ). asmNode ();
}
}Котлин
suspend fun findNormalDistribution (): MethodNode {
val commonsMath32 = File ( " commons-math3-3.2.jar " )
val commonsMath36 = File ( " commons-math3-3.6.1.jar " )
val buildDir = File ( " my-project/build/classes/java/main " )
val database = jacodb {
useProcessJavaRuntime()
persistent( " /tmp/compilation-db/ ${ System .currentTimeMillis()} " ) // persist data
}
// Let's load these three bytecode locations
database.load( listOf (commonsMath32, commonsMath36, buildDir))
// This method just refreshes the libraries inside the database. If there are any changes in libs then
// the database updates data with the new results.
database.load( listOf (buildDir))
// Let's assume that we want to get bytecode info only for `commons-math3` version 3.2.
val jcClass = database.classpath( listOf (commonsMath32, buildDir))
.findClass( " org.apache.commons.math3.distribution.NormalDistribution " )
println (jcClass.declaredMethods.size)
println (jcClass.constructors.size)
println (jcClass.annotations.size)
// At this point the database read the method bytecode and return the result.
return jcClass.methods[ 0 ].asmNode()
} Класс может быть в неполной среде (то есть супер класс, интерфейс, тип возврата или параметр метода, не найден в классе), тогда API будет выбросить NoClassInClasspathException во время выполнения. Чтобы исправить эту функцию UnknownClasses в Classpath во время создания.
База данных может наблюдать за изменениями файловой системы в фоне и явно обновить Jar-Files:
Ява
public static void watchFileSystem () throws Exception {
JcDatabase database = JacoDB . async ( new JcSettings ()
. watchFileSystem ()
. useProcessJavaRuntime ()
. loadByteCode ( Arrays . asList ( lib1 , buildDir ))
. persistent ( "" , false )). get ();
}
// A user rebuilds the buildDir folder.
// The database re-reads the rebuilt directory in the background.Котлин
val database = jacodb {
watchFileSystem()
useProcessJavaRuntime()
loadByteCode( listOf (lib1, buildDir))
}
// A user rebuilds the buildDir folder.
// The database re-reads the rebuilt directory in the background.тип может быть представлен как один из
Он представляет поведение во время выполнения в соответствии с заменой параметров в данном общем типе:
Ява
public static class A < T > {
T x = null ;
}
public static class B extends A < String > {
}
public static void typesSubstitution () {
JcClassType b = ( JcClassType ) classpath . findTypeOrNull ( "org.jacodb.examples.JavaReadMeExamples.B" );
JcType xType = b . getFields ()
. stream ()
. filter ( it -> "x" . equals ( it . getName ()))
. findFirst (). get (). getFieldType ();
JcClassType stringType = ( JcClassType ) classpath . findTypeOrNull ( "java.lang.String" );
System . out . println ( xType . equals ( stringType )); // will print `true`
}Котлин
open class A < T >( val x : T )
class B ( x : String ): A<String>(x)
suspend fun typesSubstitution () {
val db = jacodb {
loadByteCode( listOf ( File ( " all-classpath " )))
}
val classpath = db.classpath( listOf ( File ( " all-classpath " )))
val b = classpath.findClass< B >().toType()
println (b.fields.first { it.name == " x " }.fieldType == classpath.findClass< String >().toType()) // will print `true`
} Особенности могут быть использованы для целой JcDatabase или конкретного JcClasspath
Функция базы данных для поиска использования полей и методов.
val database = jacodb {
install( Usages )
}увидеть больше
Издеваться неизвестными классами. Это благоясть, чтобы справиться с неполными путями в классе
val database = jacodb {}
val classpath = database.classpath( listOf ( UnknownClasses ))
val clazz = classpath.findClass( " UnknownClasses " ) // will return `JcClassOrInterface` instanceувидеть больше
Немного быстрее иерархии, но потребляйте больше памяти оперативной памяти:
val database = jacodb {
install( InMemoryHierarchy )
}увидеть больше
Экземпляры JcClassOrInterface , JcMethod и JcClasspath являются потоковыми и неизменными.
JcClasspath представляет собой независимый снимок классов, который не может быть изменен, поскольку он создан. Удаление или изменение библиотечных файлов не влияет на структуру экземпляра JcClasspath . Метод JcClasspath#close выпускает все снимки и очищает сохраняемые данные, если некоторые библиотеки устарели.
Ява
public static void refresh () throws Exception {
JcDatabase database = JacoDB . async (
new JcSettings ()
. watchFileSystem ()
. useProcessJavaRuntime ()
. loadByteCode ( Arrays . asList ( lib1 , buildDir ))
. persistent ( "..." )
). get ();
JcClasspath cp = database . asyncClasspath ( Collections . singletonList ( buildDir )). get ();
database . asyncRefresh (). get (); // does not affect cp classes
JcClasspath cp1 = database . asyncClasspath ( Collections . singletonList ( buildDir )). get (); // will use new version of compiled results in buildDir
}Котлин
val database = jacodb {
watchFileSystem()
useProcessJavaRuntime()
loadByteCode( listOf (lib1, buildDir))
persistent( " " )
}
val cp = database.classpath( listOf (buildDir))
database.refresh() // does not affect cp classes
val cp1 = database.classpath( listOf (buildDir)) // will use new version of compiled results in buildDir Если есть запрос на экземпляр JcClasspath , содержащий библиотеки, которые еще не были индексированы, процесс индексации запускается, и возвращается новый экземпляр набора JcClasspath .
Ява
public static void autoProcessing () throws Exception {
JcDatabase database = JacoDB . async (
new JcSettings ()
. loadByteCode ( Arrays . asList ( lib1 ))
. persistent ( "..." )
). get ();
JcClasspath cp = database . asyncClasspath ( Collections . singletonList ( buildDir )). get (); // database will automatically process buildDir
}Котлин
val database = jacodb {
loadByteCode( listOf (lib1))
persistent( " " )
}
val cp = database.classpath( listOf (buildDir)) // database will automatically process buildDir JacoDB -это безопасность. Если кто-то запрашивает экземпляр JcClasspath при загрузке JAR-Files из другой потока, JcClasspath может представлять собой только последовательное состояние загружаемых файлов для JAR-файлов. Это полностью загруженный баночный файл, который появляется в JcClasspath . Обратите внимание: нет никакой гарантии, что все Jar-Files, отправленные для загрузки, будут фактически загружены.
Ява
class Example {
public static void main ( String [] args ) {
val db = JacoDB . async ( new JcSettings ()). get ();
new Thread (() -> db . asyncLoad ( Arrays . asList ( lib1 , lib2 )). get ()). start ();
new Thread (() -> {
// maybe created when lib2 or both are not loaded into database
// but buildDir will be loaded anyway
var cp = db . asyncClasspath ( buildDir ). get ();
}). start ();
}
}Котлин
val db = jacodb {
persistent( " " )
}
thread(start = true ) {
runBlocking {
db.load( listOf (lib1, lib2))
}
}
thread(start = true ) {
runBlocking {
// maybe created when lib2 or both are not loaded into database
// but buildDir will be loaded anyway
val cp = db.classpath( listOf (buildDir))
}
}Нагрузка на байт -код состоит из двух шагов:
JcFeature и т. Д.) Экземпляры JacoDB или JcClasspath возвращаются сразу после выполнения первого шага. Вы получаете окончательное представление классов во время второго шага. Вполне возможно, что файлы .class претерпевают изменения в какой -то момент между первым шагом и вторым, а представление классов затронуто соответствующим образом.
Вот результаты критериев и миграция сажи.
