跳到主要内容
版本：v5

实现 Android 平台

插件的开发几乎完成了。剩下的就是 Android 实现！

向 Capacitor 注册插件​

先决条件： 在继续之前，请熟悉 Capacitor 自定义原生 Android 代码文档。

通过运行 npx cap open android 在 Android Studio 中打开 Capacitor 应用的 Android 项目。展开 app 模块和 java 文件夹，右键单击您的应用的 Java 包。从上下文菜单中选择 New -> Package，创建一个名为 plugins 的子包。右键单击 plugins 包，重复上述过程，创建一个名为 ScreenOrientation 的子包。

接下来，右键单击 ScreenOrientation 包，从上下文菜单中选择 New -> Java File 添加一个新的 Java 文件。将此文件命名为 ScreenOrientationPlugin.java。重复此过程创建一个名为 ScreenOrientation.java 的新文件。

将以下代码复制到 ScreenOrientationPlugin.java 中：

package io.ionic.cap.plugin.plugins.ScreenOrientation;

import com.getcapacitor.Plugin;
import com.getcapacitor.PluginCall;
import com.getcapacitor.PluginMethod;
import com.getcapacitor.annotation.CapacitorPlugin;

@CapacitorPlugin(name = "ScreenOrientation")
public class ScreenOrientationPlugin extends Plugin {

   @PluginMethod()
   public void orientation(PluginCall call) {
       call.resolve();
   }

   @PluginMethod()
   public void lock(PluginCall call) {
       call.resolve();
   }

   @PluginMethod()
   public void unlock(PluginCall call) {
       call.resolve();
   }
}

在项目的 MainActivity 中注册插件类，以在 Java 和 JavaScript 之间建立桥梁。打开 MainActivity.java 并添加一个 onCreate() 方法，我们可以在其中注册插件：

package io.ionic.cap.plugin;

import android.os.Bundle;
import com.getcapacitor.BridgeActivity;
import io.ionic.cap.plugin.plugins.ScreenOrientation.ScreenOrientationPlugin;

public class MainActivity extends BridgeActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        registerPlugin(ScreenOrientationPlugin.class);
        super.onCreate(savedInstanceState);
    }
}

获取当前屏幕方向​

与 iOS 一样，我们将首先处理获取当前屏幕方向。打开 ScreenOrientation.java 来设置类并编写一个获取当前方向的方法：

package io.ionic.cap.plugin.plugins.ScreenOrientation;

import android.view.Surface;
import androidx.appcompat.app.AppCompatActivity;

public class ScreenOrientation {
   private AppCompatActivity activity;

   public ScreenOrientation(AppCompatActivity activity) {
       this.activity = activity;
   }

   public String getCurrentOrientationType() {
       int rotation = activity.getWindowManager().getDefaultDisplay().getRotation();
       return fromRotationToOrientationType(rotation);
   }

   private String fromRotationToOrientationType(int rotation) {
       switch (rotation) {
           case Surface.ROTATION_90:
               return "landscape-primary";
           case Surface.ROTATION_180:
               return "portrait-secondary";
           case Surface.ROTATION_270:
               return "landscape-secondary";
           default:
               return "portrait-primary";
       }
   }
}

接下来，将 ScreenOrientationPlugin.java 中的 orientation 方法连接起来，以调用实现类的方法：

package io.ionic.cap.plugins.ScreenOrientation;

import com.getcapacitor.JSObject;
/* 为简洁起见省略了剩余的导入 */

@CapacitorPlugin(name = "ScreenOrientation")
public class ScreenOrientationPlugin extends Plugin {

   private ScreenOrientation implementation;

   @Override
   public void load() {
       implementation = new ScreenOrientation(getActivity());
   }

   @PluginMethod()
   public void orientation(PluginCall call) {
       JSObject ret = new JSObject();
       String type = implementation.getCurrentOrientationType();
       ret.put("type", type);
       call.resolve(ret);
   }

   /* 为简洁起见省略了剩余的代码 */
}

load() 方法是使用 Capacitor 桥接对象初始化 ScreenOrientation 类实例的正确位置。

从 Android Studio 中运行应用，无论是在真实设备上还是在 Android 模拟器上。打开 Logcat，您应该看到调用被记录：

V/Capacitor/Plugin: To native (Capacitor plugin): callbackId: 89582874, pluginId: ScreenOrientation, methodName: orientation

注意： 日志的具体值对您来说会有所不同。在此示例中，89582874 是分配给插件方法调用的任意 ID。

监听屏幕方向变化​

