開発ガイドライン | Forguncy 10 オンラインヘルプ

開発ガイドライン

このトピックで

アプリケーション開発の効率と品質を向上させるための開発ガイドラインを示します。なお、本ガイドラインは、プロジェクト規模や開発環境に関わらず採用できる推奨事項になります。

命名規則

ページ

データベース

データベース、テーブル、フィールドの名前
英字を使用します。
英字以外を使用した場合でも、Forguncyアプリケーションは基本的に問題なく動作します。ただし、日本語がサポートされていない外部システムと連携して使用するような場合では、英単語以外の名前を使用すると予期しない問題が発生する可能性があります。
テーブル名には「アンダースコア（スネークケース）命名規則」を使用します。
英単語はすべて小文字で記述し、単語間はアンダースコアで区切ります。
例：
student_profile,product_name
Forguncy Builder上で英単語のフィールド名では可読性が低い場合は、日本語を使用した別名を設定します。
下図のようにテーブルのフィールド名に「別名」を設定できます。

参考：フィールドの作成とデータの入力
英単語を使用する際は開発者によって解釈が異ならないよう、理解しやすい名前を使用します。
例：
custではなくcustomerとする
外部キーは、外部キーであることが視覚的にわかるように接尾語に「Id」を追加します。
例：
CustomerId

コマンド

サーバーサイドコマンドが外部システムから呼び出される場合、サーバーサイドコマンド名がURLに表示される可能性があります。そのため、サーバーサイドコマンド名には日本語を使用せず、小文字の英語の動詞句を使用します。
例：
create-student-profile

コーディング

カスタムWeb APIやJavaScriptなどコーディングを伴う実装を行う際は、メソッド名やクラス名、変数名などは英単語を使用します。
英単語以外を使用すると、外部システムから呼び出される場合や、別システムでそれらを使用する場合に、予期しない問題が発生する可能性があります。

1つのテーブルに多くのフィールドを持たないようにします。
フィールドが多いテーブルは可読性やメンテナンス性を低下させるため、可能な限りシンプルな設計を意識してください。
フィールドのサイズは登録されるデータのサイズにあわせて適切にしてください。
関連付けされたテーブル間のデータに関連性がある場合は［外部キー制約を有効化する］オプションを有効にし、テーブルの外部キー削除時の挙動を適切に設定します。
これにより、関連付けされたテーブル間のデータ整合性を保証し、不整合なデータの挿入や削除を防ぐことができます。

参考：関連付いたテーブルの削除と更新

同一の処理が複数個所にある場合は「再利用コマンド」や「サーバーサイドコマンド」を使用します。
これによりコマンドの重複作成を防ぎメンテナンス性を向上させます。

注意：再利用コマンドにはシンプルなロジックを設定してください。また、セル位置やセル名を使って、ページ上のセルや表を直接操作するようなロジックは避けてください。
画面のUIデザインやロジックを共通化したい場合は「カスタムセル」を使用します。
これにより、統一されたデザインと一貫した業務ロジックを維持でき、開発の効率化とメンテナンス性が向上します。