Maven 插件元数据模型

插件元数据

与基于脚本的 mojo 一起使用的插件描述符元数据。

<pluginMetadata xmlns="http://maven.apache.org/PLUGIN-METADATA/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/PLUGIN-METADATA/1.1.0 http://maven.apache.org/xsd/plugin-metadata-1.1.0.xsd">
  <mojos>
    <mojo>
      <goal/>
      <phase/>
      <aggregator/>
      <requiresDependencyResolution/>
      <requiresProject/>
      <requiresReports/>
      <requiresOnline/>
      <inheritByDefault/>
      <requiresDirectInvocation/>
      <execution>
        <lifecycle/>
        <phase/>
        <goal/>
      </execution>
      <components>
        <component>
          <role/>
          <hint/>
        </component>
      </components>
      <parameters>
        <parameter>
          <name/>
          <alias/>
          <property/>
          <required/>
          <readonly/>
          <expression/>
          <defaultValue/>
          <type/>
          <description/>
          <deprecated/>
          <since/>
        </parameter>
      </parameters>
      <description/>
      <deprecated/>
      <since/>
      <call/>
    </mojo>
  </mojos>
</pluginMetadata>

插件元数据

基于脚本的 mojo 插件元数据绑定的根元素。

元素	类型	自从	描述
`mojos/mojo*`	`List<Mojo>`		（许多）随附脚本中包含的 mojos 列表。

魔力

Mojo 描述符定义。

元素	类型	自从	描述
`goal`	`String`		用于调用此 mojo 的目标的名称。
`phase`	`String`		默认情况下，此 mojo 应绑定到的阶段。
`aggregator`	`boolean`		当反应器运行时，此 mojo 是否作为聚合器运行。也就是说，只运行一次。默认值为：`false`。
`requiresDependencyResolution`	`String`		此 mojo 需要解决的依赖关系范围。
`requiresProject`	`boolean`		此 mojo 是否需要项目实例才能执行。默认值为：`false`。
`requiresReports`	`boolean`		此 mojo 是否需要 POM 中的报告部分。默认值为：`false`。
`requiresOnline`	`boolean`		此 mojo 是否需要在线模式才能正常运行。默认值为：`false`。
`inheritByDefault`	`boolean`		默认情况下，此 mojo 的配置是否应沿 POM 继承链传播。默认值为：`false`。
`requiresDirectInvocation`	`boolean`		如果为 true，则只能直接调用此 mojo（例如，直接在命令行上指定）。默认值为：`false`。
`execution`	`LifecycleExecution`		有关应处理的 Maven 生命周期的子执行的信息。
`components/component*`	`List<Component>`		（许多）此 mojo 所需的丛组件列表。
`parameters/parameter*`	`List<Parameter>`		（许多）此 mojo 使用的参数列表。
`description`	`String`		此参数的说明。
`deprecated`	`String`		此 mojo 参数的弃用消息。
`since`	`String`	1.1.0	将 mojo 添加到 API 时的版本。
`call`	`String`		执行此 mojo 时要调用的脚本中的目标/方法。

执行

生命周期的子流程执行，以满足 mojo 的需求。

元素	类型	描述
`lifecycle`	`String`	在执行之前应用于子生命周期的覆盖的名称。如果指定，此生命周期覆盖定义将与插件捆绑在一起。
`phase`	`String`	子生命周期中的阶段。
`goal`	`String`	一个目标，不附加到生命周期阶段，应该在这个 mojo 之前执行。

零件

对 plexus 组件的引用，假定可用于插件容器。

元素	类型	自从	描述
`role`	`String`		要查找的组件角色。
`hint`	`String`		要查找的角色提示。

范围

mojo 使用的参数，可从命令行或 POM 配置部分进行配置。

元素	类型	自从	描述
`name`	`String`		参数名称
`alias`	`String`		参数的备用名称。
`property`	`String`		用于使用此参数配置 mojo 的 JavaBeans 属性名称。
`required`	`boolean`		是否需要此参数。默认值为：`false`。
`readonly`	`boolean`		该参数是否可以直接编辑。如果为 false，则此参数要么派生自另一个 POM 元素，要么引用构建系统的运行时实例。默认值为：`false`。
`expression`	`String`		对该参数的命令行引用。
`defaultValue`	`String`		${instance.property} 形式的表达式，用于提取此参数的值，尤其是从构建系统中的运行时实例中。（例如，${project.build.directory} 引用 project.getBuild().getDirectory()）
`type`	`String`		此参数的 java 类型。
`description`	`String`		此参数的说明。
`deprecated`	`String`		此 mojo 参数的弃用消息。
`since`	`String`	1.1.0	添加参数时的版本。