配置OSGi

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

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

这样可以轻松管理捆绑套件，因为可以单独停止、安装和启动捆绑套件。 互依关系将自动处理。 每个OSGi组件（请参见OSGi规范）都包含在各种包之一中。

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

• 使用Adobe CQ Web控制台
• 使用配置文件
• 在存储库](#osgi-configuration-in-the-repository)中配置[content-nodes(sling:OsgiConfig)

尽管存在细微差异，但可以使用两种方法，主要与运行模式相关：

• Adobe CQ Web控制台

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

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

  • 使用Web控制台进行的任何配置都将立即应用并适用于当前实例，而不管当前运行模式或随后对运行模式的任何更改。

• 配置文件

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

• 存储库中的content-nodes(sling:osgiConfig)

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

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

• 确保复制或复制存储库内容会重新创建相同的配置。
• 允许您将配置签出到FileVault或Subversion;用于安全或更新。
• 可以保存在包中，以便在设置其他实例时使用。
• 允许您使用脚本来传播配置详细信息来执行配置推出。

使用Web控制台进行OSGi配置

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

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

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

1. 通过以下任一方式访问Web控制台的​配置​选项卡：

   • 从​工具 — >操作​菜单上的链接打开Web控制台。 登录控制台后，您可以使用以下下拉菜单：

     OSGi >

   • 直接URL;例如：

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

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

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

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

   

   注意

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

4. 单击​保存。

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

   注意

   您现在可以找到相关的配置文件;例如，包含在内容包中以用于其他实例。

配置文件的OSGi配置

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

/apps

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

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

1. 通过在Web控制台中进行初始更改来创建配置文件。

2. 打开CRXDE Lite。

3. 在​工具​菜单中，选择​查询…。

4. 提交​Type SQL的查询，以搜索已更新的配置的PID。

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

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

   因此SQL查询可以是：

   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

   注意

   您可以打开此文件以视图更改，但为避免键入错误，建议使用控制台进行实际更改。

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

存储库中的OSGi配置

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

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

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

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

• 搜索类型为sling:OsgiConfig的所有节点
• 过滤器（根据服务名称）
• 根据运行模式过滤器

将新配置添加到存储库

您需要了解的

要将新配置添加到存储库，您需要了解以下内容：

1. 服务的​永久标识(PID)。

   在Web控制台中引用​配置​字段。 名称显示在捆绑名称后方的括号中（或页面底部的​配置信息​中）。

   例如，创建一个节点com.day.cq.wcm.core.impl.VersionManagerImpl.以配置​AEM WCM Version Manager。

   

2. 是否需要特定的运行模式。 创建文件夹：

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

3. 是否需要​配置​或​工厂配置。

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

   在Web控制台中引用单个参数字段。 每个参数的名称将显示在括号中。

   例如，创建属性
   versionmanager.createVersionOnActivation to configure Create Version on 激活。

   

5. /libs中是否已存在配置？ 要列表实例中的所有配置，请使用CRXDE Lite中的​查询​工具提交以下SQL查询:

   select * from sling:OsgiConfig

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

在存储库中创建配置

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

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

   注意

   在将-<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，请使用versionmanager.createVersionOnActivation
   • 类型：酌情。
   • 值：。

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

5. 保存所有更改。

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

配置详细信息

启动时的分辨率顺序

使用以下优先顺序：

1. /apps/*/config...下的存储库节点。sling:OsgiConfig

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

3. 来自<*cq-installation-dir*>/crx-quickstart/launchpad/config/...的任何.config文件。 本地文件系统上。

这意味着/libs中的通用配置可以由/apps中的项目特定配置进行掩码。

运行时的分辨率顺序

在系统运行时所做的配置更改触发使用修改后的配置的重新加载。

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

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

多种运行模式的分辨率

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

/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/中的同一PID定义某些属性，而为同一PID定义/apps/*/config.emea.author/中的更多特定属性。
对于整个PID，具有最大匹配运行模式数的配置是有效的。

标准配置

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

• 作者 — 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

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

select * from sling:OsgiConfig

配置持久性

• 如果通过Web控制台更改配置，则（通常）会将其写入存储库：

  /apps/{somewhere}

  • 默认情况下，{somewhere}为system/config，因此将配置写入

    /apps/system/config

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

    /libs/foo/config/someconfig

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

    /apps/foo/config/someconfig

• 由admin更改的设置将保存在*.config文件中：

     /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