# 使用Flink Jar读写DIS开发指南
#### 概述
本节操作介绍基于Flink 1.12版本的Flink Jar作业读写DIS数据的操作方法。
Flink 1.12版本Flink Opensource SQL作业不支持使用DLI提供的[connector](https://support.huaweicloud.com/usermanual-dis/dis_01_0309.html)读写DIS，因此推荐您使用本节操作提供的方法。
Flink 1.15不再推荐使用DIS服务， 建议搭配DMS kafka使用。请参考[Kafka connector](https://support.huaweicloud.com/sqlref-flink-dli/dli_08_15058.html)。
#### 环境准备
- 已在DLI控制台创建了弹性资源池并添加了通用类型的队列。 具体操作请参考[创建弹性资源池并添加队列](https://support.huaweicloud.com/usermanual-dli/dli_01_0505.html)。
- 已购买了DIS通道。[开通DIS通道](https://support.huaweicloud.com/usermanual-dis/dis_01_0601.html)。
- 用户在使用Flink 1.12版本，则依赖的DIS connector版本需要不低于2.0.1，详细代码参考[DISFlinkConnector相关依赖]，如何配置connector，详细参考[自定义Flink Streaming作业](https://support.huaweicloud.com/usermanual-dis/dis_01_0304.html)。
若读取DIS，且配置groupId，则需要提前在DIS的"App管理"中创建所需的App名称。
- 请勿将disToDis.properties放在生成的jar包中，在代码里有关于disToDis.properties的路径，如果放在jar包中，代码会找不到disToDis.properties路径。
#### 操作步骤
1. 创建所需要的DIS通道，具体流程可参[开通DIS通道](https://support.huaweicloud.com/usermanual-dis/dis_01_0601.html)。
在DIS控制台，打开"App管理 \> 创建App"，填写App名称，App名称对应的是代码中的groupId。
图1创建App
2. 创建Flink Jar对应的程序包。
在DLI控制台，打开"数据管理 \> 程序包管理"，单击"创建程序包"，创建Flink Jar对应的程序包。代码样例请参考[FlinkDisToDisExample.java]样例。
表1创建Flink Jar对应的程序包主要参数说明
| 参数名称 | 说明 | 示例 |
|:---|:---|:---|
| 包类型 | 支持的包类型如下： - JAR：用户jar文件 - PyFile：用户Python文件 - File：用户文件 - ModelFile：用户AI模型文件 | JAR |
| OBS路径 | 选择对应程序包的OBS路径。 说明： - 程序包需提前上传至OBS服务中保存。 - 只支持选择文件。 | Flink Jar所在的OBS路径 |
| 分组名称 | - 选择"已有分组"：可选择已有的分组。 - 选择"创建新分组"：可输入自定义的组名称。 - 选择"不分组"：不需要选择或输入组名称。 | 自定义分组或选择已有的分组名称。 |
图2创建对应的Flink Jar包
3. 创建distoDis对应的包。
在DLI控制台，打开"数据管理 \> 程序包管理"，单击"创建程序包"，创建disToDis.properties对应的程序包。代码样例请参考[disToDis.properties样例]。
表2创建disToDis.properties对应的程序包主要参数说明
| 参数名称 | 说明 | 示例 |
|:---|:---|:---|
| 包类型 | 支持的包类型如下： - JAR：用户jar文件 - PyFile：用户Python文件 - File：用户文件 - ModelFile：用户AI模型文件 | File |
| OBS路径 | 选择对应程序包的OBS路径。 说明： - 程序包需提前上传至OBS服务中保存。 - 只支持选择文件。 | disToDis.properties所在的OBS路径。 |
| 分组名称 | - 选择"已有分组"：可选择已有的分组。 - 选择"创建新分组"：可输入自定义的组名称。 - 选择"不分组"：不需要选择或输入组名称。 | 自定义分组或选择已有的分组名称。 |
图3创建disToDis.properties对应的程序包
4. 创建Flink Jar作业并运行。 详情参考[创建Flink Jar作业](https://support.huaweicloud.com/usermanual-dli/dli_01_0457.html)。
在应用程序中选择步骤[2]中创建的Flink Jar文件，在其他依赖文件中选择步骤[3]中创建的properties文件，并指定主类。
表3创建Flink Jar作业参数说明
| 参数 | 说明 | 示例 |
|:---|:---|:---|
| 所属队列 | 队列用于指定Flink作业执行的资源队列。 队列决定了作业在弹性资源池中运行时能够使用的计算资源。每个队列都分配了指定的资源，即队列的CU，队列的CU配置直接影响作业的性能和执行效率。 在提交作业前，评估作业的资源需求，选择一个能够满足需求的队列。 Flink Jar作业即支持选择**通用类型**的队列。 | 选择Flink Jar作业运行的队列 |
| 应用程序 | 用户自定义的程序包 | 自定义的程序包 |
| 主类 | 指定加载的Jar包类名，如FlinkDisToDisExample。 - 默认：根据Jar包文件的Manifest文件指定。 - 指定：必须输入"类名"并确定类参数列表（参数间用空格分隔） 说明： 当类属于某个包时，主类路径需要包含完整包路径，例如：packagePath.KafkaMessageStreaming | 指定 |
| 其他依赖文件 | 用户自定义的依赖文件。其他依赖文件需要自行在代码中引用。 在选择依赖文件之前需要将对应的文件上传至OBS桶中，并在"数据管理\>程序包管理"中创建程序包，包类型没有限制。具体操作请参考[创建程序包](https://support.huaweicloud.com/usermanual-dli/dli_01_0367.html)。 通过在应用程序中添加以下内容可访问对应的依赖文件。其中，"fileName"为需要访问的文件名，"ClassName"为需要访问该文件的类名。 ``` ClassName.class.getClassLoader().getResource("userData/fileName") ``` | 选择[3]的properties文件。 |
| Flink版本 | 选择Flink版本前，需要先选择所属的队列。当前支持"1.10"和"1.11"和"1.12"。 | 1.12 |
图4创建Flink Jar作业
5. 结果校验。 作业处于运行中状态时，向DIS的source通道发送数据，验证DIS的sink通道能否收到数据。发送和接受都有字节数证明接收到数据。
图5查看校验结果
#### JAVA样例代码
- DIS Flink Connector相关依赖
```
com.huaweicloud.dis
huaweicloud-dis-flink-connector_2.11
2.0.1
org.apache.flink
*
org.apache.logging.log4j
*
```
- pom文件配置
```
4.0.0
org.example
Flink-dis-12
1.0-SNAPSHOT
UTF-8
1.12.2
1.8
2.11
2.13.3
2.10.0
8
8
com.huaweicloud.dis
huaweicloud-dis-flink-connector_2.11
2.0.1
org.apache.flink
*
org.apache.logging.log4j
*
org.apache.flink
flink-java
${flink.version}
provided
org.apache.flink
flink-streaming-java_${scala.binary.version}
${flink.version}
provided
org.apache.flink
flink-statebackend-rocksdb_2.11
${flink.version}
provided
org.apache.logging.log4j
log4j-slf4j-impl
${slf4j.version}
provided
org.apache.logging.log4j
log4j-api
${log4j.version}
provided
org.apache.logging.log4j
log4j-core
${log4j.version}
provided
org.apache.logging.log4j
log4j-jcl
${log4j.version}
provided
org.apache.maven.plugins
maven-assembly-plugin
3.3.0
package
single
com.flink.FlinkDisToDisExample
jar-with-dependencies
../main/config
true
**/*.*
```
- FlinkDisToDisExample.java样例（可参考[自定义Flink Streaming作业](https://support.huaweicloud.com/usermanual-dis/dis_01_0304.html)）
```
package com.flink;
import com.huaweicloud.dis.DISConfig;
import com.huaweicloud.dis.adapter.common.consumer.DisConsumerConfig;
import org.apache.flink.api.common.serialization.SimpleStringSchema;
import org.apache.flink.api.java.utils.ParameterTool;
import org.apache.flink.contrib.streaming.state.RocksDBStateBackend;
import org.apache.flink.runtime.state.filesystem.FsStateBackend;
import org.apache.flink.streaming.api.datastream.DataStream;
import org.apache.flink.streaming.api.environment.CheckpointConfig;
import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment;
import org.apache.flink.streaming.connectors.dis.FlinkDisConsumer;
import org.apache.flink.streaming.connectors.dis.FlinkDisProducer;
import org.apache.flink.util.TernaryBoolean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Collections;
/**
* Read data from dis and then write them into another dis channel.
*/
public class FlinkDisToDisExample {
private static final Logger LOG = LoggerFactory.getLogger(FlinkDisToDisExample.class);
public static void main(String[] args) throws IOException {
LOG.info("Read data from dis and write them into dis.");
String propertiesPath = FlinkDisToDisExample.class.getClassLoader()
.getResource("userData/disToDis.properties").getPath();
ParameterTool params = ParameterTool.fromPropertiesFile(propertiesPath);
// DIS终端节点，如 https://dis.cn-north-1.myhuaweicloud.com
String endpoint = params.get("disEndpoint");
// DIS服务所在区域ID，如 cn-north-1
String region = params.get("region");
// 用户的AK
String ak = params.get("ak");
// 用户的SK
String sk = params.get("sk");
// 用户的项目ID
String projectId = params.get("projectId");
// 作为source的DIS通道名称
String sourceChannel = params.get("sourceChannel");
// 作为sink的DIS通道名称
String sinkChannel = params.get("sinkChannel");
// 消费策略，只有当分区没有Checkpoint或者Checkpoint过期时，才会使用此配置的策略；如果存在有效的Checkpoint，则会从此Checkpoint开始继续消费
// 取值有： LATEST 从最新的数据开始消费，此策略会忽略通道中已有数据
// EARLIEST 从最初的数据开始消费，此策略会获取通道中所有的有效数据
String startingOffsets = params.get("startOffset");
// 消费组标识，同一个消费组下的不同客户端可以同时消费同一个通道
String groupId = params.get("groupId");
// Checkpoint输出路径，格式obs://bucket/path/
String checkpointBucket = params.get("checkpointPath");
// DIS Config
DISConfig disConfig = DISConfig.buildDefaultConfig();
disConfig.put(DISConfig.PROPERTY_ENDPOINT, endpoint);
disConfig.put(DISConfig.PROPERTY_REGION_ID, region);
disConfig.put(DISConfig.PROPERTY_AK, ak);
disConfig.put(DISConfig.PROPERTY_SK, sk);
disConfig.put(DISConfig.PROPERTY_PROJECT_ID, projectId);
disConfig.put(DisConsumerConfig.AUTO_OFFSET_RESET_CONFIG, startingOffsets);
disConfig.put(DisConsumerConfig.GROUP_ID_CONFIG, groupId);
// 是否主动更新分片信息及更新时间间隔（毫秒），若有主动扩缩容需求，可以开启
disConfig.put(FlinkDisConsumer.KEY_PARTITION_DISCOVERY_INTERVAL_MILLIS, "10000");
SimpleDateFormat dateTimeFormat = new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss");
String time = dateTimeFormat.format(System.currentTimeMillis());
String checkpointPath = checkpointBucket + time;
try {
StreamExecutionEnvironment env =
StreamExecutionEnvironment.getExecutionEnvironment();
// 设置checkpoint
RocksDBStateBackend rocksDBStateBackend = new RocksDBStateBackend(new FsStateBackend(checkpointPath),
TernaryBoolean.TRUE);
env.setStateBackend(rocksDBStateBackend);
// 开启Flink CheckPoint配置，开启时若触发CheckPoint，会将Offset信息同步到Kafka
env.enableCheckpointing(180000);
// 设置两次checkpoint的最小间隔时间
env.getCheckpointConfig().setMinPauseBetweenCheckpoints(60000);
// 设置checkpoint超时时间
env.getCheckpointConfig().setCheckpointTimeout(60000);
// 设置checkpoint最大并发数
env.getCheckpointConfig().setMaxConcurrentCheckpoints(1);
// 设置作业取消时保留checkpoint
env.getCheckpointConfig().enableExternalizedCheckpoints(
CheckpointConfig.ExternalizedCheckpointCleanup.RETAIN_ON_CANCELLATION);
FlinkDisConsumer consumer =
new FlinkDisConsumer<>(
Collections.singletonList(sourceChannel), new SimpleStringSchema(), disConfig);
DataStream sourceStream = env.addSource(consumer, "disSource");
FlinkDisProducer producer = new FlinkDisProducer<>(
sinkChannel, new SimpleStringSchema(), disConfig);
sourceStream.addSink(producer).disableChaining().name("dis-to-dis");
env.execute();
} catch (Exception ex) {
LOG.error(ex.getMessage(), ex);
}
}
}
```
- disToDis.properties样例（注意：groupId的值为步骤1中创建的App名称）
认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。
```
# dis所在局点的endpoint，如 https://dis.cn-north-1.myhuaweicloud.com
disEndpoint=xx
# DIS服务所在区域ID，如 cn-north-1
region=xx
# 用户的AK
ak=xx
# 用户的SK
sk=xx
# id示例：6m3nhAGTLxmNfZ4HOit
projectId=xx
# 作为source的dis通道，如：OpenSource_outputmTtkR
sourceChannel=xx
# 作为sink的dis通道，如：OpenSource_disQFXD
sinkChannel=xx
# dis消费组，需要提前在dis的Apps中创建
groupId=xx
# 消费模式，从最开始消费或者EARLIEST从最新开始消费LATEST
startOffset=LATEST
# flink保存checkpoint的路径
checkpointPath=obs://bucket/path/
```
#### 常见问题
- Q：作业运行失败，运行日志中有如下报错信息，应该怎么解决？
```
java.lang.NoSuchMethodError: org.apache.flink.api.java.ClosureCleaner.clean(Ljava/lang/Object;Z)V
```
A：该问题是因为所选择的huaweicloud-dis-flink-connector_2.11版本过低导致，请选择2.0.1及以上版本。
- Q：运行作业读取DIS数据时，无法读出数据且Taskmanager的运行日志中有如下报错信息，应该怎么解决？
```
ERROR com.huaweicloud.dis.adapter.common.consumer.Coordinator [] - Failed to getCheckpointAsync, error : [400 : {"errorCode":"DIS.4332","message":"app not found. "}],
request : [{"stream_name":"xx","partition_id":"shardId-0000000000","checkpoint_type":"LAST_READ","app_name":"xx"}]
```
A: 该问题是因为读取DIS数据所使用的group.id在DIS的Apps中并没有提前创建。