FLEX编码规范(公司要求)

Flexのベストプラクティス＜パート1＞:Flexプロジェクトの設定 

1.     必要条件

このベストプラクティスを読み進める前に、次のソフトウェアをインストールする必要があります。

①    Flex Builder 3

②    Flex 3 SDK（Flex Builder 3の体験版と一緒に無料提供）

 

2.     ワークスペースによるプロジェクトの整理

ワークスペースを使用してFlexプロジェクトを整理する。

チーム環境でFlexワークスペースに共通のディレクトリを使用する。

 

3.     FLEXプロジェクト名前付け規則

Flexプロジェクト名の共通の名前付け規則に従う。

Flex プロジェクト名は、常に大文字で開始し、後続の各単語の先頭文字も大文字にします。これを「UpperCamelCase」といいます。例えば、「MyGreatFlexApplication」のように表記します。この名前は、Flex Builderでアプリケーションのメインの配布用MXMLファイルにも使用されます。注意：Flexプロジェクト名は後でいつでも変更できます。

 

4.     アプリケーションの種類の決定

ターゲットプラットフォームを決定する。

Flexアプリケーションは、WebブラウザまたはAdobe Integrated Runtime（AIR）で実行するFlash Playerをターゲットにすることができます。Flexプロジェクトを作成するときに、アプリケーションの種類を設定するよう要求されます。これにより、プロジェクトのターゲットをWebブラウザまたはAIRに設定し、後でターゲットプラットフォームを追加または変更する場合に必要になる作業のやり直しを最小限にすることができます。

 

5.     Flexプロジェクトの出力の設定

Flexプロジェクトでローカル開発サーバを使用する場合を除いて、デフォルトの"bin-debug"ディレクトリを使用する。

Flexプロジェクトのコンパイル時に、アプリケーションを構成するファイルが作成されてFlexプロジェクトの"bin-debug"という出力ディレクトリに書き込まれます。Flexを初めてお使いになる場合は、デフォルトの"bin-debug"ディレクトリを使用して混乱を避けることをお勧めします。ただし、チームの方針も考慮する必要があります。チームが別の出力ディレクトリを使用している場合は、そのベストプラクティスに従ってください。

Flex プロジェクトでローカル開発サーバを使用する場合は、プロジェクトの作成プロセスでパスを定義する必要があります。

「リリースビルドの書き出し」を使用してアプリケーションを発行する場合は、Flex Builder 3.0によって新しい出力ディレクトリが作成されます。デフォルト名は"bin-release"です。

再度、出力ディレクトリをまとめます。

開発の場合："bin-debug"

発行の場合："bin-release"

 

6.     ソースコードディレクトリの管理

ソースコードは常に"src"という名前のディレクトリに配置する。

これは、バックグラウンドや言語が異なる様々な開発者間で広く共有される規則です。ほとんどの開発者は、このディレクトリで必要なコードを探します。これはFlex Builder 3.0でのデフォルト値であり、変更しないようお勧めします。

Flexプロジェクトにはオブジェクト指向プログラミングのプラクティスを使用する。

パッケージを使用するための詳細な規則については後述します。今は、Flexアプリケーションの開発には次のオブジェクト指向プログラミングのプラクティスが基本であることに留意してください。

 

7.     ソースコントロール管理の検討

"メインソース" フォルダにはソースコードコントロールソリューションを使用する。

ソースコントロール管理（SCM）はチーム環境に不可欠です。ソースコントロールにより、チームはアプリケーションのコードベースへの変更を追跡することができます。また、ソースコントールにより、ファイルの履歴を戻ったり進んだりすることができます。Flexプロジェクトにはソースコントロールが不可欠です。一般的なソースコントロールソリューションとして、Subversion*、CVS*およびPerforce*の3つがあります。

 

8.     SWCライブラリの追加および管理

SWCファイルを参照するときのベストプラクティスを決める際に、2つの検討事項があります。

共有SWCライブラリを参照するにはFlexライブラリパスを使用する。

このアプローチは、SWCライブラリを頻繁に更新したり、複数のプロジェクト間で共有したりする場合に役立ちます。SWCライブラリを共有するには、Flexライブラリパスを使用して参照する必要があります。

SWCライブラリをFlexプロジェクトにバンドルするにはlibsフォルダを使用する。

