创建设备组筛选器

注意

Adobe建议对需要基于单页应用程序框架的客户端渲染（例如React）的项目使用SPA编辑器。了解详情.

创建设备组筛选器以定义一组设备功能要求。根据需要创建任意数量的过滤器，以定位所需的设备功能组。

设计过滤器以便使用它们的组合来定义功能组。通常，不同设备组的功能会重叠。因此，您可以使用具有多个设备组定义的某些筛选器。

创建过滤器后，您可以在以下位置使用它：组配置。

过滤器Java类

设备组过滤器是实现 com.day.cq.wcm.mobile.api.device.DeviceGroupFilter 界面。部署后，实现类将提供筛选服务，该服务可用于设备组配置。

本文中介绍的解决方案使用Apache Felix Maven SCR插件来促进组件和服务的开发。因此，示例Java类使用 @Component和 @Service 注释。类具有以下结构：

package com.adobe.example.myapp;

import java.util.Map;

import com.day.cq.wcm.mobile.api.device.DeviceGroup;
import com.day.cq.wcm.mobile.api.device.DeviceGroupFilter;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;

@Component(metatype = false)
@Service
public class myDeviceGroupFilter implements DeviceGroupFilter {

       public String getDescription() {
  return null;
 }

 public String getTitle() {
  return null;
 }

 public boolean matches(DeviceGroup arg0, String arg1, Map arg2) {
  return false;
 }

}

您需要为以下方法提供代码：

getDescription：返回过滤器描述。说明将显示在“设备组配置”对话框中。
getTitle：返回筛选器的名称。为设备组选择筛选器时将显示该名称。
matches：确定设备是否具有所需的功能。

提供过滤器名称和描述

此 getTitle 和 getDescription 方法分别返回过滤器名称和描述。以下代码说明了最简单的实施：

public String getDescription() {
    return "An example device group filter";
}

public String getTitle() {
 return "myFilter";
}

对名称和描述文本进行硬编码足以用于单语言创作环境。考虑将字符串外部化以便用于多语言，或者允许更改字符串而不重新编译源代码。

根据筛选条件进行评估

此 matches 函数返回 true 如果设备功能满足所有筛选条件。评估方法参数中提供的信息，以确定设备是否属于组。以下值作为参数提供：

设备组对象
用户代理的名称
包含设备功能的映射对象。 Map键是WURFL™功能名称，值是WURFL™数据库中的相应值。

此 com.day.cq.wcm.mobile.api.devicespecs.DeviceSpecsConstants 接口在静态字段中包含WURFL™功能名称的子集。从设备功能图检索值时，使用这些字段常量作为键。

例如，以下代码示例确定设备是否支持CSS：

boolean cssSupport = true;
cssSupport = NumberUtils.toInt(capabilities.get(DeviceSpecsConstants.DSPEC_XHTML_SUPPORT_LEVEL)) > 1;

此 org.apache.commons.lang.math 包提供 NumberUtils 类。

注意

确保部署到AEM的WURFL™数据库包含您用作筛选条件的功能。 (请参阅设备检测.)

屏幕大小的示例筛选条件

后续示例DeviceGroupFilter实施确定设备的物理大小是否符合最低要求。此过滤器旨在向触控设备组添加粒度。无论物理屏幕大小如何，应用程序UI中的按钮大小都应相同。其他项目（如文本）的大小可能有所不同。该过滤器允许动态选择特定CSS，以控制UI元素的大小。

此筛选器将大小条件应用于 physical_screen_height 和 physical_screen_width WURFL™属性名称。

package com.adobe.example.myapp;

import java.util.Map;

import com.day.cq.wcm.mobile.api.device.DeviceGroup;
import com.day.cq.wcm.mobile.api.device.DeviceGroupFilter;

import org.apache.commons.lang.math.NumberUtils;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;

@Component(metatype = false)
@Service
@SuppressWarnings("unused")
public class ScreenSizeLarge implements DeviceGroupFilter {
    private int len=400;
    private int wid=200;
    public String getDescription() {

        return "Requires the physical size of the screen to have minimum dimensions " + len + "x" + wid+".";
    }

