理解Maven的运行模式
Maven在执行构建时，主要有两种运行模式：
- 交互模式（Interactive Mode）：这是Maven的默认模式。在此模式下，Maven可能会在必要时暂停执行，等待用户输入（例如，当插件需要用户确认某些操作时）。
- 批处理模式（Batch Mode）：当通过命令行参数-B或--batch-mode启动Maven时，它会进入批处理模式。在此模式下，Maven会尝试避免任何交互式操作，即使插件通常会请求用户输入，它也会尝试使用默认值或直接失败，以确保构建过程能够无人值守地完成。这在持续集成/持续部署（CI/CD）环境中尤为重要。
对于Maven插件开发者而言，了解当前Maven的运行模式至关重要，以便在批处理模式下避免可能导致构建中断的交互式行为，或根据模式调整插件的逻辑。
在Mojo中注入MavenSession
要判断Maven是否处于批处理模式，最简单且推荐的方法是在Mojo中注入MavenSession对象。MavenSession包含了当前Maven构建的运行时信息，包括请求参数等。
通过在Mojo类中声明一个字段并使用@Parameter注解，可以轻松注入MavenSession：
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
@Mojo(name = "my-batch-detector")
public class MyBatchDetectorMojo extends AbstractMojo {
/**
* The current Maven session.
*/
@Parameter(defaultValue = "${session}", required = true, readonly = true)
private MavenSession session;
// ... execute method will go here
}- @Parameter(defaultValue = "${session}", required = true, readonly = true)：这个注解指示Maven将当前构建的MavenSession对象注入到session字段中。
- defaultValue = "${session}"：这是一个表达式，告诉Maven将当前会话对象绑定到此参数。
- required = true：表示此参数是必需的，如果无法注入，Maven将报错。
- readonly = true：表示此参数在Mojo执行期间不应被修改。
判断批处理模式的逻辑
一旦MavenSession被成功注入，就可以通过访问session.getRequest().isInteractiveMode()方法来判断Maven的运行模式。
- 如果isInteractiveMode()返回true，则表示Maven处于交互模式。
- 如果isInteractiveMode()返回false，则表示Maven处于批处理模式（即使用了-B参数）。
以下是Mojo中实现判断逻辑的示例代码：
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
@Mojo(name = "my-batch-detector", defaultPhase = org.apache.maven.plugins.annotations.LifecyclePhase.VALIDATE)
public class MyBatchDetectorMojo extends AbstractMojo {
/**
* The current Maven session.
*/
@Parameter(defaultValue = "${session}", required = true, readonly = true)
private MavenSession session;
@Override
public void execute() throws MojoExecutionException {
if (session.getRequest().isInteractiveMode()) {
getLog().info("Maven is running in INTERACTIVE mode.");
// 在交互模式下执行的逻辑，例如：可以提示用户输入
// 例如：Scanner scanner = new Scanner(System.in);
// String input = scanner.nextLine();
} else {
getLog().info("Maven is running in BATCH mode (--batch-mode or -B).");
// 在批处理模式下执行的逻辑，例如：使用默认值，跳过用户交互
// 例如：String input = "default_value";
}
}
}应用场景与注意事项
应用场景：
- 避免CI/CD中断：在持续集成环境中，构建通常是无人值守的。如果插件在交互模式下会弹出确认框或等待用户输入，那么在批处理模式下检测到这一点，就可以自动选择默认选项或跳过相关步骤，防止构建卡住。
- 调整日志输出：在批处理模式下，可能需要更简洁或更详细的日志输出，以方便自动化工具解析。
- 启用/禁用特定功能：某些功能可能只适用于交互式开发，而在自动化构建中则应禁用。
- 默认值处理：当用户未提供某些参数时，交互模式下可以提示用户输入，而批处理模式下则应使用预设的默认值。
注意事项：
- Mojo注解：确保Mojo类正确使用了@Mojo注解，并指定了name和可选的defaultPhase。
-
Maven依赖：确保项目的pom.xml中包含Maven插件API的依赖：
org.apache.maven.plugin-tools maven-plugin-annotations 3.6.1 provided org.apache.maven maven-plugin-api 3.8.1 provided org.apache.maven maven-core 3.8.1 provided maven-core依赖提供了MavenSession和MavenExecutionRequest等核心类。
- 测试：在开发和测试插件时，务必分别使用mvn clean install（默认交互模式）和mvn -B clean install（批处理模式）来测试插件的行为，确保在两种模式下都能按预期工作。
总结
通过在Maven插件中注入MavenSession并检查session.getRequest().isInteractiveMode()，开发者可以准确判断Maven当前是否以批处理模式运行。这一能力对于编写健壮、适应性强的Maven插件至关重要，尤其是在需要支持自动化构建流程的场景下。合理利用这一机制，可以显著提升插件的用户体验和自动化兼容性。
