-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Flink supports udf function #5067
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,6 +46,8 @@ public enum SqlCommand { | |
|
|
||
| CREATE_DATABASE, | ||
|
|
||
| CREATE_FUNCTION, | ||
|
|
||
| ALTER_DATABASE, | ||
|
|
||
| DROP_DATABASE, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
...re/src/main/java/org/apache/linkis/engineconnplugin/flink/client/utils/FlinkUdfUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /* | ||
| * 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.linkis.engineconnplugin.flink.client.utils; | ||
|
|
||
| import org.apache.commons.collections.CollectionUtils; | ||
| import org.apache.flink.configuration.Configuration; | ||
| import org.apache.flink.configuration.PipelineOptions; | ||
| import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; | ||
| import org.apache.flink.table.functions.UserDefinedFunction; | ||
|
|
||
| import java.lang.reflect.Field; | ||
| import java.lang.reflect.Method; | ||
| import java.net.URL; | ||
| import java.net.URLClassLoader; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class FlinkUdfUtils { | ||
|
|
||
| private static final Logger logger = LoggerFactory.getLogger(FlinkUdfUtils.class); | ||
|
|
||
| private static final String CREATE_TEMP_FUNCTION_PATTERN = | ||
| "create\\s+temporary\\s+function\\s+(\\w+)\\s+as\\s+\"(.*?)\""; | ||
|
|
||
| private static final String CREATE_TEMP_FUNCTION_SQL = | ||
| "CREATE TEMPORARY FUNCTION IF NOT EXISTS %s AS '%s' "; | ||
|
|
||
| public static void addFlinkPipelineClasspaths(StreamExecutionEnvironment env, String path) { | ||
| logger.info("Flink udf start add pipeline classpaths, jar path: {}", path); | ||
|
|
||
| try { | ||
| Field configuration = StreamExecutionEnvironment.class.getDeclaredField("configuration"); | ||
| configuration.setAccessible(true); | ||
| Configuration conf = (Configuration) configuration.get(env); | ||
|
|
||
| Field confData = Configuration.class.getDeclaredField("confData"); | ||
| confData.setAccessible(true); | ||
| Map<String, Object> map = (Map<String, Object>) confData.get(conf); | ||
| List<String> jarList = new ArrayList<>(); | ||
| List<String> oldList = | ||
| conf.getOptional(PipelineOptions.CLASSPATHS).orElseGet(Collections::emptyList); | ||
| if (CollectionUtils.isNotEmpty(oldList)) { | ||
| jarList.addAll(oldList); | ||
| } | ||
| jarList.add(path); | ||
| map.put(PipelineOptions.CLASSPATHS.key(), jarList); | ||
| } catch (Exception e) { | ||
| logger.warn("Flink udf add pipeline classpaths failed", e); | ||
| } | ||
| } | ||
|
|
||
| public static void loadJar(String jarPath) { | ||
| logger.info("Flink udf URLClassLoader start loadJar: {}", jarPath); | ||
|
|
||
| Method method = null; | ||
| Boolean accessible = null; | ||
| try { | ||
| method = URLClassLoader.class.getDeclaredMethod("addURL", URL.class); | ||
| accessible = method.isAccessible(); | ||
|
|
||
| if (accessible == false) { | ||
| method.setAccessible(true); | ||
| } | ||
| URLClassLoader classLoader = (URLClassLoader) ClassLoader.getSystemClassLoader(); | ||
| method.invoke(classLoader, new URL(jarPath)); | ||
|
|
||
| } catch (Exception e) { | ||
| logger.warn("Flink udf URLClassLoader loadJar failed", e); | ||
| } finally { | ||
| if (accessible != null) { | ||
| method.setAccessible(accessible); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public static String extractUdfClass(String statement) { | ||
| Pattern pattern = Pattern.compile(CREATE_TEMP_FUNCTION_PATTERN); | ||
| Matcher matcher = pattern.matcher(statement); | ||
| if (matcher.find() && matcher.groupCount() >= 2) { | ||
| return matcher.group(2); | ||
| } | ||
| return ""; | ||
| } | ||
|
|
||
| public static boolean isFlinkUdf(ClassLoader classLoader, String className) { | ||
| try { | ||
| Class<?> udfClass = classLoader.loadClass(className); | ||
| if (UserDefinedFunction.class.isAssignableFrom(udfClass)) { | ||
| return true; | ||
| } | ||
|
|
||
| } catch (ClassNotFoundException e) { | ||
| logger.warn("flink udf load isFlinkUdf failed, ClassNotFoundException: {}", className); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| public static String generateFlinkUdfSql(String name, String className) { | ||
| return String.format(CREATE_TEMP_FUNCTION_SQL, name, className); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
.../src/main/scala/org/apache/linkis/engineconnplugin/flink/hook/FlinkJarUdfEngineHook.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| * 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.linkis.engineconnplugin.flink.hook | ||
|
|
||
| import org.apache.linkis.engineconn.common.creation.EngineCreationContext | ||
| import org.apache.linkis.engineconn.common.engineconn.EngineConn | ||
| import org.apache.linkis.engineconn.computation.executor.hook.UDFLoadEngineConnHook | ||
| import org.apache.linkis.engineconn.core.executor.ExecutorManager | ||
| import org.apache.linkis.engineconnplugin.flink.client.utils.FlinkUdfUtils | ||
| import org.apache.linkis.engineconnplugin.flink.executor.FlinkSQLComputationExecutor | ||
| import org.apache.linkis.manager.label.entity.Label | ||
| import org.apache.linkis.manager.label.entity.engine.{CodeLanguageLabel, EngineTypeLabel, RunType} | ||
| import org.apache.linkis.udf.utils.ConstantVar | ||
| import org.apache.linkis.udf.vo.UDFInfoVo | ||
|
|
||
| import org.apache.commons.lang3.StringUtils | ||
|
|
||
| import scala.collection.JavaConverters.asScalaBufferConverter | ||
|
|
||
| class FlinkJarUdfEngineHook extends UDFLoadEngineConnHook { | ||
| override val udfType: BigInt = ConstantVar.UDF_JAR | ||
| override val category: String = ConstantVar.UDF | ||
| override val runType = RunType.SQL | ||
|
|
||
| var labels: Array[Label[_]] = null | ||
|
|
||
| override protected def constructCode(udfInfo: UDFInfoVo): String = { | ||
| val path: String = udfInfo.getPath | ||
| val registerFormat: String = udfInfo.getRegisterFormat | ||
|
|
||
| if (StringUtils.isBlank(path) && StringUtils.isBlank(registerFormat)) { | ||
| logger.warn("Flink udfInfo path or registerFormat cannot is empty") | ||
| return "" | ||
| } | ||
|
|
||
| val udfClassName: String = FlinkUdfUtils.extractUdfClass(registerFormat) | ||
| if (StringUtils.isBlank(udfClassName)) { | ||
| logger.warn("Flink extract udf class name cannot is empty") | ||
| return "" | ||
| } | ||
|
|
||
| FlinkUdfUtils.loadJar(path) | ||
|
|
||
| if (!FlinkUdfUtils.isFlinkUdf(ClassLoader.getSystemClassLoader(), udfClassName)) { | ||
| logger.warn( | ||
| "There is no extends Flink UserDefinedFunction, skip loading flink udf: {} ", | ||
| path | ||
| ) | ||
| return "" | ||
| } | ||
|
|
||
| val flinkUdfSql: String = | ||
| FlinkUdfUtils.generateFlinkUdfSql(udfInfo.getUdfName, udfClassName) | ||
|
|
||
| logger.info( | ||
| s"Flink start load udf, udfName:${udfInfo.getUdfName}, udfJar:${path}, udfClass:${udfClassName}\n" | ||
| ) | ||
|
|
||
| if (labels != null && labels.nonEmpty) { | ||
| val executor = ExecutorManager.getInstance.getExecutorByLabels(labels) | ||
| executor match { | ||
| case computationExecutor: FlinkSQLComputationExecutor => | ||
| FlinkUdfUtils.addFlinkPipelineClasspaths( | ||
| computationExecutor.clusterDescriptor.executionContext.getStreamExecutionEnvironment, | ||
| path | ||
| ) | ||
| case _ => | ||
| } | ||
| } | ||
|
|
||
| "%sql\n" + flinkUdfSql | ||
| } | ||
|
|
||
| override def afterExecutionExecute( | ||
| engineCreationContext: EngineCreationContext, | ||
| engineConn: EngineConn | ||
| ): Unit = { | ||
| val codeLanguageLabel = new CodeLanguageLabel | ||
| engineCreationContext.getLabels().asScala.find(_.isInstanceOf[EngineTypeLabel]) match { | ||
| case Some(engineTypeLabel) => | ||
| codeLanguageLabel.setCodeType( | ||
| getRealRunType(engineTypeLabel.asInstanceOf[EngineTypeLabel].getEngineType).toString | ||
| ) | ||
| case None => | ||
| codeLanguageLabel.setCodeType(runType.toString) | ||
| } | ||
| labels = Array[Label[_]](codeLanguageLabel) | ||
|
|
||
| super.afterExecutionExecute(engineCreationContext, engineConn) | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
.../flink-core/src/test/java/org/apache/linkis/engineplugin/flink/LinkisFlinkUdfExample.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /* | ||
| * 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.linkis.engineplugin.flink; | ||
|
|
||
| import org.apache.flink.table.functions.ScalarFunction; | ||
|
|
||
| public class LinkisFlinkUdfExample extends ScalarFunction { | ||
| public String eval(String str) { | ||
| return String.format("linkis flink udf test: %s", str); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it necessary to consider the situation where the value was originally changed to append list?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, thanks for reviewing the code