gradle 在Idea 中生成Vert.x 中vertx-service-proxy 代码

学Vert.x 有一段时间了,在vertx-service-proxy 中总是卡住,反复了好几次,今天总算是掌握了,在此分享一下。

最初一直不得要领,是因为对java 的annotation processor 不了解,所以一直很困惑。查询大量资料后,明白了这是用来自动生成代码的。

官方文档给了maven 的插件配置,使用起来很方便。

  1. 首先是jar 依赖
<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-service-proxy</artifactId> 
</dependency>
<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-codegen</artifactId>
  <scope>provided</scope>
</dependency>
  1. plugin 依赖
<!-- 生成文件 -->
<plugin>
  <artifactId>maven-compiler-plugin</artifactId>
  <version>3.5.1</version>
  <configuration>
    <source>1.8</source>
    <target>1.8</target>
    <useIncrementalCompilation>false</useIncrementalCompilation>
    <annotationProcessors><annotationProcessor>io.vertx.codegen.CodeGenProcessor</annotationProcessor>
    </annotationProcessors>
    <!-- 生成java 文件所在目录 -->
    <generatedSourcesDirectory>${project.basedir}/src/main/generated</generatedSourcesDirectory>
    <compilerArgs>
      <arg>-AoutputDirectory=${project.basedir}/src/main</arg>
    </compilerArgs>
  </configuration>
</plugin>

<!-- 删除生成的文件 -->
<plugin>
  <artifactId>maven-clean-plugin</artifactId>
  <version>3.0.0</version>
  <configuration>
    <filesets>
      <fileset>
        <directory>${project.basedir}/src/main/generated</directory>
      </fileset>
    </filesets>
  </configuration>
</plugin>
  1. 编写自己的服务接口
@VertxGen
public interface DatabaseService {
  
  @Fluent
  DatabaseService save(String data, Handler<AsyncResult<Void>> resultHandler);

}

执行后会抛出异常:

src\main\java\org\acui\DBService.java:7: ����: Could not generate model for org.acui.DBService: Declaration annotated with @VertxGen must be under a package annotatedwith @ModuleGen. Check that the package 'org.acui.DBService' or a parent package contains a 'package-info.java' using the @ModuleGen annotation
public interface DBService {
       ^
1 ������

需要创建package-info.java

// groupPackage  最好和服务接口package 一致
@ModuleGen(name = "proxy", groupPackage = "org.acui")
package org.acui;

import io.vertx.codegen.annotations.ModuleGen;

之后执行compileJava,会生成相关的Proxy 代码。

以上都很顺利,不过我换成gradle 后,按照官方文档所说Idea 支持自动annotation processor,网上也有很多配置方式,但我使用后却完全没有效果(如果有大神知道原因,求教!)。反复折腾了很长时间最终放弃了,后来发现gradle 有相关的插件io.dotinc.vertx-codegen-plugin,大家可以参考插件介绍文档。

我最终没有选择使用插件,是因为插件不支持最新的vert.x 版本,接下来是我自己在gradle 中进行的配置。

// 添加依赖
compile("io.vertx:vertx-codegen:3.8.2:processor")
compile("io.vertx:vertx-service-proxy:3.8.2")

// clean 时删除生成的文件
tasks.withType<Delete> {
    doFirst {
        delete(File("$projectDir/src/main/generated"))
    }
}

// 编译时使用annotation processor 处理
tasks.withType<JavaCompile> {
    options.annotationProcessorGeneratedSourcesDirectory = File("$projectDir/src/main/generated")
    // 指定注解处理器的位置为classpath
    options.annotationProcessorPath = this.classpath
}

执行compileJava,生成相关Proxy 代码!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容