AS自定义模板，效率提升的不是一星半点

/   今日科技快讯   /

TikTok已与流媒体巨头Netflix接洽&＃xff0c;以“评估其对收购TikTok美国业务的兴趣”。据悉&＃xff0c;Netflix已经接受了与TikTok母公司字节跳动进行谈判的邀请。面对美国禁令的威胁&＃xff0c;TikTok正在考虑出售美国业务。

/   作者简介   /

本篇文章来自谭嘉俊的投稿&＃xff0c;和大家分享了在android studio中如何制作一键生成框架代码的模板&＃xff0c;相信会对大家有所帮助&＃xff01;同时也感谢作者贡献的精彩文章&＃xff01;

谭嘉俊的博客地址&＃xff1a;

https://juejin.im/user/2400989124522446

/   前言   /

本文章讲解的内容是Android Studio自定义模板——一键生成框架模板代码。

为了快速使用Android通用框架开发项目&＃xff0c;我配置了一套属于它的模板&＃xff0c;可以一键生成框架模板代码。

GitHub地址&＃xff1a;

https://github.com/TanJiaJunBeyond/AndroidGenericFrameworkTemplate

/   使用方法   /

将模板下载回来&＃xff0c;目录如下图所示&＃xff1a;

• TanJiaJunActivityForDagger2&＃xff1a;用于生成Dagger2版本的Activity对应的xml、Activity和ViewModel。

• TanJiaJunFragmentForDagger2&＃xff1a;用于生成Dagger2版本的Fragment对应的xml、Fragment和ViewModel。

• TanJiaJunActivityForKoin&＃xff1a;用于生成Koin版本的Activity对应的xml、Activity和ViewModel。

• TanJiaJunFragmentForKoin&＃xff1a;用于生成Koin版本的Fragment对应的xml、Fragment和ViewModel。

然后把TanJiaJunActivityForDagger2和TanJiaJunActivityForKoin放到Activity模板目录下&＃xff0c;把TanJiaJunActivityForKoin和TanJiaJunFragmentForKoin放到Fragment模板目录下。

Activity模板目录地址&＃xff1a;/Applications/Android Studio.app/Contents/plugins/android/lib/templates/activities&＃xff0c;如下图所示&＃xff1a;

Fragment模板目录地址&＃xff1a;/Applications/Android Studio.app/Contents/plugins/android/lib/templates/fragments&＃xff0c;如下图所示&＃xff1a;

最后重启Android Studio&＃xff0c;然后就可以使用这些模板了&＃xff0c;如下图所示&＃xff1a;

Activity

Fragment

创建面板界面如下图所示&＃xff1a;

下面用TanJiaJunActivityForDagger2来描述目录结构。

/   目录结构   /

目录结构如下图所示&＃xff1a;

globals.xml.ftl

用于定义全局变量&＃xff0c;代码如下所示&＃xff1a;


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

recipe.xml.ftl

该文件可以定义如下常用的标签&＃xff1a;

• copy&＃xff1a;复制文件到目标目录&＃xff0c;可以用于将图标复制到项目的文件夹。

• merge&＃xff1a;合并&＃xff0c;可以用于将文件和项目中现有的文件合并。

• instantiate&＃xff1a;通过FreeMarker将ftl文件中的变量都转换成对应的值&＃xff0c;并且生成我们想要的文件。

• open&＃xff1a;在代码生成后&＃xff0c;打开指定的文件。

FreeMarker是一个模板引擎&＃xff0c;它可以用来生成输出文本&＃xff08;例如&＃xff1a;HTML网页、电子邮件、配置文件、源代码等&＃xff09;的通用工具&＃xff0c;如下图所示&＃xff1a;

FreeMarker的工作原理&＃xff0c;如下图所示&＃xff1a;

代码如下所示&＃xff1a;


<#import "root://activities/common/kotlin_macros.ftl" as kt>
<&＃64;kt.addAllKotlinDependencies />

我解释下代码的逻辑&＃xff1a;在指定的目录下&＃xff0c;用activity_tan_jia_jun_for_dagger2.xml.ftl文件生成${layoutName}.xml文件&＃xff0c;用TanJiaJunActivityForDagger2.kt.ftl文件生成${activityName}.kt文件&＃xff0c;用TanJiaJunViewModelForDagger2.kt.ftl文件生成${viewModelName}.kt文件&＃xff0c;最后打开${activityName}.kt文件。

root

存放ftl文件&＃xff0c;也就是模板代码&＃xff0c;代码如下所示&＃xff1a;

activity_tan_jia_jun_for_dagger2.xml.ftl

TanJiaJunActivityForDagger2.kt.ftl

package ${kotlinEscapedPackageName}.ui.${businessName}.activityimport 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() {override val layoutRes: Int &＃61; 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}.viewmodelimport com.tanjiajun.androidgenericframework.ui.BaseViewModel
import javax.inject.Injectclass ${viewModelName} &＃64;Inject constructor() : BaseViewModel() {}

template_blank_activity.png

展示模板界面的缩略图&＃xff0c;如下图所示&＃xff1a;

template.xml

用于定义创建面板的控件&＃xff0c;代码如下所示&＃xff1a;


template_blank_activity.png

• packageName&＃xff1a;包名&＃xff0c;默认值是com.tanjiajun.androidgenericframework。

• businessName&＃xff1a;业务名称&＃xff0c;默认值是main。

• objectKind&＃xff1a;对象类型&＃xff0c;默认值是TanJiaJun。

• activityName&＃xff1a;Activity名称&＃xff0c;默认值是TanJiaJunActivity。

• layoutName&＃xff1a;布局名称&＃xff0c;默认值是activity_tan_jia_jun。

• viewModelName&＃xff1a;ViewModel名称&＃xff0c;默认值是TanJiaJunViewModel。

每一个parameter对应创建面板的一个控件&＃xff0c;控件的id可以得到用户输入的值&＃xff0c;用于渲染ftl文件。

下面以TanJiaJunAcitivityForDagger2为例生成相应的代码。

/   生成代码   /

activity_tan_jia_jun.xml&＃xff0c;代码如下所示&＃xff1a;

TanJiaJunActivity.kt&＃xff0c;代码如下所示&＃xff1a;

package com.tanjiajun.androidgenericframework.ui.ui.main.activityimport 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.TanJiaJunViewModelclass TanJiaJunActivity : BaseActivity() {override val layoutRes: Int &＃61; R.layout.activity_tan_jia_junoverride val viewModel by viewModels { viewModelFactory }override fun onCreate(savedInstanceState: Bundle?) {super.onCreate(savedInstanceState)}}

TanJiaJunViewModel.kt&＃xff1a;代码如下所示&＃xff1a;

package com.tanjiajun.androidgenericframework.ui.ui.main.viewmodelimport com.tanjiajun.androidgenericframework.ui.BaseViewModel
import javax.inject.Injectclass TanJiaJunViewModel &＃64;Inject constructor() : BaseViewModel() {}

项目地址&＃xff1a;

https://github.com/codoon/ThreadTracker

推荐阅读&＃xff1a;

我的新书&＃xff0c;《第一行代码 第3版》已出版&＃xff01;

Jetpack新成员&＃xff0c;App Startup一篇就懂

自定义一个密码输入框吧&＃xff01;

欢迎关注我的公众号

学习技术或投稿

长按上图&＃xff0c;识别图中二维码即可关注