[OSPP] Mapper-framework-Java design and implementation by ryWangkkk · Pull Request #5900 · kubeedge/kubeedge

ryWangkkk · 2024-09-29T06:05:17Z

What type of PR is this?
/kind feature

What this PR does / why we need it:
As other language mapper-frameworks are in demand in actual business, we implement a java version mapper-framework and realize a modbus protocol based mapper as an example. The developers could use the template to customize their own protocol, which could translate information between device and kubeEdge into the format understood by each other.
Which issue(s) this PR fixes:

Fixes #5594

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

ryWangkkk · 2024-09-29T06:28:53Z

/assign @kevin-wangzefeng

wbc6080

/kind feature
/remove-kind design
Please describe in detail what this PR is used for in the description of the PR.

ryWangkkk · 2024-09-30T02:47:48Z

As other language mapper-frameworks are in demand in actual business, we implement a java version mapper-framework and realize a modbus protocol based mapper as an example. The developers could use the template to customize their own protocol, which could translate information between device and kubeEdge into the format understood by each other.

wbc6080

In the go version of mapper-framework, we provide Makefile. Users can execute make generate to generate a custom mapper project, but similar files are not found in the java version. So how to generate a user-defined mapper here?

wbc6080 · 2024-10-12T02:49:38Z

staging/src/github.com/kubeedge/mapper-framework-Java/.idea/.gitignore

+# 默认忽略的文件
+/shelf/
+/workspace.xml
+# 基于编辑器的 HTTP 客户端请求
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml


Remove these idea files

wbc6080 · 2024-10-12T02:52:30Z

...ing/src/github.com/kubeedge/mapper-framework-Java/src/main/java/data/dbmethod/Influxdb2.java

+            Point point = Point.measurement(influxdb2DataConfig.getMeasurement())
+                    .addTags(influxdb2DataConfig.getTag())
+                    .addField(influxdb2DataConfig.getFieldKey(), data.getValue())
+                    .time(Instant.now(), WritePrecision.NS); // 使用纳秒精度


Use English comments

wbc6080 · 2024-10-12T02:52:48Z

staging/src/github.com/kubeedge/mapper-framework-Java/src/main/java/data/dbmethod/Mysql.java

+                pstmt.setString(1, dateTime);  // 设置日期时间参数
+                pstmt.setString(2, data.getValue());  // 设置字段值参数
+                pstmt.executeUpdate();  // 执行插入


ditto. Please replace all Chinese comments in the code with English

wbc6080

Please make the check pipeline pass. You can run make verify and then run git status. There will be some new changes and you can push them again.

wbc6080 · 2024-10-12T03:03:18Z

As other language mapper-frameworks are in demand in actual business, we implement a java version mapper-framework and realize a modbus protocol based mapper as an example. The developers could use the template to customize their own protocol, which could translate information between device and kubeEdge into the format understood by each other.

Populate this content into the PR's description

ryWangkkk · 2024-10-24T02:27:58Z

As a java project, it makes sense that it wouldn't be able to get past the go pipeline check.
Now we have added Makefile, Dockerfile to help user quickly generate a custom mapper project and build it into a docker image.
Besides that, we have checked all codes and remove Chinese comments or replace it by English.

JiaweiGithub · 2024-10-24T02:59:16Z

staging/src/github.com/kubeedge/mapper-framework-Java/src/main/java/data/TwinData.java

+import driver.CustomizedClient;
+import grpc.GrpcClient;
+import lombok.Getter;
+import lombok.Setter;


Whether lombok compilation needs to rely on plug-in configuration ？ It is recommended to explain it in the readme document.

In this project maven is used to manage dependencies, and the pom.xml already contains this dependency

If I compile your project with Idea, don't I need to install the Lombok plugin in Idea？

You don't need to install the Lombok plugin in Idea.

JiaweiGithub · 2024-10-24T03:01:33Z

staging/src/github.com/kubeedge/mapper-framework-Java/src/main/java/data/dbmethod/Tdengine.java

