在开发maven插件时，有时需要根据maven的运行模式来调整插件的行为。例如，在交互模式下可能需要向用户提问或显示详细进度，而在批处理模式（通过命令行参数-b或--batch-mode激活）下则应避免任何用户交互，并以非阻塞方式运行。判断当前是否处于批处理模式，是实现这种差异化行为的关键。
判断批处理模式的方法
Maven提供了MavenSession对象，其中包含了当前Maven执行的上下文信息，包括请求详情。我们可以通过将MavenSession注入到Mojo中，并检查其MavenExecutionRequest的isInteractiveMode()方法来判断运行模式。
1. 注入 MavenSession
首先，在你的Mojo类中声明一个MavenSession类型的字段，并使用@Parameter注解进行注入。defaultValue = "${session}"是关键，它告诉Maven将当前的MavenSession实例注入到此字段。required = true确保该会话对象是必需的，而readonly = true是一个良好的实践，表明该注入对象不应被Mojo修改。
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.execution.MavenSession;
@Mojo(name = "check-mode")
public class CheckModeMojo extends AbstractMojo {
/**
* The current Maven session.
*/
@Parameter(defaultValue = "${session}", required = true, readonly = true)
private MavenSession session;
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
// ... 插件执行逻辑 ...
}
}2. 检查交互模式状态
在Mojo的execute()方法中，你可以通过session.getRequest().isInteractiveMode()来获取当前是否处于交互模式的信息。
- 如果isInteractiveMode()返回true，表示Maven当前处于交互模式（默认模式）。
- 如果isInteractiveMode()返回false，表示Maven当前处于批处理模式（例如，当命令行包含-B或--batch-mode时）。
以下是一个完整的Mojo示例，演示了如何根据运行模式输出不同的信息：
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.execution.MavenSession;
/**
* 一个用于演示如何判断Maven批处理模式的Mojo。
*/
@Mojo(name = "check-mode", defaultPhase = org.apache.maven.plugins.annotations.LifecyclePhase.PROCESS_SOURCES)
public class CheckModeMojo extends AbstractMojo {
/**
* 当前的Maven会话。
* 通过此对象可以获取Maven执行的上下文信息。
*/
@Parameter(defaultValue = "${session}", required = true, readonly = true)
private MavenSession session;
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
getLog().info("--- 检查 Maven 运行模式 ---");
if (session.getRequest().isInteractiveMode()) {
getLog().info("Maven 正在以交互模式运行。");
getLog().info("在此模式下，插件可以与用户进行交互，例如请求输入。");
// 示例：在交互模式下执行的逻辑
// askForUserInput();
} else {
getLog().info("Maven 正在以批处理模式运行（Batch Mode）。");
getLog().info("此模式通常通过命令行参数 -B 或 --batch-mode 激活。");
getLog().info("在此模式下，插件应避免任何用户交互，并以非阻塞方式运行。");
// 示例：在批处理模式下执行的逻辑
// processSilently();
}
getLog().info("--- 模式检查完成 ---");
}
// 假设的辅助方法，用于演示不同模式下的行为
private void askForUserInput() {
// 模拟用户交互
getLog().info("请在交互模式下输入一些信息...");
}
private void processSilently() {
// 模拟静默处理
getLog().info("在批处理模式下静默处理数据...");
}
}注意事项
- @Parameter注解：确保正确使用@Parameter(defaultValue = "${session}", required = true, readonly = true)来注入MavenSession。defaultValue = "${session}"是Maven内部用于注入会话对象的表达式。
- isInteractiveMode()的含义：isInteractiveMode()返回true表示允许用户交互，false表示不允许。因此，当其返回false时，就意味着Maven处于批处理模式。
-
Mojo的依赖：确保你的Mojo项目依赖于maven-plugin-api和maven-core，以便能够访问MavenSession和相关的类。
org.apache.maven maven-plugin-api 3.x.x provided org.apache.maven maven-core 3.x.x provided org.apache.maven.plugin-tools maven-plugin-annotations 3.x provided
总结
通过上述方法，Maven插件开发者可以轻松地在Mojo中判断Maven的运行模式。这为创建更加智能和适应性强的插件提供了基础，使得插件在不同场景下（如CI/CD管道中的批处理执行或开发环境中的交互式调试）都能提供最佳的用户体验和功能表现。正确区分和处理这两种模式，是编写健壮和用户友好型Maven插件的重要一环。
