代码模板

最近更新时间:2025-09-01 14:09:31

我的收藏

功能概述

代码模板提供代码复用能力,创建一个代码,可以被多个任务使用,实现代码的复用和代码的统一管理能力。

使用场景

在实际的开发场景中,存在大量类似的 SQL 代码,业务逻辑完全相同,仅部分内容存在差异。例如输入表和输出表的结构一致仅名称上存在差异,此时,开发者可以将该 SQL 抽象成一个模板,将存在差异的地方定义为一个参数。在任务中引用模板,并配置不同的参数值,即可实现 SQL 代码的复用。

功能说明

进入代码模板

2. 单击左侧菜单中的项目列表,找到需要配置告警规则的目标项目。
3. 选择项目后,单击进入离线开发模块。
4. 单击左侧菜单中的代码模板。

新建模板

单击左上角图标展开菜单,并单击新建模板


第一步:新建代码模板

模板名称:定义模板名称。
支持任务类型:当前支持任务 DLC SQL、DLC PySpark、Python,选择模板需要应用的任务类型。
模板描述:配置模板描述信息。
目标文件夹:可根据业务需要定义和选择文件夹,方便对模板进行管理。


第二步:配置模板内容并提交

代码编辑器:配置模板的代码内容,参数可采用${}的方式定义。
模板属性配置:
属性
内容
模板名称
可定义或修改模板名称,支持中文、英文、数字、下划线(_)和中划线(-)。
模板描述
可定义或修改模板描述.
负责人
新建时默认当前操作人为负责人,您后续可在该入口修改负责人。
其他运行相关参数
根据模板支持任务类型的不同展示不同的运行配置参数,参数仅在模板测试运行时生效,不会在引用模板的任务中生效,引用模板的任务需单独配置对应参数。例如,这里 DLC SQL 任务可以配置 Spark SQL 配置参数,用于当前模板的测试运行。所需参数及含义可参考计算任务节点具体描述。
资源配置
可选运行此模板的已有资源组或自定义资源。
网络配置
通过任务绑定网络配置,可以实现对指定网络下数据的访问。可在 DLC-数据引擎-网络配置 中查看详情。
版本
可查看模板历史版本详细信息,可进行对比和回滚等操作,回滚后需重新提交才能生效。
引用记录
支持查看引用当前模板的任务,方便用户进行模板管理。


第三步:测试运行

测试运行,编辑完模板后,可进行模板测试运行。单击编辑器上方的运行操作,定义参数值,即可进行模板测试,可在当前页面查看运行结果及日志。


第四步:提交

测试无问题后,即可进行提交。单击编辑器上方提交操作,完成提交。提交后引用模板的任务将在生产态使用模板最新版本的代码。


任务中引用模板

第一步:新建任务

1. 进入离线开发 > 编排空间 > 工作流目录,单击右上角新建任务
2. 新建任务时,若创建任务类型为 DLC SQL、DLC PySpark、Python,则可选择引用模板方式创建任务,引用模板后,任务的代码编辑器中将会展示模板的代码,且不支持修改。
创建方式:选择引用模板
模板名称:选择需要引用的模板名称
注意:
任务只会引用模板的代码内容,不引用调度资源组、数据源等其他配置。
模板功能仅 DLC SQL、DLC PySpark、Python 三个任务类型支持。
仅提交过的模板才能在创建任务时被选中。


第二步:配置模板参数值

任务属性 > 调度参数中,配置模板参数的值。
可手动填写参数名和参数值。
也可点击自动解析代码参数,定义参数值后点击确认,即可完成模板参数值的配置。


修改模板

引用模板的任务,您无法直接修改其代码,需统一修改代码模板中的代码。修改方式如下:
1. 打开代码模板,修改代码内容。
2. 提交:在更新场景中,提交代码模板若有参数的新增,您可以在提交时给引用代码模板的任务配置参数值,配置好的参数值会在提交时自动填充到对应任务的调度参数中,即您无需在重复提交任务。
提交时默认勾选同时更新引用任务的调度运行代码:
勾选:
为新建、已下线状态的任务修改编排空间中任务已保存的版本。
为调度中、已暂停、已失效的任务修改编排空间中任务已保存的版本并使处于调度中的任务使用修改后的代码运行(即本次代码模板的改动在调度中生效);
不勾选:针对所有状态的任务均对编排空间中任务已保存的版本做修改。