文档AEMAEM 教程AEM Foundation 教程

安装第三方工件 — 在公共Maven存储库中不可用

Last update: Mon Sep 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 中级
  • 开发人员

了解如何在生成和部署AEM项目时安装公共Maven存储库​ 中不可用的 ​第三方工件。

第三方工件 ​可以是：

  • OSGi捆绑包： OSGi捆绑包是一个Java™存档文件，它包含Java类、资源以及描述捆绑包及其依赖项的清单。
  • Java jar：包含Java类和资源的Java™存档文件。
  • 包：包是包含文件系统序列化形式的存储库内容的zip文件。

标准方案

AEM通常，您会安装​ 在公共Maven存储库中作为依赖项pom.xml文件提供的第三方包。

例如：

  • AEM WCM核心组件 包 ​已添加为WKND项目的 pom.xml文件中的依赖项。 此处provided范围用作AEM运行时提供的AEM WCM核心组件包。 如果AEM运行时未提供该捆绑包，则您将使用compile作用域，并且它是默认作用域。

  • WKND共享 包 ​已添加为WKND项目的 pom.xml文件中的依赖项。

罕见场景

有时，在生成和部署AEM项目时，您可能需要安装第三方捆绑包、jar或包​ ，这些捆绑包或在Maven中央存储库或Adobe公共存储库中不可用。

原因可能是：

  • 捆绑包或包由内部团队或第三方供应商提供，在公共Maven存储库 ​中不可用。

  • Java™ jar文件​ 不是OSGi捆绑包，并且在公共Maven存储库中可能可用，也可能不可用。

  • 您需要的功能尚未在公共Maven存储库中提供的最新版第三方软件包中发布。 您决定安装本地构建的RELEASE或SNAPSHOT版本。

先决条件

要学习本教程，您需要：

设置

  • 设置AEM 6.X、AEM as a Cloud Service (AEMCS)本地开发环境或RDE环境。

  • 克隆和部署AEM WKND项目。

    code language-none 
    $ git clone git@github.com:adobe/aem-guides-wknd.git
$ cd aem-guides-wknd
$ mvn clean install -PautoInstallPackage

    验证WKND网站页面是否正确呈现。

在AEM项目中安装第三方捆绑包 install-third-party-bundle

让我们将公共Maven存储库​ 中不可用的 ​演示OSGi my-example-bundle安装并用于AEM WKND项目。

my-example-bundle ​导出HelloWorldService OSGi服务，其sayHello()方法返回Hello Earth!消息。

有关详细信息，请参阅my-example-bundle.zip文件中的README.md文件。

将包添加到all模块

第一步是将my-example-bundle添加到AEM WKND项目的all模块。

  • 下载并解压缩my-example-bundle.zip文件。

  • 在AEM WKND项目的all模块中，创建all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install目录结构。 /all/src/main/content目录存在，您只需要创建jcr_root/apps/wknd-vendor-packages/container/install目录。

  • 将my-example-bundle-1.0-SNAPSHOT.jar文件从提取的target目录复制到上述all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install目录。

    所有模块中的 第三方包

使用捆绑包中的服务

让我们使用AEM WKND项目中my-example-bundle的HelloWorldService OSGi服务。

  • 在AEM WKND项目的core模块中，创建SayHello.java Sling servlet @ core/src/main/java/com/adobe/aem/guides/wknd/core/servlet。

    code language-java 
    package com.adobe.aem.guides.wknd.core.servlet;

import java.io.IOException;

import javax.servlet.Servlet;
import javax.servlet.ServletException;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.ServletResolverConstants;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import com.example.services.HelloWorldService;

@Component(service = Servlet.class, property = {
    ServletResolverConstants.SLING_SERVLET_PATHS + "=/bin/sayhello",
    ServletResolverConstants.SLING_SERVLET_METHODS + "=" + HttpConstants.METHOD_GET
})
public class SayHello extends SlingSafeMethodsServlet {

        private static final long serialVersionUID = 1L;

        // Injecting the HelloWorldService from the `my-example-bundle` bundle
        @Reference
        private HelloWorldService helloWorldService;

        @Override
        protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServletException, IOException {
            // Invoking the HelloWorldService's `sayHello` method
            response.getWriter().write("My-Example-Bundle service says: " + helloWorldService.sayHello());
        }
}

  • 在AEM WKND项目的根pom.xml文件中，将my-example-bundle添加为依赖项。

    code language-xml 
    ...
<!-- My Example Bundle -->
<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-example-bundle</artifactId>
    <version>1.0-SNAPSHOT</version>
    <scope>system</scope>
    <systemPath>${maven.multiModuleProjectDirectory}/all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install/my-example-bundle-1.0-SNAPSHOT.jar</systemPath>