    public String getTitle() {
        return "Screen Size Large ("+len + "x" + wid+")";
    }

    public boolean matches(DeviceGroup deviceGroup, String userAgent,
            Map<String, String> deviceCapabilities) {

        boolean longEnough=true;
        boolean wideEnough=false;
        int dimension1=NumberUtils.toInt(deviceCapabilities.get("physical_screen_height"));
        int dimension2=NumberUtils.toInt(deviceCapabilities.get("physical_screen_width"));
        if(dimension1>dimension2){
            longEnough=dimension1>=len;
            wideEnough=dimension2>=wid;
        }else{
            longEnough=dimension2>=len;
            wideEnough=dimension1>=wid;
        }

        return longEnough && wideEnough;
    }
}

getTitle方法返回的字符串值显示在设备组属性的下拉列表中。

filteradtogroup

getTitle和getDescription方法返回的字符串值包含在设备组摘要页面的底部。

filterdescription

Maven POM文件

如果您使用Maven构建应用程序，则以下POM代码非常有用。 POM引用了多个必需的插件和依赖关系。

插件:

Apache Maven编译器插件：从源代码中编译Java类。
Apache Felix Maven捆绑包插件：创建捆绑包和清单
Apache Felix Maven SCR插件：创建组件描述符文件并配置服务组件清单标头。

依赖项:

cq-wcm-mobile-api-5.5.2.jar：提供DeviceGroup和DeviceGroupFilter接口。
org.apache.felix.scr.annotations.jar：提供组件和服务注释。

DeviceGroup和DeviceGroupFilter接口包含在Day Communique 5 WCM移动API包中。 Felix注释包含在Apache Felix Declarative Services包中。您可以从公共Adobe存储库获取此JAR文件。

在创作时， 5.5.2是AEM最新版本中的WCM移动API包版本。使用AdobeWeb控制台(https://localhost:4502/system/console/bundles)，以确保这是您的环境中部署的捆绑包版本。

POM： （您的POM将使用其他组ID和版本。）

<project xmlns="https://maven.apache.org/POM/4.0.0"
        xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.adobe.example.myapp</groupId>
      <artifactId>devicefilter</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <name>my app device filter</name>
      <url>https://dev.day.com/docs/en/cq/current.html</url>
  <packaging>bundle</packaging>
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.5</source>
                <target>1.5</target>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.felix</groupId>
            <artifactId>maven-scr-plugin</artifactId>
            <executions>
                  <execution>
                    <id>generate-scr-scrdescriptor</id>
                    <goals>
                          <goal>scr</goal>
                    </goals>
                  </execution>
            </executions>
          </plugin>
        <plugin>
            <groupId>org.apache.felix</groupId>
            <artifactId>maven-bundle-plugin</artifactId>
            <version>1.4.3</version>
            <extensions>true</extensions>
            <configuration>
                <instructions>
                    <Export-Package>com.adobe.example.myapp.*;version=${project.version}</Export-Package>
                </instructions>
            </configuration>
        </plugin>
    </plugins>
</build>
<dependencies>
     <dependency>
         <groupId>com.day.cq.wcm</groupId>
         <artifactId>cq-wcm-mobile-api</artifactId>
         <version>5.5.2</version>
         <scope>provided</scope>
     </dependency>
     <dependency>
        <groupId>org.apache.felix</groupId>
        <artifactId>org.apache.felix.scr.annotations</artifactId>
        <version>1.6.0</version>
        <scope>compile</scope>
    </dependency>
</dependencies>
</project>

添加配置文件，以便获取内容包Maven插件部分向您的maven设置文件提供了以使用公共Adobe存储库。

Business.Adobe.com 资源

Content Insights Asset Collections Mobile Forms Document Generation Digital Rights Management Headless Cms

创建设备组筛选器

过滤器Java类

提供过滤器名称和描述

根据筛选条件进行评估

屏幕大小的示例筛选条件

Maven POM文件

Business.Adobe.com 资源

在此页面上

查看下一个：

学习

文档

社区

技术支持

资源

Adobe 帐户

Adobe