AndroidStudio4.1 自定义模板的使用方法

简介

在开发 Android 应用过程中，我们经常需要创建大量的 Activity、Fragment、Adapter、ViewModel 等等。而每次新建这些文件都需要手动创建，费时费力，容易出错。Android Studio 就提供了模板功能，支持快速生成各种文件模板。在 Android Studio 4.1 及以上版本，用户还可以自定义模板，以进一步提高开发效率。

步骤

步骤一：创建模板

1. 首先要新建一个模板，打开 Android Studio ，选择 File -> New -> New Template。如果找不到该选项，可以进入 Preferences -> Editor -> File and Code Templates 界面，点击“+”按钮即可。

2. 在出现的 “Create new Template” 窗口中，可以自定义模板的名称、描述和类别。例如，我创建了一个叫做 MVPActivity 的 Activity 模板，类别为 Activity。

3. 编辑模板文件。模板文件是一个或多个文件的集合，用于描述所创建文件的内容和结构。具体而言，可以包含以下内容：

4. velocity 脚本。velocity 语言是一种基于模板的代码生成语言，常用于 Eclipse 和 Android Studio 等开发工具中的代码模板。模板文件的主要内容就是这些 velocity 脚本，用于生成模板中的代码。

5. 可替换区域（variables）。这些区域可以用变量替换，从而更加灵活。例如，我们可以通过 $NAME$ 变量来指定生成文件的名称，通过 $PACKAGE_NAME$ 变量来指定生成文件所属的包名等等。
6. 一些模板文件中需要的其他资源，例如图片和样式表等。

示例中的 MVPActivity 模板的 velocity 脚本如下：

#set ($packagePath = $PACKAGE_NAME.replace(".", "/"))
#set ($presenterName = $NAME + "Presenter")
#set ($contractName = $NAME + "Contract")

package $PACKAGE_NAME.ui.activity.$NAME.toLowerCase()
$BLANK_LINE$
import android.os.Bundle;
import com.blankj.utilcode.util.ToastUtils;
import $PACKAGE_NAME.R;
import $PACKAGE_NAME.base.mvp.BaseActivity;
import $PACKAGE_NAME.ui.activity.$NAME_SERVICE_NAME;
import $PACKAGE_NAME.ui.activity.$presenterName;
import $PACKAGE_NAME.ui.activity.$contractName;
import $PACKAGE_NAME.widget.LoadingDialog;

public class $NAME extends BaseActivity<$presenterName> implements $contractName.View {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_$NAME);
        setTitle("$NAME");
        $presenterName presenter = new $presenterName(this);
        presenter.start();
    }

    @Override
    protected $presenterName createPresenter() {
        return new $presenterName(this);
    }

    @Override
    public void showLoading() {
        LoadingDialog.Companion.showLoading(this, "请稍后...");
    }

    @Override
    public void hideLoading() {
        LoadingDialog.Companion.hideLoading();
    }

    @Override
    public void showErrorMsg(String message) {
        ToastUtils.showShort(message);
    }

    @Override
    public void onSuccess(Object data) {
        ToastUtils.showShort("操作成功");
    }

    #if (${viewModel})
    @Override
    public ${NAME}ViewModel createViewModel() {
        return getViewModel(${NAME}ViewModel.class);
    }
    #end

    #if (${isService})
    @Override
    public Class<?> getServiceClazz() {
        return ${NAME}Service.class;
    }
    #end
}

步骤二：使用模板

1. 在需要创建新文件的时候，选择 File -> New，可以看到自定义模板已经被添加到菜单里了。例如，我的 MVPActivity 模板被添加到了“Activity”选项下。

2. 选择 MVPActivity 模板，弹出 “New MVPActivity” 窗口，该窗口中会有一些可配置的选项。根据需要，修改模板参数，例如修改 Activity 名称、继承的父类名称等等。

3. 点击“Finish”按钮，即可创建一个新的 Activity 文件，其中包含了模板定义的所有代码和结构。

示例

以下是两个示例，演示如何使用自定义模板：

示例一：创建 MVPActivity 文件

1. 首先创建 MVPActivity 模板，具体步骤见上文。

2. 在项目中需要创建一个 MVPActivity 文件，选择 New -> MVPActivity，弹出 “New MVPActivity” 窗口。

3. 在窗口中填写文件名，例如 "LoginActivity"，并修改 "Layout name" 为 "activity_login"，点击“Finish”按钮。

4. 自定义模板即可根据模板文件创建一个新的 Activity 文件结构，包含 Presenter、Contract 和 MVP 的提交。

示例二：创建自己的代码注释模板

1. 打开 Android Studio ，进入 Preferences -> Editor -> File and Code Templates。

2. 选择 Java -> File Header，可以看到注释文件头的模板。

3. 根据需要修改模板，例如，可以将“Created by”和“Last Modified”字段换成自己的信息。

4. 点击“Apply”按钮即可。从此以后每次新建 Java 文件时，都会自动添加自己修改后的注释文件头。