文档AEM 6.4部署指南

配置OSGi configuring-osgi

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 开发人员
CAUTION
AEM 6.4已结束扩展支持，本文档将不再更新。 有关更多详细信息，请参阅 技术支助期. 查找支持的版本 此处.

OSGi 是Adobe Experience Manager(AEM)技术堆栈中的一个基本元素。 它用于控制AEM的复合包及其配置。

OSGi "提供标准化的基元，允许应用程序从可重用的小组件和协作组件构建。 这些组件可以组合成应用程序并进行部署"

这样可以轻松管理包，因为可以单独停止、安装和启动包。 互依关系会自动处理。 每个OSGi组件(请参阅 OSGi规范)包含在各种包中的一个包中。

您可以通过以下任一方式管理此类包的配置设置：

虽然存在细微差异，但这两种方法均可使用，主要与 运行模式:

  • Adobe CQ Web控制台

    • Web控制台是OSGi配置的标准界面。 它提供了用于编辑各种属性的UI，在这些属性中，可以从预定义列表中选择可能的值。

      因此，这是最简单的方法。

    • 使用Web控制台进行的任何配置都将立即应用并适用于当前实例，而与当前运行模式无关，也与后续对运行模式所做的任何更改无关。

  • 配置文件

    • 包含在Web控制台中定义的设置。
    • 可以包含在内容包中，以供在其他实例上使用。

  • 存储库中的内容节点(sling:osgiConfig)

    • 这需要使用CRXDE Lite进行手动配置。
    • 由于 sling:OsgiConfig 节点，您可以将配置绑定到特定 运行模式. 您甚至可以在同一存储库中保存多个运行模式的配置。
    • 立即应用任何适当的配置（取决于运行模式）。

无论您使用哪种方法，所有这些配置方法：

  • 确保复制或复制存储库内容会重新创建相同的配置。
  • 允许您将配置签出到FileVault或Subversion;安全或进一步更新。
  • 可以保存在包中，以便在设置其他实例时使用。
  • 允许您使用脚本执行配置转出以传播配置详细信息。
NOTE
以下列出了某些重要设置的详细信息： OSGi配置设置。

使用Web控制台进行OSGi配置 osgi-configuration-with-the-web-console

的 Web控制台 在AEM中，提供了用于配置包的标准化界面。 的 配置 选项卡用于配置OSGi包，因此是配置AEM系统参数的基础机制。

所做的任何更改都会立即应用于相关的OSGi配置，无需重新启动。

NOTE
在Web控制台中所做的更改会保存在存储库中，如下所示 配置文件. 这些组件可以包含在内容包中，以供在进一步安装中重复使用。
NOTE
在Web控制台中，任何提及默认设置的描述都与Sling默认值相关。
Adobe Experience Manager有其自己的默认值，因此默认设置可能与控制台中记录的默认值不同。

要使用Web控制台更新配置，请执行以下操作：

  1. 访问 配置 选项卡，方法是：

    • 从 工具 — >操作 菜单。 登录控制台后，您可以使用下拉菜单：

      OSGi >

    • 直接URL;例如：

      http://localhost:4502/system/console/configMgr
      将显示一个列表。

  2. 通过以下任一方式选择要配置的包：

    • 单击 编辑 图标
    • 单击 名称 包的

  3. 此时将打开一个对话框。 您可以在此处根据需要进行编辑；例如，将 日志级别 to INFO:

    chlimage_1-140

    note note
    NOTE
    更新在存储库中保存为 配置文件. 要在之后找到这些标识（例如，要包含在内容包中以供在其他实例上使用），您应记下永久标识( PID)。

  4. 单击“保存”。

    您所做的更改会立即应用于正在运行的系统的相关OSGi配置，无需重新启动。

    note note
    NOTE
    您现在可以找到相关 配置文件;例如，包含在内容包中以供在其他实例上使用。

包含配置文件的OSGi配置 osgi-configuration-with-configuration-files

使用Web控制台进行的配置更改将作为配置文件保留在存储库中( .config)下：

/apps

这些文件包可以包含在内容包中，并可在其他实例上重复使用。

NOTE
配置文件的格式非常具体 — 请参阅 Sling Apache文档 以了解完整详细信息。
因此，建议通过在Web控制台中进行实际更改来创建和维护配置文件。

