maven 插件如何加载项目中的类

maven 插件如何加载项目中的类

有不少插件希望扫描所在项目的类，如利用反射加载项目中的类，但如果不看官方文档直接开发，最初特别容易掉入一个深坑——ClassNotFoundException。因为不了解Maven插件的类加载器机制，maven 插件里是没法直接加载项目中的类，当且仅当以特殊方式编码才能加载。

获取项目编译环境类路径

在插件中如何获取项目类路径呢？官方插件（maven-compiler-plugin）为我们做出了示例，源码：Apache Maven Compiler Plugin 源码。

下载源码，发现 CompilerMojo 类中，有两个关键点：

类注释

类注释上有一个 @requiresDependencyResolution compile ，查阅官方文档后发现该注释意味着在此插件执行前会准备好项目 compile 作用域依赖 作为类路径。

编译环境类路径

	@Parameter( defaultValue = "${project.compileClasspathElements}", readonly = true, required = true )
    private List<String> compilePath;

该属性可以获取目标项目的环境类路径

参考

• Guide to Maven Classloading
• Mojo API Specification
• 插件编写指导

---

详细步骤

注入 MavenProject 类（在 maven-core 中）

确保 pom.xml 里存在

		<dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-core</artifactId>
            <version>3.0</version>
        </dependency>

MOJO 注入 MavenProject 类或compilePath （二选一即可，这两种方式获取的都是相同的）

	@Parameter(defaultValue = "${project}")
	public MavenProject project;

	@Parameter( defaultValue = "${project.compileClasspathElements}", readonly = true, required = true )
    private List<String> compilePath;

MOJO 上添加类注释

/**
 * @requiresDependencyResolution compile
 */

获取类加载器

	private ClassLoader getClassLoader(MavenProject project)
    {
        try
        {
        	// 所有的类路径环境，也可以直接用 compilePath
            List classpathElements = project.getCompileClasspathElements();
            
            classpathElements.add( project.getBuild().getOutputDirectory() );
            classpathElements.add( project.getBuild().getTestOutputDirectory() );
            // 转为 URL 数组
            URL urls[] = new URL[classpathElements.size()];
            for ( int i = 0; i < classpathElements.size(); ++i )
            {
                urls[i] = new File( (String) classpathElements.get( i ) ).toURL();
            }
            // 自定义类加载器
            return new URLClassLoader( urls, this.getClass().getClassLoader() );
        }
        catch ( Exception e )
        {
            getLog().debug( "Couldn't get the classloader." );
            return this.getClass().getClassLoader();
        }
    }

使用特定类加载器加载

getClassLoader(this.project).loadClass("com.somepackage.SomeClass")

---

其他类似问题

MavenProject 能给我们一些信息，可以该变量里取，如 获取项目编译环境路径

project.getArtifact().getFile().getAbsolutePath()