libフォルダを使用する利点は、アプリケーションに外部の依存関係がないことです。コンパイルして実行する場合に、Flexプロジェクトのプロパティを変更する必要がありません。libsディレクトリは、Flexプロジェクトのライブラリパスに自動的に追加されます。

重要な点として、通常、libsフォルダのSWCファイルは自動的に更新されません。通常、SWCはアプリケーションとは別個に開発されるため、SWCがコンパイルされるディレクトリはFlexプロジェクトのlibsディレクトリではありません。

 

9.     ファイル名の付け方

MXMLファイル名にはUpperCamelCaseを使用する。

ActionScriptクラスのファイル名にはUpperCamelCaseを使用する。

ActionScriptインターフェイスのファイル名にはUpperCamelCaseを使用し、ファイル名を大文字のIで始める。

ファイル名の中ではスペースを使用しない。

ファイル名の中では特殊文字を使用しない。

感嘆符"!"、開始の角括弧"["、左の丸括弧"("などの文字は多くのコンテキストで許可されません。使用した場合は、アプリケーションに重大な支障を与える可能性があります。

頭文字や略語を使用しない。

ただし、HTTP、WWW、SQL など一般に通用している略語は除きます。

ピリオドを使用しない。

 

10.  パッケージによるコードの整理

パッケージを使用してプロジェクトのコードベースを整理および構成する。

パッケージは、オブジェクト指向プログラミングペースのアプリケーションの標準です。パッケージは、論理的に関連するActionScriptおよびMXMLファイルをクラスとしてまとめます。オブジェクト指向プログラミングでは、パッケージとクラスの使用は基本です。

コミュニティの標準化の一環として、パッケージに名前を付けるには、次のプラクティスに従います。

lowerCamelCaseを使用する。

例えば、com.seantheflexguy.stringUtilsのように一番最初の文字を小文字にします。

パッケージ名をアプリケーションのオーナーの最上位ドメイン（TLD）で始める。

例：com、net、us

次にアプリケーションオーナーの名前を続けます。

例：seantheflexguy、adobe

次にプロジェクト名を続けます。

例：burrow

次に論理的に関連するコードファイルのグループを続けます。

例：utilsやcomponentsなどの該当するグループ名

この名前付け規則に基づくパッケージ名の例を次に示します。

com.seantheflexguy.burrow.view

11.  Flexプロジェクトの設定に関する留意事項のまとめ

以上、基本的なプラクティスを紹介しました。これらは、Flexプロジェクトの作業環境を透明にして理解しやすくします。開発者間で作業を理解するには、一貫性が決定的に重要です。アプリケーションの開発が進むに従って、様々な開発者が新たに参入して変更や改良を行う場合があります。プロジェクトのコードベースは生命体のように多様な成長をします。これは、アイデアや技術の異なる様々な開発者がプロジェクトの成長に寄与する結果です。最初からベストプラクティスを使用すれば、それをテンプレートとして、開発者は作業の構造や形式を統一できます。

これらのプラクティスは、すべてのFlexアプリケーションに適用できます。再度ベストプラクティスをご確認ください。

ü  ワークスペースを使用してFlexプロジェクトを整理する。

ü  チーム環境でFlexワークスペースに共通のディレクトリを使用する。

ü  Flexプロジェクト名の共通の名前付け規則に従う。

ü  ターゲットプラットフォームを決定する。

ü  デフォルトの"bin-debug"ディレクトリを使用する。

ü  コードを"src"ディレクトリに挿入する。

ü  Flex プロジェクトにはオブジェクト指向プログラミングのプラクティスを使用する。

ü  ソースコードコントロールソリューションを使用する。

ü  共有SWCライブラリを参照するにはFlexライブラリパスを使用する。

ü  SWCライブラリをFlexプロジェクトにバンドルするにはlibsフォルダを使用する。

ü  MXMLファイル名にはUpperCamelCaseを使用する。

ü  ActionScriptクラスのファイル名にはUpperCamelCaseを使用する。

ü  ActionScriptインターフェイスのファイル名にはUpperCamelCaseを使用し、ファイル名を大文字のIで始める。

ü  ファイル名の中ではスペースを使用しない。

ü  ファイル名の中では特殊文字を使用しない。

ü  頭文字や略語を使用しない。

ü  ファイル名の中ではピリオドを使用しない。

ü  パッケージを使用してプロジェクトのコードベースを整理および構成する。

ü  パッケージ名の形式は、com.seantheflexguy.stringUtilsのようにする。