本文章已授權(quán)微信公眾號郭霖（guolin_blog）轉(zhuǎn)載。

本文章講解的內(nèi)容是Android Studio自定義模板——一鍵生成框架模板代碼。

框架GitHub地址：

Dagger2版本：Dagger2

Koin版本：Koin

為了快速使用Android通用框架開發(fā)項(xiàng)目，我配置了一套屬于它的模板，可以一鍵生成框架模板代碼。

模板GitHub地址：AndroidGenericFrameworkTemplate

使用方法

將模板下載回來，目錄如下圖所示：

AndroidGenericFrameworkTemplateDirectory.png

TanJiaJunActivityForDagger2：用于生成Dagger2版本的Activity對應(yīng)的xml、Activity和ViewModel。
TanJiaJunFragmentForDagger2：用于生成Dagger2版本的Fragment對應(yīng)的xml、Fragment和ViewModel。
TanJiaJunActivityForKoin：用于生成Koin版本的Activity對應(yīng)的xml、Activity和ViewModel。
TanJiaJunFragmentForKoin：用于生成Koin版本的Fragment對應(yīng)的xml、Fragment和ViewModel。

然后把TanJiaJunActivityForDagger2和TanJiaJunActivityForKoin放到Activity模板目錄下，把TanJiaJunActivityForKoin和TanJiaJunFragmentForKoin放到Fragment模板目錄下。

Activity模板目錄地址：/Applications/Android Studio.app/Contents/plugins/android/lib/templates/activities，如下圖所示：

AndroidActivityTemplateDirectory.png

Fragment模板目錄地址：/Applications/Android Studio.app/Contents/plugins/android/lib/templates/fragments，如下圖所示：

AndroidFragmentTemplateDirectory.png

最后重啟Android Studio，然后就可以使用這些模板了，如下圖所示：

Activity：

AndroidActivityTemplateMenu.png

Fragment：

AndroidFragmentTemplateMenu.png

創(chuàng)建面板界面如下圖所示：

AndroidGenericFrameworkTemplateCreatePanel.png

下面用TanJiaJunActivityForDagger2來描述目錄結(jié)構(gòu)。

目錄結(jié)構(gòu)

目錄結(jié)構(gòu)如下圖所示：

TanJiaJunActivityForDagger2Directory.png

globals.xml.ftl

用于定義全局變量，代碼如下所示：

<?xml version="1.0"?>
<globals>

    <#include "../common/common_globals.xml.ftl" />

    <global id="hasNoActionBar" type="boolean" value="false" />
    <global id="simpleLayoutName" value="${layoutName}" />
    <global id="excludeMenu" type="boolean" value="true" />
    <global id="generateActivityTitle" type="boolean" value="false" />
    <global id="nativeSrcOut" value="${escapeXmlAttribute(projectOut)}/src/main/cpp" />

</globals>

recipe.xml.ftl

該文件可以定義如下常用的標(biāo)簽：

copy：復(fù)制文件到目標(biāo)目錄，可以用于將圖標(biāo)復(fù)制到項(xiàng)目的文件夾。
merge：合并，可以用于將文件和項(xiàng)目中現(xiàn)有的文件合并。
instantiate：通過FreeMarker將ftl文件中的變量都轉(zhuǎn)換成對應(yīng)的值，并且生成我們想要的文件。
open：在代碼生成后，打開指定的文件。

FreeMarker是一個(gè)模板引擎，它可以用來生成輸出文本（例如：HTML網(wǎng)頁、電子郵件、配置文件、源代碼等）的通用工具，如下圖所示：

FreeMarker.png

FreeMarker的工作原理，如下圖所示：

TheWorkingPrincipleOfFreeMarker.jpg

代碼如下所示：

<?xml version="1.0"?>
<#import "root://activities/common/kotlin_macros.ftl" as kt>
<recipe>

    <@kt.addAllKotlinDependencies />

    <instantiate
        from="root/res/layout/activity_tan_jia_jun_for_dagger2.xml.ftl"
        to="${escapeXmlAttribute(resOut)}/layout/${layoutName}.xml" />

    <instantiate
        from="root/src/app_package/TanJiaJunActivityForDagger2.kt.ftl"
        to="${escapeXmlAttribute(srcOut)}/ui/${businessName}/activity/${activityName}.kt" />

    <instantiate
        from="root/src/app_package/TanJiaJunViewModelForDagger2.kt.ftl"
        to="${escapeXmlAttribute(srcOut)}/ui/${businessName}/viewmodel/${viewModelName}.kt" />

    <open file="${escapeXmlAttribute(srcOut)}/ui/${businessName}/activity/${activityName}.kt" />

</recipe>

我解釋下代碼的邏輯：在指定的目錄下，用activity_tan_jia_jun_for_dagger2.xml.ftl文件生成 ${layoutName}.xml**文件，用**TanJiaJunActivityForDagger2.kt.ftl**文件生成**$ {activityName}.kt文件，用TanJiaJunViewModelForDagger2.kt.ftl文件生成 ${viewModelName}.kt**文件，最后打開**$ {activityName}.kt文件。

root

存放ftl文件，也就是模板代碼，代碼如下所示：

activity_tan_jia_jun_for_dagger2.xml.ftl：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <data>

        <variable
            name="viewModel"
            type="${kotlinEscapedPackageName}.ui.${businessName}.viewmodel.${viewModelName}" />

    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="@color/background_color">

    </androidx.constraintlayout.widget.ConstraintLayout>

</layout>

TanJiaJunActivityForDagger2.kt.ftl：

package ${kotlinEscapedPackageName}.ui.${businessName}.activity

