AutoService+javaPoet+maven+注解自动生成java代码

已于 2023-04-11 23:23:38 修改
阅读量944 收藏 1
点赞数
文章标签： java maven 开发语言
于 2022-09-20 22:39:15 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/a__da/article/details/126963052
版权

1、资料

AutoService: https://github.com/google/auto/tree/master/service
javaPoet: https://github.com/square/javapoet

2、介绍

本文主要是利用两者+注解在maven的编译期来生成代码，一个简单demo，也可以用来扩展逻辑来生成自己的代码。

3、工程介绍

3.1 父子工程截图

在这里插入图片描述

3.2 父工程testo的pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <packaging>pom</packaging>
    <modules>
        <module>auto</module>
        <module>test</module>
    </modules>

    <groupId>com.example</groupId>
    <artifactId>testo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>testo</name>
    <description>testo</description>
    <properties>
        <java.version>8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <auto-service.version>1.0-rc6</auto-service.version>
    </properties>
</project>

3.3 子模块test的pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>testo</artifactId>
        <groupId>com.example</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>test</artifactId>

    <properties>
        <java.version>8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <auto-service.version>1.0-rc6</auto-service.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>auto</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>2.0.12</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.10.1</version>
                <configuration>
                    <annotationProcessorPaths>
                        <path>
                            <groupId>com.example</groupId>
                            <artifactId>auto</artifactId>
                            <version>0.0.1-SNAPSHOT</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

3.4 子模块test代码截图

在这里插入图片描述

3.5 子模块auto的pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>testo</artifactId>
        <groupId>com.example</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>auto</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.google.auto.service</groupId>
            <artifactId>auto-service</artifactId>
            <version>1.0-rc2</version>
        </dependency>
        <dependency>
            <groupId>com.squareup</groupId>
            <artifactId>javapoet</artifactId>
            <version>1.13.0</version>
        </dependency>
    </dependencies>

</project>

3.6 子模块auto的代码截图在这里插入图片描述

3.7 子模块auto代码

package com.example.testo.auto;

import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.TypeSpec;

import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;

public abstract class BaseCodeGenProcessor implements CodeGenProcessor {

  public static final String PREFIX = "Base";

  @Override
  public void generate(TypeElement typeElement, RoundEnvironment roundEnvironment)
      throws Exception {
    System.out.println(1111);
    //添加其他逻辑扩展
  }

  public void genJavaSourceFile(String packageName, String pathStr, TypeSpec.Builder typeSpecBuilder) {
    TypeSpec typeSpec = typeSpecBuilder.build();
    JavaFile javaFile = JavaFile.builder(packageName, typeSpec)
            .addFileComment("--auto generated by ada--")
            .build();
    String packagePath = packageName.replace(".", File.separator) + File.separator + typeSpec.name + ".java";
    try {
      Path path = Paths.get(pathStr);
      File file = new File(path.toFile().getAbsolutePath());
      if (!file.exists()) {
        return;
      }
      String sourceFileName = path.toFile().getAbsolutePath() + File.separator + packagePath;
      File sourceFile = new File(sourceFileName);
      if (!sourceFile.exists()) {
        javaFile.writeTo(file);
      }
    } catch (IOException e) {
      e.printStackTrace();
    }
  }


}


package com.example.testo.auto;

import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;
import java.lang.annotation.Annotation;

/**
 * @Author ada
 * @Date 2022/9/5 10:37 PM
 * @Version 1.0
 */
public interface CodeGenProcessor {

    /**
     * 需要解析的类上的注解.
     * @return
     */
    Class<? extends Annotation> getAnnotation();

    /**
     * 获取生成的包路径.
     * @param typeElement
     * @return
     */
    String generatePackage(TypeElement typeElement);

    /**
     * 代码生成逻辑.
     * @param typeElement
     * @param roundEnvironment
     * @throws Exception
     */
    void generate(TypeElement typeElement, RoundEnvironment roundEnvironment) throws Exception;
}

package com.example.testo.auto;

import com.google.common.collect.Maps;