</dependency>
...

    此处：

    • system范围表示不应在公共Maven存储库中查找依赖项。
    • systemPath是AEM WKND项目的all模块中my-example-bundle文件的路径。
    • ${maven.multiModuleProjectDirectory}是一个指向多模块项目根目录的Maven属性。

  • 在AEM WKND项目的core模块的core/pom.xml文件中，将my-example-bundle添加为依赖项。

    code language-xml 
    ...
<!-- My Example Bundle -->
<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-example-bundle</artifactId>
</dependency>
...

  • 使用以下命令生成和部署AEM WKND项目：

    code language-none 
    $ mvn clean install -PautoInstallPackage

  • 通过访问浏览器中的URL http://localhost:4502/bin/sayhello，验证SayHello servlet是否按预期工作。

  • 将以上更改提交到AEM WKND项目的存储库。 然后通过运行Cloud Manager管道来验证RDE或AEM环境中的更改。

    验证SayHello servlet — 捆绑包服务

AEM WKND项目的tutorial/install-3rd-party-bundle分支具有上述更改以供您参考。

重要学习 key-learnings-bundle

可通过以下步骤在AEM项目中安装公共Maven存储库中不可用的OSGi包：

  • 将OSGi包复制到all模块的jcr_root/apps/<PROJECT-NAME>-vendor-packages/container/install目录。 要打包捆绑包并将其部署到AEM实例，必须执行此步骤。

  • 更新根和核心模块的pom.xml文件，将OSGi包添加为具有system作用域和systemPath指向包文件的依赖项。 此步骤是编译项目所必需的。

在AEM项目中安装第三方jar

在此示例中，my-example-jar不是OSGi捆绑包，而是Java jar文件。

让我们安装并使用演示my-example-jar，该演示​ 在公共Maven存储库 ​中不可用于AEM WKND项目。

my-example-jar ​是一个Java jar文件，该文件包含带有sayHello()方法的MyHelloWorldService类，并返回Hello World!消息。

有关详细信息，请参阅my-example-jar.zip文件中的README.md文件。

将jar添加到all模块

第一步是将my-example-jar添加到AEM WKND项目的all模块。

  • 下载并解压缩my-example-jar.zip文件。

  • 在AEM WKND项目的all模块中，创建all/resource/jar目录结构。

  • 将my-example-jar-1.0-SNAPSHOT.jar文件从提取的target目录复制到上述all/resource/jar目录。

    所有模块中的 3rd-party-jar

使用jar中的服务

让我们在AEM WKND项目中使用my-example-jar中的MyHelloWorldService。

  • 在AEM WKND项目的core模块中，创建SayHello.java Sling servlet @ core/src/main/java/com/adobe/aem/guides/wknd/core/servlet。

    code language-java 
    package com.adobe.aem.guides.wknd.core.servlet;

import java.io.IOException;

import javax.servlet.Servlet;
import javax.servlet.ServletException;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.ServletResolverConstants;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.osgi.service.component.annotations.Component;

import com.my.example.MyHelloWorldService;

@Component(service = Servlet.class, property = {
        ServletResolverConstants.SLING_SERVLET_PATHS + "=/bin/sayhello",
        ServletResolverConstants.SLING_SERVLET_METHODS + "=" + HttpConstants.METHOD_GET
})
public class SayHello extends SlingSafeMethodsServlet {

    private static final long serialVersionUID = 1L;

    @Override
    protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response)
            throws ServletException, IOException {

        // Creating an instance of MyHelloWorldService
        MyHelloWorldService myHelloWorldService = new MyHelloWorldService();

        // Invoking the MyHelloWorldService's `sayHello` method
        response.getWriter().write("My-Example-JAR service says: " + myHelloWorldService.sayHello());
    }
}

  • 在AEM WKND项目的根pom.xml文件中，将my-example-jar添加为依赖项。

    code language-xml 
    ...
<!-- My Example JAR -->
<dependency>
    <groupId>com.my.example</groupId>
    <artifactId>my-example-jar</artifactId>
    <version>1.0-SNAPSHOT</version>
    <scope>system</scope>
    <systemPath>${maven.multiModuleProjectDirectory}/all/resource/jar/my-example-jar-1.0-SNAPSHOT.jar</systemPath>
</dependency>
...

    此处：

    • system范围表示不应在公共Maven存储库中查找依赖项。
    • systemPath是AEM WKND项目的all模块中my-example-jar文件的路径。
    • ${maven.multiModuleProjectDirectory}是一个指向多模块项目根目录的Maven属性。

  • 在AEM WKND项目的core模块的core/pom.xml文件中，进行两项更改：

    • 将my-example-jar添加为依赖项。

      code language-xml 
      ...
