Android IDEテンプレート形式

新しいアプリケーションを作成するプロセスでは、同じタイプのコードを記述し、時間ですでにテストされたクラス構造を再現する必要が非常に頻繁にあります。 IDE（特にAndroid Studio）は、アプリケーションの新しいコンポーネントの作成に関連するタスクを大幅に促進します。 テンプレートアクティビティのリストは、SDKツールの新しいバージョンごとに増加しています。 しかし、独自のテンプレートを作成する必要がある場合はどうでしょうか？ 単一のファイルの場合、これは簡単ですが、複数のファイルでテンプレートを作成する必要がある場合はどうでしょうか？ IDEの機能を知っていれば、アクティビティはマークアップファイルと共に作成され、フラグメントを追加できるため、これは非常に実現可能です。 ただし、そのような機能の説明は見つからなかったため、この機能の解決策を自分で探す必要がありました。



カットの下で、この機能がAndroid Studioでどのように実装されるかについて説明します。





最初の考えは、JetBrainsを使用している同僚に、この問題の解決方法を尋ねることでした。 答えは非常に簡単でした。 クラス構造を作成するために、必要なすべてのアクションを実行する別個のスクリプトが作成されました。



実際、このような決定が最初に思い浮かびました。 また、IDEからの独立性という利点もあります。 ただし、これは不便であり、IDEとの互換性の問題は引き続き重要です。



SDKのソースコードには、タスクを解決する方法の説明があります。 Android IDEテンプレート形式 。



そのような道具を受け取ったので、私はすぐにそれを試してみることにし、この経験を急いで共有しました。

FreeMarkerを使用してテンプレートを作成するには。 これは、PHPおよびDjangoテンプレートの使用に非常に似ています。











一番下の行は、パラメーターを入力するための特定のテンプレートとフォームがあることです。 入力後、パラメーターはテンプレートに転送され、このデータに基づいて必要なクラスが収集されます。



使用されているすべてのテンプレートのリストは、次のアドレスにあります。

android-studio-folder \ plugins \ android \ lib \ templates \



テンプレートを作成するには、次のファイルのリストを含む新しいディレクトリをアクティビティ（またはその他）ディレクトリに追加します





template.xmlおよびrecipe.xmlファイルのみが必要です。

template.xml

このXMLファイルには、IDEのオプションとして使用可能な、ユーザーに表示される名前、説明、カテゴリ、パラメーターなど、テンプレートに関するメタデータが含まれています。







テンプレート要素

formatは、このテンプレートが準拠するテンプレートのバージョンです。 4でなければなりません（まあ、そのように）

リビジョンはオプションのパラメーターです。 このテンプレートのバージョン（テンプレートを更新することで増やすことができます）

name-テンプレートの表示名。

description-テンプレートの説明。

minApiはオプションのパラメーターです。 このテンプレートの最小APIレベルがチェックされます。 テンプレートを作成する前に、IDEはminSdkVersionがこの値より小さくないことを確認します。



パラメータ要素

ユーザー設定可能なテンプレートパラメータを定義します。

id-変数の識別子。 グローバル変数ファイルで利用可能。 識別子がFooの場合、パラメーター値はFreeMarkerファイルで$ {Foo}として利用できます。

name-パラメーターの表示名。

type-パラメーターのタイプ。 使用可能な値は、string、boolean、enum、およびseparatorです。

制約 -オプション。 パラメータの制限。 制約は、|を使用して組み合わせることができます。



suggest-オプション。 他のパラメーターの値に応じて、自動的に更新される式。

デフォルトはオプションです。 このパラメーターのデフォルト値。

可視性 -オプション。 コンポーネントの可視性を定義するFreeMarker式。

ヘルプはオプションです。 このパラメーターのヒント。



オプション要素

列挙型のパラメーターの場合、これらは選択する項目です。



id-このオプションが選択されている場合、パラメーター値が設定されます。

minApi-オプション。 最低限のAPIレベルが必要です。

[text] -このオプションが選択されたときに表示されるテキスト。



親指要素

テンプレートのサムネイルを表示します。 要素は要素内になければなりません。 この要素に含まれるテキストは、サムネイルへのパスです。 この要素に属性がある場合、それらはセレクターと見なされます。

例：

 <thumbs> <thumb>template.png</thumb> <thumb navType="tabs">template_tabs.png</thumb> </thumbs>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

navTypeでタブが選択されている場合、Template_tabs.pngはサムネイルとして表示されます。

globals.xml.ftl

XMLファイルには、FreeMarker作業レイアウトで使用するグローバル変数が含まれています。