import android.os.Bundle
import androidx.activity.viewModels
import ${applicationPackage}.R
import ${applicationPackage}.databinding.Activity${objectKind}Binding
import com.tanjiajun.androidgenericframework.ui.BaseActivity
import ${kotlinEscapedPackageName}.ui.${businessName}.viewmodel.${viewModelName}

class ${activityName} : BaseActivity<Activity${objectKind}Binding, ${viewModelName}>() {

    override val layoutRes: Int = R.layout.${layoutName}
    override val viewModel by viewModels<${viewModelName}> { viewModelFactory }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
    }

}

TanJiaJunViewModelForDagger2.kt.ftl：

package ${kotlinEscapedPackageName}.ui.${businessName}.viewmodel

import com.tanjiajun.androidgenericframework.ui.BaseViewModel
import javax.inject.Inject

class ${viewModelName} @Inject constructor() : BaseViewModel() {

}

template_blank_activity.png

展示模板界面的縮略圖，如下圖所示：

TemplateBlankActivity.png

template.xml

用于定義創(chuàng)建面板的控件，代碼如下所示：

<?xml version="1.0"?>
<template
    format="8"
    revision="8"
    name="TanJiaJun Activity For Dagger2"
    minApi="9"
    minBuildApi="26"
    description="Creates a new activity of Android Generic Framework For Dagger2.">

    <category value="Activity" />

    <formfactor value="Mobile" />

    <parameter
        id="packageName"
        name="Package Name"
        type="string"
        constraints="package"
        default="com.tanjiajun.androidgenericframework" />

    <parameter
        id="businessName"
        name="Business Name"
        type="string"
        constraints="nonempty"
        default="main" />

    <parameter
        id="objectKind"
        name="Object Kind"
        type="string"
        constraints="nonempty"
        default="TanJiaJun" />

    <parameter
        id="activityName"
        name="Activity Name"
        type="string"
        constraints="class|unique|nonempty"
        suggest="${extractLetters(objectKind)}Activity"
        default="TanJiaJunActivity"
        help="The name of the activity class to create." />

    <parameter
        id="layoutName"
        name="Layout Name"
        type="string"
        constraints="layout|unique|nonempty"
        suggest="${activityToLayout(activityName)}"
        default="activity_tan_jia_jun"
        help="The name of the layout to create for the activity." />

    <parameter
        id="viewModelName"
        name="ViewModel Name"
        type="string"
        constraints="class|unique|nonempty"
        suggest="${extractLetters(objectKind)}ViewModel"
        default="TanJiaJunViewModel"
        help="The name of the viewModel class to create." />

    <!-- 128x128 thumbnails relative to template.xml -->
    <thumbs>
        <!-- default thumbnail is required -->
        <thumb>template_blank_activity.png</thumb>
    </thumbs>

    <globals file="globals.xml.ftl" />

    <execute file="recipe.xml.ftl" />

</template>

packageName：包名，默認(rèn)值是com.tanjiajun.androidgenericframework。
businessName：業(yè)務(wù)名稱，默認(rèn)值是main。
objectKind：對象類型，默認(rèn)值是TanJiaJun。
activityName：Activity名稱，默認(rèn)值是TanJiaJunActivity。
layoutName：布局名稱，默認(rèn)值是activity_tan_jia_jun。
viewModelName：ViewModel名稱，默認(rèn)值是TanJiaJunViewModel。

每一個(gè)parameter對應(yīng)創(chuàng)建面板的一個(gè)控件，控件的id可以得到用戶輸入的值，用于渲染ftl文件。

下面以TanJiaJunAcitivityForDagger2為例生成相應(yīng)的代碼。

生成代碼

activity_tan_jia_jun.xml，代碼如下所示：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <data>

        <variable
            name="viewModel"
            type="com.tanjiajun.androidgenericframework.ui.ui.main.viewmodel.TanJiaJunViewModel" />

    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="@color/background_color">

    </androidx.constraintlayout.widget.ConstraintLayout>

</layout>

TanJiaJunActivity.kt，代碼如下所示：

package com.tanjiajun.androidgenericframework.ui.ui.main.activity

import android.os.Bundle
import androidx.activity.viewModels
import com.tanjiajun.androidgenericframework.R
import com.tanjiajun.androidgenericframework.databinding.ActivityTanJiaJunBinding
import com.tanjiajun.androidgenericframework.ui.BaseActivity
import com.tanjiajun.androidgenericframework.ui.ui.main.viewmodel.TanJiaJunViewModel

class TanJiaJunActivity : BaseActivity<ActivityTanJiaJunBinding, TanJiaJunViewModel>() {

    override val layoutRes: Int = R.layout.activity_tan_jia_jun
    override val viewModel by viewModels<TanJiaJunViewModel> { viewModelFactory }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
    }

}

TanJiaJunViewModel.kt：代碼如下所示：

package com.tanjiajun.androidgenericframework.ui.ui.main.viewmodel

import com.tanjiajun.androidgenericframework.ui.BaseViewModel
import javax.inject.Inject

class TanJiaJunViewModel @Inject constructor() : BaseViewModel() {

}

我的GitHub：TanJiaJunBeyond

Android通用框架：Android通用框架

我的掘金：譚嘉俊

我的簡書：譚嘉俊

我的CSDN：譚嘉俊

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av

Android Studio自定義模板——一鍵生成框架模板代碼

Android Studio自定義模板——一鍵生成框架模板代碼

使用方法

目錄結(jié)構(gòu)

globals.xml.ftl

recipe.xml.ftl

root

template_blank_activity.png

template.xml

生成代碼

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九 欧美,1769亚洲,黄色成人av

Android Studio自定義模板——一鍵生成框架模板代碼

使用方法

目錄結(jié)構(gòu)

globals.xml.ftl

recipe.xml.ftl

root

template_blank_activity.png

template.xml

生成代碼

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av