Web控制台不显示您所做的更改已保存在存储库中的位置，但可以轻松找到这些更改：

  1. 创建配置文件的方式 在web控制台中进行初始更改.

  2. 打开CRXDE Lite。

  3. 在 工具 菜单选择 查询…… .

  4. 提交查询 类型 SQL 以搜索已更新配置的PID。

    例如， Apache Felix OSGi管理控制台 具有以下项的永久标识(PID):

    org.apache.felix.webconsole.internal.servlet.OsgiManager

    因此SQL查询可以是：

    code language-shell 
    select * from nt:base where jcr:path like '/apps/%' and contains(*, 'org.apache.felix.webconsole.internal.servlet.OsgiManager')

  5. 将显示配置文件节点。

    对于上例：

    /apps/system/config/org.apache.felix.webconsole.internal.servlet.OsgiManager.config

    note caution
    CAUTION
    您可以打开此文件以查看您所做的更改，但为避免键入错误，建议使用控制台进行实际更改。

  6. 您现在可以构建包含此节点的内容包，并根据需要在其他实例中使用。

存储库中的OSGi配置 osgi-configuration-in-the-repository

除了使用Web控制台之外，您还可以在存储库中定义配置详细信息。 这样，您就可以轻松配置不同的运行模式。

这些配置是通过创建 sling:OsgiConfig 库中供系统引用的节点。 这些节点将镜像OSGi配置，并与它们形成用户界面。 要更新配置数据，请更新节点属性。

如果修改存储库中的配置数据，则所做的更改会立即应用于相关OSGi配置，就像更改是使用Web控制台进行的一样，并进行相应的验证和一致性检查。 这也适用于从中复制配置的操作 /libs/ to /apps/.

由于同一配置参数可以位于多个位置，因此系统：

  • 搜索所有类型的节点 sling:OsgiConfig
  • 根据服务名称过滤
  • 根据运行模式筛选
NOTE
另请阅读 如何仅为特定实例定义基于存储库的配置.

向存储库添加新配置 adding-a-new-configuration-to-the-repository

您需要了解的信息 what-you-need-to-know

要向存储库添加新配置，您需要了解以下信息：

  1. 的 永久标识 (PID)。

    引用 配置 字段。 名称将显示在包名称后面的方括号中(或 配置信息 )。

    例如，创建节点 com.day.cq.wcm.core.impl.VersionManagerImpl. 配置 AEM WCM版本管理器.

    chlimage_1-141

  2. 是否 运行模式 必需。 创建文件夹：

    • config — 用于所有运行模式
    • config.author — 对于创作环境
    • config.publish — 对于发布环境
    • config.<run-mode> - 酌情

  3. 是否 配置 或 工厂配置 必需。

  4. 要配置的各个参数；包括需要重新创建的任何现有参数定义。

    在Web控制台中引用单个参数字段。 每个参数的名称都用方括号括起来。

    例如，创建属性
    versionmanager.createVersionOnActivation 配置 激活时创建版本.

    chlimage_1-142

  5. 中是否已存在配置 /libs? 要列出实例中的所有配置，请使用 查询 工具，用于提交以下SQL查询：

    select * from sling:OsgiConfig

    如果是，则此配置可以复制到 /apps/<yourProject>/，然后在新位置中自定义。

在存储库中创建配置 creating-the-configuration-in-the-repository

要将新配置实际添加到存储库，请执行以下操作：

  1. 使用CRXDE Lite导航到：

    /apps/<yourProject>

  2. 如果尚未存在，请创建 config 文件夹( sling:Folder):

    • config — 适用于所有运行模式
    • config.<run-mode> — 特定于特定运行模式

  3. 在此文件夹下，创建一个节点：

    • 类型: sling:OsgiConfig

    • 名称：持久身份(PID);

      例如，AEM Wcm Version Manager使用 com.day.cq.wcm.core.impl.VersionManagerImpl

    note note
    NOTE
    在附加工厂配置时 -<identifier> 名称。
    如下所示： org.apache.sling.commons.log.LogManager.factory.config-<identifier>
    其中 <identifier> 替换为您（必须）输入以标识实例的自由文本（您不能忽略此信息）；例如：
    org.apache.sling.commons.log.LogManager.factory.config-MINE

  4. 对于要配置的每个参数，在此节点上创建一个属性：

    • 名称：Web控制台中显示的参数名称；字段描述末尾的括号中显示该名称。 例如， Create Version on Activation use versionmanager.createVersionOnActivation
    • 类型：酌情。
    • 值：。

    您只需为要配置的参数创建属性，其他参数仍将采用AEM设置的默认值。

  5. 保存所有更改。

    通过重新启动服务来更新节点后，会立即应用更改（与在Web控制台中所做的更改一样）。

