You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampark.apache.org by be...@apache.org on 2026/07/29 06:10:18 UTC
(streampark) branch dev updated: [Migrate] Migrate streampark-flink-sqlclient from Scala to Java (#4462)
This is an automated email from the ASF dual-hosted git repository.
wolfboys pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampark.git
The following commit(s) were added to refs/heads/dev by this push:
new be3229ebf [Migrate] Migrate streampark-flink-sqlclient from Scala to Java (#4462)
be3229ebf is described below
commit be3229ebf160c9a0d3c7b05ea5ea076cec89d032
Author: Assert <42...@users.noreply.github.com>
AuthorDate: Wed Jul 29 14:10:12 2026 +0800
[Migrate] Migrate streampark-flink-sqlclient from Scala to Java (#4462)
* [Migrate] #4448 Migrate streampark-flink-sqlclient from Scala to Java
Convert SqlClient CLI entry to Java while preserving FQCN and submission
behavior, remove enumeratum dependency, and add unit tests for runtime mode
resolution.
Co-authored-by: Cursor <cu...@cursor.com>
* [CI] Fix Sonar issues for #4462 sqlclient migration
Use Arrays.asList for argument copying and rename inner launchers from
main to run to satisfy java:S3012 and java:S3051.
Co-authored-by: Cursor <cu...@cursor.com>
---------
Co-authored-by: Cursor <cu...@cursor.com>
---
.../streampark-flink-sqlclient/pom.xml | 5 +-
.../org/apache/streampark/flink/cli/SqlClient.java | 150 +++++++++++++++++++++
.../apache/streampark/flink/cli/SqlClient.scala | 107 ---------------
.../apache/streampark/flink/cli/SqlClientTest.java | 82 +++++++++++
4 files changed, 235 insertions(+), 109 deletions(-)
diff --git a/streampark-flink/streampark-flink-sqlclient/pom.xml b/streampark-flink/streampark-flink-sqlclient/pom.xml
index 6e9133c1c..b09e6ad60 100644
--- a/streampark-flink/streampark-flink-sqlclient/pom.xml
+++ b/streampark-flink/streampark-flink-sqlclient/pom.xml
@@ -30,8 +30,9 @@
<dependencies>
<dependency>
- <groupId>com.beachape</groupId>
- <artifactId>enumeratum_${scala.binary.version}</artifactId>
+ <groupId>org.junit.jupiter</groupId>
+ <artifactId>junit-jupiter-engine</artifactId>
+ <scope>test</scope>
</dependency>
<dependency>
diff --git a/streampark-flink/streampark-flink-sqlclient/src/main/java/org/apache/streampark/flink/cli/SqlClient.java b/streampark-flink/streampark-flink-sqlclient/src/main/java/org/apache/streampark/flink/cli/SqlClient.java
new file mode 100644
index 000000000..7556feec1
--- /dev/null
+++ b/streampark-flink/streampark-flink-sqlclient/src/main/java/org/apache/streampark/flink/cli/SqlClient.java
@@ -0,0 +1,150 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.streampark.flink.cli;
+
+import org.apache.streampark.common.conf.ConfigKeys;
+import org.apache.streampark.common.util.DeflaterUtils;
+import org.apache.streampark.common.util.PropertiesUtils;
+import org.apache.streampark.common.util.SystemPropertyUtils;
+import org.apache.streampark.flink.core.FlinkTableInitializer;
+import org.apache.streampark.flink.core.SqlCommand;
+import org.apache.streampark.flink.core.SqlCommandCall;
+import org.apache.streampark.flink.core.SqlCommandParser;
+import org.apache.streampark.flink.core.StreamTableContext;
+import org.apache.streampark.flink.core.TableContext;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.flink.api.common.RuntimeExecutionMode;
+import org.apache.flink.api.java.utils.ParameterTool;
+import org.apache.flink.configuration.ExecutionOptions;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+
+/** Flink SQL job CLI entry point. */
+public final class SqlClient {
+
+ private SqlClient() {
+ }
+
+ public static void main(String[] args) {
+ List<String> arguments = new ArrayList<>(Arrays.asList(args));
+
+ ParameterTool parameterTool = ParameterTool.fromArgs(args);
+
+ String sqlKey = ConfigKeys.KEY_FLINK_SQL();
+ String sql = parameterTool.get(sqlKey);
+ if (StringUtils.isBlank(sql)) {
+ throw new IllegalArgumentException("Usage: flink sql cannot be null");
+ }
+ String flinkSql;
+ try {
+ flinkSql = DeflaterUtils.unzipString(sql);
+ } catch (Exception e) {
+ throw new IllegalArgumentException("Usage: flink sql is invalid or null, please check");
+ }
+
+ List<SqlCommandCall> sets = new ArrayList<>();
+ for (SqlCommandCall call : SqlCommandParser.parseSQL(flinkSql)) {
+ if (call.command() == SqlCommand.SET) {
+ sets.add(call);
+ }
+ }
+
+ String defaultMode = RuntimeExecutionMode.STREAMING.name();
+ String mode =
+ resolveExecutionMode(parameterTool, sets, arguments, defaultMode);
+
+ switch (mode) {
+ case "STREAMING":
+ case "AUTOMATIC":
+ StreamSqlApp.run(arguments.toArray(new String[0]));
+ break;
+ case "BATCH":
+ BatchSqlApp.run(arguments.toArray(new String[0]));
+ break;
+ default:
+ throw new IllegalArgumentException(
+ "Usage: runtime execution-mode invalid, optional [STREAMING|BATCH|AUTOMATIC]");
+ }
+ }
+
+ static String resolveExecutionMode(
+ ParameterTool parameterTool,
+ List<SqlCommandCall> sets,
+ List<String> arguments,
+ String defaultMode) {
+ for (SqlCommandCall setCall : sets) {
+ if (setCall.operands().length > 0
+ && ExecutionOptions.RUNTIME_MODE.key().equals(setCall.operands()[0])) {
+ String runtimeMode = setCall.operands()[1].toUpperCase();
+ arguments.add("-D" + ExecutionOptions.RUNTIME_MODE.key() + "=" + runtimeMode);
+ return runtimeMode;
+ }
+ }
+
+ String configuredMode = parameterTool.get(ExecutionOptions.RUNTIME_MODE.key(), null);
+ if (configuredMode != null) {
+ return configuredMode;
+ }
+
+ String appConf = parameterTool.get(ConfigKeys.KEY_APP_CONF(), null);
+ String runtimeMode;
+ if (appConf == null) {
+ runtimeMode = defaultMode;
+ } else {
+ Map<String, String> parameter =
+ PropertiesUtils.fromYamlText(DeflaterUtils.unzipString(appConf.substring(7)));
+ runtimeMode =
+ parameter
+ .getOrDefault(ConfigKeys.KEY_FLINK_TABLE_MODE(), defaultMode)
+ .toUpperCase();
+ }
+ arguments.add("-D" + ExecutionOptions.RUNTIME_MODE.key() + "=" + runtimeMode);
+ return runtimeMode;
+ }
+
+ private static final class BatchSqlApp {
+
+ private BatchSqlApp() {
+ }
+
+ static void run(String[] args) {
+ SystemPropertyUtils.setAppHome(ConfigKeys.KEY_APP_HOME(), SqlClient.class);
+ TableContext context = new TableContext(FlinkTableInitializer.initialize(args, null));
+ context.sql();
+ context.start();
+ }
+ }
+
+ private static final class StreamSqlApp {
+
+ private StreamSqlApp() {
+ }
+
+ static void run(String[] args) {
+ SystemPropertyUtils.setAppHome(ConfigKeys.KEY_APP_HOME(), SqlClient.class);
+ StreamTableContext context =
+ new StreamTableContext(FlinkTableInitializer.initialize(args, null, null));
+ context.sql();
+ context.start();
+ }
+ }
+}
diff --git a/streampark-flink/streampark-flink-sqlclient/src/main/scala/org/apache/streampark/flink/cli/SqlClient.scala b/streampark-flink/streampark-flink-sqlclient/src/main/scala/org/apache/streampark/flink/cli/SqlClient.scala
deleted file mode 100644
index 0add0c7ab..000000000
--- a/streampark-flink/streampark-flink-sqlclient/src/main/scala/org/apache/streampark/flink/cli/SqlClient.scala
+++ /dev/null
@@ -1,107 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.apache.streampark.flink.cli
-
-import org.apache.streampark.common.conf.ConfigKeys
-import org.apache.streampark.common.util.{DeflaterUtils, PropertiesUtils, SystemPropertyUtils}
-import org.apache.streampark.common.util.Implicits._
-import org.apache.streampark.flink.core.{FlinkTableInitializer, SqlCommand, SqlCommandParser, StreamTableContext, TableContext}
-
-import org.apache.commons.lang3.StringUtils
-import org.apache.flink.api.common.RuntimeExecutionMode
-import org.apache.flink.api.java.utils.ParameterTool
-import org.apache.flink.configuration.ExecutionOptions
-
-import scala.collection.mutable.ArrayBuffer
-import scala.util.{Failure, Success, Try}
-
-object SqlClient extends App {
-
- val arguments = ArrayBuffer(args: _*)
-
- private[this] val parameterTool = ParameterTool.fromArgs(args)
-
- private[this] val flinkSql = {
- val sql = parameterTool.get(ConfigKeys.KEY_FLINK_SQL())
- require(StringUtils.isNotBlank(sql), "Usage: flink sql cannot be null")
- Try(DeflaterUtils.unzipString(sql)) match {
- case Success(value) => value
- case Failure(_) =>
- throw new IllegalArgumentException("Usage: flink sql is invalid or null, please check")
- }
- }
-
- private[this] val sets =
- SqlCommandParser.parseSQL(flinkSql).filter(_.command == SqlCommand.SET)
-
- private[this] val defaultMode = RuntimeExecutionMode.STREAMING.name()
-
- private[this] val mode =
- sets.find(_.operands.head == ExecutionOptions.RUNTIME_MODE.key()) match {
- case Some(e) =>
- // 1) flink sql execution.runtime-mode has highest priority
- val m = e.operands()(1).toUpperCase()
- arguments += s"-D${ExecutionOptions.RUNTIME_MODE.key()}=$m"
- m
- case None =>
- // 2) dynamic properties execution.runtime-mode
- parameterTool.get(ExecutionOptions.RUNTIME_MODE.key(), null) match {
- case null =>
- val m = parameterTool.get(ConfigKeys.KEY_APP_CONF(), null) match {
- case null => defaultMode
- case f =>
- val parameter: Map[String, String] =
- PropertiesUtils.fromYamlText(DeflaterUtils.unzipString(f.drop(7)))
- // 3) application conf execution.runtime-mode
- parameter
- .getOrElse(ConfigKeys.KEY_FLINK_TABLE_MODE(), defaultMode)
- .toUpperCase()
- }
- arguments += s"-D${ExecutionOptions.RUNTIME_MODE.key()}=$m"
- m
- case m => m
- }
- }
-
- mode match {
- case "STREAMING" | "AUTOMATIC" => StreamSqlApp.main(arguments.toArray)
- case "BATCH" => BatchSqlApp.main(arguments.toArray)
- case _ =>
- throw new IllegalArgumentException(
- "Usage: runtime execution-mode invalid, optional [STREAMING|BATCH|AUTOMATIC]")
- }
-
- private[this] object BatchSqlApp {
- def main(args: Array[String]): Unit = {
- SystemPropertyUtils.setAppHome(ConfigKeys.KEY_APP_HOME(), SqlClient.getClass)
- val context = new TableContext(FlinkTableInitializer.initialize(args, null))
- context.sql()
- context.start()
- }
- }
-
- private[this] object StreamSqlApp {
- def main(args: Array[String]): Unit = {
- SystemPropertyUtils.setAppHome(ConfigKeys.KEY_APP_HOME(), SqlClient.getClass)
- val context = new StreamTableContext(FlinkTableInitializer.initialize(args, null, null))
- context.sql()
- context.start()
- }
- }
-
-}
diff --git a/streampark-flink/streampark-flink-sqlclient/src/test/java/org/apache/streampark/flink/cli/SqlClientTest.java b/streampark-flink/streampark-flink-sqlclient/src/test/java/org/apache/streampark/flink/cli/SqlClientTest.java
new file mode 100644
index 000000000..9ceef8143
--- /dev/null
+++ b/streampark-flink/streampark-flink-sqlclient/src/test/java/org/apache/streampark/flink/cli/SqlClientTest.java
@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.streampark.flink.cli;
+
+import org.apache.streampark.flink.core.SqlCommand;
+import org.apache.streampark.flink.core.SqlCommandCall;
+
+import org.apache.flink.api.common.RuntimeExecutionMode;
+import org.apache.flink.api.java.utils.ParameterTool;
+import org.apache.flink.configuration.ExecutionOptions;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class SqlClientTest {
+
+ @Test
+ void resolveExecutionModeFromSetCommand() {
+ List<String> arguments = new ArrayList<>();
+ List<SqlCommandCall> sets =
+ Collections.singletonList(
+ new SqlCommandCall(
+ 1,
+ 1,
+ SqlCommand.SET,
+ new String[]{ExecutionOptions.RUNTIME_MODE.key(), "batch"},
+ "SET 'execution.runtime-mode' = 'batch'"));
+
+ String mode =
+ SqlClient.resolveExecutionMode(
+ ParameterTool.fromArgs(new String[0]),
+ sets,
+ arguments,
+ RuntimeExecutionMode.STREAMING.name());
+
+ assertEquals("BATCH", mode);
+ assertTrue(
+ arguments.contains("-D" + ExecutionOptions.RUNTIME_MODE.key() + "=BATCH"));
+ }
+
+ @Test
+ void resolveExecutionModeFromDynamicProperty() {
+ List<String> arguments = new ArrayList<>();
+ Map<String, String> properties = new HashMap<>();
+ properties.put(ExecutionOptions.RUNTIME_MODE.key(), "BATCH");
+ ParameterTool parameterTool =
+ ParameterTool.fromSystemProperties().mergeWith(ParameterTool.fromMap(properties));
+
+ String mode =
+ SqlClient.resolveExecutionMode(
+ parameterTool,
+ Collections.emptyList(),
+ arguments,
+ RuntimeExecutionMode.STREAMING.name());
+
+ assertEquals("BATCH", mode);
+ assertTrue(arguments.isEmpty());
+ }
+}