Построение моделей кода Java из исходного кода и файлов JAR

Недавно я провел некоторое время, работая над  эффективными java , которые находятся на пути к достижению 300 звезд на GitHub (не стесняйтесь помогать в достижении цели: D).

Effectivejava — это инструмент для выполнения запросов к вашему Java-коду. Он основан на другом проекте, в который я участвую,  javaparser . Javaparser принимает в качестве входного исходного кода Java и создает абстрактное синтаксическое дерево (AST). Мы можем выполнить простой анализ непосредственно на AST. Например, мы можем выяснить, какие методы принимают более 5 параметров (вы можете реорганизовать их…). Однако более сложный анализ требует  разрешения символов .

В этом посте я опишу, как я работаю над реализацией разрешения символов с учетом как исходного кода, так и файлов JAR. В этом первом посте мы создадим однородное представление как исходного кода, так и файлов JAR, в следующем посте мы решим эти символы, исследуя эти модели.

Код доступен на GitHub, на ветке  символьной ссылки  эффективной Java .

Разрешающие символы

По какой причине нам нужно разрешить символы?

Учитывая этот код:

foo.method(a,b,c);

нам нужно выяснить, что такое  foo ,  method ,  a ,  b ,  c  . Это ссылки на локальные переменные? К аргументам текущего метода? Чтобы поля объявлены в классе? Полям, унаследованным от класса суперкласса? Какой у них тип? Чтобы ответить на этот вопрос, мы должны уметь разрешать символы.

Для решения символов мы можем перемещаться по AST и применять правила определения объема. Например, мы можем посмотреть, соответствует ли определенный символ локальной переменной. Если нет, мы можем посмотреть среди параметров этого метода. Если мы все еще не можем найти соответствие, нам нужно искать среди полей, объявленных классом, и если нам все еще не повезло, нам, возможно, придется везти среди полей, унаследованных этим классом.

Теперь правила определения объема намного сложнее, чем набор маленьких шагов, которые я только что описал. Особенно сложно разрешить методы из-за перегрузки. Однако одним из ключевых моментов является то, что для решения символов нам нужно искать среди импортированных классов, расширенных классов и внешних классов в целом, которые могут быть частью проекта или импортироваться как зависимости.

Таким образом, чтобы решить символ, мы должны искать соответствующие объявления:

1. на AST классов проекта мы изучаем
2. среди классов, содержащихся в файлах JAR, используемых в качестве зависимостей

Javaparser предоставляет нам AST, которые нам нужны для первого пункта, для второго мы собираемся построить модель классов в файлах JAR с использованием  Javassist .

Создайте модель классов, содержащихся в JAR-файлах

Наш решатель символов должен просмотреть список записей (наши   записи пути к классам ) по порядку и посмотреть, можно ли там найти определенный класс. Для этого нам нужно открыть файлы JAR и просмотреть их содержимое. По соображениям производительности мы могли бы захотеть создать кеш элементов, содержащихся в данном JAR.

(ns app.jarloading
  (:use [app.javaparser])
  (:use [app.operations])
  (:use [app.utils])
  (:import [app.operations Operation]))

(import java.net.URLDecoder)
(import java.util.jar.JarEntry)
(import java.util.jar.JarFile)
(import javassist.ClassPool)
(import javassist.CtClass)

; An element on the classpath (a single class, interface, enum or resource file)
(defrecord ClasspathElement [resource path contentAsStreamThunk])

(defn- jarEntryToClasspathElement [jarFile jarEntry]
  (let [name (.getName jarEntry)
        content (fn [] (.getInputStream jarFile jarEntry))]
    (ClasspathElement. jarFile name content)))

(defn getElementsEntriesInJar
  "Return a set of ClasspathElements"
  [pathToJarFile]
  (let [url (URLDecoder/decode pathToJarFile "UTF-8")
        jarfile (new JarFile url)
        entries (enumeration-seq (.entries jarfile))
        entries' (filter (fn [e] (not (.isDirectory e))) entries )]
    (map (partial jarEntryToClasspathElement jarfile) entries')))

(defn getClassesEntriesInJar
  "Return a set of ClasspathElements"
  [pathToJarFile]
  (filter (fn [e] (.endsWith (.path e) ".class")) (getElementsEntriesInJar pathToJarFile)))

(defn pathToTypeName [path]
  (if (.endsWith path ".class")
    (let [path' (.substring path 0 (- (.length path) 6))
          path'' (clojure.string/replace path' #"/" ".")
          path''' (clojure.string/replace path'' "$" ".")]
      path''')
    (throw (IllegalArgumentException. "Path not ending with .class"))))

(defn findEntry
  "return the ClasspathElement corresponding to the given name, or nil"
  [typeName classEntries]
  (first (filter (fn [e] (= typeName (pathToTypeName (.path e)))) classEntries)))

(defn findType
  "return the CtClass corresponding to the given name, or nil"
  [typeName classEntries]
  (let [entry (findEntry typeName classEntries)
        classPool (ClassPool/getDefault)]
    (if entry
      (.makeClass classPool ((.contentAsStreamThunk entry)))
      nil)))

package me.tomassetti;

import com.github.someproject.ClassInJar;

public class MyClass extends ClassInJar {
    private int myDeclaredField;

    public int foo(){
        return myDeclaredField + myInheritedField;
    }
}

(defprotocol FieldDecl
  (fieldName [this]))

(extend-protocol FieldDecl
  com.github.javaparser.ast.body.VariableDeclarator
  (fieldName [this]
    (.getName (.getId this))))

(extend-protocol FieldDecl
  javassist.CtField
  (fieldName [this]
    (.getName this)))