CAUTION
您不得在 /libs 路径。
CAUTION
配置的完整路径必须正确，才能在启动时读取。

配置详细信息 configuration-details

启动时的分辨率顺序 resolution-order-at-startup

使用以下优先顺序：

  1. 下的存储库节点 /apps/*/config...类型为 sling:OsgiConfig 或属性文件。

  2. 具有类型的存储库节点 sling:OsgiConfig 在 /libs/*/config.... （现成定义）。

  3. 任意 .config 文件 <*cq-installation-dir*>/crx-quickstart/launchpad/config/.... 在本地文件系统上。

这表示 /libs 中的项目特定配置可能会掩盖 /apps.

运行时的解决顺序 resolution-order-at-runtime

在系统运行时所做的配置更改会通过修改的配置触发重新加载。

然后，将按以下优先顺序应用：

  1. 在Web控制台中修改配置将立即生效，因为它在运行时具有优先权。
  2. 在中修改配置 /apps 会立即生效。
  3. 在中修改配置 /libs 将立即生效，除非它被中的配置掩盖 /apps.

多运行模式的分辨率 resolution-of-multiple-run-modes

对于特定于运行模式的配置，可以组合多种运行模式。 例如，您可以按以下样式创建配置文件夹：

/apps/*/config.<runmode1>.<runmode2>/

如果所有运行模式都与启动时定义的运行模式匹配，则将应用此类文件夹中的配置。

例如，如果实例是以运行模式启动的 author,dev,emea，配置节点 /apps/*/config.emea, /apps/*/config.author.dev/ 和 /apps/*/config.author.emea.dev/ 将应用，而 /apps/*/config.author.asean/ 和 /config/author.dev.emea.noldap/ 将不应用。

如果同一PID的多个配置适用，则应用匹配运行模式数目最多的配置。

例如，如果实例是以运行模式启动的 author,dev,emea和 /apps/*/config.author/ 和 /apps/*/config.emea.author/ 为定义配置
com.day.cq.wcm.core.impl.VersionManagerImpl，中的配置 /apps/*/config.emea.author/ 中，将被应用。

此规则的粒度处于PID级别。
您不能在 /apps/*/config.author/ 更具体的 /apps/*/config.emea.author/ 相同PID。
具有最大匹配运行模式数的配置将对整个PID有效。

标准配置 standard-configurations

以下列表显示了存储库中可用配置的一小部分（在标准安装中）：

  • 作者 — AEM WCM过滤器：

    libs/wcm/core/config.author/com.day.cq.wcm.core.WCMRequestFilter

  • 发布 — AEM WCM过滤器：

    libs/wcm/core/config.publish/com.day.cq.wcm.core.WCMRequestFilter

  • 发布 — AEM WCM页面统计信息：

    libs/wcm/core/config.publish/com.day.cq.wcm.core.stats.PageViewStatistics

NOTE
由于这些配置位于 /libs 不得直接编辑，而是复制到您的应用程序区域( /apps)。

要列出实例中的所有配置节点，请使用 查询 CRXDE Lite中用于提交以下SQL查询的功能：

select * from sling:OsgiConfig

配置持久性 configuration-persistence

  • 如果通过Web控制台更改配置，则该配置（通常）会写入存储库中，具体位置为：

    /apps/{somewhere}

    • 默认情况下 {somewhere} is system/config 这样配置就会写入

      /apps/system/config

    • 但是，如果您正在编辑最初来自存储库其他位置的配置：例如：

      /libs/foo/config/someconfig

      然后，将更新后的配置写在原始位置下；例如：

      /apps/foo/config/someconfig

  • 更改的设置 admin 保存在 *.config 文件位于：

    code language-none 
       /crx-quickstart/launchpad/config

    • 这是OSGi配置管理员的专用数据区域，它包含 admin，无论他们是如何进入系统的。

    • 这是实施详细信息，您绝不能直接编辑此目录。

    • 但是，了解这些配置文件的位置以便可以获取备份和/或多个安装的副本是有用的：

      • Apache Felix OSGi管理控制台

        ../crx/org/apache/felix/webconsole/internal/servlet/OsgiManager.config

      • CRX Sling客户端存储库

        ../com/day/crx/sling/client/impl/CRXSlingClientRepository/<pid-nr>.config

CAUTION
您必须 从 编辑以下文件夹或文件：
/crx-quickstart/launchpad/config
recommendation-more-help
6a71a83d-c2e0-4ce7-a6aa-899aa3885b56