<!-- My Example JAR -->
<dependency>
    <groupId>com.my.example</groupId>
    <artifactId>my-example-jar</artifactId>
</dependency>
...

    • 更新bnd-maven-plugin配置以将my-example-jar包含在正在构建的OSGi捆绑包(aem-guides-wknd.core)中。

      code language-xml 
      ...
<plugin>
    <groupId>biz.aQute.bnd</groupId>
    <artifactId>bnd-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>bnd-process</id>
            <goals>
                <goal>bnd-process</goal>
            </goals>
            <configuration>
                <bnd><![CDATA[
            Import-Package: javax.annotation;version=0.0.0,*
            <!-- Include the 3rd party jar as inline resource-->
            -includeresource: \
            lib/my-example-jar.jar=my-example-jar-1.0-SNAPSHOT.jar;lib:=true
                    ]]></bnd>
            </configuration>
        </execution>
    </executions>
</plugin>
...

  • 使用以下命令生成和部署AEM WKND项目：

    code language-none 
    $ mvn clean install -PautoInstallPackage

  • 通过访问浏览器中的URL http://localhost:4502/bin/sayhello，验证SayHello servlet是否按预期工作。

  • 将以上更改提交到AEM WKND项目的存储库。 然后通过运行Cloud Manager管道来验证RDE或AEM环境中的更改。

    验证SayHello servlet - JAR服务

AEM WKND项目的tutorial/install-3rd-party-jar分支具有上述更改以供您参考。

如果Java jar文件​ 在公共Maven存储库中可用，但不是OSGi捆绑包，则可以按照上述步骤操作，但<dependency>的system作用域和systemPath元素不是必需的。

重要学习 key-learnings-jar

可以按照以下步骤在AEM项目中安装非OSGi捆绑包并且可能在公共Maven存储库中提供的Java Jar：

  • 更新核心模块pom.xml文件中的bnd-maven-plugin配置，以将Java jar作为内联资源包含在正在生成的OSGi包中。

仅当Java jar在公共Maven存储库中不可用时，才需要执行以下步骤：

  • 将Java jar复制到all模块的resource/jar目录。

  • 更新根和核心模块的pom.xml文件，将Java jar添加为具有system作用域和systemPath指向jar文件的依赖项。

在AEM项目中安装第三方软件包

让我们安装从主分支本地构建的ACS AEM Commons SNAPSHOT ​版本。

它只是为了演示安装公共Maven存储库中没有的AEM包的步骤。

ACS AEM Commons包在公共Maven存储库中可用。 请参阅将ACS AEM Commons添加到您的AEM Maven项目，以将其添加到AEM项目。

将包添加到all模块

第一步是将包添加到AEM WKND项目的all模块。

  • 从POM文件中注释或删除ACS AEM Commons版本依赖项。 请参阅将ACS AEM Commons添加到您的AEM Maven项目以确定依赖关系。

  • 将ACS AEM Commons存储库的master分支克隆到本地计算机。

  • 使用以下命令构建ACS AEM Commons SNAPSHOT版本：

    code language-none 
    $mvn clean install

  • 本地生成的包位于@ all/target，有两个.zip文件，一个以-cloud结尾，适用于AEM as a Cloud Service，另一个适用于AEM 6.X。

  • 在AEM WKND项目的all模块中，创建all/src/main/content/jcr_root/apps/wknd-vendor-packages/container/install目录结构。 /all/src/main/content目录存在，您只需要创建jcr_root/apps/wknd-vendor-packages/container/install目录。

  • 将本地生成的包(.zip)文件复制到/all/src/main/content/jcr_root/apps/mysite-vendor-packages/container/install目录。

  • 使用以下命令生成和部署AEM WKND项目：

    code language-none 
    $ mvn clean install -PautoInstallPackage

  • 验证已安装的ACS AEM Commons包：

    • CRX包管理器@ http://localhost:4502/crx/packmgr/index.jsp

      ACS AEM Commons快照版本包

    • OSGi控制台@ http://localhost:4502/system/console/bundles

      ACS AEM Commons快照版本包

  • 将以上更改提交到AEM WKND项目的存储库。 然后通过运行Cloud Manager管道来验证RDE或AEM环境中的更改。

重要学习 key-learnings-package

可通过以下步骤将公共Maven存储库中不可用的AEM包安装到AEM项目中：

  • 将包复制到all模块的jcr_root/apps/<PROJECT-NAME>-vendor-packages/container/install目录。 要将包打包并部署到AEM实例，必须执行此步骤。

摘要

在本教程中，您已了解如何在生成和部署AEM项目时安装公共Maven存储库中不可用的第三方工件（捆绑包、Java jar和包）。

recommendation-more-help
c92bdb17-1e49-4e76-bcdd-89e4f85f45e6