+        private TDEngineClientConfig tdClientConfig;
+        public Connection initDbClient(){
+            Connection dbClient = null;
+            String userName = System.getenv("USERNAME");


USERNAME and PASSWORD are suggested to be made constants

Do you mean to set default values for USERNAME and PASSWORD?
Since USERNAME and PASSWORD are more private information, we want users to enter this information themselves and add it to the local environment.

Defined as a constant, and here we reference this constant, not a magic string

JiaweiGithub · 2024-10-24T03:02:49Z

staging/src/github.com/kubeedge/mapper-framework-Java/src/main/java/data/publish/Mqtt.java

+                client.publish(this.mqttpConfig.topic, message);
+
+                client.disconnect(250);
+                System.out.println("###############  Message published.  ###############");


Do not use System. out. println for logging, as it is usually used for temporary debugging

OK, I will correct it.

JiaweiGithub · 2024-10-24T03:04:41Z

staging/src/github.com/kubeedge/mapper-framework-Java/src/main/java/grpc/GrpcServer.java

+//
+//        File socketFile = new File(socketPath);
+//        if (socketFile.exists()) {
+//            if (socketFile.isDirectory()) {


Annotate the code, add comments to explain why, or simply delete them and explain in the readme document

OK, I will correct it.

Shelley-BaoYue · 2024-10-29T02:38:10Z

staging/src/github.com/kubeedge/mapper-framework-Java/hack/make-rules/run.sh

@@ -0,0 +1,53 @@
+##!/usr/bin/env bash


If this shell is not needed, you can remove this file.

wbc6080

Do not modify these irrelevant files. @ryWangkkk

kubeedge-bot · 2024-10-29T13:31:53Z

@JiaweiGithub: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

wbc6080 · 2024-10-30T02:35:59Z

staging/src/github.com/kubeedge/mapper-framework-Java/src/main/java/http/HTTPServer.java

+        // handle /api/v1/ping request
+        @Override
+        public void handle(HttpExchange exchange) throws IOException {
+            // 创建响应对象


Do not use Chinese comments

wbc6080 · 2024-10-30T02:36:38Z

...ng/src/github.com/kubeedge/mapper-framework-Java/src/main/java/model/common/DeviceModel.java

+    private String nameSpace = "";
+
+    @JsonProperty("description")
+    private String description = "";//这个属性暂时没用到


Signed-off-by: ryWangkkk <ryWang@zju.edu.cn> Java Version mapper framework Signed-off-by: ryWangkkk <ryWang@zju.edu.cn> Java Version mapper framework Signed-off-by: ryWangkkk <ryWang@zju.edu.cn> Java Version mapper framework Signed-off-by: ryWangkkk <ryWang@zju.edu.cn>

wbc6080

Looks good for the first version.

Mappers with other languages are best developed in independent repo, so we firstly merge into the feature development branch and then @ryWangkkk need to migrate to the new repo.

/lgtm
cc @JiaweiGithub @WillardHu @fisherxu

fisherxu

/approve

kubeedge-bot · 2024-10-30T10:04:18Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fisherxu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [fisherxu]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kubeedge-bot added the kind/design Categorizes issue or PR as related to design. label Sep 29, 2024

kubeedge-bot requested review from WillardHu and sids-b September 29, 2024 06:05

kubeedge-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Sep 29, 2024

ryWangkkk force-pushed the Mapper-framework-Java branch from d712614 to 72c0f35 Compare September 29, 2024 06:10

kubeedge-bot assigned kevin-wangzefeng Sep 29, 2024

wbc6080 reviewed Sep 29, 2024

View reviewed changes

kubeedge-bot added kind/feature Categorizes issue or PR as related to a new feature. and removed kind/design Categorizes issue or PR as related to design. labels Sep 29, 2024

wbc6080 reviewed Oct 12, 2024

View reviewed changes

JiaweiGithub reviewed Oct 24, 2024

View reviewed changes

ryWangkkk force-pushed the Mapper-framework-Java branch 5 times, most recently from 434dd21 to ce716b5 Compare October 25, 2024 05:22

ryWangkkk changed the title ~~Mapper-framework-Java design and implementation~~ [OSSP] Mapper-framework-Java design and implementation Oct 29, 2024

ryWangkkk changed the title ~~[OSSP] Mapper-framework-Java design and implementation~~ [OSPP] Mapper-framework-Java design and implementation Oct 29, 2024

Shelley-BaoYue reviewed Oct 29, 2024

View reviewed changes

wbc6080 reviewed Oct 29, 2024

View reviewed changes

ryWangkkk force-pushed the Mapper-framework-Java branch from f916f2c to 8839729 Compare October 29, 2024 13:24

ryWangkkk force-pushed the Mapper-framework-Java branch from 8839729 to 7394e7e Compare October 29, 2024 13:44

ryWangkkk force-pushed the Mapper-framework-Java branch from 7394e7e to 376531d Compare October 29, 2024 13:48

wbc6080 reviewed Oct 30, 2024

View reviewed changes

ryWangkkk force-pushed the Mapper-framework-Java branch from e34cd98 to 8af74fe Compare October 30, 2024 05:06

Shelley-BaoYue changed the base branch from master to feature-multilingual-mapper October 30, 2024 08:57

Shelley-BaoYue closed this Oct 30, 2024

Shelley-BaoYue reopened this Oct 30, 2024

wbc6080 reviewed Oct 30, 2024

View reviewed changes

kubeedge-bot added the lgtm Indicates that a PR is ready to be merged. label Oct 30, 2024

fisherxu reviewed Oct 30, 2024

View reviewed changes

kubeedge-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 30, 2024

kubeedge-bot merged commit 375ba46 into kubeedge:feature-multilingual-mapper Oct 30, 2024

Conversation

ryWangkkk commented Sep 29, 2024 • edited by wbc6080 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ryWangkkk commented Sep 29, 2024

Uh oh!

wbc6080 left a comment

Choose a reason for hiding this comment

Uh oh!

ryWangkkk commented Sep 30, 2024

Uh oh!

wbc6080 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wbc6080 left a comment

Choose a reason for hiding this comment

Uh oh!

wbc6080 commented Oct 12, 2024

Uh oh!

ryWangkkk commented Oct 24, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wbc6080 left a comment

Choose a reason for hiding this comment

Uh oh!

kubeedge-bot commented Oct 29, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wbc6080 left a comment

Choose a reason for hiding this comment

Uh oh!

fisherxu left a comment

Choose a reason for hiding this comment

Uh oh!

kubeedge-bot commented Oct 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ryWangkkk commented Sep 29, 2024 •

edited by wbc6080

Loading