From 062fb20485a0c44d3e8537a8eef9d5ccf0f4ada0 Mon Sep 17 00:00:00 2001 From: lqyan Date: Mon, 19 Feb 2024 15:48:24 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BD=BF=E7=94=A8=E6=96=87=E6=A1=A3=E5=AE=8C?= =?UTF-8?q?=E5=96=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 81 ++++++++++++++++++- pom.xml | 15 +++- .../sdk/openapi/api/JHApiExecution.java | 6 +- .../openapi/api/app/JHAppApiExecution.java | 2 + .../sdk/openapi/api/app/SessionInfo.java | 1 - .../openapi/api/data/JHDataApiExecution.java | 1 + 6 files changed, 98 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f3b613e..520e1bc 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,87 @@ - Java 1.8 or later - Maven -- JH_Appform_6.0_Release + +## SDK与Appform的版本对应情况 + + + + + + + + + + + + + + + + + + + +
jhinno-openapi-java-sdk下载地址Appform
1.0.0 +

+ jhinno-openapi-java-sdk-6.0.0.jar +

+

+ jhinno-openapi-java-sdk-6.0.0-source.jar +

+ 		JH_Appform_6.0_Release
JH_Appform_6.0_SP1_Release
## 安装 建议在您的项目中使用Jhinno OpenAPI SDK for Java的方法是从Maven中使用它。导入如下： ```xml + com.jhinno jhinno-openapi-java-sdk - 6.0.0 + 1.0.0 + +``` + +对于没有网络的用户，可以使用以下方法使用： + +方法一：通过命令将jar包导入本地Maven仓库 + +```shell +# 其中为jar的路径，为源码路径 +mvn install:install-file -Dfile=/jhinno-openapi-java-sdk-1.0.0.jar -DgroupId=com.jhinno -DartifactId=jhinno-openapi-java-sdk -Dversion=1.0.0 -Dpackaging=jar +mvn install:install-file -Dfile=/jhinno-openapi-java-sdk-1.0.0-source.jar -DgroupId=com.jhinno -DartifactId=jhinno-openapi-java-sdk -Dversion=1.0.0 -Dpackaging=jar +# 例如 +mvn install:install-file -Dfile=D:/jar/jhinno-openapi-java-sdk-1.0.0.jar -DgroupId=com.jhinno -DartifactId=jhinno-openapi-java-sdk -Dversion=1.0.0 -Dpackaging=jar +``` + +然后在`pom.xml`添加 + +```xml + + + com.jhinno + jhinno-openapi-java-sdk + 1.0.0 + +``` + +方法二：直接在`pom.xml`引用jar + +```xml + + + com.jhinno + jhinno-openapi-java-sdk + 1.0.0 + system + ${path-to-file} ``` ## 使用 + ```java public class DemoUserSDK { @@ -49,10 +115,19 @@ public class DemoUserSDK { ``` ## 构建 + 一旦您检出代码，就可以使用Maven构建它。使用以下命令进行构建： + ```shell mvn clean install -DskipTests ``` +## 代码提交 + +- 代码必须格式化，使用IDEA自带的格式即可； +- 请求路径必须放在一个单独的const类中统一维护，具体可参考现有代码提交； +- 封装新的接口是需要继承`JHApiExecution`，调用父类的辅助方法辅助封装； + ## 作者 - - [yanlongqi](https://github.com/yanlongqi) \ No newline at end of file + +- [yanlongqi](https://github.com/yanlongqi) \ No newline at end of file diff --git a/pom.xml b/pom.xml index 2d130ef..6dba9e7 100644 --- a/pom.xml +++ b/pom.xml @@ -17,14 +17,14 @@ 8 8 UTF-8 - 6.0.0-SNAPSHOT + 1.0.0-SNAPSHOT product - 6.0.0 + 1.0.0 @@ -119,11 +119,22 @@ 3.2.2 + + org.projectlombok + lombok-maven-plugin + 1.18.0.0 + + UTF-8 + src/main/java + + + org.apache.maven.plugins maven-javadoc-plugin 2.10.4 + target/generated-sources/delombok ${project.build.sourceEncoding} ${project.build.sourceEncoding} ${project.build.sourceEncoding} diff --git a/src/main/java/com/jhinno/sdk/openapi/api/JHApiExecution.java b/src/main/java/com/jhinno/sdk/openapi/api/JHApiExecution.java index 842266d..28716be 100644 --- a/src/main/java/com/jhinno/sdk/openapi/api/JHApiExecution.java +++ b/src/main/java/com/jhinno/sdk/openapi/api/JHApiExecution.java @@ -1,6 +1,7 @@ package com.jhinno.sdk.openapi.api; import cn.hutool.crypto.symmetric.AES; +import cn.hutool.http.ContentType; import com.fasterxml.jackson.core.type.TypeReference; import com.jhinno.sdk.openapi.ArgsException; import com.jhinno.sdk.openapi.CommonConstant; @@ -143,14 +144,15 @@ public class JHApiExecution { /** * 构建一个带token的请求头 * - * @param username 用户名 + * @param username 用户名 + * @param isContentType 是否携带默认的Content-type，默认为{@link ContentType#JSON} * @return 请求头 */ protected Map getHeaders(String username, boolean isContentType) { Map headers = new HashMap<>(); // 默认请求json数据 if (isContentType) { - headers.put("Content-type", "application/json"); + headers.put("Content-type", ContentType.JSON.getValue()); } if (StringUtils.isBlank(username)) { return headers; diff --git a/src/main/java/com/jhinno/sdk/openapi/api/app/JHAppApiExecution.java b/src/main/java/com/jhinno/sdk/openapi/api/app/JHAppApiExecution.java index 99c11f7..8f2ce18 100644 --- a/src/main/java/com/jhinno/sdk/openapi/api/app/JHAppApiExecution.java +++ b/src/main/java/com/jhinno/sdk/openapi/api/app/JHAppApiExecution.java @@ -66,6 +66,7 @@ public class JHAppApiExecution extends JHApiExecution { * 注：开启密集后，仅能查看自己的会话和比自己密级低的会话 *

* + * @param username 用户名 * @return 会话列表 */ public List getDesktopList(String username) { @@ -223,6 +224,7 @@ public class JHAppApiExecution extends JHApiExecution { /** * 连接会话 * + * @param username 用户名 * @param sessionId 会话拆 * @return JHClient协议链接信息 */ diff --git a/src/main/java/com/jhinno/sdk/openapi/api/app/SessionInfo.java b/src/main/java/com/jhinno/sdk/openapi/api/app/SessionInfo.java index 0072bd2..0426fd7 100644 --- a/src/main/java/com/jhinno/sdk/openapi/api/app/SessionInfo.java +++ b/src/main/java/com/jhinno/sdk/openapi/api/app/SessionInfo.java @@ -1,6 +1,5 @@ package com.jhinno.sdk.openapi.api.app; -import com.sun.java.swing.plaf.windows.resources.windows; import lombok.Data; import java.util.Date; diff --git a/src/main/java/com/jhinno/sdk/openapi/api/data/JHDataApiExecution.java b/src/main/java/com/jhinno/sdk/openapi/api/data/JHDataApiExecution.java index e8d42af..4e507cb 100644 --- a/src/main/java/com/jhinno/sdk/openapi/api/data/JHDataApiExecution.java +++ b/src/main/java/com/jhinno/sdk/openapi/api/data/JHDataApiExecution.java @@ -35,6 +35,7 @@ public class JHDataApiExecution extends JHApiExecution { /** * 根据用户scope查询数据目录列表 * + * @param username 用户名 * @return 用户数据目录列表 */ public List getSpoolersData(String username) {