例globals.xml.ftl：

 <globals> <global id="srcOut" value="src/${slashedPackageName(packageName)}" /> <global id="activityNameLower" value="${activityName?lower_case}" /> <global id="activityClass" value="${activityName}Activity" /> </globals>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

recipe.xml.ftl

このXMLファイルには、このテンプレートのコードを生成する際に従う必要がある個別の指示が含まれています。

たとえば、いくつかのファイルまたはディレクトリをコピーし（コピー命令）、FreeMarkerを介してファイルを作成し（インスタンス化命令）、IDEにファイルを開くように要求できます（オープン命令）。



注：指示ファイルの名前は、template.xmlで定義されています。 ただし、慣例により、recipe.xml.ftlと呼ぶのが最善です。

注：グローバル変数globals.xml.ftlは、recipe.xml.ftlで使用できます。





指示は次の方法をサポートします。



依存関係

テンプレートにライブラリが必要であることを示します。 そうでない場合、IDEはプロジェクトに依存関係を追加します。



MavenUrl属性

Mavenライブラリパッケージの指定。 たとえば、com.android.support：appcompat-v7：+



コピー

唯一の必須パラメーターは、ルート/ディレクトリを基準にしてコピーするソースファイルへのパスです。 必要に応じて、必要なすべてのサブディレクトリが自動的に作成されます。

デフォルトの作成ディレクトリは、/ルートフォルダを基準にしたテンプレートの場所と同じです。 ファイル作成パスを指定するためのオプションのパラメーターがあります。 .ftl拡張子は自動的に削除されることに注意してください。 たとえば、entry>は正しいです。 strings.xml.ftlではなく、strings.xmlという名前のファイルが作成されます。



インスタンス化する

コピーと同じですが、ソースファイルの場合、FreeMarkerが最初に起動されます。



併合する

この命令は、ソースファイルのFreeMarkerを起動し、コンテンツをプロジェクト内の既存のファイルとマージするか、新しいファイルを作成します。 この命令の最も一般的な使用例は、AndroidManifest.xmlファイルにコンポーネントを追加するか、strings.xmlなどのリソースを組み合わせることです。



開く

コード生成の完了後に、引数で指定されたファイルを開きます。



mkdir

引数で指定されたディレクトリの存在を確認します

ルート/

すべてのテンプレートファイル（リソース、Javaソース、Androidマニフェスト）はルート/ディレクトリに配置する必要があります

ただし、ソースファイルをsrc / com / google /に配置する代わりに、単にsrc / app_package /を使用できます。

組み込みテンプレート関数

使用できるFreeMarker関数のリストに含まれていない関数がいくつかあります。



それらのいくつかを次に示します。



文字列activityToLayout（文字列）

Activityクラス名を、リソース名として使用するのに適した文字列に変換します。 たとえば、FooActivityはactivity_fooに変換されます。



文字列camelCaseToUnderscore（文字列）

キャメルケース文字列を下線文字列に変換します。 たとえば、FooBarはfoo_barに変換されます。



文字列classToResource（文字列）

FooActivityやFooFragmentなどのAndroidクラス名を、接尾辞「Activity」または「Fragment」を持つ対応するリソースに変換します。

現在認識されているもの：

• アクティビティ
• フラグメント
• プロバイダー
• サービス

文字列layoutToActivity（文字列）

接尾辞を持つリソースをクラス文字列に変換します。 たとえば、activity_fooはJavaクラスFooActivityに変換されます。



文字列slashedPackageName（文字列）

完全修飾Javaパッケージ名を対応するディレクトリパスに変換します。 たとえば、指定された引数がcom.example.fooの場合、戻り値はcom / example / fooになります。



文字列underscoreToCamelCase（文字列）

行のアンダースコアを対応するキャメルケース行に変換します。 たとえば、foo_barからFooBarへ。

組み込みテンプレートパラメータ

FreeMarkerの式とファイルで利用可能なオプション。



packageName

プロジェクトパッケージ名（com.example.fooなど）



isNewProject

テンプレートが新しいプロジェクトテンプレートかどうかを示すブール値。



manifestDir

AndroidManifest.xmlを含むディレクトリ。



srcDir

プロジェクトのJavaソースファイルディレクトリ。



resDir

プロジェクトのリソースルートディレクトリ（res /）のディレクトリ。



関数とパラメーターの完全なリストについては、 ドキュメントを参照してください。



一般に、独自のテンプレートを作成することは難しくありません。 作成に少し時間を費やした後、プロジェクトでコンポーネントと構造を作成するルーチンを取り除くことができます。

自動化できるすべてのものを使用して自動化します。

便利なリンク

ドキュメント

Googleアナリティクスの独自のアクティビティの作成に関する記事

FreeMarkerを使用する