От анализа аннотаций во время компиляции до Lombok

Java
От анализа аннотаций во время компиляции до Lombok

Содержимое, связанное с аннотациями Java, было представлено в предыдущих статьях (см.Java Annotations), в этой статье будет представлен Lombok и стоящая за ним технология обработки аннотаций во время компиляции.

Создание сеттеров/геттеров POJO с помощью аннотаций

Сначала определите аннотацию@Data:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface Data {
}

Обработчик аннотаций, реализующий @Data

public class DataProcessor extends AbstractProcessor {

    private Messager messager;
    private JavacTrees trees;
    // 创建AST节点工具
    private TreeMaker treeMaker;
    private Names names;

    /** 获取处理器框架组件 */
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        messager = processingEnv.getMessager();
        trees = JavacTrees.instance(processingEnv);
        Context context = ((JavacProcessingEnvironment) processingEnv).getContext();
        treeMaker = TreeMaker.instance(context);
        names = Names.instance(context);
    }

    /** 注解处理逻辑，在这里修改AST */
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        messager.printMessage(Kind.NOTE, "starting process");
        /** 获取Data注解的元素 */
        Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(Data.class);
        for (Element element : elements) {
            JCTree jcTree = trees.getTree(element);
            // 遍历类定义的元素
            jcTree.accept(new TreeTranslator() {
                @Override
                public void visitClassDef(JCClassDecl jcClassDecl) {
                    super.visitClassDef(jcClassDecl);
                    try {
                        java.util.List<JCVariableDecl> jcVariableDeclList = new ArrayList<>();
                        for (JCTree tree : jcClassDecl.defs) {
                            // 收集所有field
                            if (tree.getKind() == Tree.Kind.VARIABLE) {
                                jcVariableDeclList.add((JCVariableDecl) tree);
                            }
                        }

                        for (JCVariableDecl jcVariableDecl : jcVariableDeclList) {
                            // 生成相应的geeter，setter
                            generateElement(jcClassDecl, jcVariableDecl);
                        }
                    } catch (Throwable e) {
                        try {
                            e.printStackTrace(new PrintStream(new FileOutputStream("error.txt")));
                        } catch (FileNotFoundException e1) {
                            messager.printMessage(Kind.ERROR, "Error create log file");
                        }
                    }
                }
            });
        }
        return true;
    }

    /** 处理的注解类型 */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        LinkedHashSet<String> supportedAnnotations = new LinkedHashSet<>();
        supportedAnnotations.add("*");
        return supportedAnnotations;
    }

    /** 支持的JDK版本 */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }
}

Конкретный метод генерирует логику:

private void generateElement(JCClassDecl jcClassDecl, JCVariableDecl jcVariableDecl) throws Exception {
        // 将生成的getter方法插入类语法树中
        JCMethodDecl getter = generateGetterMethodElement(jcVariableDecl);
        jcClassDecl.defs = jcClassDecl.defs.append(getter);

  			// 将生成的setter方法插入类语法树中
        JCMethodDecl setter = generateSetterMethodElement(jcVariableDecl);
        jcClassDecl.defs = jcClassDecl.defs.append(setter);
    }

		/** 生成getter方法 */
    private JCMethodDecl generateGetterMethodElement(JCVariableDecl jcVariableDecl) {

        String field = jcVariableDecl.getName().toString();
        Name name = names.fromString("get" + field.substring(0, 1).toUpperCase() + field.substring(1, field.length()));

        ListBuffer<JCStatement> statements = new ListBuffer<>();
        statements.append(
            treeMaker.Return(treeMaker.Select(treeMaker.Ident(names.fromString("this")), jcVariableDecl.getName())));

        JCTree.JCBlock body = treeMaker.Block(0, statements.toList());

        return treeMaker.MethodDef(treeMaker.Modifiers(Flags.PUBLIC), name, jcVariableDecl.vartype,
            List.nil(), List.nil(), List.nil(), body, null);
    }

		/** 生成setter方法 */
    private JCMethodDecl generateSetterMethodElement(JCVariableDecl jcVariableDecl) throws Exception {

        String field = jcVariableDecl.getName().toString();
        Name name = names.fromString("set" + field.substring(0, 1).toUpperCase() + field.substring(1, field.length()));

        JCTree.JCExpression returnMethodType = treeMaker
            .Type((Type) (Class.forName("com.sun.tools.javac.code.Type$JCVoidType").newInstance()));

        ListBuffer<JCStatement> statements = new ListBuffer<>();
        statements.append(treeMaker.Exec(treeMaker
            .Assign(treeMaker.Select(treeMaker.Ident(names.fromString("this")), jcVariableDecl.getName()),
                treeMaker.Ident(jcVariableDecl.getName()))));
        JCTree.JCBlock body = treeMaker.Block(0, statements.toList());

        JCTree.JCVariableDecl param = treeMaker
            .VarDef(treeMaker.Modifiers(Flags.PARAMETER, List.nil()), jcVariableDecl.name, jcVariableDecl.vartype,
                jcVariableDecl.nameexpr);
        List<JCTree.JCVariableDecl> parameters = List.of(param);

        return treeMaker.MethodDef(treeMaker.Modifiers(Flags.PUBLIC), name, returnMethodType,
            List.nil(), parameters, List.nil(), body, null);
    }

