Ribbit.work

Kintoneのフィールドコードの命名規則と、JavaScript上で使用する際に気を付けること

Kintonejavascript

last modified date2021-7-10

publish date2021-7-9

こんにちはリビットです。

Kintoneで作成できるアプリには様々なフィールドが存在し、その全てにフィールド名とフィールドコードを割り振る必要があります。

フィールド名は主にユーザーが見える部分に、フィールドコードは主にアプリ管理者およびJavaScriptで参照するために使用します。

今回はフィールドコードの命名規則と、私がJavaScript上でフィールドコードを使用する際に気を付けていることを紹介します。

この記事のまとめ

  • JavaScriptは日本語の変数名を許容しているので、日本語でもかまわない。
  • チームでルールを決めることが大切
  • 基本的にはフィールド名と合わせるべき

正解はない

命名規則については、Kintoneのガイドラインに明記されていません。

JavaScriptは変数名を日本語で定義することを制限していません。

上記の2点から命名について、必ずこうしましょう。という正解はありません。

みなさんのやりやすいようにやるのが良いでしょう。エラーが出ないわけですし。

大切なのは統一していること

正解はありませんが、明らかに不正解と言えるものはいくつかあると思います。

その一つがチームで開発している場合に、各メンバーの命名ルールが統一されていないことです。

  • フィールド名に対応する英語にする。
  • フィールド名と同じ日本語にする。
  • 一意になるキーと名前を組み合わせる。

いずれにしても、命名ルールを共有して統一していることが大切だと思います。

フィールド名と合わせるのがいいと思う

ここからは私が使用しているルールにそった個人的な意見になりますが、例えばフィールドの名前が「顧客名」であれば、フィールドコードは「顧客名」でいいと思います。

理由としてはいくつかありますが、

  • developer networkでそのルールを使用しているサンプルが多い。
  • フィールド名と対応するフィールドコードを確認しやすい。
  • コーディングしない人もフィールドコードを管理しないといけないことがある。

などでしょうか。

JavaScriptで気を付けていること

前述しましたが、JavaScriptでは日本語を変数名に使うことが特に制限されていません。 ただ私がコード上でフィールドコードを使う際は、いくつか気を付けていることがあります。 注意点をいくつか紹介します。

プロパティのつなげ方

recordオブジェクトから各フィールドデータを取得する際は以下のように行うようにしています。

const { record } = kintone.app.record.get();

// OK: このように書く
record['コード1'].value;

// NG: このようには書かない
record.コード1.value;

developer networkでよくこの書き方をする方が多かったので、このようにしています。

分割代入を使わない

分割代入を使うことで、各フィールドコードを以下のようにまとめて変数に代入できるんですが、これはやらないようにしています。

const { record } = kintone.app.record.get();

const { コード1, コード2 } = record;

if (コード1.value === 'フィールドのデータ') {
  console.log(コード1.value);
} else {
  console.log(コード2.value);
}

record以下に日本語の変数がいるのはギリギリ許容できますが、日本語の変数がそのままオブジェクトとしていることにどうしても違和感があるので使わないようにしています。 動作的には問題ないはずなので、この方が分かりやすいと思う方は積極的に使っても良いと思います。

この記事をシェア

この記事を読んだ方におすすめの記事

レコードのサブテーブルを並び替えて登録する【Kintone JavaScriptカスタマイズ】
2021-12-4

レコードのサブテーブルを並び替えて登録する【Kintone JavaScriptカスタマイズ】

JavaScriptKintone
レコード一覧表示時(app.record.index.show)のサンプルコード集【Kintone】
2021-11-29

レコード一覧表示時(app.record.index.show)のサンプルコード集【Kintone】

JavaScriptKintone
スライダーを使って数値を設定できるKintoneプラグイン【無料公開】
2021-11-26

スライダーを使って数値を設定できるKintoneプラグイン【無料公開】

KintoneJavaScriptTypeScript
レコード編集時(app.record.edit.show)のサンプルコード集【Kintone】
2021-11-25

レコード編集時(app.record.edit.show)のサンプルコード集【Kintone】

JavaScriptKintone

最新の記事

kuromoji.jsで形態素解析
2021-12-4

kuromoji.jsで形態素解析

TypeScriptJavaScript
レコードのサブテーブルを並び替えて登録する【Kintone JavaScriptカスタマイズ】
2021-12-4

レコードのサブテーブルを並び替えて登録する【Kintone JavaScriptカスタマイズ】

JavaScriptKintone
レコード一覧表示時(app.record.index.show)のサンプルコード集【Kintone】
2021-11-29

レコード一覧表示時(app.record.index.show)のサンプルコード集【Kintone】

JavaScriptKintone
スライダーを使って数値を設定できるKintoneプラグイン【無料公開】
2021-11-26

スライダーを使って数値を設定できるKintoneプラグイン【無料公開】

KintoneJavaScriptTypeScript