import java.lang.annotation.Annotation;
import java.util.Iterator;
import java.util.Map;
import java.util.ServiceLoader;
import java.util.Set;


public final class CodeGenProcessorRegistry {

  private static Map<String, ? extends CodeGenProcessor> PROCESSORS;


  private CodeGenProcessorRegistry() {
    throw new UnsupportedOperationException();
  }

  /**
   * 注解处理器要处理的注解集合
   *
   * @return
   */
  public static Set<String> getSupportedAnnotations() {
    return PROCESSORS.keySet();
  }

  public static CodeGenProcessor find(String annotationClassName) {
    return PROCESSORS.get(annotationClassName);
  }

  /**
   * spi 加载所有的processor
   *
   * @return
   */
  public static void initProcessors() {
    final Map<String, CodeGenProcessor> map = Maps.newLinkedHashMap();
    ServiceLoader<CodeGenProcessor> processors = ServiceLoader.load(CodeGenProcessor.class,CodeGenProcessor.class.getClassLoader());
    Iterator<CodeGenProcessor> iterator = processors.iterator();
    while (iterator.hasNext()) {
      CodeGenProcessor next = iterator.next();
      Class<? extends Annotation> annotation = next.getAnnotation();
      map.put(annotation.getName(), next);
    }
    PROCESSORS = map;
  }

}

package com.example.testo.auto;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface GenService {

  String pkgName();

  String sourcePath() default "src/main/java";

  boolean overrideSource() default false;
}

package com.example.testo.auto;

import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;

import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import java.io.File;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.nio.file.Path;
import java.nio.file.Paths;

/**
 * @Author ada
 * @Date 2022/9/15 11:39 PM
 * @Version 1.0
 */
@AutoService(CodeGenProcessor.class)
public class GenServiceProcessor extends BaseCodeGenProcessor {
    @Override
    public Class<? extends Annotation> getAnnotation() {
        return GenService.class;
    }

    @Override
    public String generatePackage(TypeElement typeElement) {
        return typeElement.getAnnotation(GenService.class).pkgName();
    }

    @Override
    public void generate(TypeElement typeElement, RoundEnvironment roundEnvironment) throws Exception {
        MethodSpec main = MethodSpec.methodBuilder("main")
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                .returns(void.class)
                .addParameter(String[].class, "args")
                .addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!")
                .build();

        String className = "HelloWorld";
        TypeSpec.Builder helloWorld = TypeSpec.classBuilder(className)
                .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                .addMethod(main);

        String packageName = "com.example.helloworld";

        genJavaSourceFile(packageName, typeElement.getAnnotation(GenService.class).sourcePath(), helloWorld);
    }


}

package com.example.testo.auto;

import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.TypeSpec;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.ElementFilter;
import javax.tools.Diagnostic.Kind;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Set;


@AutoService(Processor.class)
public class Only4PlayCodeGenProcessor extends AbstractProcessor {

  @Override
  public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    annotations.stream().forEach(an -> {
      Set<? extends Element> typeElements = roundEnv.getElementsAnnotatedWith(an);
      Set<TypeElement> types = ElementFilter.typesIn(typeElements);
      for (TypeElement typeElement : types){
        CodeGenProcessor codeGenProcessor = CodeGenProcessorRegistry.find(
            an.getQualifiedName().toString());
        try {
          codeGenProcessor.generate(typeElement,roundEnv);
        } catch (Exception e) {
          ProcessingEnvironmentHolder.getEnvironment().getMessager().printMessage(Kind.ERROR,"代码生成异常:" + e.getMessage());
        }
      }

    });
    return false;
  }

  @Override
  public synchronized void init(ProcessingEnvironment processingEnv) {
    super.init(processingEnv);
    ProcessingEnvironmentHolder.setEnvironment(processingEnv);
    CodeGenProcessorRegistry.initProcessors();
  }

  @Override
  public Set<String> getSupportedAnnotationTypes() {
    return CodeGenProcessorRegistry.getSupportedAnnotations();
  }

  @Override
  public SourceVersion getSupportedSourceVersion() {
    return SourceVersion.latestSupported();
  }


}


