命名ルールを検討する - IM-BloomMaker
IM-BloomMakerのコンテンツおよびルーティング定義の新規作成で入力するIDと名称の命名方法についてのルールを、書式例と実際の入力例をもちいて紹介しています。
このページでは、「商 品管理マスタ」というアプリケーションを作成する場合を想定して入力例を説明します。
慣れていないかたや、はじめてローコード開発をする際には、まずこのルールにしたがって開発をすることをおすすめします。一方で、ローコード開発の経験がある場合などには、このルールを参考に活用できる箇所をご自身のプロジェクトに反映していただくような利用を想定しています。
Accel Studioを使って開発することを前提に説明しています。アプリケーションIDやアプリケーション名はAccel Studioで作成・管理する単位のことです。
表記 について
IDの命名方法について、書式例は以下のように表記します。{ }の囲みはその内容が定義済みのIDや処理名称、処理対象であることを示しています。これらを組み合わせてIDを命名します。
IDはスネークケース（snake_case）で命名します。{ }のリンク先で具体的な定義説明をしています。
実際の入力例は以下のように表記します。
- 入力例：
item_master_maintenance_register
{ }で囲んだ箇所の定義説明を以下のように表記します。
{application_id}
内容をitem_master_maintenanceとする説明を記載します。
{function}
内容をregisterとする説明を記載します。
事前準備
アプリケーション作成時に、アプリケーションIDとアプリケーション名を事前に決めておくことをおすすめします。
ほ かのアプリケーションとの重複を避けることや、Accel Studioのアプリケーション管理＞リソースを追加で既存の資材を追加するときにどのアプリケーションで利用しているものなのかを判別しやすくするためです。
アプリケーションID
- 書式例：
{application_id} - 入力例：
item_master_maintenance
アプリケーション名
- 書式例：
{application_name} - 入力例：
商品管理
アプリケーションのIDと名称の定義ができたら、IM-BloomMakerの各項目で入力する内容を検討していきます。
コンテンツ
コンテンツを新規作成するときに入力する定義情報の例を紹介します。
コンテンツID
- 書式例：
{application_id}_{view} - 入力例：
item_master_maintenance_list
コンテンツ名
- 書式例：
{application_name} {画面名} - 入力例：
商品管理 商品一覧画面
{画面名}・{view}の決めかた
以下の手順で命名します。
- コンテンツで定義する画面の概要を
{画面名}として命名する {画面名}をもとに{view}を命名する（参考：よくある画面の例）
よくある画面の例
| 画面名 | view | 備考 |
|---|---|---|
| 一覧画面 | list | |
| 登録・編集・参照画面 | crud | ひとつのコンテンツで登録・編集・参照表示が切り替わる場合 |
| 登録画面 | register | |
| 編集画面 | edit | |
| 参照画面 | refer |
ルーティング定義
ルーティング定義を新規作成するときに入力する定義情報の例を紹介します。
ルーティングID
- 書式例：
{application_id}_{view} - 入力例：
item_master_maintenance_list
ルーティング名
- 書式例：
{application_name} {画面名} - 入力例：
商品管理 商品一覧画面
URL
- 書式例：
{application_id}/{view} - 入力例：
item_master_maintenance/list