предисловие
Недавно я пишу плагин maven, который включает разбор кода Java. Нужно разобрать исходный код Java, а затем обработать разные части класса. До сих пор трудно найти почерк.Посмотрев вокруг, я нашел два хороших инструмента для использования, один из нихjavaparser, другойqdox. Лично я считаю, что javaparser мощнее, а обновление и обслуживание также более частые, но начать работу относительно сложно.Из его документа использования видно, что он покупает книгу самостоятельно, а qdox относительно небольшой , его можно быстро начать, а его функции отвечают большинству потребностей.В конце концов, я выбрал qdox.
Что такое QDox
Официальное введение:
QDox - full extractor of Java class/interface/method definitions (including annotations, parameters, param names)
Это, вероятно, означает полный экстрактор классов Java, интерфейсов и определений методов, включая аннотации, параметры и имена параметров. На самом деле основная функция заключается в том, что я ввожу исходный код класса Java, и он может разобрать класс Java в объект. Через этот объект мы можем легко получить различные компоненты анализируемого класса. Например, я могу получить какие методы есть у этого класса, какие параметры у этого метода, каковы возвращаемые значения и каковы их типы? И какие аннотации и теги есть у этого метода. Вы также можете получить, какие поля есть в классе. . . Короче говоря, этот класс разбирается как корова, так что вызывающий может легко получить интересующую его информацию.
Зачем использовать QDox
В дополнение к упомянутому выше QDox, он относительно быстр в использовании, а его скорость работы и занимаемая площадь превосходны.
Кроме того, я должен сказать, что этот проект можно назвать древним.После прочтения записей о представлении на github, самая ранняя запись о представлении была в 2002 году.Поскольку этот проект ранее использовал svn, конкретное время может быть раньше. Весьма похвально, что проект с открытым исходным кодом поддерживается уже почти 20 лет. Но пока у этого проекта всего 151 звезда на github.Если этот проект будет вам полезен, надеюсь, вы сможете поставить звезду автору. На github слишком много похожих проектов, которые то появляются, то исчезают в неизвестности.
Слишком далеко, хотя людей, обеспокоенных проектом, меньше, но проектов, использующих его, все же больше. Официальный подключаемый модуль javadoc Maven maven-javadoc-plugin использует его для анализа тегов документа в коде. Так что, возможно, вы не используете его напрямую, но он уже лежит в вашем локальном репозитории maven. Есть официальное одобрение, и пользоваться им более уверенно.
Когда использовать QDox
Это больше, как правило, пока нам нужно разобрать содержимое исходного кода, мы можем его использовать, например, я хочу получить все методы в указанном файле класса. готов к использованию. Некоторые люди могут быть озадачены, почему бы не получить это содержимое через отражение, не так ли удобнее? Прежде всего, предпосылка отражения заключается в том, что вы можете получить экземпляр этого класса или у вас есть этот класс в вашем проекте. Даже если эти условия соблюдены, не может быть выполнено очень распространенное отражение требований, например получение аннотаций и тегов методов, которые стираются во время компиляции. В этом случае необходимо использовать метод анализа исходного кода.
Кроме того, он может не только анализировать, но и генерировать файлы классов Java, поэтому вы можете динамически генерировать некоторые классы Java.
Будь то парсинг или генерация, при написании плагина должен быть такой сценарий, например, я хочу сгенерировать интерфейсный документ к фронтенду через теги javadoc в коде, чтобы у меня не было чтобы написать это один за другим. В качестве другого примера я хочу автоматически генерировать классы моделей и классы обслуживания с помощью информации из таблицы данных. . . Предел использования сцены в основном личное воображение.
Как использовать QDox
Создайте объект построителя проекта Java
// 创建 java 项目 builder 对象
JavaProjectBuilder javaProjectBuilder = new JavaProjectBuilder();
Добавить исходные файлы Java
// 添加 java 源文件
javaProjectBuilder.addSource(new File("/Users/kiwi/study/code/study-example/study-qdox-example/src/main/java/cn/coder4j/study/example/qdox/Demo.java"));
Демонстрационный пример добавляется по файлу.На самом деле, он поддерживает множество типов, таких как URL, Reader или даже прямое добавление каталога.Фреймворк сам просканирует все java-файлы в каталоге.
Получить проанализированный объект JavaClass
После двух вышеперечисленных шагов подготовительная работа завершена, и проанализированный объект JavaClass может быть получен напрямую.Есть два способа его получения.Первый – напрямую получить проанализированную коллекцию классов.Почему это коллекция? Поскольку выше также сказано, что каталоги могут быть добавлены, а addSource может вызываться несколько раз для добавления нескольких файлов. Другой - использовать getClassByName напрямую, когда вы знаете имя класса.
// 获得解析后的类
Collection<JavaClass> classes = javaProjectBuilder.getClasses();
for (JavaClass javaClass : classes) {
}
Определение интерфейса JavaClass
package com.thoughtworks.qdox.model;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import com.thoughtworks.qdox.library.ClassLibrary;
/**
* Equivalent of {@link java.lang.Class}, providing the most important methods.
* Where the original Class is using an Array, this model is using a List.
*
* @author Robert Scholte
*/
public interface JavaClass extends JavaModel, JavaType, JavaAnnotatedElement, JavaGenericDeclaration
{
/**
* The compilation unit, which includes the imports, the public and anonymous classes
*
* @return the {@link JavaSource} of this element
*/
JavaSource getSource();
/**
* (API description of {@link java.lang.Class#isInterface()})
* <p>
* Determines if the specified <code>Class</code> object represents an interface type.
* </p>
*
* @return <code>true</code> if this object represents an interface, otherwise <code>false</code>
*/
boolean isInterface();
/**
* (API description of {@link java.lang.Class#isEnum()})
* <p>
* Returns <code>true</code> if and only if this class was declared as an enum in the source code.
* </p>
*
* @return <code>true</code> if this object represents an enum, otherwise <code>false</code>
*/
boolean isEnum();
/**
* (API description of {@link java.lang.Class#isAnnotation()})
* <p>Returns true if this <code>Class</code> object represents an annotation type.
* Note that if this method returns true, {@link #isInterface()} would also return true, as all annotation types are also interfaces.
* </p>
*
* @return <code>true</code> if this object represents an annotation, otherwise <code>false</code>
* @since 2.0
*/
boolean isAnnotation();
JavaClass getDeclaringClass();
JavaType getSuperClass();
/**
* Shorthand for getSuperClass().getJavaClass() with null checking.
* @return the super class as {@link JavaClass}
*/
JavaClass getSuperJavaClass();
List<JavaType> getImplements();
/**
* Equivalent of {@link java.lang.Class#getInterfaces()}
* Determines the interfaces implemented by the class or interface represented by this object.
*
* @return a list of interfaces, never <code>null</code>
* @since 2.0
*/
List<JavaClass> getInterfaces();
String getCodeBlock();
JavaSource getParentSource();
/**
* Equivalent of {@link java.lang.Class#getPackage()}
* @return the package
*/
JavaPackage getPackage();
/**
* If this class has a package, the packagename will be returned.
* Otherwise an empty String.
*
* @return the name of the package, otherwise an empty String
*/
String getPackageName();
/**
* @since 1.3
* @return <code>true</code> if this class is an inner class, otherwise <code>false</code>
*/
boolean isInner();
/**
* Equivalent of {@link java.lang.Class#getMethods()}
*
* @return the methods declared or overridden in this class
*/
List<JavaMethod> getMethods();
/**
* Equivalent of {@link java.lang.Class#getConstructors()}
*
* @return the list of constructors
* @since 2.0
*/
List<JavaConstructor> getConstructors();
/**
*
* @param parameterTypes the parameter types of the constructor, can be <code>null</code>
* @return the matching constructor, otherwise <code>null</code>
* @since 2.0
*/
JavaConstructor getConstructor(List<JavaType> parameterTypes);
/**
*
* @param parameterTypes the parameter types of the constructor, can be <code>null</code>
* @param varArg define is the constructor has varArgs
* @return the matching constructor, otherwise <code>null</code>
* @since 2.0
*/
JavaConstructor getConstructor(List<JavaType> parameterTypes, boolean varArg);
/**
* Return declared methods and optionally the inherited methods
*
* @param superclasses {@code true} if inherited methods should be returned as well
* @return all methods
* @since 1.3
*/
List<JavaMethod> getMethods( boolean superclasses );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be <code>null</code>.
* @return the matching method, otherwise <code>null</code>
*/
JavaMethod getMethodBySignature( String name, List<JavaType> parameterTypes );
/**
* This should be the signature for getMethodBySignature.
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param varArgs define if the method has varArgs
* @return the matching method, otherwise {@code null}
*/
JavaMethod getMethod( String name, List<JavaType> parameterTypes, boolean varArgs );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses to define if superclasses should be included as well
* @return the matching method, otherwise {@code null}
*/
JavaMethod getMethodBySignature( String name, List<JavaType> parameterTypes, boolean superclasses );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses {@code true} if inherited methods should be matched as well
* @param varArg define if the method has varArgs
* @return the matching method, otherwise {@code null}
*/
JavaMethod getMethodBySignature( String name, List<JavaType> parameterTypes, boolean superclasses, boolean varArg );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses {@code true} if inherited methods should be matched as well
* @return the matching methods, otherwise {@code null}
*/
List<JavaMethod> getMethodsBySignature( String name, List<JavaType> parameterTypes, boolean superclasses );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses {@code true} if inherited methods should be matched as well
* @param varArg define if the method has varArgs
* @return the matching methods, otherwise {@code null}
*/
List<JavaMethod> getMethodsBySignature( String name, List<JavaType> parameterTypes, boolean superclasses,
boolean varArg );
/**
* Equivalent of {@link java.lang.Class#getFields()}
*
* @return a list of fiels, never {@code null}
*/
List<JavaField> getFields();
/**
* Equivalent of {@link java.lang.Class#getField(String)}, where this method can resolve every field
*
* @param name the name of the field
* @return the field
*/
JavaField getFieldByName( String name );
/**
* Based on {@link java.lang.Class#getEnumConstants()}.
*
*
* @return a List of enum constants if this class is an <code>enum</code>, otherwise {@code null}
*/
List<JavaField> getEnumConstants();
/**
*
* @param name the name of the enum constant
* @return the enumConstant matching the {@code name}, otherwise <code>null</code>
*/
JavaField getEnumConstantByName( String name );
/**
* Equivalent of {@link Class#getDeclaredClasses()}
*
* @return a list of declared classes, never <code>null</code>
* @since 1.3
*/
List<JavaClass> getNestedClasses();
JavaClass getNestedClassByName( String name );
/**
* @param fullyQualifiedName the FQN to match with
* @return {@code true} if this is of type FQN, otherwise {@code false}
* @since 1.3
*/
boolean isA( String fullyQualifiedName );
/**
* @param javaClass the JavaClass to match with
* @return {@code true} if this is of type {@literal javaClass}, otherwise {@code false}
* @since 1.3
*/
boolean isA( JavaClass javaClass );
/**
* Returns the depth of this array, 0 if it's not an array
*
* @return The depth of this array, at least <code>0</code>
* @since 2.0
*/
int getDimensions();
/**
*
* @return <code>true</code> if this JavaClass is an array, otherwise <code>false</code>
* @since 2.0
*/
boolean isArray();
/**
*
* @return <code>true</code> if this JavaClass is a void, otherwise <code>false</code>
* @since 2.0 (was part of Type since 1.6)
*/
boolean isVoid();
/**
* Equivalent of {@link Class#getComponentType()}
* If this type is an array, return its component type
*
* @return the type of array if it's one, otherwise <code>null</code>
*/
JavaClass getComponentType();
/**
* Gets bean properties without looking in superclasses or interfaces.
*
* @return the bean properties
* @since 1.3
*/
List<BeanProperty> getBeanProperties();
/**
*
* @param superclasses to define if superclasses should be included as well
* @return the bean properties
* @since 1.3
*/
List<BeanProperty> getBeanProperties( boolean superclasses );
/**
* Gets bean property without looking in superclasses or interfaces.
*
* @param propertyName the name of the property
* @return the bean property
* @since 1.3
*/
BeanProperty getBeanProperty( String propertyName );
/**
* @param propertyName the name of the property
* @param superclasses to define if superclasses should be included as well
* @return the bean property
* @since 1.3
*/
BeanProperty getBeanProperty( String propertyName, boolean superclasses );
/**
* Equivalent of {@link Class#getClasses()}
* Gets the known derived classes. That is, subclasses or implementing classes.
* @return the derived classes
*/
List<JavaClass> getDerivedClasses();
List<DocletTag> getTagsByName( String name, boolean superclasses );
ClassLibrary getJavaClassLibrary();
/**
* A list if {@link JavaInitializer}, either static or instance initializers.
*
* @return a List of initializers
*/
List<JavaInitializer> getInitializers();
/**
* Equivalent of {@link java.lang.Class#getName()}.
*
* @return the name of the entity (class, interface, array class, primitive type, or void) represented by this Class object, as a String.
*/
String getName();
/**
* Equivalent of {@link java.lang.Class#getSimpleName()}.
*
* @return the simple name of the underlying class as given in the source code.
* @since 2.0
*/
String getSimpleName();
/**
* Equivalent of {@link Class#getModifiers()}
*
* <strong>This does not follow the java-api</strong>
* The Class.getModifiers() returns an <code>int</code>, which should be decoded with the {@link java.lang.reflect.Modifier}.
* This method will return a list of strings representing the modifiers.
* If this member was extracted from a source, it will keep its order.
* Otherwise if will be in the preferred order of the java-api.
*
* @return all modifiers is this member
*/
List<String> getModifiers();
/**
* (API description of {@link java.lang.reflect.Modifier#isPublic(int)})
* <p>
* Return <code>true</code> if the class includes the public modifier, <code>false</code> otherwise.
* <p>
*
* @return <code>true</code> if class has the public modifier, otherwise <code>false</code>
*/
boolean isPublic();
/**
* (API description of {@link java.lang.reflect.Modifier#isProtected(int)})
* <p>
* Return <code>true</code> if the class includes the protected modifier, <code>false</code> otherwise.
* </p>
*
* @return <code>true</code> if class has the protected modifier, otherwise <code>false</code>
*/
boolean isProtected();
/**
* (API description of {@link java.lang.reflect.Modifier#isPrivate(int)})
* <p>
* Return <code>true</code> if the class includes the private modifier, <code>false</code> otherwise.
* </p>
*
* @return <code>true</code> if class has the private modifier, otherwise <code>false</code>
*/
boolean isPrivate();
/**
* (API description of {@link java.lang.reflect.Modifier#isFinal(int)})
* <p>
* Return <code>true</code> if the class includes the final modifier, <code>false</code> otherwise.
* </p>
*
* @return <code>true</code> if class has the final modifier, otherwise <code>false</code>
*/
boolean isFinal();
/**
* (API description of {@link java.lang.reflect.Modifier#isStatic(int)})
* <p>
* Return <code>true</code> if the class includes the static modifier, <code>false</code> otherwise.
* </p>
*
* @return <code>true</code> if class the static modifier, otherwise <code>false</code>
*/
boolean isStatic();
/**
* (API description of {@link java.lang.reflect.Modifier#isAbstract(int)})
*
* Return <code>true</code> if the class includes the abstract modifier, <code>false</code> otherwise.
*
* @return <code>true</code> if class has the abstract modifier, otherwise <code>false</code>
*/
boolean isAbstract();
/**
* Equivalent of {@link java.lang.Class#isPrimitive()}
*
* @return <code>true</code> if this class represents a primitive, otherwise <code>false</code>
*/
boolean isPrimitive();
/**
* (API description of {@link java.lang.Class#toString()})
*
* Converts the object to a string.
* The string representation is the string "class" or "interface", followed by a space, and then by the fully qualified name of the class in the format returned by <code>getName</code>.
* If this <code>Class</code> object represents a primitive type, this method returns the name of the primitive type.
* If this <code>Class</code> object represents void this method returns "void".
*
* @return a string representation of this class object.
*/
@Override
String toString();
}
Можно видеть, что JavaClass по-прежнему предоставляет множество методов, в основном следующих, которые можно условно разделить на две категории:
Одним из них является getXXX, который получается путем получения различных компонентов класса. Наиболее часто используемые из них — это getFields, которые могут получать объекты всех переменных поля класса. Через поле можно получить аннотации, аннотации и типы полей. . . . Все о полевой информации. Другим примером является getTags, getMethods, как следует из названия, предназначен для получения списка комментариев и методов javadoc.
Другой тип — это isXXX, который используется для оценки определенных характеристик класса, таких как isEnum, чтобы определить, является ли класс перечислением, и isInterface, чтобы определить, является ли он интерфейсом.
// 这些方法名，其实也是用 QDox 打印出来的
getBeanProperties
getBeanProperty
getCodeBlock
getComponentType
getConstructor
getConstructors
getDeclaringClass
getDerivedClasses
getDimensions
getEnumConstantByName
getEnumConstants
getFieldByName
getFields
getImplements
getInitializers
getInterfaces
getJavaClassLibrary
getMethod
getMethodBySignature
getMethods
getMethodsBySignature
getModifiers
getName
getNestedClassByName
getNestedClasses
getPackage
getPackageName
getParentSource
getSimpleName
getSource
getSuperClass
getSuperJavaClass
getTagsByName
isA
isAbstract
isAnnotation
isArray
isEnum
isFinal
isInner
isInterface
isPrimitive
isPrivate
isProtected
isPublic
isStatic
isVoid
Полная демонстрация
/*
*
* * *
* * * blog.coder4j.cn
* * * Copyright (C) 2016-2020 All Rights Reserved.
* *
*
*/
package cn.coder4j.study.example.qdox;
import com.thoughtworks.qdox.JavaProjectBuilder;
import com.thoughtworks.qdox.model.JavaClass;
import com.thoughtworks.qdox.model.JavaMethod;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;
/**
* @author buhao
* @version DemoParser.java, v 0.1 2020-03-22 19:03 buhao
*/
public class DemoParser {
public static void main(String[] args) throws IOException {
// 创建 java 项目 builder 对象
JavaProjectBuilder javaProjectBuilder = new JavaProjectBuilder();
// 添加 java 源文件
javaProjectBuilder.addSource(new File("/Users/kiwi/study/code/study-example/study-qdox-example/src/main/java/cn/coder4j/study/example/qdox/Demo.java"));
// 获得解析后的类
Collection<JavaClass> classes = javaProjectBuilder.getClasses();
for (JavaClass javaClass : classes) {
// 打印类相关信息
System.out.println("类名:" + javaClass.getName());
System.out.println("实现了哪些类：" + javaClass.getImplements());
System.out.println("继承哪个类：" + javaClass.getSuperJavaClass());
System.out.println("注释：" + javaClass.getComment());
// 获得方法列表
List<JavaMethod> methods = javaClass.getMethods();
for (JavaMethod method : methods) {
System.out.println("方法名是：" + method.getName());
System.out.println("方法的 Tags 有哪些：" + method.getTags().stream().map(it -> it.getName() + "->"+ it.getValue()).collect(Collectors.joining("\n")));
System.out.println("方法的参数有哪些：" + method.getParameters());
System.out.println("方法的返回值有哪些：" + method.getReturns());
}
}
}
}
Результаты
类名:Demo
实现了哪些类：[java.io.Serializable]
继承哪个类：class java.lang.Object
注释：这是一个 demo 类
方法名是：hello
方法的 Tags 有哪些：param->name 姓名
return->hello {name}
方法的参数有哪些：[String name]
方法的返回值有哪些：java.lang.String
разное
код проекта
Из-за ограниченного места разместить все коды невозможно, если у вас возникнут проблемы, вы можете перейти наgithubСм. исходный код выше.
обо мне
Добро пожаловать, чтобы обратить внимание на мой личный публичный номерРазбитые мысли КИВИ, подписывайтесь и отвечайтеучебные материалы, огромный учебный контент передается напрямую!