java:修复aspectj-maven-plugin插件在java9项目中执行报错:cannot be resolved to a module

javadocreader9(https://gitee.com/l0km/javadocreader9)是我最近写的一个基于Java 9 的javadoc读取java代码注释的工具。在基于Java 9(我用的编译器JDK 19)编译时,aspectj-maven-plugin插件在执行报了一堆错误: xxx cannot be resolved to a module,如下:

[INFO] --- aspectj-maven-plugin:1.15.0:compile (default) @ javadocreader9 ---
[INFO] Showing AJC message detail for messages of types: [error, warning, fail]
[ERROR] com.google.common cannot be resolved to a module
        J:\javadocreader9\src\main\java\module-info.java:5
requires transitive com.google.common;
                    ^^^^^^^^^^^^^^^^^

[ERROR] com4j.base2 cannot be resolved to a module
        J:\javadocreader9\src\main\java\module-info.java:6
requires transitive com4j.base2;
                    ^^^^^^^^^^^

[ERROR] com4j.base cannot be resolved to a module
        J:\javadocreader9\src\main\java\module-info.java:7
requires transitive com4j.base;
                    ^^^^^^^^^^

[ERROR] aocache cannot be resolved to a module
        J:\javadocreader9\src\main\java\module-info.java:8
requires aocache;
         ^^^^^^^

显示所有的模块在都不能被aspectj-maven-plugin识别,这些模块名都是javadocreader9的module-info.java中定义的模块名。

如下是module-info.java定义

java 复制代码
module com.gitee.l0km.javadocreader{
    exports com.gitee.l0km.javadocreader;
    requires java.desktop;
    requires transitive  jdk.javadoc;
	requires transitive com.google.common;
	requires transitive com4j.base2;
	requires transitive com4j.base;
	requires aocache;
}

如下是javadocreader9的pom.xml片段:

xml 复制代码
<project>
	<properties>
		<maven.compiler.source>9</maven.compiler.source>
		<maven.compiler.target>9</maven.compiler.target>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<com4j.version>4.0.0</com4j.version>
		<aocache.version>0.4.5</aocache.version>
		<aspectj.version>1.9.21</aspectj.version>
	</properties>
	<build>
		<plugins>
			<plugin>
				<groupId>org.codehaus.mojo</groupId>
				<artifactId>aspectj-maven-plugin</artifactId>
				<version>1.15.0</version>
				<configuration>
					<encoding>UTF-8</encoding>
					<complianceLevel>9</complianceLevel>
					<verbose>true</verbose>
					<showWeaveInfo>true</showWeaveInfo>
					<!-- 忽略adviceDidNotMatch警告-->
					<Xlint>adviceDidNotMatch=ignore</Xlint>
					<aspectLibraries>
						<aspectLibrary>
							<groupId>com.gitee.l0km</groupId>
							<artifactId>aocache</artifactId>
						</aspectLibrary>
					</aspectLibraries>
				</configuration>
				<executions>
					<execution>
						<goals>
							<goal>compile</goal>
						</goals>
					</execution>
				</executions>
				<dependencies>
					<!-- 确保编译器使用的aspectj工具版本与依赖项使用的版本相同。避免警告 -->
					<dependency>
						<groupId>org.aspectj</groupId>
						<artifactId>aspectjtools</artifactId>
						<version>${aspectj.version}</version>
					</dependency>
				</dependencies>
			</plugin>
		</plugins>
	</build>
</project>

解决方案一

使用dev.aspectj:aspectj-maven-plugin:1.14插件代替org.codehaus.mojo:aspectj-maven-plugin:1.15.0来执行编译时织入。
org.codehaus.mojo:aspectj-maven-plugin是Apache Maven官方提供的插件,我们在网上找到关于aspectj-maven-plugin插件的介绍都是基于这个插件的。
dev.aspectj:aspectj-maven-plugin是eclipse aspectj项目官方提供的插件,

我不太清楚为什么有两个官方插件。但是dev.aspectj:aspectj-maven-plugin1.13版本开始为解决module无法解析问题,增加了<javaModules></javaModules>参数,用于定义ajc--module-path参数,说明如下图:

参见 https://dev-aspectj.github.io/aspectj-maven-plugin/compile-mojo.html#javaModules

根据这个参数,我修改了pom.xml,使用dev.aspectj:aspectj-maven-plugin:1.14插件代替org.codehaus.mojo:aspectj-maven-plugin:1.15.0,并增加了<javaModules></javaModules>参数定义如下:

xml 复制代码
<project>
	<properties>
		<maven.compiler.source>9</maven.compiler.source>
		<maven.compiler.target>9</maven.compiler.target>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<com4j.version>4.0.0</com4j.version>
		<aocache.version>0.4.5</aocache.version>
		<aspectj.version>1.9.21</aspectj.version>
	</properties>
	<build>
		<plugins>
			<plugin>
				<groupId>dev.aspectj</groupId>
				<version>1.14</version>
				<artifactId>aspectj-maven-plugin</artifactId>
				<configuration>
					<encoding>UTF-8</encoding>
					<complianceLevel>9</complianceLevel>
					<verbose>true</verbose>
					<showWeaveInfo>true</showWeaveInfo>
					<!-- 忽略adviceDidNotMatch警告-->
					<Xlint>adviceDidNotMatch=ignore</Xlint>
					<aspectLibraries>
						<aspectLibrary>
							<groupId>com.gitee.l0km</groupId>
							<artifactId>aocache</artifactId>
						</aspectLibrary>
					</aspectLibraries>
					<javaModules>
						<javaModule>
							<groupId>com.gitee.l0km</groupId>
							<artifactId>com4j-base</artifactId>
						</javaModule>
						<javaModule>
							<groupId>com.gitee.l0km</groupId>
							<artifactId>com4j-base2</artifactId>
						</javaModule>
						<javaModule>
							<groupId>com.google.guava</groupId>
							<artifactId>guava</artifactId>							
						</javaModule>
						<javaModule>
							<groupId>com.gitee.l0km</groupId>
							<artifactId>aocache</artifactId>
						</javaModule>
					</javaModules>
				</configuration>
				<executions>
					<execution>
						<goals>
							<goal>compile</goal>
						</goals>
					</execution>
				</executions>
				<dependencies>
					<!-- 确保编译器使用的aspectj工具版本与依赖项使用的版本相同。避免警告 -->
					<dependency>
						<groupId>org.aspectj</groupId>
						<artifactId>aspectjtools</artifactId>
						<version>${aspectj.version}</version>
					</dependency>
				</dependencies>
			</plugin>
		</plugins>
	</build>
</project>

修改后效果立竿见影,aspectj-maven-plugin的报错减少了,只剩下aocache这个模块找不到。

[INFO] --- aspectj-maven-plugin:1.14:compile (default) @ javadocreader9 ---
[INFO] Showing AJC message detail for messages of types: [error, warning, fail]
[ERROR] aocache cannot be resolved to a module
        J:\javadocreader9\src\main\java\module-info.java:8
requires aocache;
         ^^^^^^^

关于aocache这个模块为什么找不到,我至今也没想明白原因,aocache这个模块也是我写的(仓库地址https://gitee.com/l0km/aocache)。除了项目使用org.apache.maven.plugins:maven-shade-plugin插件打包之外,它与同样是我写的模块com4j.base,com4j-base2(仓库地址https://gitee.com/l0km/common-java)相比没有什么特别的。我尝试了很多方式改进aocache但就是无法解决这个问题。问题只能留待以后了。

解决方案二

如果你的项目使用解决方案一就能解决问题,可以不用看这部分了。

因为我使用解决方案一,仍然无法解决找不到aocache这个模块的问题,我只能继续想辙。
aspectj-maven-plugin的报错一直都是聚集在模块定义文件module-info.java上。因为module-info.java解析失败,后续会导致所有引用该模块的包名统统报错。

如果不让aspectj-maven-plugin编译module-info.java这个文件,是不是就能解决问题呢?

于是我用回org.codehaus.mojo:aspectj-maven-plugin:1.15.0插件,在插件定义中增加源码排除定义(<excludes></excludes>),不编译module-info.java ,如下:

xml 复制代码
					<sources>
						<source>
							<basedir>src/main/java</basedir>
							<excludes>
								<exclude>module-info.java</exclude>
							</excludes>
						</source>
					</sources>

果然问题解决,

当然使用源码包含定义(<includes></includes>)指定只编译需要织入的代码,效果也是一样的

xml 复制代码
					<sources>
						<source>
							<basedir>src/main/java</basedir>
							<includes>
								<include>**/JavadocReader.java</include>
							</includes>
						</source>
					</sources>

<excludes></excludes><includes></includes>的说明如下图:

https://www.mojohaus.org/aspectj-maven-plugin/compile-mojo.html#includes
https://www.mojohaus.org/aspectj-maven-plugin/compile-mojo.html#excludes

pom.xml片段如下。

xml 复制代码
<project>
	<properties>
		<maven.compiler.source>9</maven.compiler.source>
		<maven.compiler.target>9</maven.compiler.target>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<com4j.version>4.0.0</com4j.version>
		<aocache.version>0.4.5</aocache.version>
		<aspectj.version>1.9.21</aspectj.version>
	</properties>
	<build>
		<plugins>
			<plugin>
				<groupId>org.codehaus.mojo</groupId>
				<artifactId>aspectj-maven-plugin</artifactId>
				<version>1.15.0</version>
				<configuration>
					<encoding>UTF-8</encoding>
					<complianceLevel>9</complianceLevel>
					<verbose>true</verbose>
					<showWeaveInfo>true</showWeaveInfo>
					<!-- 忽略adviceDidNotMatch警告-->
					<Xlint>adviceDidNotMatch=ignore</Xlint>
					<sources>
						<source>
							<basedir>src/main/java</basedir>
							<excludes>
								<exclude>module-info.java</exclude>
							</excludes>
						</source>
					</sources>
					<aspectLibraries>
						<aspectLibrary>
							<groupId>com.gitee.l0km</groupId>
							<artifactId>aocache</artifactId>
						</aspectLibrary>
					</aspectLibraries>
				</configuration>
				<executions>
					<execution>
						<goals>
							<goal>compile</goal>
						</goals>
					</execution>
				</executions>
				<dependencies>
					<!-- 确保编译器使用的aspectj工具版本与依赖项使用的版本相同。避免警告 -->
					<dependency>
						<groupId>org.aspectj</groupId>
						<artifactId>aspectjtools</artifactId>
						<version>${aspectj.version}</version>
					</dependency>
				</dependencies>
			</plugin>
		</plugins>
	</build>
</project>

参考资料

《javaModules》
《includes》
《excludes》

相关推荐
小屁孩大帅-杨一凡12 分钟前
python获取本地电脑的ip和mac地址
java·服务器·网络·python·tcp/ip
sinat_3842410913 分钟前
修改Android Studio项目配置JDK路径和项目Gradle路径的GUI工具
android·java·android studio
苹果醋322 分钟前
Redis | 第3章 对象《Redis设计与实现》
java·运维·spring boot·mysql·nginx
bingbingyihao43 分钟前
代码辅助工具 GPT / Cursor
android·java·gpt
CN.LG43 分钟前
浅谈Spring Boot之任务调度
java·spring boot·后端
少说多做34344 分钟前
Android 使用 LiveData/OnCheckedChangeListener 来监听变量变化
android·java·android-studio
安girl1 小时前
springMVC重点知识
java·开发语言
被猫枕的咸鱼1 小时前
工作学习--Arrays.asList的问题
java·开发语言·学习
RT_01142 小时前
设计模式之策略模式
java·设计模式·策略模式
无名指的等待7122 小时前
Nacos实现IP动态黑白名单过滤
java·spring boot·tcp/ip