使用文档完善

2026-03-22 06:15:10 +08:00 · 2024-02-19 15:48:24 +08:00
parent ccff90c96a
commit 062fb20485
6 changed files with 98 additions and 8 deletions
--- a/README.md
+++ b/README.md
@@ -6,21 +6,87 @@

 - Java 1.8 or later
 - Maven
- JH_Appform_6.0_Release
+
+## SDK与Appform的版本对应情况
+
+<table>
+    <thead>
+        <tr>
+            <td>jhinno-openapi-java-sdk</td>
+            <td>下载地址</td>
+            <td>Appform</td>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td rowspan="2">1.0.0</td>
+            <td rowspan="2">
+                <p>
+                    <a href="http://192.168.87.22:8000/job/jhinno-openapi-java-sdk/lastSuccessfulBuild/artifact/target/jhinno-openapi-java-sdk-1.0.0.jar">jhinno-openapi-java-sdk-6.0.0.jar</a>
+                </p>
+                <p>
+                    <a href="http://192.168.87.22:8000/job/jhinno-openapi-java-sdk/lastSuccessfulBuild/artifact/target/jhinno-openapi-java-sdk-1.0.0-SNAPSHOT.jar">jhinno-openapi-java-sdk-6.0.0-source.jar</a>
+                </p>
+            </td>
+            <td>JH_Appform_6.0_Release</td>
+        </tr>
+        <tr>
+            <td>JH_Appform_6.0_SP1_Release</td>
+        </tr>
+    </tbody>
+</table>

 ## 安装

 建议在您的项目中使用Jhinno OpenAPI SDK for Java的方法是从Maven中使用它。导入如下：

 ```xml
+
 <dependency>
    <groupId>com.jhinno</groupId>
    <artifactId>jhinno-openapi-java-sdk</artifactId>
-    <version>6.0.0</version>
+    <version>1.0.0</version>
+</dependency>
+```
+
+对于没有网络的用户，可以使用以下方法使用：
+
+方法一：通过命令将jar包导入本地Maven仓库
+
+```shell
+# 其中<path-to-file-jar>为jar的路径，<path-to-file-source-jar>为源码路径
+mvn install:install-file -Dfile=<path-to-file-jar>/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=<path-to-file-source-jar>/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
+
+<dependency>
+    <groupId>com.jhinno</groupId>
+    <artifactId>jhinno-openapi-java-sdk</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+方法二：直接在`pom.xml`引用jar
+
+```xml
+<!-- 其中${path-to-file}为jar的位置 -->
+<dependency>
+    <groupId>com.jhinno</groupId>
+    <artifactId>jhinno-openapi-java-sdk</artifactId>
+    <version>1.0.0</version>
+    <scope>system</scope>
+    <systemPath>${path-to-file}</systemPath>
 </dependency>
 ```

 ## 使用
+
 ```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)
--- a/pom.xml
+++ b/pom.xml
@@ -17,14 +17,14 @@
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <project.release.version>6.0.0-SNAPSHOT</project.release.version>
+        <project.release.version>1.0.0-SNAPSHOT</project.release.version>
    </properties>

    <profiles>
        <profile>
            <id>product</id>
            <properties>
-                <project.release.version>6.0.0</project.release.version>
+                <project.release.version>1.0.0</project.release.version>
            </properties>
        </profile>
    </profiles>
@@ -119,11 +119,22 @@
                <version>3.2.2</version>
            </plugin>

+            <plugin>
+                <groupId>org.projectlombok</groupId>
+                <artifactId>lombok-maven-plugin</artifactId>
+                <version>1.18.0.0</version>
+                <configuration>
+                    <encoding>UTF-8</encoding>
+                    <sourceDirectory>src/main/java</sourceDirectory>
+                </configuration>
+            </plugin>
+
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.10.4</version>
                <configuration>
+                    <sourcepath>target/generated-sources/delombok</sourcepath>
                    <encoding>${project.build.sourceEncoding}</encoding>
                    <docencoding>${project.build.sourceEncoding}</docencoding>
                    <charset>${project.build.sourceEncoding}</charset>
--- 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;
@@ -144,13 +145,14 @@ public class JHApiExecution {
     * 构建一个带token的请求头
     *
     * @param username      用户名
+     * @param isContentType 是否携带默认的Content-type，默认为{@link ContentType#JSON}
     * @return 请求头
     */
    protected Map<String, String> getHeaders(String username, boolean isContentType) {
        Map<String, String> 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;
--- 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 {
     * 注：开启密集后，仅能查看自己的会话和比自己密级低的会话
     * </p>
     *
+     * @param username 用户名
     * @return 会话列表
     */
    public List<SessionInfo> getDesktopList(String username) {
@@ -223,6 +224,7 @@ public class JHAppApiExecution extends JHApiExecution {
    /**
     * 连接会话
     *
+     * @param username  用户名
     * @param sessionId 会话拆
     * @return JHClient协议链接信息
     */
--- 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;
--- 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<SpoolerDataInfo> getSpoolersData(String username) {