Украсьте класс аннотацией @Data:

@Data
public class Member {
    private Long id;
    private String name;
    private Date joinDate;
}

Возьми! Подтвердите это:

javac DataProcessor.java && javac -g -processor DataProcessor Member.java && javap -p Member

Упакован в комплект через SPI

Конфигурация сборки maven:

<build>
    <resources>
      <resource>
        <directory>src/main/resources</directory>
        <excludes>
          <!-- 构建时排除Service声明，此时Processor还不可用 -->
          <exclude>META-INF/**/*</exclude>
        </excludes>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>8</source>
          <target>8</target>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.0.2</version>
        <executions>
          <execution>
            <!-- prepare-package阶段再把services拷贝到生成类目标目录 -->
            <id>process-META</id>
            <phase>prepare-package</phase>
            <goals>
              <goal>copy-resources</goal>
            </goals>
            <configuration>
              <outputDirectory>target/classes</outputDirectory>
              <resources>
                <resource>
                  <directory>${basedir}/src/main/resources/</directory>
                  <includes>
                    <include>**/*</include>
                  </includes>
                </resource>
              </resources>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

Создайте новый проект и введите зависимости:

<dependency>
  <groupId>org.yannis</groupId>
  <artifactId>srctool</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Скопируйте Member.java в новый проект:

mvn clean package, наблюдайте за результатами декомпиляции целевого сгенерированного класса Member.class:

Пока реализована простая функция ломбока!

Lombok

Lombok — мой любимый инструмент в личных проектах, он позволяет нам генерировать серию шаблонного кода для классов во время компиляции с помощью простых аннотаций, а исходный код можно сохранить очень кратким. Несколько общих аннотаций кратко представлены ниже, а более подробное их использование можно посмотреть на официальном сайте.

Dependency:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.20</version>
    <scope>provided</scope>
</dependency>

Примечание. Установите подключаемый модуль Lombok в таких средах разработки, как idea, eclipse и т. д., и вы сразу увидите сгенерированный метод.

@Getter/@Setter

Создавайте методы получения/установки для полей экземпляра, значение по умолчанию общедоступно, а уровень управления доступом можно изменить с помощью AccessLevel. Префиксы атрибутов можно определить по @Accessors(prefix = "m").

@ToString

Метод toString() сгенерированного объекта черезexcludeУстановите поля для исключения.

@EqualsAndHashCode

Сгенерируйте методы hashCode() и equals() объекта черезexcludeУстановите поля для исключения

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

Создает конструктор без параметров, параметризованный (final или свойство @NotNull-modified), конструктор с полными параметрами.

@Data

Эквивалентно коллекции @ToString, @EqualsAndHashCode, @Getter/@Setter и @RequiredArgsConstructor, эффект выглядит следующим образом:

@Builder

Сгенерируйте класс статического конструктора XxxBuilder для класса, обычно используемого

@Log

Представлять журнал очень удобно

над!

Прошлые статьи:

Все статьи в публичном аккаунте WeChat обновлены впервые

Категории