Android Studio 代码模板

2026-08-04

目标是快速开发，实现一套文件的快速创建，例如创建一个滑动的列表，直接创建 Activity 或 Fragment + Adapter + Layout + itemLayout，但是看了一下网上的教程都是在旧版本的 Android Studio 有添加一套代码模板的入口，只能通过 IDEA 编写 Android Studio 插件的形式进行添加，并且添加文件也只是添加在同一个文件目录下面，这个跟项目目录不相符。

但是有创建单个文件的代码模板，例如根据现在项目的情况，快速创建 Activity、Fragment、Adapter。

1. 文件代码模板

都是统一的创建模板的入口，在 Settings > Editor > File and Code Templates > File 中添加就可以了。

其中的变量名可以直接命名，理解成是字符串替换。下面举三个例子。

1.1 创建 Activity 代码模板

在 File 中创建一个 Activity 的选项，再右侧编辑框输入以下内容。

Activity 代码模板配置

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}

import com.alibaba.android.arouter.facade.annotation.Route
import com.gbits.annotations.AddTheme
import com.gbits.common.event.MessageEvent
import com.gbits.common.extensions.StatusBarUtil
import com.gbits.rastar.data.router.RouterPath
import com.gbits.rastar.databinding.RefreshFragmentLayoutBinding
import com.gbits.rastar.ui.base.BaseActivity

#end
#parse("File Header.java")
@AddTheme
@Route(path = ${ROUTER_PATH})
class ${NAME}Activity : BaseActivity<${Binding}>() {

    override fun getContentView(): ${Binding} = ${Binding}.inflate(layoutInflater)

    /**
     * 绑定UI事件
     */
    override fun initViews() {
        StatusBarUtil.setDarkMode(this, true)

    }

    /**
     * 绑定数据
     */
    override fun bindData() {
        super.bindData()


        // 初始化数据
        onRefresh()
    }

    /**
     * 处理消息
     */
    override fun handleMessage(event: MessageEvent) {
        super.handleMessage(event)

    }

    /**
     * 刷新数据
     */
    private fun onRefresh() {

    }
}

创建完成后，在 File > New 就能找到对应的选项了。

新建菜单中的 Activity 选项

在选项选择 Activity 后会弹出选项框，在选项框输入对应的参数就能创建对应的类了。对应的这些参数就是在上面的代码模板中建的名字，代码模板直接按照字符串一样直接将这些拼接起来。

Activity 参数输入弹窗

点击 OK 之后就能生成对应的模板代码文件了。

生成的模板代码文件

1.2 创建 Fragment 代码模板

跟 Activity 也是相同的道理，操作步骤也是一样的，下面是代码模板。

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}

import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import com.gbits.common.event.MessageEvent
import com.gbits.rastar.ui.base.BaseFragment

#end
#parse("File Header.java")

class ${NAME}Fragment : BaseFragment<${VIEW_BINDING}>() {

    override fun getContentView(
        inflater: LayoutInflater,
        parent: ViewGroup?,
        attachToParent: Boolean
    ): ${VIEW_BINDING} =
        ${VIEW_BINDING}.inflate(inflater, parent, attachToParent)

    /**
     * UI绑定
     */
    override fun initView(view: View) {

    }

    /**
     * 数据绑定
     */
    override fun bindData() {
        super.bindData()

        onRefresh()
    }

    /**
     * 数据刷新
     */
    override fun onRefresh() {
        super.onRefresh()

    }

    /**
     * 处理消息
     */
    override fun handleMessage(event: MessageEvent) {
        super.handleMessage(event)

    }
}

1.3 创建 Adapter 代码模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}

import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import com.gbits.common.basic.BaseListAdapter

#end
#parse("File Header.java")
class ${NAME}Adapter() : BaseListAdapter<${MODEL_CLASS}, ${NAME}Adapter.${NAME}ViewHolder>() {

    class ${NAME}ViewHolder(
        private val binding: ${LAYOUT_NAME}Binding,
    ) : BaseListAdapter.DataViewHolder<${MODEL_CLASS}>(binding.root) {
        override fun bindData(data: ${MODEL_CLASS}) {

        }
    }

    override fun isDiffEnabled(): Boolean {
        return false
    }

    override fun areItemsTheSame(oldItem: ${MODEL_CLASS}, newItem: ${MODEL_CLASS}): Boolean {
        return false
    }

    override fun areContentsTheSame(oldItem: ${MODEL_CLASS}, newItem: ${MODEL_CLASS}): Boolean {
        return false
    }

    override fun onCreateDataItemViewHolder(parent: ViewGroup): ${NAME}ViewHolder {
        val binding =
            ${LAYOUT_NAME}Binding.inflate(LayoutInflater.from(parent.context), parent, false)
        return ${NAME}ViewHolder(binding)
    }

    override fun bindDataItemViewHolder(holder: ${NAME}ViewHolder, position: Int) {
        holder.bindData(dataList[position])
    }
}

2. 代码模板

2.1 创建代码块模板

创建模板的入口，在 Settings > Editor > Live Templates。

将相同的功能模块创建成一个模板，输入关键字就能快速带入。

// 例如默认的 log 模板，输入 logd 就可以添加
// 模板是：android.util.Log.d(TAG, "$METHOD_NAME$: $content$");
Log.d(TAG, "initViews: ")

// 抑或我创建了一个使用 Slog 的模板，通过 slog 就可以生成提示，直接回车就能补全
// 模板，直接导包 + 光标停留在 content 的位置，方便输入 log 信息
com.gbits.common.utils.Slog.d("yangg :$content$")
// 生成结果
Slog.d("yangg :")

部分常用的代码模板介绍。

缩写	功能描述
newInstance	Fragment 创建对象的 newInstance 方法
key	创建常量，KEY_ 开头