package com.example.testo.auto;

import javax.annotation.processing.ProcessingEnvironment;


public final class ProcessingEnvironmentHolder {

  public static final ThreadLocal<ProcessingEnvironment> environment = new ThreadLocal<>();


  public static void setEnvironment(ProcessingEnvironment pe){
    environment.set(pe);
  }

  public static ProcessingEnvironment getEnvironment(){
    return environment.get();
  }


}

4、调试技巧

1、mvn install auto
2、mvn clean test，然后debug mvn complie test
在这里插入图片描述

猿人换羽
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
使用注解自动生成代码
GeeJoe 的博客
03-29 1888
如何使用注解来消除模板代码？关于 Annotation Processor 还有哪些你不知道的事...
javapoet-maven-plugin：JavaPoet Maven插件
02-13
JavaPoet Maven插件 一个简单的maven插件，可让您使用生成项目的源。 开发JavaFile Generator 要开发JavaFile生成器， 编写public static方法 仅有一个java.lang.String参数，并且 返回java.lang.Iterable<com> 。 例如： package your.name ; import com.squareup.javapoet.JavaFile ; import com.squareup.javapoet.TypeSpec ; import static java.util.Collections.singletonList ; import static javax.lang.model.element.Modifier.FINAL ; impor
Android代码生成技术JavaPoet的使用
07-24
一个简单的了解编译期代码生成原理的demo，涉及到了javaPoet技术、自定义注解等，可用来了解butterknife、greenDao的原理
Java代码生成器合集Auto.zip
07-17
Auto 是 Google 开发的一组 Java 代码生成器。Java 有许多机械、重复、未经测试的代码，而且有时会出现一些微妙的 Bug 。Auto 项目是自动执行这些类型的任务的代码生成器的集合，他们可以无 Bug 创建你要编写的代码。目前包括以下子项目AutoFactory - JSR-330-compatible factories。AutoService - Provider-configuration files for ServiceLoader。AutoValue - Immutable value-type code generation for Java 1.6 。Common - Helper utilities for writing annotation processors。 标签：Auto
Java进阶--编译时注解处理器（APT）详解
最新发布
2401_83641392的博客
04-02 719
蚂蚁面试比较重视基础，所以Java那些基本功一定要扎实。蚂蚁的工作环境还是挺赞的，因为我面的是稳定性保障部门，还有许多单独的小组，什么三年1班，很有青春的感觉。面试官基本水平都比较高，基本都P7以上，除了基础还问了不少架构设计方面的问题，收获还是挺大的。经历这次面试我还通过一些渠道发现了需要大厂真实面试主要有：蚂蚁金服、拼多多、阿里云、百度、唯品会、携程、丰巢科技、乐信、软通动力、OPPO、银盛支付、中国平安等初，中级，高级Java面试题集合，附带超详细答案，希望能帮助到大家。
auto-service:自动生成META-INFservices文件
03-14
汽车服务 Auto Service
AutoService:自动服务的Java Web应用程序。 CodersLab训练营第三周后完成的项目
05-10
汽车服务 AutoService是用于管理汽车服务的简单Java Web应用程序。 CodersLab Bootcamp第三周“ Java开发人员：Web”之后创建的项目。 功能： 管理：汽车维修，员工和客户； 编辑以下数据：汽车，客户，员工； 提供汽车维修的报告和历史记录。 屏幕截图 使用的技术/框架 内置： 执照 :copyright:
Java注解处理(Annotation Processor)：(三) 代码生成
jjxojm的专栏
05-20 8295
上节中AutoService利用注解处理生成的Service文件，这次我们主要进行代码生成，分析注解处理过程中代码生成的过程以及Gradle和Maven应如何配置Annotation Processor的支持。 @Retention(RetentionPolicy.SOURCE) @Target(ElementType.TYPE) public @interface Hello { ...
Java语言使用注解处理器生成代码 —— 第一部分：注解类型
琴弦第七
10-09 3654
从本文开始，我将开始写一系列关于Java语言使用注解处理器生成代码的文章，包括这种方法的强大之处。最后还会描述如何确保在编译的时候使用这种方法生成源代码。在这系列文章中，我们将会： 介绍Java语言的注解。 了解注解的常用方式以及使用范围。 了解注解处理器以及它们所代表的角色。 学习如何创建注解处理器。 学习如何在终端命令行、Eclipse和Maven中运行注解处理器。 学习如何使用注解处理器生成源
Java的SPI机制及AutoService
Luck_ZZ的博客
03-06 1136
一、SPI机制 SPI：Service Provider Interface，是一种服务发现机制 它通过在ClassPath路径下的META-INF/services文件夹查找文件，自动加载文件里所定义的类，模块之间基于接口编程，实现可拔插 二、栗子 1.定义接口 package com.zz.spi; public interface SPIService { void execute(); } 2.实现类 SPIImpl1.java package com.zz.spi;
使用java语言中的注解生成器生成代码
知其然知其所以然
05-29 2296
该文翻译自https://deors.wordpress.com/2011/09/26/annotation-types/ Code Generation using Annotation Processors in the Java language
autoservice java,安卓使用注解处理器自动生成代码操作详解(AutoService,JavaPoet,AbstractProcessor)...
weixin_39875629的博客
03-12 454
新手村先来说说注解处理器(AbstractProcessor)是干嘛的，它主要是用来处理注解的一些内部逻辑，拿butterknife举例，我声明了一个bindView注解，那肯定是要写一些逻辑才能找到控件的id对吧，AbstractProcessor就是注解处理的逻辑入口，出于性能考虑，肯定是不能使用反射来处理找id这个逻辑的，这时，JavaPoet就派上用场了，它的作用是根据特定的规则生成jav...
java自定义注解实现由类自动生成表
01-08
自定义注解实现由类自定生成数据库中的表，适合各种类型的数据库，本案例主要实现的时sql server和oracle
maven 代码生成（maven插件）
05-08
项目导入成功后 生成方式 : 选中pom.xml运行Run As --- Goals:mybatis-generator:generate
尚硅谷——使用注解生成代码
01-30
生成源代码很容易，但是生成正确的源代码就不容易了。要使用优雅高效的方法来生成源代码将是一个繁重的任务。
Auto:Java 源代码生成器的集合-开源
08-07
一些 Auto 子项目包括 AutoFactory、JSR-330 兼容工厂、AutoService、ServiceLoader 的提供者配置文件、AutoValue、Java 7+ 的不可变值类型代码生成以及 Common，用于编写注释处理器的辅助实用程序。 Auto 是根据 ...
【Android】Google AutoService的使用与源码解析
devnn的专栏
09-13 6083
AutoService是Google开发一个自动生成SPI资源文件的框架。看过一些基于APT的三方框架源码的读者应该有所了解。比如Arouter、EventBus等等。一般我们用它来自动帮我们注册APT文件(全称是Annotation Process Tool，或者叫注解处理器，AbstractProcessor的实现)。很多生成SPI文件的框架也是抄袭它的源码，可见它的作用还不小。
Java开源工具库使用之java源代码生成库JavaPoet
十十办文武的博客
10-17 1310
JavaPoet是一个用于生成 .java 源代码文件的 Java API。截止博客发表为止，整个项目核心源码就17个类文件，github上却有 9.9k stars，可谓短小精悍。javapoet 实现了自动导包和语句分号添加，代码流程控制，代码格式化等功能，很方便开发者生成一些模板代码
总结
XYYFKJK的博客
06-26 108
文章目录mybatis批量插入常规批量插入。（通过foreach，生成很长的SQL）自动生成代码 mybatis批量插入 常规批量插入。（通过foreach，生成很长的SQL） int batchInsertByNormal(List<Teacher> teacherList); List<Teacher> testData = new ArrayList&lt...
java autoservice注解无法生成meta-inf文件
08-09
3. 配置文件缺失或错误：autoservice注解生成META-INF文件的前提是META-INF目录存在，并且配置文件的名称和路径正确。如果自动生成的META-INF文件不存在，或者文件名或路径有误，就无法实现服务发现。我们需要检查...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值