ShrinkWrap Resolvers 技术文档

1. 安装指南

环境要求

• JDK: 版本 8 或更新。
• Maven: 版本 3.6.3 或更新（用于构建），版本 3.3.9 或更新（用于使用）。
• Gradle: 版本 3 或更新（用于使用）。

添加 ShrinkWrap Resolvers 到项目

在 Maven 项目中，可以通过在 pom.xml 文件中添加以下依赖来引入 ShrinkWrap Resolvers：

<dependencies>
    <dependency>
      <groupId>org.jboss.shrinkwrap.resolver</groupId>
      <artifactId>shrinkwrap-resolver-depchain</artifactId>
      <version>${version.shrinkwrap.resolvers}</version>
      <scope>test</scope>
      <type>pom</type>
    </dependency>
</dependencies>

如果你使用的是 Arquillian BOM 版本早于 1.1.0.Final，请确保在 Arquillian BOM 之前导入 ShrinkWrap Resolvers BOM，以获取 2.0.x 版本。

2. 项目使用说明

依赖解析

ShrinkWrap Resolvers 提供了 org.jboss.shrinkwrap.resolver.api.maven.Maven 类来启动依赖解析。以下是一些常见的使用场景：

通过 Maven 坐标解析文件

Maven 坐标遵循 groupId:artifactId:[packagingType:[classifier]]:version 格式。你可以使用这些坐标来解析文件。

• 解析包含传递依赖的文件：

  File[] files = Maven.resolver().resolve("G:A:V").withTransitivity().asFile();
  

• 解析单个文件，不包含传递依赖：

  File file = Maven.resolver().resolve("G:A:V").withoutTransitivity().asSingleFile();
  

• 解析多个工件：

  File[] files = Maven.resolver().resolve("G1:A1:V1", "G2:A2:V2").withTransitivity().asFile();
  

指定打包类型和分类器

File file = Maven.resolver().resolve("G:A:war:V").withTransitivity().asFile();
File fileWithClassifier = Maven.resolver().resolve("G:A:test-jar:tests:V").withTransitivity().asFile();

返回解析的工件

ShrinkWrap Resolvers 提供了多种选项来获取解析的工件，如文件、流、URL 或特定的归档类型（如 JavaArchive、WebArchive 或 EnterpriseArchive）。

// 获取解析的工件为 URL
URL[] urls = Maven.resolver().resolve("G:A:V").withTransitivity().as(URL.class);
// 获取解析的工件为 JAR
JavaArchive[] jars = Maven.resolver().resolve("G:A:V").withTransitivity().as(JavaArchive.class);
// 获取解析的工件为 WAR
WebArchive war = Maven.resolver().resolve("G:A:war:V").withTransitivity().asSingle(WebArchive.class);

3. 项目 API 使用文档

工件元数据操作

MavenResolvedArtifact artifact = Maven.resolver().resolve("G:A:war:V").withoutTransitivity()
  .asSingle(MavenResolvedArtifact.class);
MavenCoordinate coordinates = artifact.getCoordinate();
MavenArtifactInfo[] dependencies = artifact.getDependencies();
String version = artifact.getResolvedVersion();
ScopeType scope = artifact.getScope();
// 你仍然可以从 MavenResolvedArtifact 中获取解析的工件
File file = artifact.asFile();

工件坐标操作

MavenCoordinate[] coordinates = Maven.resolver().resolve("G:A:V")
   .withTransitivity().as(MavenCoordinate.class);

解析工件为集合

List<File> files = Maven.resolver().resolve("G:A:V")
    .withTransitivity().asList(File.class);

排除特定依赖

File file = Maven.resolver().addDependencies(
    MavenDependencies.createDependency("G:A:V", ScopeType.COMPILE, false,
      MavenDependencies.createExclusion("G:B"))).resolve().withTransitivity().asFile();

使用策略控制解析结果

File file = Maven.resolver().resolve("G:A:V").using(new RejectDependenciesStrategy(false, "G:B")).asFile();

4. 项目安装方式

控制解析源

ShrinkWrap Resolvers 允许你指定工件解析的源。默认情况下，它使用类路径（Maven Reactor）和 Maven Central 仓库。

// 禁用类路径解析
Maven.configureResolver().withClassPathResolution(false).resolve("G:A:V").withTransitivity().asFile();
// 禁用使用 Maven Central 仓库
Maven.configureResolver().withMavenCentralRepo(false).resolve("G:A:V").withTransitivity().asFile();
// 启用离线模式，仅使用本地缓存
Maven.configureResolver().workOffline().resolve("G:A:V").withTransitivity().asFile();
// 忽略本地仓库中的工件来源
Maven.configureResolver().useLegacyLocalRepo(true).resolve("G:A:V").withTransitivity().asFile();

指定 settings.xml

Maven.configureResolver().fromFile("/path/to/settings.xml")
  .resolve("G:A:V").withTransitivity().asFile();

Maven.configureResolver().fromClassloaderResource("path/to/settings.xml")
  .resolve("G:A:V").withTransitivity().asFile();

手动定义 Maven 仓库

Maven.configureResolver().withRemoteRepo("my-repository-id", "url://to/my/repository", "layout")
  .resolve("G:A:V").withTransitivity().asFile();

Maven.configureResolver().withRemoteRepo(MavenRemoteRepositories.createRemoteRepository("my-repository-id", "url://to/my/repository", "layout"))
  .resolve("G:A:V").withTransitivity().asFile();

从 POM 文件解析工件

在 Maven 项目中，依赖项在 pom.xml 文件中指定。ShrinkWrap Resolvers 遵循 DRY 原则，自动加载这些元数据。

Maven.resolver().loadPomFromFile("/path/to/pom.xml").resolve("G:A").withTransitivity().asFile();

版本范围解析

ShrinkWrap Resolver API 允许解析请求范围内的可用版本信息。

final MavenVersionRangeResult versionRangeResult = Maven.resolver().resolveVersionRange("G:A:[1.0.0]");

系统属性

ShrinkWrap Resolvers 允许通过系统属性覆盖任何程序化配置。

• org.apache.maven.user-settings: 用户 settings.xml 文件的路径。
• org.apache.maven.global-settings: 全局 settings.xml 文件的路径。
• settings.security: settings-security.xml 的路径，包含加密的主密码。
• org.apache.maven.offline: 离线模式标志。
• org.apache.maven.flat: 平铺模式标志。