2025年1月9日木曜日

MotionのQuick Startを3つの異なる実装方法でAPEXアプリケーションに組み込んでみる

State of JavaScriptによる2024年のサーベイを見ていたところ、Graphics & Animationsの分野でFramer Motionが3位になっていました。Framer MotionはReact向けのライブラリなのでOracle APEXでは使えませんが、Motion自体はVanilla JavaScriptの環境に組み込めるため、Oracle APEXにも組み込むことができます。

実際にMotionのJavaScriptのQuick startをOracle APEXに実装してみました。Motionのサイトの以下のページに記載されています。

今回は単にMotionのQuick startをAPEXアプリケーションのページに実装するだけではなく、以下の3種類の方法で実装します。
  1. 外部ファイルに素のJavaScriptでコーディングする。
  2. 外部ファイルにapex.actionsを使ったコーディングをする。
  3. 外部ファイルを使わず、主に動的アクションで実装する。
APEXアプリケーションに組み込んだMotionのQuick startは以下のように動作します。上記の3種類とも、同じ動作になるように実装しています。


上記のAPEXアプリケーションのエクスポートを以下に置きました。
https://github.com/ujnak/apexapps/blob/master/exports/sample-motion.zip

これより、それぞれの実装について簡単に紹介します。

素のJavaScriptによる実装


素のJavaScriptによる実装は、ページ番号ホーム・ページに行っています。左ペインに現れるレンダリング・ビューに配置されているコンポーネントは概ねHTML要素に対応していて、APEXアプリケーションにJavaScriptのコードやCSSのクラス定義は含みません。

JavaScriptのコードは、ページ・プロパティJavaScriptファイルURLに記述している以下のファイルにまとめています。

[module,defer]#APP_FILES#js/quick-start-motion#MIN#.js


CSSのクラス定義は、ページ・プロパティCSSファイルURLに記述している以下のファイルにまとめています。

#APP_FILES#css/quick-start-motion#MIN#.css


画面に配置されるOracle APEXのコンポーネントは、コンポーネントの単位で静的IDとしてHTML要素のID属性を設定できます。そのため、コンポーネントに設定した静的IDgetElementByIdの引数として渡すことにより、処理の対象とするHTML要素を取得できます。

以下の画面のように、ボタンに静的IDとしてANIMATE_ROTATEが設定されている場合、ボタン要素を取得するには以下を呼び出します。

document.getElementById("ANIMATE_ROTATE")


コンポーネントに含まれるHTML要素、例えばレポートに含まれるセルのようなHTML要素にアクセスする場合は、CSSクラスを設定してquerySelectorまたはquerySelectorAllを呼び出して、対象とするHTML要素を取り出します。CSSクラスといってもquerySelectorなどの引数に与えるための名前で、実際にCSSクラスを定義する必要はありません。CSSクラスを設定する場所が列CSSクラス行CSSクラス外観CSSクラス詳細CSSクラスのどこであっても、HTML要素のclass属性に含まれるため、.クラス名 (ドットで始まるクラス名)をセレクタとして指定してコンポーネントの内部にあるHTML要素にアクセスできます。

アニメーションの開始および終了は、それぞれのボタンをクリックすることで処理を呼び出します。ボタンへのイベント・リスナーの登録は、ボタン要素を取得して、addEventListenerを呼び出してコールバック・ファンクションを設定しています。
document.getElementById('ANIMATE_ROTATE').addEventListener('click', (event) => {
    animateRotate = animate(
        ".box",
        { 
            rotate: [ 0, 360 ]
        },
        {
            duration: 1,
            repeat: 3
        }
    );
    animateRotate.then(() => {
        apex.debug.info('rotate is completed.');
    });
    apex.debug.info('rotate is started.');
});
このようなコーディングは開発者への負担が大きいため、Oracle APEXのようなローコード開発プラットフォームが使われるようになったと言えますが、生成AIによるコード生成を前提とすると、より一般的な形式のコードを出力させた方が効率が良さそうです。

Oracle APEXのアプリケーションについては、コンポーネントへ静的IDやCSSクラスを設定することが多くなります。


apex.actionsを使った実装



ページ番号に、イベント・リスナーを登録する代わりに、Oracle APEXが提供しているapex.actionsを使った実装を行っています。ボタンやリンクをクリックしたときに、apex.actionsとして設定したアクションを呼び出しています。

動作は素のJavaScriptとまったく同じですが、apex.actionsを使って、コードを以下のように書き換えています。


いくつかの面でapex.actionsによる実装は、イベント・リスナーの設定よりも分かりやすい面があります。
  1. イベントの伝搬を意識しなくてよい。
  2. 呼び出される処理に名前が付いている。
  3. アクションを登録するコンテキストごとに名前空間が分かれる。
しかし、apex.actionsはボタンのクリックかリンクのクリックでの呼び出しに限定されるため、例えばmouseenterやmouseleaveといったイベントに対する処理を設定するには、イベント・リスナーを設定する必要があります。

apex.actionsを使う場合は、コンテキストの作成対象となるリージョンに静的IDを設定します。


処理を呼び出すボタンにカスタム属性data-actionを設定してアクション名を指定するか、リンクの場合はhref属性[context-id]action-name?argumentsの形式でアクション名や引数を指定します。



動的アクションによる実装



ページ番号に、Oracle APEXでの一般的な実装方法となる、動的アクションを使った実装を行なっています。

ひとつひとつのボタンに、JavaScriptコードを実行する動的アクションを設定しています。


値の設定表示非表示といった宣言的な設定だけで済む動的アクションであれば、処理内容を把握するのも難しくないと思います。しかし、JavaScriptコードがそれぞれの動的アクションに設定されている場合は、全体の処理を把握するのが難しくなる傾向があります。

動的アクションの間で共有する変数やファンクションは、ページ・プロパティJavaScriptファンクションおよびグローバル変数の宣言に記述する必要があります。
var animateRotate = null;
var animateThree = null;
var animateBasic = null;
var animateSpring = null;
var animateStagger = null;

var cube;

function rad(degrees) {
    return degrees * (Math.PI / 180)
};
Motionについては、ライブラリをJavaScriptファイルURLに指定して読み込めます。ページ中からは、グローバル変数Motionより機能を呼び出せます。

https://cdn.jsdelivr.net/npm/motion@11.16.0/dist/motion.min.js

対してThreeJSはESモジュールとして読み込む必要があり、また、従属しているライブラリもあるため、importmapの設定が必要です。
<script type="importmap">
    {
        "imports": {
            "three": "https://cdn.jsdelivr.net/npm/three@0.172.0/build/three.module.min.js",
            "three/webgpu": "https://cdn.jsdelivr.net/npm/three@0.172.0/build/three.webgpu.min.js"
        }
    }
</script>

また、アニメーションについては、静的コンテンツのリージョンにインラインでコーディングする必要があります。


3種類の実装の紹介は以上になります。

実はOracle APEXはjQueryを使っているため、どのようなページでもjQueryがロードされ、呼び出すことができます。

https://docs.oracle.com/en/database/oracle/apex/24.1/aexjs/

The jQuery library is used by APEX and is always loaded on every page. It can be used by your code.

そのため、jQueryを使ったコーディングも可能です。今回の記事でjQueryを取り上げなかったのは、個人的にjQueryは使わないようにしているためで、jQueryを使うことに問題があるわけではありません。そのため、jQueryを使うという選択肢もあります。

今回の記事は以上になります。

Oracle APEXのアプリケーション作成の参考になれば幸いです。