Android 将设备的旋转视为运行时配置更改，因此我们需要一种方式让我们的插件处理配置更改。

Capacitor 提供了一个可重写的方法 handleOnConfigurationChanged()，可用于响应运行时配置更改。

首先在 ScreenOrientationPlugin 类中添加以下导入：

import android.content.res.Configuration;

然后将以下方法添加到 ScreenOrientationPlugin 类：

@Override
public void handleOnConfigurationChanged(Configuration newConfig) {
   super.handleOnConfigurationChanged(newConfig);
   this.onOrientationChanged();
}

private void onOrientationChanged() {
   JSObject ret = new JSObject();
   String type = implementation.getCurrentOrientationType();
   ret.put("type", type);
   notifyListeners("screenOrientationChange", ret);
}

当 Android 通知应用配置更改时，它会返回整个新的配置对象，这带来两个挑战：

  1. 如何确保仅在方向改变时才通知监听器？
  2. 如何知道配置更改是由于方向改变引起的？

我们需要让插件跟踪之前的 newConfig.orientation 值，以便与后续的配置更改进行比较，从而解决这些挑战。

对 ScreenOrientation 类进行以下添加：

@Nullable private int configOrientation;

public boolean hasOrientationChanged(int orientation) {
    if (orientation == configOrientation) {
        return false;
    } else {
        this.configOrientation = orientation;
        return true;
    }
}

不要忘记在 ScreenOrientation.java 中导入 androidx.annotation.Nullable。

然后更新 ScreenOrientationPlugin.java 中的 handleOnConfigurationChanged() 方法：

@Override
public void handleOnConfigurationChanged(Configuration newConfig) {
   super.handleOnConfigurationChanged(newConfig);
   if(implementation.hasOrientationChanged(newConfig.orientation)) {
       this.onOrientationChanged();
   }
}

现在，只有当运行时配置更改与方向改变相关时，插件才会通知监听器。

锁定和解锁屏幕方向​

正如我们在 iOS 实现中看到的，我们需要一个辅助方法将 JavaScript 的 OrientationType 映射到相应的原生枚举值。对于 Android，我们将 OrientationType 映射到 ActivityInfo 枚举值。将以下方法添加到 ScreenOrientation 类：

private int fromOrientationTypeToEnum(String orientationType) {
   switch (orientationType) {
       case "landscape-primary":
           return ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE;
       case "landscape-secondary":
           return ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE;
       case "portrait-secondary":
           return ActivityInfo.SCREEN_ORIENTATION_REVERSE_PORTRAIT;
       default:
           // 情况：portrait-primary
           return ActivityInfo.SCREEN_ORIENTATION_PORTRAIT;
   }
}

确保在 ScreenOrientation.java 中导入 android.content.pm.ActivityInfo。

接下来，向 ScreenOrientation 类添加一个 lock() 方法：

public void lock(String orientationType) {
   int orientationEnum = fromOrientationTypeToEnum(orientationType);
   activity.setRequestedOrientation(orientationEnum);
}

这个方法需要从 ScreenOrientationPlugin 类中调用：

@PluginMethod()
public void lock(PluginCall call) {
   String orientationType = call.getString("orientation");
   if(orientationType == null) {
       call.reject("必须提供输入选项 'orientation'。");
       return;
   }
   implementation.lock(orientationType);
   call.resolve();
}

注意，我们防止了对未提供 orientation 输入参数的 lock() 方法的调用。

要解锁屏幕方向，我们将 Activity 的方向类型设置为 unspecified（未指定）枚举值。将以下方法添加到 ScreenOrientation 类：

public void unlock() {
   activity.setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED);
}

然后从 ScreenOrientationPlugin 类中调用实现方法：

@PluginMethod()
public void unlock(PluginCall call) {
   implementation.unlock();
   call.resolve();
}

测试一下！​

在 Android Studio 中，在设备或模拟器上运行应用。按下"Rotate My Device"按钮将屏幕方向旋转为横屏模式，如果您进一步旋转，您会看到屏幕方向已锁定。按下"Confirm Signature"将解锁屏幕方向。

注意： 在测试插件之前，请确保您已将设备的自动旋转设置设为开启；否则，它将无法正常工作。

恭喜，您已经构建了一个适用于 Web、iOS 和 Android 的 Capacitor 插件！👏 👏 👏

目前，ScreenOrientation 插件是一个本地插件；只有这个应用可以使用它。这没问题！很多时候您只希望某个插件在特定应用中使用。但是，如果您希望在多个应用中重用某个插件，我们将在最后一步中看到如何做到：打包插件。

Contents

编辑此页