16 Commits

Author SHA1 Message Date
lqyan
bfb613c15f 上传到maven仓库的配置 2024-08-19 15:59:19 +08:00
lqyan
4f2490e797 feat(扩展 优化): 优化SDK在Springboot项目中的扩展体验 2024-08-19 12:01:08 +08:00
lqyan
88d7b7b65c feat(示例): 增加SpringBoot示例以及SDK扩展逻辑的优化 2024-08-19 11:59:35 +08:00
lqyan
753a40a6d0 release(发布): release-2.0.2 2024-08-09 19:13:57 +08:00
lqyan
0c9e98247c feat(应用): 增加更加用途和文件后缀获取应用列表 2024-08-09 19:11:36 +08:00
lqyan
d134b8dc70 feat(版本发布): 2.0.1版发布 2024-08-09 10:33:38 +08:00
lqyan
3686d17f9d feat(会话连接): 支持会话连接支持获取 WEB 会话的URL 2024-08-08 19:41:56 +08:00
lqyan
75c7e02253 feat(启动应用): 支持应用启动获取 WEB 会话的URL 2024-07-26 22:19:23 +08:00
lqyan
8ed0c93867 doc(文件上传): 文件上传方法重载 2024-07-25 10:20:47 +08:00
lqyan
79a73fed6b doc(集成文档): 修改集成文档 2024-07-25 00:05:51 +08:00
lqyan
1ddd65e34e feat(数据): 测试类的适配 2024-07-24 23:19:48 +08:00
lqyan
89e858cc39 feat(数据): 数据增加额外的属性 2024-07-24 23:19:23 +08:00
lqyan
9bc5138a18 fix(作业): 添加查询仿真作业提交表单接口 2024-07-24 23:18:39 +08:00
lqyan
688617b530 fix(获取Token): 优化Token获取时间戳,支持自定义获取 2024-07-24 23:17:28 +08:00
lqyan
56b9683cf3 fix(自动配置): SpringBoot的自动配置的优化 2024-07-24 17:57:05 +08:00
lqyan
0ac882f645 fix(认证): 新增AccessKey接口安全认证的方式 2024-07-24 16:35:44 +08:00
49 changed files with 1792 additions and 661 deletions

117
README.md
View File

@@ -16,6 +16,7 @@
1. JH_Appform_6.0_Release 1. JH_Appform_6.0_Release
2. JH_Appform_6.0_SP1_Release 2. JH_Appform_6.0_SP1_Release
3. JH_Appform_6.1_Release 3. JH_Appform_6.1_Release
3. JH_Appform_6.2_Release6.2以前用1.x.x版本
# 2. 快速开始 # 2. 快速开始
@@ -25,41 +26,34 @@
建议在您的项目中使用Jhinno OpenAPI SDK for Java的方法是从Maven中使用它。 建议在您的项目中使用Jhinno OpenAPI SDK for Java的方法是从Maven中使用它。
#### 方法一:通过Maven仓库安装 #### 方法一:通过命令将jar包导入本地Maven仓库无网络开发额外配置
> 添加仓库地址改方案为备用方案后续会上传至Maven中央仓库目前不影响正常使用
```xml
<repositories>
<repository>
<id>jhinno-nexus</id>
<name>jhinno-nexus</name>
<url>https://jhinno-nexus.yuchat.top/repository/maven-releases</url>
</repository>
</repositories>
```
#### 方法二通过命令将jar包导入本地Maven仓库
```shell ```shell
# SDK Client的jar包的导入其中<path-to-dir>为jar的路径<path-to-dir>为jar包路径 # SDK Client的jar包的导入其中<path-to-dir>为jar的路径<path-to-dir>为jar包路径
mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="<path-to-dir>/jhinno-openapi-java-sdk-1.0.0.jar" -Dsources="<path-to-dir>/jhinno-openapi-java-sdk-1.0.0-sources.jar" mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="<path-to-dir>/jhinno-openapi-java-sdk-x.x.x.jar" -Dsources="<path-to-dir>/jhinno-openapi-java-sdk-x.x.x-sources.jar"
# 例如 # 例如
mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/下载/jhinno-openapi-java-sdk-1.0.0.jar" -Dsources="E:/下载/jhinno-openapi-java-sdk-1.0.0-sources.jar" mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/下载/jhinno-openapi-java-sdk-2.0.0.jar" -Dsources="E:/下载/jhinno-openapi-java-sdk-2.0.0-sources.jar"
# SDK SpringBoot Starter的jar包的导入其中<path-to-dir>为jar的路径<path-to-dir>为jar包路径 # SDK SpringBoot Starter的jar包的导入其中<path-to-dir>为jar的路径<path-to-dir>为jar包路径
mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="<path-to-dir>/jhinno-openapi-sdk-spring-boot-starter-x.x.x.jar" -Dsources="<path-to-dir>/jhinno-openapi-sdk-spring-boot-starter-x.x.x-sources.jar" mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="<path-to-dir>/jhinno-openapi-sdk-spring-boot-starter-x.x.x.jar" -Dsources="<path-to-dir>/jhinno-openapi-sdk-spring-boot-starter-x.x.x-sources.jar"
# 例如 # 例如
mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/下载/jhinno-openapi-sdk-spring-boot-starter-1.0.1.jar" -Dsources="E:/下载/jhinno-openapi-sdk-spring-boot-starter-1.0.1-sources.jar" mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/下载/jhinno-openapi-sdk-spring-boot-starter-2.0.0.jar" -Dsources="E:/下载/jhinno-openapi-sdk-spring-boot-starter-2.0.0-sources.jar"
``` ```
> 注: > 注:
> - jhinno-openapi-java-sdk-x.x.x.jar 为SDK的jar包。 > - jhinno-openapi-java-sdk-x.x.x.jar 为SDK的jar包。
> - jhinno-openapi-java-sdk-x.x.x-sources.jar 为源码包添加可方便查看SDK代码的注释。 > - jhinno-openapi-java-sdk-x.x.x-sources.jar 为源码包添加可方便查看SDK代码的注释。
> - jhinno-openapi-sdk-spring-boot-starter-x.x.x.jar 为SDK的spring-boot-starter的jar包。 > - jhinno-openapi-sdk-spring-boot-starter-x.x.x.jar 为SDK的spring-boot-starter的jar包。
> - jhinno-openapi-sdk-spring-boot-starter-1.0.1-sources.jar 为SDK的spring-boot-starter的源码包。 > - jhinno-openapi-sdk-spring-boot-starter-x.x.x-sources.jar 为SDK的spring-boot-starter的源码包。
#### 方法二:通过源码导入(无网络开发额外配置)
```shell
git clone https://github.com/yanlongqi/jhinno-openapi-java-sdk.git
cd jhinno-openapi-java-sdk
mvn clean install
```
### 2.1.2 引入`jhinno-openapi-sdk-spring-boot-starter`坐标 ### 2.1.2 引入`jhinno-openapi-sdk-spring-boot-starter`坐标
@@ -68,7 +62,7 @@ mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/
<dependency> <dependency>
<groupId>com.jhinno</groupId> <groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-sdk-spring-boot-starter</artifactId> <artifactId>jhinno-openapi-sdk-spring-boot-starter</artifactId>
<version>1.0.1</version> <version>${最新的版本号}</version>
</dependency> </dependency>
``` ```
@@ -81,20 +75,28 @@ mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/
```yaml ```yaml
jhinno: jhinno:
openapi: openapi:
server-url: https://{appform服务器的地址}/appform server-url: https://172.17.0.5/appform
used-server-time: true access-key: xxxxx
access-key-secret: xxxx
auth-type: access_secret_mode
``` ```
#### 2.1.3.2 application.properties #### 2.1.3.2 application.properties
```properties ```properties
jhinno.openapi.server-url=https://{appform服务器的地址}/appform jhinno.openapi.server-url=https://{appform服务器的地址}/appform
jhinno.openapi.used-server-time=true jhinno.openapi.access-key=xxxxx
jhinno.openapi.access-key-secret=xxxx
jhinno.openapi.auth-type=access_secret_mode
``` ```
> 注: > 注:
> - 其中`jhinno.openapi.server-url`为景行接口服务的BaseUrl > - 其中`jhinno.openapi.server-url`为景行接口服务的BaseUrl
> - `auth-type` 认证类型,`token_mode`(Token认证) 和 `access_secret_mode`AccessKey认证Appform Release 6.2 `token_mode`
作为过渡,将会弃用;
> - `jhinno.openapi.used-server-time`是否获取服务器时间来请求token关闭可提高获取token的时间但打开有可能因为服务器时间不准确而导致token获取失败的问题。 > - `jhinno.openapi.used-server-time`是否获取服务器时间来请求token关闭可提高获取token的时间但打开有可能因为服务器时间不准确而导致token获取失败的问题。
> - `access-key` 和 `access-key-secret` 作为访问接口的凭证,需要提供集成商名称、系统名称、负责人姓名、负责电话电话信息申请。
> - 更多配置见`com.jhinno.sdk.openapi.autoconfigure.JHOpenapiProperties`源码。 > - 更多配置见`com.jhinno.sdk.openapi.autoconfigure.JHOpenapiProperties`源码。
### 2.1.4 使用 ### 2.1.4 使用
@@ -127,22 +129,7 @@ public class DemoUserSDK {
建议在您的项目中使用Jhinno OpenAPI SDK for Java的方法是从Maven中使用它。 建议在您的项目中使用Jhinno OpenAPI SDK for Java的方法是从Maven中使用它。
#### 方法一:通过Maven仓库安装 #### 方法一:通过命令将jar包导入本地Maven仓库无网络开发额外配置
> 添加仓库地址改方案为备用方案后续会上传至Maven中央仓库目前不影响正常使用
```xml
<repositories>
<repository>
<id>jhinno-nexus</id>
<name>jhinno-nexus</name>
<url>https://jhinno-nexus.yuchat.top/repository/maven-releases</url>
</repository>
</repositories>
```
#### 方法二通过命令将jar包导入本地Maven仓库
```shell ```shell
@@ -156,6 +143,14 @@ mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/
> - jhinno-openapi-java-sdk-x.x.x.jar 为SDK的jar包。 > - jhinno-openapi-java-sdk-x.x.x.jar 为SDK的jar包。
> - jhinno-openapi-java-sdk-x.x.x-sources.jar 为源码包添加可方便查看SDK代码的注释。 > - jhinno-openapi-java-sdk-x.x.x-sources.jar 为源码包添加可方便查看SDK代码的注释。
#### 方法二:通过源码导入(无网络开发额外配置)
```shell
git clone https://github.com/yanlongqi/jhinno-openapi-java-sdk.git
cd jhinno-openapi-java-sdk
mvn clean install
```
### 2.2.2 引入`jhinno-openapi-java-sdk`坐标 ### 2.2.2 引入`jhinno-openapi-java-sdk`坐标
```xml ```xml
@@ -163,7 +158,7 @@ mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/
<dependency> <dependency>
<groupId>com.jhinno</groupId> <groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-java-sdk</artifactId> <artifactId>jhinno-openapi-java-sdk</artifactId>
<version>1.0.1</version> <version>${最新的版本号}</version>
</dependency> </dependency>
``` ```
@@ -174,9 +169,10 @@ spring.xml添加以下内容
```xml ```xml
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<beans> <beans>
<bean id="apiClient" class="com.jhinno.sdk.openapi.client.JHApiClient"> <bean id="apiClient" class="com.jhinno.sdk.openapi.client.JHApiClient" init-method="initDefaultApiClient">
<property name="baseUrl" value="https://172.17.0.5/appform"/> <constructor-arg value="https://172.17.0.5/appform"/>
</bean> </bean>
<bean id="appApiExecution" class="com.jhinno.sdk.openapi.api.app.JHAppApiExecution"> <bean id="appApiExecution" class="com.jhinno.sdk.openapi.api.app.JHAppApiExecution">
<constructor-arg ref="apiClient"/> <constructor-arg ref="apiClient"/>
</bean> </bean>
@@ -229,14 +225,16 @@ public class DemoUserSDK {
- 同 2.2.1 安装一样 - 同 2.2.1 安装一样
### 2.3.2 引入`jhinno-openapi-java-sdk`坐标 ### 2.3.2 引入`jhinno-openapi-java-sdk`坐标
```xml ```xml
<dependency> <dependency>
<groupId>com.jhinno</groupId> <groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-java-sdk</artifactId> <artifactId>jhinno-openapi-java-sdk</artifactId>
<version>1.0.1</version> <version>${最新的版本号}</version>
</dependency> </dependency>
``` ```
### 2.3.3 使用 ### 2.3.3 使用
`com.jhinno.sdk.openapi.api`包下面对应`app``data``file``job``organization`这几个子包,分别代表景行`Appform` `com.jhinno.sdk.openapi.api`包下面对应`app``data``file``job``organization`这几个子包,分别代表景行`Appform`
@@ -255,16 +253,39 @@ public class DemoUserSDK {
/** /**
* JHApiClient 是一个HTTP连接池开发者需要复用 * JHApiClient 是一个HTTP连接池开发者需要复用
* 其中https://192.168.87.25/appform为景行API服务的地址 * 其中https://172.17.0.5/appform为景行API服务的地址
* 注意: JHApiClient为内置的http连接池系统只需要初始化一份即可单例调用 * 注意: JHApiClient为内置的http连接池系统只需要初始化一份即可单例调用
*/ */
private static final JHApiClient client = JHApiClient.build("https://192.168.87.25/appform"); public static final JHApiClient client = new JHApiClient("https://172.17.0.5/appform");
public static final Map<Class<? extends JHApiExecution>, JHApiExecution> jhApiClientMap = new HashMap<>();
public static final String ACCESS_KEY = "3f03747f147942bd8debd81b6c9c6a80";
public static final String ACCESS_KEY_SECRET = "e0681859b91c499eb1d2c8e09cea3242";
static {
client.initDefaultApiClient();
jhApiClientMap.put(JHAppApiExecution.class, new JHAppApiExecution());
jhApiClientMap.put(JHDataApiExecution.class, new JHDataApiExecution());
jhApiClientMap.put(JHFileApiExecution.class, new JHFileApiExecution());
jhApiClientMap.put(JHJobApiExecution.class, new JHJobApiExecution());
jhApiClientMap.put(JHDepartmentApiExecution.class, new JHDepartmentApiExecution());
jhApiClientMap.put(JHUserApiExecution.class, new JHUserApiExecution());
jhApiClientMap.forEach((k, v) -> {
v.setJhApiClient(client);
v.setAuthType(AuthType.ACCESS_SECRET_MODE);
v.setAccessKey(ACCESS_KEY);
v.setAccessKeySecret(ACCESS_KEY_SECRET);
v.setUsedServerTime(true);
});
}
public static void main(String[] args) { public static void main(String[] args) {
// 初始化一个调用调用景行会话服务接口执行器 // 初始化一个调用调用景行会话服务接口执行器
JHAppApiExecution jhAppApiExecution = new JHAppApiExecution(client); JHAppApiExecution jhAppApiExecution = (JHAppApiExecution) jhApiClientMap.get(JHAppApiExecution.class);
// 调用启动会话的接口 // 调用启动会话的接口
AppStartedInfo appStartedInfo = jhAppApiExecution.desktopStart("jhadmin", "linux_desktop", new AppStartRequest()); AppStartedInfo appStartedInfo = jhAppApiExecution.desktopStart("jhadmin", "linux_desktop", new AppStartRequest());
@@ -315,7 +336,7 @@ public class JHAppApiExecution extends JHApiExecution {
一旦您检出代码就可以使用Maven构建它。使用以下命令进行构建 一旦您检出代码就可以使用Maven构建它。使用以下命令进行构建
```shell ```shell
mvn clean package -DskipTests -P product mvn clean package
``` ```
# 5. 代码贡献 # 5. 代码贡献

View File

@@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>jhinno-openapi-java-sdk</artifactId> <artifactId>jhinno-openapi-java-sdk</artifactId>
<version>1.0.2</version> <version>2.0.3</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<name>Jhinno OpenAPI SDK for Java</name> <name>Jhinno OpenAPI SDK for Java</name>
<description>The Jhinno OpenAPI SDK for Java used for accessing Jhinno OpenApi Service</description> <description>The Jhinno OpenAPI SDK for Java used for accessing Jhinno OpenApi Service</description>
@@ -14,7 +14,7 @@
<parent> <parent>
<groupId>com.jhinno</groupId> <groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-java-sdk-parent</artifactId> <artifactId>jhinno-openapi-java-sdk-parent</artifactId>
<version>1.0.2</version> <version>2.0.3</version>
</parent> </parent>
<dependencies> <dependencies>
@@ -63,12 +63,6 @@
<artifactId>jackson-databind</artifactId> <artifactId>jackson-databind</artifactId>
</dependency> </dependency>
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.8.25</version>
</dependency>
<dependency> <dependency>
<groupId>org.projectlombok</groupId> <groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId> <artifactId>lombok</artifactId>
@@ -83,19 +77,13 @@
</dependency> </dependency>
</dependencies> </dependencies>
<distributionManagement>
<repository>
<id>jhinno-releases</id>
<url>http://192.168.87.22:8081/repository/maven-releases</url>
</repository>
</distributionManagement>
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<configuration> <configuration>
<compileSourceRoots>src/main/java</compileSourceRoots>
<source>${maven.compiler.source}</source> <source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target> <target>${maven.compiler.target}</target>
<encoding>${project.build.sourceEncoding}</encoding> <encoding>${project.build.sourceEncoding}</encoding>
@@ -135,36 +123,7 @@
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.3.0</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins> </plugins>
</build> </build>
<developers>
<developer>
<id>lqyan</id>
<name>lqyan</name>
<email>lqyan@jhinno.com</email>
</developer>
</developers>
<licenses>
<license>
<name>The Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
</project> </project>

View File

@@ -0,0 +1,19 @@
package com.jhinno.sdk.openapi;
/**
* 目前Appform的认证类型有两个Token模式和AK/SK的模式。
* 推荐使用AK/SK的模式Token模式后续将被弃用
*/
public enum AuthType {
/**
* Token模式
*/
TOKEN_MODE,
/**
* AK/SK模式
*/
ACCESS_SECRET_MODE,
}

View File

@@ -1,5 +1,9 @@
package com.jhinno.sdk.openapi; package com.jhinno.sdk.openapi;
import com.fasterxml.jackson.databind.util.StdDateFormat;
import java.text.DateFormat;
/** /**
* @author yanlongqi * @author yanlongqi
* @date 2024/1/31 10:17 * @date 2024/1/31 10:17
@@ -16,18 +20,12 @@ public class CommonConstant {
*/ */
public static final String FAILED = "failed"; public static final String FAILED = "failed";
/** /**
* 默认的token有效时间单位分钟 * AES获取Token格式
*/ */
public static final int DEFAULT_TOKEN_EFFECTIVE_TIME = 30; public static final String TokenUserFormat = "%s,%s";
/**
* token 默认剩余时间
*/
public static final int DEFAULT_TOKEN_RESIDUE_TIME = 5;
/** /**
* 获取token时AES加密的默认key * 获取token时AES加密的默认key
*/ */
@@ -39,7 +37,66 @@ public class CommonConstant {
public static final String NORMAL_CHARACTER_COMMA = ","; public static final String NORMAL_CHARACTER_COMMA = ",";
/** /**
* 是否使用服务器的时间 * 签名key
*/ */
public static final boolean DEFAULT_IS_USED_SERVER_TIME = false;
public static final String SIGNATURE = "signature";
/**
* 集成方Key
*/
public static final String ACCESS_KEY = "accessKey";
/**
* 用户名
*/
public static final String USERNAME = "username";
/**
* 时间戳
*/
public static final String CURRENT_TIME_MILLIS = "currentTimeMillis";
/**
* TOKEN
*/
public static final String TOKEN = "token";
/**
* 签名加密格式
* <ul>
* <li> accessKey </li>
* <li> username </li>
* <li> currentTimeMillis </li>
* </ul>
*/
public static final String SIGNATURE_FORMAT = "#%s#%s#%s#";
/**
* HmacSHA256 算法
*/
public static final String HMAC_SHA_256_ALGORITHM = "HmacSHA256";
/**
* AES 算法
*/
public static final String AES_ALGORITHM = "AES";
/**
* AES ECB Padding
*/
public static final String AES_ECB_PADDING = "AES/ECB/PKCS5Padding";
/**
* 标准日期时间格式精确到秒yyyy-MM-dd HH:mm:ss
*/
public static final String NORM_DATETIME_PATTERN = "yyyy-MM-dd HH:mm:ss";
/**
* 时间转换
*/
public static final DateFormat HTTP_DATETIME_FORMAT = new StdDateFormat();
} }

View File

@@ -1,17 +1,23 @@
package com.jhinno.sdk.openapi.api; 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.fasterxml.jackson.core.type.TypeReference;
import com.jhinno.sdk.openapi.ArgsException; import com.jhinno.sdk.openapi.*;
import com.jhinno.sdk.openapi.CommonConstant;
import com.jhinno.sdk.openapi.ServiceException;
import com.jhinno.sdk.openapi.api.app.JHAppApiExecution; import com.jhinno.sdk.openapi.api.app.JHAppApiExecution;
import com.jhinno.sdk.openapi.api.auth.AuthPathConstant; import com.jhinno.sdk.openapi.api.auth.AuthPathConstant;
import com.jhinno.sdk.openapi.client.DefaultHttpClientConfig;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import com.jhinno.sdk.openapi.api.app.AppPathConstant; import com.jhinno.sdk.openapi.api.app.AppPathConstant;
import org.apache.http.entity.ContentType;
import javax.crypto.Cipher;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
@@ -33,28 +39,52 @@ import java.util.concurrent.ConcurrentHashMap;
* @date 2024/1/30 19:39 * @date 2024/1/30 19:39
* @see JHAppApiExecution * @see JHAppApiExecution
*/ */
@Data
@NoArgsConstructor
public class JHApiExecution { public class JHApiExecution {
/** /**
* JHApiClient实例 * JHApiClient实例
*/ */
public JHApiClient jhApiClient; private JHApiClient jhApiClient;
/** /**
* token的超时时间 * token的超时时间
*/ */
private int tokenTimeout = CommonConstant.DEFAULT_TOKEN_EFFECTIVE_TIME; private int tokenTimeout = DefaultHttpClientConfig.DEFAULT_TOKEN_EFFECTIVE_TIME;
/** /**
* token提前获取的时间 * token提前获取的时间
*/ */
private int tokenResidueTime = CommonConstant.DEFAULT_TOKEN_RESIDUE_TIME; private int tokenResidueTime = DefaultHttpClientConfig.DEFAULT_TOKEN_RESIDUE_TIME;
/** /**
* 是否使用服务器时间开启可能会导致请求过慢但是不会太慢默认token会有缓存 * 是否使用服务器时间开启可能会导致请求过慢但是不会太慢默认token会有缓存
*/ */
private boolean isUsedServerTime = CommonConstant.DEFAULT_IS_USED_SERVER_TIME; private boolean isUsedServerTime = DefaultHttpClientConfig.DEFAULT_IS_USED_SERVER_TIME;
/**
* 是否强制获取用户的token默认{@link DefaultHttpClientConfig#DEFAULT_IS_FORCE_GET_TOKEN},
* 如果强制获取token则每次请求都去获取token
*/
private boolean isForceGetToken = DefaultHttpClientConfig.DEFAULT_IS_FORCE_GET_TOKEN;
/**
* 接口请求的认证类型
*/
private AuthType authType = AuthType.ACCESS_SECRET_MODE;
/**
* 访问密钥
*/
private String accessKey;
/**
* 访问密钥密码
*/
private String accessKeySecret;
/** /**
@@ -66,47 +96,12 @@ public class JHApiExecution {
this.jhApiClient = jhApiClient; this.jhApiClient = jhApiClient;
} }
/** /**
* 用户令牌的缓存 * 用户令牌的缓存
*/ */
private static final Map<String, TokenInfo> TOKEN_INFO_MAP = new ConcurrentHashMap<>(20); private static final Map<String, TokenInfo> TOKEN_INFO_MAP = new ConcurrentHashMap<>(20);
/**
* 设置在JHApiClient实例的实例
*
* @param jhApiClient 客户端实例
*/
public void setJHApiClient(JHApiClient jhApiClient) {
this.jhApiClient = jhApiClient;
}
/**
* 设置token超时的时间单位分钟
*
* @param tokenTimeout token的超时时间
*/
public void setTokenTimeout(int tokenTimeout) {
this.tokenTimeout = tokenTimeout;
}
/**
* 设置提前获取token的时间单位分钟
*
* @param tokenResidueTime 提前获取token的时间
*/
public void setTokenResidueTime(int tokenResidueTime) {
this.tokenResidueTime = tokenResidueTime;
}
/**
* 是否使用服务器时间
*/
public boolean isUsedServerTime() {
return isUsedServerTime;
}
/** /**
* 设置是否使用服务器时间 * 设置是否使用服务器时间
* *
@@ -120,10 +115,9 @@ public class JHApiExecution {
* 获取用户的Token * 获取用户的Token
* *
* @param username 用户名 * @param username 用户名
* @param isForce 是否强制获取toke
* @return 用户的token * @return 用户的token
*/ */
public String getToken(String username, boolean isForce) { public String getToken(String username) {
if (StringUtils.isBlank(username)) { if (StringUtils.isBlank(username)) {
throw new ArgsException("用户名称不能为空!"); throw new ArgsException("用户名称不能为空!");
} }
@@ -131,14 +125,23 @@ public class JHApiExecution {
// 防止因为服务器时间的问题二导致token不可用可以通过此配置提前获取token // 防止因为服务器时间的问题二导致token不可用可以通过此配置提前获取token
int tokenEffectiveTime = (tokenTimeout - tokenResidueTime) * 60 * 1000; int tokenEffectiveTime = (tokenTimeout - tokenResidueTime) * 60 * 1000;
// 如果是强制获取、用户令牌为空、用户令牌过期等,则获取令牌 // 如果是强制获取、用户令牌为空、用户令牌过期等,则获取令牌
if (isForce || tokenInfo == null || System.currentTimeMillis() - tokenInfo.getCurrentTimestamp() > tokenEffectiveTime) { if (isForceGetToken || tokenInfo == null || System.currentTimeMillis() - tokenInfo.getCurrentTimestamp() > tokenEffectiveTime) {
Map<String, Object> params = new HashMap<>(2); Map<String, Object> params = new HashMap<>(2);
params.put("timeout", tokenTimeout); params.put("timeout", tokenTimeout);
long currentTimeMillis = isUsedServerTime ? jhApiClient.requestTimeMillis() : System.currentTimeMillis(); String currentTimeMillis = getCurrentTimeMillis();
AES aes = new AES(CommonConstant.DEFAULT_AES_KEY.getBytes()); String beforeEncryption = String.format(CommonConstant.TokenUserFormat, username, currentTimeMillis);
String base64 = aes.encryptBase64(String.format("%s,%s", username, currentTimeMillis)); try {
params.put("username", base64); SecretKeySpec secretKey = new SecretKeySpec(CommonConstant.DEFAULT_AES_KEY.getBytes(StandardCharsets.UTF_8), CommonConstant.AES_ALGORITHM);
Cipher cipher = Cipher.getInstance(CommonConstant.AES_ECB_PADDING);
cipher.init(Cipher.ENCRYPT_MODE, secretKey);
byte[] encryptBytes = cipher.doFinal(beforeEncryption.getBytes(StandardCharsets.UTF_8));
params.put("username", Base64.getEncoder().encodeToString(encryptBytes));
} catch (Exception e) {
throw new ClientException("AES加密失败失败原因" + e.getMessage(), e);
}
String url = JHApiClient.getUrl(AuthPathConstant.AUTH_TOKEN_PATH, params); String url = JHApiClient.getUrl(AuthPathConstant.AUTH_TOKEN_PATH, params);
Map<String, String> token = get(url, new TypeReference<ResponseResult<Map<String, String>>>() { Map<String, String> token = get(url, new TypeReference<ResponseResult<Map<String, String>>>() {
}); });
@@ -151,14 +154,15 @@ public class JHApiExecution {
return tokenInfo.getToken(); return tokenInfo.getToken();
} }
/** /**
* 获取用户的Token获取缓存不强制获取 * @return
*
* @param username 用户名
* @return 用户的token
*/ */
public String getToken(String username) { public String getCurrentTimeMillis() {
return getToken(username, false); if (authType == AuthType.ACCESS_SECRET_MODE || !isUsedServerTime) {
return String.valueOf(System.currentTimeMillis());
}
return jhApiClient.getAppformServerCurrentTimeMillis();
} }
@@ -166,29 +170,66 @@ public class JHApiExecution {
* 构建一个带token的请求头 * 构建一个带token的请求头
* *
* @param username 用户名 * @param username 用户名
* @param isContentType 是否携带默认的Content-type默认为{@link ContentType#JSON} * @param isContentType 是否携带默认的Content-type默认为{@link ContentType#APPLICATION_JSON}
* @return 请求头 * @return 请求头
*/ */
protected Map<String, String> getHeaders(String username, boolean isContentType) { protected Map<String, Object> getHeaders(String username, boolean isContentType) {
Map<String, String> headers = new HashMap<>(); Map<String, Object> headers = new HashMap<>();
// 默认请求json数据 // 默认请求json数据
if (isContentType) { if (isContentType) {
headers.put("Content-type", ContentType.JSON.getValue()); headers.put("Content-type", ContentType.APPLICATION_JSON.getMimeType());
} }
if (StringUtils.isBlank(username)) { if (authType == AuthType.ACCESS_SECRET_MODE) {
return headers; if (StringUtils.isBlank(accessKey)) {
throw new ClientException("AccessKey不能为空");
}
if (StringUtils.isBlank(accessKeySecret)) {
throw new ClientException("AccessKeySecret不能为空");
}
headers.put(CommonConstant.ACCESS_KEY, accessKey);
if (StringUtils.isBlank(username)) {
username = StringUtils.EMPTY;
}
headers.put(CommonConstant.USERNAME, username);
String currentTimeMillis = getCurrentTimeMillis();
headers.put(CommonConstant.CURRENT_TIME_MILLIS, currentTimeMillis);
headers.put(CommonConstant.SIGNATURE, getsSignature(username, currentTimeMillis));
} else if (authType == AuthType.TOKEN_MODE && StringUtils.isNotBlank(username)) {
headers.put(CommonConstant.TOKEN, getToken(username));
} }
headers.put("token", getToken(username));
return headers; return headers;
} }
/**
* 获取签名
*
* @param username 用户名
* @param currentTimeMillis 时间戳
* @return 签名
*/
public String getsSignature(String username, String currentTimeMillis) {
SecretKeySpec secretKey = new SecretKeySpec(accessKeySecret.getBytes(StandardCharsets.UTF_8), CommonConstant.HMAC_SHA_256_ALGORITHM);
try {
Mac mac = Mac.getInstance(CommonConstant.HMAC_SHA_256_ALGORITHM);
mac.init(secretKey);
String beforeSignature = String.format(CommonConstant.SIGNATURE_FORMAT, accessKey, username, currentTimeMillis);
byte[] digest = mac.doFinal(beforeSignature.getBytes(StandardCharsets.UTF_8));
return Hex.encodeHexString(digest);
} catch (Exception e) {
throw new ClientException("签名加密失败,失败信息:" + e.getMessage(), e);
}
}
/** /**
* 构建一个带token的请求头 * 构建一个带token的请求头
* *
* @param username 用户名 * @param username 用户名
* @return 请求头 * @return 请求头
*/ */
protected Map<String, String> getHeaders(String username) { protected Map<String, Object> getHeaders(String username) {
return getHeaders(username, true); return getHeaders(username, true);
} }
@@ -381,7 +422,7 @@ public class JHApiExecution {
/** /**
* 退出用户的登录,释放许可 * 退出用户的登录,释放许可当用户退出登录后建议清除用户的token信息
* *
* @param username 用户名 * @param username 用户名
*/ */

View File

@@ -91,4 +91,26 @@ public class AppPathConstant {
* 获取应用链接URL * 获取应用链接URL
*/ */
public static final String APPS_GET_URL_PATH = "/ws/api/apps/{appName}/url"; public static final String APPS_GET_URL_PATH = "/ws/api/apps/{appName}/url";
/**
* WEB启动会话URL
*/
public static final String WEB_SESSION_URL_PATH = "/pageapi/apps/webclient/gui/{desktopId}";
/**
* 根据用途查询应用
* <p/>
* 该接口目前在Solutions下面维护未经过产品的测试
*/
public static final String APP_USE_LABEL_PATH = "/ws/api/app/use_label/apps";
/**
* 根据文件后缀查询应用
* <p/>
* 该接口目前在Solutions下面维护未经过产品的测试
*/
public static final String APPS_SUFFIXES_PATH = "/ws/api/apps/suffixes";
} }

View File

@@ -34,4 +34,9 @@ public class AppStartedInfo {
* 作业id有可能出现但不是太明白 * 作业id有可能出现但不是太明白
*/ */
private String jobId; private String jobId;
/**
* WEB 启动会话URL
*/
private String webSessionUrl;
} }

View File

@@ -0,0 +1,121 @@
package com.jhinno.sdk.openapi.api.app;
import lombok.Data;
/**
* 应用
*/
@Data
public class AppstoreAppInfo {
/**
* 应ID
*/
private String id;
/**
* 应用名称
*/
private String name;
/**
* 应用图标
*/
private String image;
/**
* 应用类型
*/
private String type;
/**
* 应用版本
*/
private String version;
/**
* 应用状态
*/
private Boolean status;
/**
* 是否 使用
*/
private Boolean isUsed;
/**
* CPU使用
*/
private String cpuUsage;
/**
* 空闲内存
*/
private String idleMem;
/**
*
*/
private String idleTime;
/**
* 应用路径
*/
private String appPath;
/**
* 工作路径
*/
private String appCwd;
/**
* 发布时间
*/
private String appReleaseTime;
/**
* 启动选项
*/
private String appStartOpt;
/**
* 启动前缀
*/
private String appStartPrefix;
/**
* 启动后缀
*/
private String appStartSuffix;
/**
* 应用详情
*/
private String appDetail;
/**
* 启动数量
*/
private String startNum;
/**
* 用途英文名
*/
private String useLabelEnStr;
/**
* 用途中文名
*/
private String useLabelCnStr;
/**
* 应用系统
*/
private String appOs;
/**
* 申请状态
*/
private String applyStatus;
}

View File

@@ -1,15 +1,18 @@
package com.jhinno.sdk.openapi.api.app; package com.jhinno.sdk.openapi.api.app;
import cn.hutool.core.collection.CollectionUtil;
import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.core.type.TypeReference;
import com.jhinno.sdk.openapi.ArgsException; import com.jhinno.sdk.openapi.ArgsException;
import com.jhinno.sdk.openapi.AuthType;
import com.jhinno.sdk.openapi.CommonConstant; import com.jhinno.sdk.openapi.CommonConstant;
import com.jhinno.sdk.openapi.ServiceException; import com.jhinno.sdk.openapi.ServiceException;
import com.jhinno.sdk.openapi.api.JHApiExecution; import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.ResponseResult; import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import com.jhinno.sdk.openapi.utils.CollectionUtil;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import java.util.Arrays;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@@ -20,6 +23,7 @@ import java.util.Map;
* @author yanlongqi * @author yanlongqi
* @date 2024/2/1 16:26 * @date 2024/2/1 16:26
*/ */
@NoArgsConstructor
public class JHAppApiExecution extends JHApiExecution { public class JHAppApiExecution extends JHApiExecution {
/** /**
@@ -33,8 +37,10 @@ public class JHAppApiExecution extends JHApiExecution {
/** /**
* 启动一个会话 * 启动一个会话
*
* <h4>一、通过JHClient启动</h4>
* <p> * <p>
* 方法返回一个重要的参数{@link AppStartedInfo#getJhappUrl()}拉起景行客户端协议的URL * 方法返回一个重要的参数{@link AppStartedInfo#getJhappUrl()}拉起景行客户端协议的URL
* <p> * <p>
* 测试将该URL复制粘贴到浏览器的地址栏进行访问即可启动会话。 * 测试将该URL复制粘贴到浏览器的地址栏进行访问即可启动会话。
* *
@@ -59,6 +65,16 @@ public class JHAppApiExecution extends JHApiExecution {
* iframe.src = "{@link AppStartedInfo#getJhappUrl()}"; * iframe.src = "{@link AppStartedInfo#getJhappUrl()}";
* </pre> * </pre>
* *
* <p>
* 注意如果使用JHAppClient启动应用的并且没有做浏览器端和服务器没有做时间同步
* 那么 {@link AppStartRequest#setCurrentTimestamp(String)} 参数必传,
* 并使用js生产的时间具体的参数见 {@link AppStartRequest#setCurrentTimestamp(String)}
*
* <h4>通过浏览器启动</h4>
* <pre class="code">
* window.open("{@link AppStartedInfo#getWebSessionUrl()}}")
* </pre>
*
* @param username 用户名 * @param username 用户名
* @param appId 应用拆 * @param appId 应用拆
* @param appStartRequest 启动参数 * @param appStartRequest 启动参数
@@ -71,7 +87,26 @@ public class JHAppApiExecution extends JHApiExecution {
if (CollectionUtil.isEmpty(data)) { if (CollectionUtil.isEmpty(data)) {
throw new ServiceException(path, 500, "获取到的会话信息为空"); throw new ServiceException(path, 500, "获取到的会话信息为空");
} }
return data.get(0); AppStartedInfo appStartedInfo = data.get(0);
appStartedInfo.setWebSessionUrl(getWebSessionUrl(username, appStartedInfo.getDesktopId()));
return appStartedInfo;
}
public String getWebSessionUrl(String username, String desktopId) {
String webSessionUrlPath = AppPathConstant.WEB_SESSION_URL_PATH.replace("{desktopId}", desktopId);
String url = getJhApiClient().getUrl(webSessionUrlPath);
Map<String, Object> params = new HashMap<>();
AuthType authType = getAuthType();
if (authType == AuthType.TOKEN_MODE) {
params.put(CommonConstant.TOKEN, getToken(username));
} else if (authType == AuthType.ACCESS_SECRET_MODE) {
params.put(CommonConstant.USERNAME, username);
params.put(CommonConstant.ACCESS_KEY, getAccessKey());
String currentTimeMillis = getCurrentTimeMillis();
params.put(CommonConstant.CURRENT_TIME_MILLIS, currentTimeMillis);
params.put(CommonConstant.SIGNATURE, getsSignature(username, currentTimeMillis));
}
return JHApiClient.getUrl(url, params);
} }
/** /**
@@ -264,7 +299,10 @@ public class JHAppApiExecution extends JHApiExecution {
if (CollectionUtil.isEmpty(list)) { if (CollectionUtil.isEmpty(list)) {
throw new ServiceException(path, 500, "获取到的会话信息为空"); throw new ServiceException(path, 500, "获取到的会话信息为空");
} }
return list.get(0);
AppStartedInfo appStartedInfo = list.get(0);
appStartedInfo.setWebSessionUrl(getWebSessionUrl(username, sessionId));
return appStartedInfo;
} }
@@ -356,7 +394,7 @@ public class JHAppApiExecution extends JHApiExecution {
/** /**
* 获取应用链接 * 获取应用链接
* *
* @param username 户名 * @param username 户名
* @param appName 应用名 * @param appName 应用名
* @return 应用链接地址 * @return 应用链接地址
*/ */
@@ -372,4 +410,61 @@ public class JHAppApiExecution extends JHApiExecution {
} }
return apps.get(0).get("url"); return apps.get(0).get("url");
} }
/**
* 根据文件后缀查询应用
*
* @param username 用户名
* @param suffixes 文件后缀列表
* @return 应用列表
*/
public List<AppstoreAppInfo> getAppInfoSuffixList(String username, String... suffixes) {
return getAppInfoSuffixList(username, Arrays.asList(suffixes));
}
/**
* 根据文件后缀查询应用
*
* @param username 用户名
* @param suffixes 文件后缀列表
* @return 应用列表
*/
public List<AppstoreAppInfo> getAppInfoSuffixList(String username, List<String> suffixes) {
Map<String, Object> params = new HashMap<>(1);
if (CollectionUtil.isNotEmpty(suffixes)) {
params.put("suffixes", String.join(CommonConstant.NORMAL_CHARACTER_COMMA, suffixes));
}
String path = JHApiClient.getUrl(AppPathConstant.APPS_SUFFIXES_PATH, params);
return get(path, username, new TypeReference<ResponseResult<List<AppstoreAppInfo>>>() {
});
}
/**
* 根据用途查询应用
*
* @param username 用户名
* @param labels 用途列表
* @return 应用列表
*/
public List<UseLabelInfo> getUseLabelList(String username, String... labels) {
return getUseLabelList(username, Arrays.asList(labels));
}
/**
* 根据用途查询应用
*
* @param username 用户名
* @param labels 用途列表
* @return 应用列表
*/
public List<UseLabelInfo> getUseLabelList(String username, List<String> labels) {
Map<String, Object> params = new HashMap<>(1);
if (CollectionUtil.isNotEmpty(labels)) {
params.put("use_labels", String.join(CommonConstant.NORMAL_CHARACTER_COMMA, labels));
}
String path = JHApiClient.getUrl(AppPathConstant.APP_USE_LABEL_PATH, params);
return get(path, username, new TypeReference<ResponseResult<List<UseLabelInfo>>>() {
});
}
} }

View File

@@ -0,0 +1,28 @@
package com.jhinno.sdk.openapi.api.app;
import lombok.Data;
import java.util.List;
@Data
public class UseLabelInfo {
/**
* 用途id
*/
private String useLabelId;
/**
* 用途名称
*/
private String useLabelName;
/**
* 用途图片
*/
private String useLabelIcon;
/**
* 用途app列表
*/
private List<AppstoreAppInfo> apps;
}

View File

@@ -1,6 +1,5 @@
package com.jhinno.sdk.openapi.api.data; package com.jhinno.sdk.openapi.api.data;
import cn.hutool.core.collection.CollectionUtil;
import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.core.type.TypeReference;
import com.jhinno.sdk.openapi.ArgsException; import com.jhinno.sdk.openapi.ArgsException;
import com.jhinno.sdk.openapi.CommonConstant; import com.jhinno.sdk.openapi.CommonConstant;
@@ -8,6 +7,8 @@ import com.jhinno.sdk.openapi.ServiceException;
import com.jhinno.sdk.openapi.api.JHApiExecution; import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.ResponseResult; import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import com.jhinno.sdk.openapi.utils.CollectionUtil;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import java.util.Date; import java.util.Date;
@@ -21,6 +22,7 @@ import java.util.Map;
* @author yanlongqi * @author yanlongqi
* @date 2024/2/4 17:09 * @date 2024/2/4 17:09
*/ */
@NoArgsConstructor
public class JHDataApiExecution extends JHApiExecution { public class JHDataApiExecution extends JHApiExecution {
/** /**

View File

@@ -2,6 +2,8 @@ package com.jhinno.sdk.openapi.api.file;
import lombok.Data; import lombok.Data;
import java.util.Date;
/** /**
* 文件信息 * 文件信息
* *
@@ -10,6 +12,54 @@ import lombok.Data;
*/ */
@Data @Data
public class FileInfo { public class FileInfo {
/**
* 绝对路径
*/
private String absolutePath;
/**
* 是否为空
*/
private Boolean empty;
/**
* 文件密级
*/
private Integer fileConfLevel;
/**
* 文件ID
*/
private String fileId;
/**
* 是否文件夹
*/
private Boolean folder;
/**
* ID
*/
private Long id;
/**
* 最后修改时间
*/
private Date lastModified;
/**
* 权限
*/
private String permission;
/**
* 文件大小
*/
private Long size;
/** /**
* 文件名 * 文件名
*/ */
@@ -29,11 +79,26 @@ public class FileInfo {
*/ */
private String fileType; private String fileType;
/**
* 名称
*/
private String name;
/** /**
* 文件属主 * 文件属主
*/ */
private String owner; private String owner;
/**
* 组
*/
private String group;
/**
* 其他
*/
private String other;
/** /**
* 是否可读 * 是否可读
*/ */
@@ -50,9 +115,9 @@ public class FileInfo {
private Boolean execute; private Boolean execute;
/** /**
* 是否软 * 是否软
*/ */
private Boolean link; private Integer link;
} }

View File

@@ -1,6 +1,5 @@
package com.jhinno.sdk.openapi.api.file; package com.jhinno.sdk.openapi.api.file;
import cn.hutool.core.collection.CollectionUtil;
import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.core.type.TypeReference;
import com.jhinno.sdk.openapi.ArgsException; import com.jhinno.sdk.openapi.ArgsException;
import com.jhinno.sdk.openapi.CommonConstant; import com.jhinno.sdk.openapi.CommonConstant;
@@ -8,14 +7,14 @@ import com.jhinno.sdk.openapi.ServiceException;
import com.jhinno.sdk.openapi.api.JHApiExecution; import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.ResponseResult; import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import com.jhinno.sdk.openapi.utils.CollectionUtil;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream; import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@@ -26,6 +25,7 @@ import java.util.Map;
* @author yanlongqi * @author yanlongqi
* @date 2024/2/4 18:58 * @date 2024/2/4 18:58
*/ */
@NoArgsConstructor
public class JHFileApiExecution extends JHApiExecution { public class JHFileApiExecution extends JHApiExecution {
public JHFileApiExecution(JHApiClient jhApiClient) { public JHFileApiExecution(JHApiClient jhApiClient) {
@@ -189,18 +189,23 @@ public class JHFileApiExecution extends JHApiExecution {
if (StringUtils.isBlank(uploadPath)) { if (StringUtils.isBlank(uploadPath)) {
throw new ArgsException("uploadPath是必填参数"); throw new ArgsException("uploadPath是必填参数");
} }
MultipartEntityBuilder builder = MultipartEntityBuilder.create(); Map<String, Object> body = new HashMap<>(3);
builder.setCharset(StandardCharsets.UTF_8);
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.addBinaryBody("file", is, ContentType.MULTIPART_FORM_DATA, fileName);
if (isCover != null) { if (isCover != null) {
builder.addTextBody("isCover", isCover.toString()); body.put("isCover", isCover);
} }
builder.addTextBody("uploadPath", uploadPath); body.put("uploadPath", uploadPath);
HttpPost httpPost = new HttpPost(jhApiClient.getUrl(FilePathConstant.FILE_UPLOAD_PATH));
httpPost.setEntity(builder.build()); ResponseResult<Object> result = getJhApiClient().upload(
ResponseResult<Object> result = jhApiClient.request(httpPost, getHeaders(username, false), new TypeReference<ResponseResult<Object>>() { FilePathConstant.FILE_UPLOAD_PATH,
}); "file",
fileName,
is,
getHeaders(username, false),
body,
new TypeReference<ResponseResult<Object>>() {
}
);
if (StringUtils.equals(result.getResult(), CommonConstant.FAILED)) { if (StringUtils.equals(result.getResult(), CommonConstant.FAILED)) {
throw new ServiceException(FilePathConstant.FILE_UPLOAD_PATH, result.getCode(), result.getMessage()); throw new ServiceException(FilePathConstant.FILE_UPLOAD_PATH, result.getCode(), result.getMessage());
} }
@@ -220,6 +225,55 @@ public class JHFileApiExecution extends JHApiExecution {
uploadFile(username, is, fileName, uploadPath, null); uploadFile(username, is, fileName, uploadPath, null);
} }
/**
* @param username 用户名
* @param path 本地文件路径
* @param fileName 文件名
* @param uploadPath 上传路径,服务器路径
* @param isCover 是否覆盖非必填默认false
*/
public void uploadFile(String username, String path, String fileName, String uploadPath, Boolean isCover) throws FileNotFoundException {
if (StringUtils.isBlank(path)) {
throw new ArgsException("path是必填参数");
}
File file = new File(path);
FileInputStream fileInputStream = new FileInputStream(file);
uploadFile(username, fileInputStream, fileName, uploadPath, isCover);
}
/**
* @param username 用户名
* @param path 本地文件路径
* @param fileName 文件名
* @param uploadPath 上传路径,服务器路径
*/
public void uploadFile(String username, String path, String fileName, String uploadPath) throws FileNotFoundException {
uploadFile(username, path, fileName, uploadPath, null);
}
/**
* @param username 用户名
* @param path 本地文件路径
* @param uploadPath 上传路径,服务器路径
* @param isCover 是否覆盖非必填默认false
*/
public void uploadFile(String username, String path, String uploadPath, Boolean isCover) throws FileNotFoundException {
File file = new File(path);
uploadFile(username, path, file.getName(), uploadPath, isCover);
}
/**
* @param username 用户名
* @param path 本地文件路径
* @param uploadPath 上传路径,服务器路径
*/
public void uploadFile(String username, String path, String uploadPath) throws FileNotFoundException {
File file = new File(path);
uploadFile(username, path, file.getName(), uploadPath, null);
}
/** /**
* 获取文件下载地址 * 获取文件下载地址

View File

@@ -1,7 +1,5 @@
package com.jhinno.sdk.openapi.api.job; package com.jhinno.sdk.openapi.api.job;
import cn.hutool.core.collection.CollectionUtil;
import cn.hutool.json.JSONUtil;
import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.core.type.TypeReference;
import com.jhinno.sdk.openapi.ArgsException; import com.jhinno.sdk.openapi.ArgsException;
import com.jhinno.sdk.openapi.CommonConstant; import com.jhinno.sdk.openapi.CommonConstant;
@@ -10,7 +8,10 @@ import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.ResponseResult; import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.api.file.FileInfo; import com.jhinno.sdk.openapi.api.file.FileInfo;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import com.jhinno.sdk.openapi.utils.JsonUtil;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import com.jhinno.sdk.openapi.utils.CollectionUtil;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
@@ -20,6 +21,7 @@ import java.util.Map;
* @author yanlongqi * @author yanlongqi
* @date 2024/2/5 18:44 * @date 2024/2/5 18:44
*/ */
@NoArgsConstructor
public class JHJobApiExecution extends JHApiExecution { public class JHJobApiExecution extends JHApiExecution {
/** /**
@@ -48,7 +50,7 @@ public class JHJobApiExecution extends JHApiExecution {
} }
Map<String, Object> map = new HashMap<>(2); Map<String, Object> map = new HashMap<>(2);
map.put("appId", appId); map.put("appId", appId);
map.put("params", JSONUtil.toJsonStr(params)); map.put("params", JsonUtil.objectToString(params));
String path = JHApiClient.getUrl(JobPathConstant.JOB_SUBMIT_PATH, map); String path = JHApiClient.getUrl(JobPathConstant.JOB_SUBMIT_PATH, map);
List<Map<String, String>> result = post(path, username, new TypeReference<ResponseResult<List<Map<String, String>>>>() { List<Map<String, String>> result = post(path, username, new TypeReference<ResponseResult<List<Map<String, String>>>>() {
}); });
@@ -102,7 +104,7 @@ public class JHJobApiExecution extends JHApiExecution {
params.put("status", status.getStatus()); params.put("status", status.getStatus());
} }
if (CollectionUtil.isNotEmpty(condition)) { if (CollectionUtil.isNotEmpty(condition)) {
params.put("condition", JSONUtil.toJsonStr(params)); params.put("condition", JsonUtil.objectToString(params));
} }
String path = JHApiClient.getUrl(JobPathConstant.JOB_PAGE_PATH, params); String path = JHApiClient.getUrl(JobPathConstant.JOB_PAGE_PATH, params);
return get(path, username, new TypeReference<ResponseResult<PageJobInfo>>() { return get(path, username, new TypeReference<ResponseResult<PageJobInfo>>() {
@@ -354,7 +356,7 @@ public class JHJobApiExecution extends JHApiExecution {
throw new ArgsException("jobId不能为空"); throw new ArgsException("jobId不能为空");
} }
String path = JobPathConstant.JOB_PEEK_PATH.replace("{jobId}", jobId); String path = JobPathConstant.JOB_PEEK_PATH.replace("{jobId}", jobId);
ResponseResult<String> result = jhApiClient.get(path, getHeaders(username), new TypeReference<ResponseResult<String>>() { ResponseResult<String> result = getJhApiClient().get(path, getHeaders(username), new TypeReference<ResponseResult<String>>() {
}); });
if (StringUtils.equals(result.getResult(), CommonConstant.FAILED)) { if (StringUtils.equals(result.getResult(), CommonConstant.FAILED)) {
throw new ServiceException(path, result.getCode(), result.getMessage()); throw new ServiceException(path, result.getCode(), result.getMessage());
@@ -383,4 +385,19 @@ public class JHJobApiExecution extends JHApiExecution {
}); });
} }
/**
* 查询用户作业表单信息
*
* @param username 用户名
* @param appId 用户ID
*/
public List<JobAppFormItemInfo> getSimulationAppForm(String username, String appId) {
if (StringUtils.isBlank(appId)) {
throw new ArgsException("appId不能为空");
}
String path = JobPathConstant.JOB_GET_APP_FORM_PATH.replace("{appId}", appId);
return get(path, username, new TypeReference<ResponseResult<List<JobAppFormItemInfo>>>() {
});
}
} }

View File

@@ -0,0 +1,64 @@
package com.jhinno.sdk.openapi.api.job;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.List;
@Data
public class JobAppFormItemInfo {
/**
* 参数描述
*/
private String valueDesc;
/**
* 参数key
*/
private String valueKey;
/**
* 参数正则
*/
private String validateRegXp;
/**
* 参数类型
* 从参数范围内多选(多个值用英文逗号隔开)还是单选,
* string、singleSelect、multiSelect
* <ol>
* <li>选择: select</li>
* <li>开关: switch</li>
* <li>值: text</li>
* <li>文件: upload</li>
* </ol>
*/
private String valueType;
/**
* 参数范围
*/
private List<ParamsValueScope> valueScope;
/**
* 是否必填
*/
private boolean required;
/**
* 默认值
*/
private String valueDefault;
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class ParamsValueScope {
private String name;
private String value;
}
}

View File

@@ -82,4 +82,12 @@ public class JobPathConstant {
* 连接作业会话 * 连接作业会话
*/ */
public static final String JOB_CONNECT_SESSION_PATH = "/ws/api/jobs/{jobId}/connect"; public static final String JOB_CONNECT_SESSION_PATH = "/ws/api/jobs/{jobId}/connect";
/**
* 获取作业表单
* <p/>
* 该接口目前在Solutions下面维护未经过产品的测试
*/
public static final String JOB_GET_APP_FORM_PATH = "/ws/api/jobs/{appId}/form_params";
} }

View File

@@ -5,6 +5,7 @@ import com.jhinno.sdk.openapi.ArgsException;
import com.jhinno.sdk.openapi.api.JHApiExecution; import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.ResponseResult; import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import java.util.List; import java.util.List;
@@ -18,6 +19,7 @@ import java.util.Map;
* @author yanlongqi * @author yanlongqi
* @date 2024/2/6 17:37 * @date 2024/2/6 17:37
*/ */
@NoArgsConstructor
public class JHDepartmentApiExecution extends JHApiExecution { public class JHDepartmentApiExecution extends JHApiExecution {
/** /**

View File

@@ -6,6 +6,7 @@ import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.PageResult; import com.jhinno.sdk.openapi.api.PageResult;
import com.jhinno.sdk.openapi.api.ResponseResult; import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import java.util.HashMap; import java.util.HashMap;
@@ -19,6 +20,7 @@ import java.util.Map;
* @author yanlongqi * @author yanlongqi
* @date 2024/2/6 17:37 * @date 2024/2/6 17:37
*/ */
@NoArgsConstructor
public class JHUserApiExecution extends JHApiExecution { public class JHUserApiExecution extends JHApiExecution {
/** /**
* 获取一个执行器的实例 * 获取一个执行器的实例

View File

@@ -16,7 +16,7 @@ public class DefaultHttpClientConfig {
/** /**
* 默认服务每次能并行接收的请求数量 * 默认服务每次能并行接收的请求数量
*/ */
public static int MAX_PER_ROUT = 20; public static int MAX_PER_ROUTE = 20;
/** /**
@@ -33,4 +33,26 @@ public class DefaultHttpClientConfig {
* 默认请求超时的时间(单位:毫秒) * 默认请求超时的时间(单位:毫秒)
*/ */
public static final int CONNECTION_REQUEST_TIMEOUT = 5000; public static final int CONNECTION_REQUEST_TIMEOUT = 5000;
/**
* 是否使用服务器的时间
*/
public static final boolean DEFAULT_IS_USED_SERVER_TIME = false;
/**
* 默认不强制获取token
*/
public static final boolean DEFAULT_IS_FORCE_GET_TOKEN = false;
/**
* 默认的token有效时间单位分钟
*/
public static final int DEFAULT_TOKEN_EFFECTIVE_TIME = 30;
/**
* token 默认剩余时间
*/
public static final int DEFAULT_TOKEN_RESIDUE_TIME = 5;
} }

View File

@@ -1,43 +1,22 @@
package com.jhinno.sdk.openapi.client; package com.jhinno.sdk.openapi.client;
import cn.hutool.core.collection.CollectionUtil;
import cn.hutool.core.date.DatePattern;
import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature; import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.ObjectMapper;
import com.jhinno.sdk.openapi.ArgsException; import com.jhinno.sdk.openapi.ArgsException;
import com.jhinno.sdk.openapi.ClientErrorCode; import com.jhinno.sdk.openapi.ClientErrorCode;
import com.jhinno.sdk.openapi.ClientException; import com.jhinno.sdk.openapi.ClientException;
import com.jhinno.sdk.openapi.CommonConstant;
import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.api.auth.AuthPathConstant; import com.jhinno.sdk.openapi.api.auth.AuthPathConstant;
import lombok.Data; import lombok.Data;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.*;
import org.apache.http.config.Registry;
import org.apache.http.config.RegistryBuilder;
import org.apache.http.conn.socket.ConnectionSocketFactory;
import org.apache.http.conn.socket.PlainConnectionSocketFactory;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.apache.http.ssl.SSLContextBuilder;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.UnsupportedEncodingException; import java.io.UnsupportedEncodingException;
import java.net.URLEncoder; import java.net.URLEncoder;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.security.KeyManagementException;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.text.ParseException;
import java.text.SimpleDateFormat; import java.text.SimpleDateFormat;
import java.util.Date; import java.util.Date;
import java.util.Map; import java.util.Map;
@@ -53,275 +32,70 @@ import java.util.TimeZone;
public class JHApiClient { public class JHApiClient {
/** /**
* &#x57FA;&#x7840;&#x7684;&#x8BF7;&#x6C42;URL&#x5730;&#x5740; * 基础的请求URL地址
* <p> * <p>
* &#x5982;&#xFF1A;https://192.168.3.12/appform * 如:https:// 192.168.3.12/appform
* </p> * </p>
*/ */
private String baseUrl; private String baseUrl;
/** /**
* 对象转换器 * 设置自定义的jackson序列化配置
*/ */
private ObjectMapper mapper; private ObjectMapper mapper;
/**
* HTTP的连接客户端
*/
private CloseableHttpClient closeableHttpClient;
/** /**
* 每次发送请求的配置,如果该配置未进行设置则走 {@link DefaultHttpClientConfig 中的默认配置 * API HTTP 客户端
*/ */
private RequestConfig requestConfig; private JHApiHttpClient apiHttpClient;
private int socketTimeout = DefaultHttpClientConfig.SOCKET_TIMEOUT;
private int connectTimeout = DefaultHttpClientConfig.CONNECT_TIMEOUT;
private int connectRequestTimeout = DefaultHttpClientConfig.CONNECTION_REQUEST_TIMEOUT;
private int maxTotal = DefaultHttpClientConfig.MAX_TOTAL;
private int maxPerRout = DefaultHttpClientConfig.MAX_PER_ROUT;
/**
* 初始化一个JHApiClient的实例可使用自定义的客户端
*
* @param baseUrl 景行接口服务的基础地址
* @param closeableHttpClient 可关闭的HTTP客户端
*/
public JHApiClient(CloseableHttpClient closeableHttpClient, String baseUrl, int socketTimeout, int connectTimeout, int connectRequestTimeout) {
this.baseUrl = baseUrl.endsWith("/") ? baseUrl.substring(0, baseUrl.length() - 1) : baseUrl;
this.closeableHttpClient = closeableHttpClient;
this.socketTimeout = socketTimeout;
this.connectTimeout = connectTimeout;
this.connectRequestTimeout = connectRequestTimeout;
clientInit();
}
public JHApiClient() {
closeableHttpClient = createHttpClients(maxTotal, maxPerRout);
clientInit();
}
/** public JHApiClient(String baseUrl) {
* 初始化客户端 if (StringUtils.isBlank(baseUrl)) {
*/ throw new ClientException("服务器的BaseUrl不能为空");
public void clientInit(){ }
this.requestConfig = RequestConfig.custom() if (baseUrl.endsWith("/")) {
.setSocketTimeout(socketTimeout) baseUrl = baseUrl.substring(0, baseUrl.length() - 1);
.setConnectTimeout(connectTimeout) }
.setConnectionRequestTimeout(connectRequestTimeout) this.baseUrl = baseUrl;
.build();
mapper = new ObjectMapper(); mapper = new ObjectMapper();
mapper.setTimeZone(TimeZone.getTimeZone("GMT+8")); mapper.setTimeZone(TimeZone.getTimeZone("GMT+8"));
mapper.setDateFormat(new SimpleDateFormat(DatePattern.NORM_DATETIME_PATTERN)); mapper.setDateFormat(new SimpleDateFormat(CommonConstant.NORM_DATETIME_PATTERN));
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
} }
/** public void initDefaultApiClient() {
* 通过最大连接数和服务每次能并行接收的请求数量构建一个JHApiClient实例 JHApiHttpClientImpl jhApiHttpClient = new JHApiHttpClientImpl();
* jhApiHttpClient.init();
* @param maxTotal 最大连接数 jhApiHttpClient.createHttpClients();
* @param maxPerRout 服务每次能并行接收的请求数量 this.apiHttpClient = jhApiHttpClient;
* @param baseUrl 景行接口服务的基础地址 如: http://192.168.3.4/appform
* @return JHApiClient的实例
*/
public static JHApiClient build(String baseUrl, int maxTotal, int maxPerRout, int socketTimeout, int connectTimeout, int connectRequestTimeout) {
return build(createHttpClients(maxTotal, maxPerRout), baseUrl, socketTimeout, connectTimeout, connectRequestTimeout);
}
/**
* 通过{@link DefaultHttpClientConfig默认配置的最大连接数和服务每次能并行接收的请求数量构建一个JHApiClient实例
* <p>
*
* @param baseUrl 景行接口服务的基础地址,如: http://192.168.3.4/appform
* @return JHApiClient的实例
*/
public static JHApiClient build(String baseUrl) {
CloseableHttpClient client = createHttpClients(com.jhinno.sdk.openapi.client.DefaultHttpClientConfig.MAX_TOTAL, com.jhinno.sdk.openapi.client.DefaultHttpClientConfig.MAX_PER_ROUT);
return build(client, baseUrl, com.jhinno.sdk.openapi.client.DefaultHttpClientConfig.SOCKET_TIMEOUT, com.jhinno.sdk.openapi.client.DefaultHttpClientConfig.CONNECT_TIMEOUT, com.jhinno.sdk.openapi.client.DefaultHttpClientConfig.CONNECTION_REQUEST_TIMEOUT);
}
/**
* 通过外部传入的{@link CloseableHttpClient构建一个请求客户端.
* <p>
*
* @param httpClient 请求连接池
* @param baseUrl 景行接口服务的基础地址
* @return JHApiClient的实例
*/
public static JHApiClient build(CloseableHttpClient httpClient, String baseUrl, int socketTimeout, int connectTimeout, int connectRequestTimeout) {
return new JHApiClient(httpClient, baseUrl, socketTimeout, connectTimeout, connectRequestTimeout);
}
/**
* 初始化一个HTTP客户端实例
*
* @param maxTotal 设置最大连接数
* @param maxPerRoute 服务每次能并行接收的请求数量
* @return 返回一个可关闭的HTTP客户端示例
*/
public static CloseableHttpClient createHttpClients(int maxTotal, int maxPerRoute) {
SSLContextBuilder builder = new SSLContextBuilder();
try {
builder.loadTrustMaterial(null, (x509Certificates, s) -> true);
SSLConnectionSocketFactory sslref = new SSLConnectionSocketFactory(builder.build(), NoopHostnameVerifier.INSTANCE);
Registry<ConnectionSocketFactory> registry = RegistryBuilder.<ConnectionSocketFactory>create().register("http", new PlainConnectionSocketFactory()).register("https", sslref).build();
PoolingHttpClientConnectionManager cm = new PoolingHttpClientConnectionManager(registry);
cm.setMaxTotal(maxTotal);
cm.setDefaultMaxPerRoute(maxPerRoute);
return HttpClients.custom().setSSLSocketFactory(sslref).setConnectionManager(cm).setConnectionManagerShared(true).build();
} catch (NoSuchAlgorithmException | KeyManagementException | KeyStoreException e) {
throw new ClientException(e.getMessage(), ClientErrorCode.SSL_EXCEPTION, e);
}
}
/**
* 关闭JHApiClient实例 (释放所有资源)
* 调用JHApiClient实例的shutdown() 后JHApiClient实例不可用。
* 如果客户端不存在则不进行任何操作
*/
public void shutdown() {
try {
if (closeableHttpClient != null) {
closeableHttpClient.close();
}
} catch (IOException e) {
throw new ClientException("关闭JHApiClient失败", e);
}
}
/**
* 设置自定义的jackson序列化配置
*
* @param mapper 序列化器
*/
public void setMapper(ObjectMapper mapper) {
this.mapper = mapper;
}
/**
* <p>
* 设置一个HTTP请求的配置
* </p>
*
* <p>
* {@link JHApiClient 默认只配置了 socket连接超时的时间(socketTimeout) 、连接超时的时间(connectTimeout)、
* 请求超时的时间(connectionRequestTimeout)这三项,其默认配置在{@link DefaultHttpClientConfig 中。
* 如果你要自定义你自己的配置,则可以通过{@link HttpClients构建自己的RequestConfig来请求接口
* </p>
*
* @param requestConfig HTTP请求的配置
*/
public void setRequestConfig(RequestConfig requestConfig) {
this.requestConfig = requestConfig;
}
/**
* 原始发送请求
*
* @param httpRequest 请求体
* @param headers 请求头
* @return 响应体
*/
public HttpEntity request(HttpRequestBase httpRequest, Map<String, String> headers) {
if (requestConfig == null) {
throw new ClientException("请配置requestConfig");
}
if (httpRequest == null) {
throw new ClientException("httpRequest不能为空");
}
httpRequest.setConfig(requestConfig);
// 添加请求头
if (CollectionUtil.isNotEmpty(headers)) {
for (Map.Entry<String, String> entry : headers.entrySet()) {
httpRequest.setHeader(entry.getKey(), entry.getValue());
}
}
try {
HttpResponse response = closeableHttpClient.execute(httpRequest);
int statusCode = response.getStatusLine().getStatusCode();
if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
httpRequest.releaseConnection();
throw new ClientException("发送HTTP请求失败请求码" + statusCode, ClientErrorCode.REQUEST_ERROR);
}
return response.getEntity();
} catch (IOException e) {
throw new ClientException(e.getMessage());
}
}
/**
* 请求服务器的时间戳
*
* @return 服务器的时间戳
*/
public Long requestTimeMillis() {
HttpGet httpGet = new HttpGet(getUrl(AuthPathConstant.PING));
httpGet.setConfig(requestConfig);
try {
HttpResponse response = closeableHttpClient.execute(httpGet);
Header header = response.getFirstHeader("Date");
if (header == null) {
return null;
}
String value = header.getValue();
if (StringUtils.isBlank(value)) {
return null;
}
return DatePattern.HTTP_DATETIME_FORMAT.parse(value).getTime();
} catch (IOException e) {
throw new ClientException(e.getMessage());
} catch (ParseException e) {
throw new RuntimeException(e);
}
}
/**
* 发送请求
*
* @param httpRequest HttpRequestBase
* @param headers 请求头
* @param type 返回数据类型
* @param <T> 返回的数据类型
* @return 返回的接口数据
*/
public <T> T request(HttpRequestBase httpRequest, Map<String, String> headers, TypeReference<T> type) {
try {
InputStream content = request(httpRequest, headers).getContent();
return mapper.readValue(content, type);
} catch (IOException e) {
throw new ClientException(e.getMessage());
}
} }
/** /**
* 发送一个get请求 * 发送一个get请求
* *
* @param path 接口地址 * @param path 接口路径
* @param headers 请求头 * @param headers 请求头
* @param type 请求返回值类型 * @param type 返回数据类型
* @param <T> t * @param <T> 返回数据类型
* @return t * @return 返回数据
*/ */
public <T> T get(String path, Map<String, String> headers, TypeReference<T> type) { public <T> T get(String path, Map<String, Object> headers, TypeReference<T> type) {
if (StringUtils.isBlank(path)) { if (StringUtils.isBlank(path)) {
throw new ArgsException("url不能为空"); throw new ArgsException("url不能为空");
} }
HttpGet httpGet = new HttpGet(getUrl(path)); try {
return request(httpGet, headers, type); InputStream content = apiHttpClient.get(getUrl(path), headers);
return mapper.readValue(content, type);
} catch (IOException e) {
throw new ClientException(e.getMessage(), e);
}
} }
/** /**
* 发起一个get请求 * 发起一个get请求
* *
@@ -360,8 +134,8 @@ public class JHApiClient {
if (value instanceof String) { if (value instanceof String) {
urlBuilder.append(URLEncoder.encode((String) value, StandardCharsets.UTF_8.name())); urlBuilder.append(URLEncoder.encode((String) value, StandardCharsets.UTF_8.name()));
} else if (value instanceof Date) { } else if (value instanceof Date) {
SimpleDateFormat format = new SimpleDateFormat(DatePattern.NORM_DATETIME_PATTERN); SimpleDateFormat format = new SimpleDateFormat(CommonConstant.NORM_DATETIME_PATTERN);
urlBuilder.append(URLEncoder.encode(format.format(value), "utf-8")); urlBuilder.append(URLEncoder.encode(format.format(value), StandardCharsets.UTF_8.name()));
} else { } else {
urlBuilder.append(value); urlBuilder.append(value);
} }
@@ -396,19 +170,48 @@ public class JHApiClient {
* @param <K> k body的类型 * @param <K> k body的类型
* @return t * @return t
*/ */
public <T, K> T post(String path, K body, Map<String, String> headers, TypeReference<T> type) { public <T, K> T post(String path, K body, Map<String, Object> headers, TypeReference<T> type) {
if (StringUtils.isBlank(path)) { if (StringUtils.isBlank(path)) {
throw new ArgsException("path不能为空"); throw new ArgsException("path不能为空");
} }
HttpPost httpPost = new HttpPost(getUrl(path));
try { try {
String bodyStr = null;
if (body != null) { if (body != null) {
String bodyStr = mapper.writeValueAsString(body); bodyStr = mapper.writeValueAsString(body);
httpPost.setEntity(new StringEntity(bodyStr, "utf-8"));
} }
return request(httpPost, headers, type); InputStream content = apiHttpClient.post(getUrl(path), bodyStr, headers);
} catch (Exception e) { return mapper.readValue(content, type);
throw new ClientException(e.getMessage()); } catch (IOException e) {
throw new ClientException(e.getMessage(), e);
}
}
/**
* 发起put请求
*
* @param path 请求地址
* @param params 请求参数
* @param body 请求体
* @param headers 请求头
* @param type 请求数据类型
* @param <T> t 返回的数据的类型
* @param <K> k body的类型
* @return 请求返回的数据
*/
public <T, K> T put(String path, Map<String, Object> params, K body, Map<String, Object> headers, TypeReference<T> type) {
if (StringUtils.isBlank(path)) {
throw new ArgsException("path不能为空");
}
try {
String bodyStr = null;
if (body != null) {
bodyStr = mapper.writeValueAsString(body);
}
InputStream content = apiHttpClient.put(getUrl(path), bodyStr, headers);
return mapper.readValue(content, type);
} catch (IOException e) {
throw new ClientException(e.getMessage(), e);
} }
} }
@@ -424,20 +227,8 @@ public class JHApiClient {
* @param <K> k body的类型 * @param <K> k body的类型
* @return 请求返回的数据 * @return 请求返回的数据
*/ */
public <T, K> T put(String path, K body, Map<String, String> headers, TypeReference<T> type) { public <T, K> T put(String path, K body, Map<String, Object> headers, TypeReference<T> type) {
if (StringUtils.isBlank(path)) { return put(path, null, body, headers, type);
throw new ArgsException("url不能为空");
}
HttpPut httpPost = new HttpPut(getUrl(path));
try {
if (body != null) {
String bodyStr = mapper.writeValueAsString(body);
httpPost.setEntity(new StringEntity(bodyStr, "utf-8"));
}
return request(httpPost, headers, type);
} catch (Exception e) {
throw new ClientException(e.getMessage());
}
} }
@@ -477,12 +268,16 @@ public class JHApiClient {
* @param <T> 响应数据类型 * @param <T> 响应数据类型
* @return 响应数据 * @return 响应数据
*/ */
public <T> T delete(String path, Map<String, String> headers, TypeReference<T> type) { public <T> T delete(String path, Map<String, Object> headers, TypeReference<T> type) {
if (StringUtils.isBlank(path)) { if (StringUtils.isBlank(path)) {
throw new ArgsException("url不能为空"); throw new ArgsException("path不能为空");
}
try {
InputStream content = apiHttpClient.delete(getUrl(path), headers);
return mapper.readValue(content, type);
} catch (IOException e) {
throw new ClientException(e.getMessage(), e);
} }
HttpDelete httpDelete = new HttpDelete(getUrl(path));
return request(httpDelete, headers, type);
} }
@@ -497,4 +292,41 @@ public class JHApiClient {
public <T> T delete(String path, TypeReference<T> type) { public <T> T delete(String path, TypeReference<T> type) {
return delete(path, null, type); return delete(path, null, type);
} }
/**
* @param path 请求路径
* @param keyName 文件key
* @param fileName 文件名
* @param is 文件流
* @param headers 请求头
* @param body 请求体其他数据
* @param type 返回数据类型
* @return 请求类型
*/
public ResponseResult<Object> upload(String path,
String keyName,
String fileName,
InputStream is,
Map<String, Object> headers,
Map<String, Object> body,
TypeReference<ResponseResult<Object>> type) {
if (StringUtils.isBlank(path)) {
throw new ArgsException("path不能为空");
}
try {
InputStream content = apiHttpClient.upload(getUrl(path), keyName, fileName, is, body, headers);
return mapper.readValue(content, type);
} catch (IOException e) {
throw new ClientException(e.getMessage(), e);
}
}
public String getAppformServerCurrentTimeMillis() {
try {
long currentTimeMillis = apiHttpClient.getAppformServerCurrentTimeMillis(getUrl(AuthPathConstant.PING));
return String.valueOf(currentTimeMillis);
} catch (IOException e) {
throw new ClientException(e.getMessage(), e);
}
}
} }

View File

@@ -0,0 +1,84 @@
package com.jhinno.sdk.openapi.client;
import com.jhinno.sdk.openapi.AuthType;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
/**
* 该接口用户实现发送HTTP请求的方法
*/
public interface JHApiHttpClient {
/**
* 发起一个get请求
*
* @param url 请求url
* @param headers 请求头
* @return 数据流
* @throws IOException io异常
*/
InputStream get(String url, Map<String, Object> headers) throws IOException;
/**
* 发起一个post请求
*
* @param url 请求url
* @param body 请求体
* @param headers 请求头
* @return 数据流
* @throws IOException io异常
*/
InputStream post(String url, String body, Map<String, Object> headers) throws IOException;
/**
* 发起一个put请求
*
* @param url 请求url
* @param body 请求体
* @param headers 请求头
* @return 数据流
* @throws IOException io异常
*/
InputStream put(String url, String body, Map<String, Object> headers) throws IOException;
/**
* 发起一个GET请求
*
* @param url 请求url
* @param headers 请求头
* @return 数据流
* @throws IOException io异常
*/
InputStream delete(String url, Map<String, Object> headers) throws IOException;
/**
* 文件上传
*
* @param url 请求url
* @param keyName 文件key
* @param is 文件流
* @param body 请求体
* @param headers 请求头
* @return 响应
* @throws IOException io异常
*/
InputStream upload(String url, String keyName, String fileName, InputStream is, Map<String, Object> body, Map<String, Object> headers) throws IOException;
/**
* 获取Appform服务器当前的时间
* <p/>
* {@link AuthType#TOKEN_MODE}模式,并且打开了获取服务器时间的开关需要实现改方法
*
* @return 服务器的时间
*/
default long getAppformServerCurrentTimeMillis(String url) throws IOException {
return System.currentTimeMillis();
}
}

View File

@@ -0,0 +1,233 @@
package com.jhinno.sdk.openapi.client;
import com.jhinno.sdk.openapi.ClientErrorCode;
import com.jhinno.sdk.openapi.ClientException;
import com.jhinno.sdk.openapi.CommonConstant;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.*;
import org.apache.http.config.Registry;
import org.apache.http.config.RegistryBuilder;
import org.apache.http.conn.socket.ConnectionSocketFactory;
import org.apache.http.conn.socket.PlainConnectionSocketFactory;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.apache.http.ssl.SSLContextBuilder;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.security.KeyManagementException;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.text.ParseException;
import java.util.Map;
@Data
@NoArgsConstructor
public class JHApiHttpClientImpl implements JHApiHttpClient {
/**
* HTTP的连接客户端
*/
private CloseableHttpClient closeableHttpClient;
/**
* <p>
* 每次发送请求的配置,如果该配置未进行设置则走 {@link DefaultHttpClientConfig 中的默认配置
* </p>
*
* <p>
* {@link JHApiClient 默认只配置了 socket连接超时的时间(socketTimeout) 、连接超时的时间(connectTimeout)、
* 请求超时的时间(connectionRequestTimeout)这三项,其默认配置在{@link DefaultHttpClientConfig 中。
* 如果你要自定义你自己的配置,则可以通过{@link HttpClients 构建自己的RequestConfig来请求接口
* </p>
*
* @param requestConfig HTTP请求的配置
*/
private RequestConfig requestConfig;
/**
* Socket连接超时的时间(单位:毫秒,默认:{@link DefaultHttpClientConfig#SOCKET_TIMEOUT})
*/
private int socketTimeout = DefaultHttpClientConfig.SOCKET_TIMEOUT;
/**
* 连接超时的时间(单位:毫秒,默认:{@link DefaultHttpClientConfig#CONNECT_TIMEOUT})
*/
private int connectTimeout = DefaultHttpClientConfig.CONNECT_TIMEOUT;
/**
* 默认请求超时的时间(单位:毫秒,默认:{@link DefaultHttpClientConfig#CONNECTION_REQUEST_TIMEOUT})
*/
private int connectRequestTimeout = DefaultHttpClientConfig.CONNECTION_REQUEST_TIMEOUT;
/**
* 设置最大连接数(默认:{@link DefaultHttpClientConfig#MAX_TOTAL})
*/
private int maxTotal = DefaultHttpClientConfig.MAX_TOTAL;
/**
* 服务每次能并行接收的请求数量(默认:{@link DefaultHttpClientConfig#MAX_PER_ROUTE})
*/
private int maxPerRoute = DefaultHttpClientConfig.MAX_PER_ROUTE;
/**
* 初始化一个HTTP客户端实例
*
* @return 返回一个可关闭的HTTP客户端示例
*/
public void createHttpClients() {
SSLContextBuilder builder = new SSLContextBuilder();
try {
builder.loadTrustMaterial(null, (x509Certificates, s) -> true);
SSLConnectionSocketFactory sslref = new SSLConnectionSocketFactory(builder.build(), NoopHostnameVerifier.INSTANCE);
Registry<ConnectionSocketFactory> registry = RegistryBuilder.<ConnectionSocketFactory>create().register("http", new PlainConnectionSocketFactory()).register("https", sslref).build();
PoolingHttpClientConnectionManager cm = new PoolingHttpClientConnectionManager(registry);
cm.setMaxTotal(maxTotal);
cm.setDefaultMaxPerRoute(maxPerRoute);
closeableHttpClient = HttpClients.custom().setSSLSocketFactory(sslref).setConnectionManager(cm).setConnectionManagerShared(true).build();
} catch (NoSuchAlgorithmException | KeyManagementException | KeyStoreException e) {
throw new ClientException(e.getMessage(), ClientErrorCode.SSL_EXCEPTION, e);
}
}
/**
* 初始化客户端
*/
public void init() {
this.requestConfig = RequestConfig.custom()
.setSocketTimeout(socketTimeout)
.setConnectTimeout(connectTimeout)
.setConnectionRequestTimeout(connectRequestTimeout)
.build();
}
/**
* 原始发送请求
*
* @param httpRequest 请求体
* @param headers 请求头
* @return 响应体
*/
public HttpEntity request(HttpRequestBase httpRequest, Map<String, Object> headers) {
if (requestConfig == null) {
throw new ClientException("请配置requestConfig");
}
if (httpRequest == null) {
throw new ClientException("httpRequest不能为空");
}
httpRequest.setConfig(requestConfig);
// 添加请求头
if (headers != null && !headers.isEmpty()) {
for (Map.Entry<String, Object> entry : headers.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
if (value == null) {
continue;
}
httpRequest.setHeader(key, value.toString());
}
}
try {
HttpResponse response = closeableHttpClient.execute(httpRequest);
int statusCode = response.getStatusLine().getStatusCode();
if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
httpRequest.releaseConnection();
throw new ClientException("发送HTTP请求失败请求码" + statusCode, ClientErrorCode.REQUEST_ERROR);
}
return response.getEntity();
} catch (IOException e) {
httpRequest.releaseConnection();
throw new ClientException(e.getMessage());
}
}
@Override
public InputStream get(String url, Map<String, Object> headers) throws IOException {
HttpGet httpGet = new HttpGet(url);
return request(httpGet, headers).getContent();
}
@Override
public InputStream post(String url, String body, Map<String, Object> headers) throws IOException {
HttpPost httpPost = new HttpPost(url);
if (StringUtils.isNotBlank(body)) {
httpPost.setEntity(new StringEntity(body, StandardCharsets.UTF_8));
}
return request(httpPost, headers).getContent();
}
@Override
public InputStream put(String url, String body, Map<String, Object> headers) throws IOException {
HttpPut httpPut = new HttpPut(url);
if (StringUtils.isNotBlank(body)) {
httpPut.setEntity(new StringEntity(body, StandardCharsets.UTF_8));
}
return request(httpPut, headers).getContent();
}
@Override
public InputStream delete(String url, Map<String, Object> headers) throws IOException {
HttpDelete httpDelete = new HttpDelete(url);
return request(httpDelete, headers).getContent();
}
@Override
public InputStream upload(String url, String keyName, String fileName, InputStream is, Map<String, Object> body, Map<String, Object> headers) throws IOException {
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.setCharset(StandardCharsets.UTF_8);
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.addBinaryBody(keyName, is, ContentType.MULTIPART_FORM_DATA, fileName);
if (body != null && !body.isEmpty()) {
for (Map.Entry<String, Object> entry : body.entrySet()) {
builder.addTextBody(entry.getKey(), entry.getValue().toString());
}
}
HttpPost httpPost = new HttpPost(url);
httpPost.setEntity(builder.build());
return request(httpPost, headers).getContent();
}
@Override
public long getAppformServerCurrentTimeMillis(String url) throws IOException {
HttpGet httpGet = new HttpGet(url);
httpGet.setConfig(requestConfig);
try {
HttpResponse response = closeableHttpClient.execute(httpGet);
Header header = response.getFirstHeader("Date");
if (header == null) {
throw new ClientException("获取时间戳响应为空!");
}
String value = header.getValue();
if (StringUtils.isBlank(value)) {
throw new ClientException("获取时间戳响应头为空!");
}
return CommonConstant.HTTP_DATETIME_FORMAT.parse(value).getTime();
} catch (ParseException e) {
throw new ClientException("时间格式获取失败,失败原因:" + e.getMessage(), e);
}finally {
httpGet.releaseConnection();
}
}
}

View File

@@ -0,0 +1,48 @@
package com.jhinno.sdk.openapi.utils;
import java.util.Collection;
import java.util.Map;
public class CollectionUtil {
/**
* Map是否为空
*
* @param map 集合
* @return 是否为空
*/
public static boolean isEmpty(Map<?, ?> map) {
return map == null || map.isEmpty();
}
/**
* Map是否为非空
*
* @param map 集合
* @return 是否为非空
*/
public static boolean isNotEmpty(Map<?, ?> map) {
return !isEmpty(map);
}
/**
* Collection是否为空
*
* @param collection 集合
* @return 是否为非空
*/
public static boolean isEmpty(Collection<?> collection) {
return collection == null || collection.isEmpty();
}
/**
* Collection是否为非空
*
* @param collection 集合
* @return 是否为非空
*/
public static boolean isNotEmpty(Collection<?> collection) {
return !isEmpty(collection);
}
}

View File

@@ -0,0 +1,54 @@
package com.jhinno.sdk.openapi.utils;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jhinno.sdk.openapi.CommonConstant;
import lombok.SneakyThrows;
import org.apache.commons.lang3.StringUtils;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.TimeZone;
public class JsonUtil {
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
static {
OBJECT_MAPPER.setTimeZone(TimeZone.getTimeZone("GMT+8"));
OBJECT_MAPPER.setDateFormat(new SimpleDateFormat(CommonConstant.NORM_DATETIME_PATTERN));
OBJECT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
}
@SneakyThrows
public static <T> T stringToObject(String str, Class<T> cls) {
if (StringUtils.isBlank(str)) {
return null;
}
return OBJECT_MAPPER.readValue(str, cls);
}
@SneakyThrows
public static <T> T stringToObject(String str, TypeReference<T> type) {
if (StringUtils.isBlank(str)) {
return null;
}
return OBJECT_MAPPER.readValue(str, type);
}
@SneakyThrows
public static <T> T isToObject(InputStream is, Class<T> cls) {
if (is == null) {
return null;
}
return OBJECT_MAPPER.readValue(is, cls);
}
@SneakyThrows
public static String objectToString(Object object) {
return OBJECT_MAPPER.writeValueAsString(object);
}
}

View File

@@ -1,7 +1,18 @@
package com.jhinno.sdk.openapi.test; package com.jhinno.sdk.openapi.test;
import com.jhinno.sdk.openapi.AuthType;
import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.app.JHAppApiExecution;
import com.jhinno.sdk.openapi.api.data.JHDataApiExecution;
import com.jhinno.sdk.openapi.api.file.JHFileApiExecution;
import com.jhinno.sdk.openapi.api.job.JHJobApiExecution;
import com.jhinno.sdk.openapi.api.organization.JHDepartmentApiExecution;
import com.jhinno.sdk.openapi.api.organization.JHUserApiExecution;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import java.util.HashMap;
import java.util.Map;
/** /**
* SDK Client 的配置 * SDK Client 的配置
* *
@@ -13,6 +24,30 @@ public class JHClientConfig {
/** /**
* 初始化JHApi客户端 * 初始化JHApi客户端
*/ */
public static final JHApiClient client = JHApiClient.build("https://172.17.0.5/appform"); public static final JHApiClient client = new JHApiClient("https://172.17.0.5/appform");
public static final Map<Class<? extends JHApiExecution>, JHApiExecution> jhApiClientMap = new HashMap<>();
public static final String ACCESS_KEY = "3f03747f147942bd8debd81b6c9c6a80";
public static final String ACCESS_KEY_SECRET = "e0681859b91c499eb1d2c8e09cea3242";
static {
client.initDefaultApiClient();
jhApiClientMap.put(JHAppApiExecution.class, new JHAppApiExecution());
jhApiClientMap.put(JHDataApiExecution.class, new JHDataApiExecution());
jhApiClientMap.put(JHFileApiExecution.class, new JHFileApiExecution());
jhApiClientMap.put(JHJobApiExecution.class, new JHJobApiExecution());
jhApiClientMap.put(JHDepartmentApiExecution.class, new JHDepartmentApiExecution());
jhApiClientMap.put(JHUserApiExecution.class, new JHUserApiExecution());
jhApiClientMap.forEach((k, v) -> {
v.setJhApiClient(client);
v.setAuthType(AuthType.ACCESS_SECRET_MODE);
v.setAccessKey(ACCESS_KEY);
v.setAccessKeySecret(ACCESS_KEY_SECRET);
v.setUsedServerTime(true);
});
}
} }

View File

@@ -1,6 +1,5 @@
package com.jhinno.sdk.openapi.test.app; package com.jhinno.sdk.openapi.test.app;
import cn.hutool.core.lang.ConsoleTable;
import com.jhinno.sdk.openapi.api.app.*; import com.jhinno.sdk.openapi.api.app.*;
import com.jhinno.sdk.openapi.test.JHClientConfig; import com.jhinno.sdk.openapi.test.JHClientConfig;
import org.junit.Test; import org.junit.Test;
@@ -21,7 +20,7 @@ public class AppApiTest {
/** /**
* 获得一个调用应用接口的执行器 * 获得一个调用应用接口的执行器
*/ */
public static final JHAppApiExecution jhAppApiExecution = new JHAppApiExecution(JHClientConfig.client); public static final JHAppApiExecution jhAppApiExecution = (JHAppApiExecution) JHClientConfig.jhApiClientMap.get(JHAppApiExecution.class);
/** /**
* 测测试使用自定义的参数启动jhadmin的Linux桌面 * 测测试使用自定义的参数启动jhadmin的Linux桌面
@@ -157,14 +156,7 @@ public class AppApiTest {
@Test @Test
public void testGetAppList() { public void testGetAppList() {
List<AppInfo> appList = jhAppApiExecution.getAppList("jhadmin"); List<AppInfo> appList = jhAppApiExecution.getAppList("jhadmin");
System.out.println(appList);
ConsoleTable consoleTable = ConsoleTable.create();
consoleTable.setSBCMode(false);
consoleTable.addHeader("id", "name", "type", "category", "protocol");
for (AppInfo appInfo : appList) {
consoleTable.addBody(appInfo.getId(), appInfo.getName(), appInfo.getType(), appInfo.getCategory(), appInfo.getProtocol());
}
consoleTable.print();
} }
@@ -176,4 +168,21 @@ public class AppApiTest {
System.out.println(jhAppApiExecution.getAppUrl("jhadmin", "myjobmana")); System.out.println(jhAppApiExecution.getAppUrl("jhadmin", "myjobmana"));
} }
/**
* 测试根据文件后缀取应用列表
*/
@Test
public void testGetAppInfoSuffixList() {
System.out.println(jhAppApiExecution.getAppInfoSuffixList("test", ".sh"));
}
/**
* 测试根据用途获取应用列表
*/
@Test
public void testGetUseLabelList() {
System.out.println(jhAppApiExecution.getUseLabelList("jhadmin"));
}
} }

View File

@@ -1,33 +0,0 @@
package com.jhinno.sdk.openapi.test.auth;
import com.jhinno.sdk.openapi.api.app.JHAppApiExecution;
import com.jhinno.sdk.openapi.test.JHClientConfig;
import org.junit.Test;
/**
* 鉴权相关测试累类
*
* @author yanlongqi
* @date 2024/2/1 18:06
*/
public class AuthApiTest {
JHAppApiExecution jhAppApiExecution = new JHAppApiExecution(JHClientConfig.client);
/**
* 测试获取token
*/
@Test
public void testGetToken() {
String token = jhAppApiExecution.getToken("jhadmin");
System.out.println("token:" + token);
}
/**
* 测试退出登录
*/
@Test
public void testLogout(){
jhAppApiExecution.logout("lqyan");
}
}

View File

@@ -14,7 +14,7 @@ import java.util.Arrays;
*/ */
public class DataApiTest { public class DataApiTest {
public static final JHDataApiExecution execution = new JHDataApiExecution(JHClientConfig.client); public static final JHDataApiExecution execution = (JHDataApiExecution) JHClientConfig.jhApiClientMap.get(JHDataApiExecution.class);
/** /**
* 测试获取作业数据区目录列表 * 测试获取作业数据区目录列表

View File

@@ -1,6 +1,6 @@
package com.jhinno.sdk.openapi.test.file; package com.jhinno.sdk.openapi.test.file;
import cn.hutool.core.lang.ConsoleTable;
import com.jhinno.sdk.openapi.api.file.FileInfo; import com.jhinno.sdk.openapi.api.file.FileInfo;
import com.jhinno.sdk.openapi.api.file.JHFileApiExecution; import com.jhinno.sdk.openapi.api.file.JHFileApiExecution;
import com.jhinno.sdk.openapi.test.JHClientConfig; import com.jhinno.sdk.openapi.test.JHClientConfig;
@@ -17,7 +17,7 @@ import java.util.List;
*/ */
public class FileApiTest { public class FileApiTest {
private static final JHFileApiExecution execution = new JHFileApiExecution(JHClientConfig.client); private static final JHFileApiExecution execution = (JHFileApiExecution) JHClientConfig.jhApiClientMap.get(JHFileApiExecution.class);
/** /**
@@ -51,13 +51,7 @@ public class FileApiTest {
@Test @Test
public void testGetFileList() { public void testGetFileList() {
List<FileInfo> fileList = execution.getFileList("jhadmin", "$HOME"); List<FileInfo> fileList = execution.getFileList("jhadmin", "$HOME");
ConsoleTable consoleTable = ConsoleTable.create(); System.out.println(fileList);
consoleTable.setSBCMode(false);
consoleTable.addHeader("fileName", "fileType", "owner", "read", "write", "execute", "path");
for (FileInfo fileInfo : fileList) {
consoleTable.addBody(fileInfo.getFileName(), fileInfo.getFileType(), fileInfo.getOwner(), fileInfo.getRead().toString(), fileInfo.getWrite().toString(), fileInfo.getExecute().toString(), fileInfo.getPath());
}
consoleTable.print();
} }
/** /**
@@ -92,9 +86,9 @@ public class FileApiTest {
*/ */
@Test @Test
public void testUploadFile() throws IOException { public void testUploadFile() throws IOException {
File file = new File("C:\\Users\\yanlongqi\\Desktop\\双色球.xls"); File file = new File("C:\\Users\\yanlongqi\\Desktop\\LdapAdminv1830.exe");
FileInputStream fileInputStream = new FileInputStream(file); FileInputStream fileInputStream = new FileInputStream(file);
execution.uploadFile("jhadmin", fileInputStream, file.getName(), "$HOME/temp", true); execution.uploadFile("jhadmin", fileInputStream, file.getName(), "$HOME", true);
} }

View File

@@ -1,9 +1,6 @@
package com.jhinno.sdk.openapi.test.job; package com.jhinno.sdk.openapi.test.job;
import com.jhinno.sdk.openapi.api.job.JHJobApiExecution; import com.jhinno.sdk.openapi.api.job.*;
import com.jhinno.sdk.openapi.api.job.JobHistoryInfo;
import com.jhinno.sdk.openapi.api.job.JobStatusEnum;
import com.jhinno.sdk.openapi.api.job.PageJobInfo;
import com.jhinno.sdk.openapi.test.JHClientConfig; import com.jhinno.sdk.openapi.test.JHClientConfig;
import org.junit.Test; import org.junit.Test;
@@ -20,7 +17,7 @@ import java.util.Map;
*/ */
public class JobApiTest { public class JobApiTest {
private static final JHJobApiExecution execution = new JHJobApiExecution(JHClientConfig.client); private static final JHJobApiExecution execution = (JHJobApiExecution) JHClientConfig.jhApiClientMap.get(JHJobApiExecution.class);
/** /**
* 测试提交作业 * 测试提交作业
@@ -125,4 +122,13 @@ public class JobApiTest {
System.out.println(o); System.out.println(o);
} }
/**
* 测试获取作业表单
*/
@Test
public void testGetSimulationAppForm() {
List<JobAppFormItemInfo> simulationAppForm = execution.getSimulationAppForm("jhadmin", "common_sub");
System.out.println(simulationAppForm);
}
} }

View File

@@ -13,7 +13,7 @@ import org.junit.Test;
*/ */
public class DepartmentApiTest { public class DepartmentApiTest {
private static final JHDepartmentApiExecution execution = new JHDepartmentApiExecution(JHClientConfig.client); private static final JHDepartmentApiExecution execution = (JHDepartmentApiExecution) JHClientConfig.jhApiClientMap.get(JHDepartmentApiExecution.class);
/** /**

View File

@@ -15,7 +15,7 @@ import org.junit.Test;
*/ */
public class UserApiTest { public class UserApiTest {
private static final JHUserApiExecution execution = new JHUserApiExecution(JHClientConfig.client); private static final JHUserApiExecution execution = (JHUserApiExecution) JHClientConfig.jhApiClientMap.get(JHUserApiExecution.class);
/** /**

View File

@@ -0,0 +1,75 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cim.jhinno</groupId>
<artifactId>jhinno-openapi-sdk-spring-boot-example</artifactId>
<version>2.0.3</version>
<packaging>jar</packaging>
<name>Jhinno OpenAPI SDK for Java SpringBoot Example</name>
<description>The Jhinno OpenAPI SDK for Java used for accessing Jhinno OpenApi Service</description>
<url>http://jhinno.com</url>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.18</version>
</parent>
<dependencies>
<dependency>
<groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-sdk-spring-boot-starter</artifactId>
<version>2.0.3</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<includeSystemScope>true</includeSystemScope>
</configuration>
</plugin>
</plugins>
</build>
<developers>
<developer>
<id>lqyan</id>
<name>lqyan</name>
<email>lqyan@jhinno.com</email>
</developer>
</developers>
<licenses>
<license>
<name>The Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
</project>

View File

@@ -0,0 +1,13 @@
package com.jhinno.sdk.openapi.example;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ExampleApplication {
public static void main(String[] args) {
SpringApplication.run(ExampleApplication.class, args);
}
}

View File

@@ -0,0 +1,19 @@
package com.jhinno.sdk.openapi.example.api.extend;
public enum FileEnvType {
HOME_ENV{
@Override
public String getEnv() {
return "home";
}
},
SPOOLER_ENV{
@Override
public String getEnv() {
return "spooler";
}
};
public abstract String getEnv();
}

View File

@@ -0,0 +1,13 @@
package com.jhinno.sdk.openapi.example.api.extend;
import lombok.Data;
@Data
public class FilePath {
/**
* 文件路径
*/
private String path;
}

View File

@@ -0,0 +1,24 @@
package com.jhinno.sdk.openapi.example.api.extend;
import lombok.AllArgsConstructor;
import lombok.Getter;
@Getter
@AllArgsConstructor
public enum FileSystemType {
SYSTEM_TYPE_LINUX {
@Override
public String getType() {
return "linux";
}
},
SYSTEM_TYPE_WINDOWS {
@Override
public String getType() {
return "windows";
}
};
public abstract String getType();
}

View File

@@ -0,0 +1,29 @@
package com.jhinno.sdk.openapi.example.api.extend;
import com.fasterxml.jackson.core.type.TypeReference;
import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.ResponseResult;
import com.jhinno.sdk.openapi.client.JHApiClient;
import org.apache.commons.lang3.StringUtils;
import java.util.HashMap;
import java.util.Map;
public class JHFileApiExtendExecution extends JHApiExecution {
public static String GET_FILE_ENV_PATH = "/ws/api/files/path/{env}";
public FilePath getFileEnvPath(String username, FileEnvType env, FileSystemType type) {
Map<String, Object> params = new HashMap<>(1);
if (StringUtils.isNotBlank(type.getType())) {
params.put("type", type.getType());
}
String url = JHApiClient.getUrl(GET_FILE_ENV_PATH.replace("{env}", env.getEnv()), params);
return get(url, username, new TypeReference<ResponseResult<FilePath>>() {
});
}
public FilePath getFileHomeEnvPath(String username, FileSystemType type) {
return getFileEnvPath(username, FileEnvType.HOME_ENV, type);
}
}

View File

@@ -0,0 +1,19 @@
package com.jhinno.sdk.openapi.example.config;
import com.jhinno.sdk.openapi.example.api.extend.JHFileApiExtendExecution;
import com.jhinno.sdk.openapi.utils.JHOpenApiConfig;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@RequiredArgsConstructor
public class JHOpenapiExecutionConfig {
@Bean
public JHFileApiExtendExecution fileApiExtendExecution(JHOpenApiConfig jhOpenApiConfig) {
return jhOpenApiConfig.configJHApiExecution(new JHFileApiExtendExecution());
}
}

View File

@@ -0,0 +1,6 @@
jhinno:
openapi:
server-url: https://172.17.0.5/appform
auth-type: access_secret_mode
access-key: 3f03747f147942bd8debd81b6c9c6a80
access-key-secret: e0681859b91c499eb1d2c8e09cea3242

View File

@@ -0,0 +1,19 @@
package com.jhinno.sdk.openapi.example.test.extend;
import com.jhinno.sdk.openapi.example.api.extend.FileSystemType;
import com.jhinno.sdk.openapi.example.api.extend.JHFileApiExtendExecution;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class JHFileApiExtendTest {
@Autowired
private JHFileApiExtendExecution jhFileApiExtendExecution;
@Test
void testGetFileHomeEnvPath() {
System.out.println(jhFileApiExtendExecution.getFileHomeEnvPath("jhadmin", FileSystemType.SYSTEM_TYPE_LINUX));
}
}

View File

@@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>jhinno-openapi-sdk-spring-boot-starter</artifactId> <artifactId>jhinno-openapi-sdk-spring-boot-starter</artifactId>
<version>1.0.2</version> <version>2.0.3</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<name>Jhinno OpenAPI SDK for Java SpringBoot Starter</name> <name>Jhinno OpenAPI SDK for Java SpringBoot Starter</name>
<description>The Jhinno OpenAPI SDK for Java used for accessing Jhinno OpenApi Service</description> <description>The Jhinno OpenAPI SDK for Java used for accessing Jhinno OpenApi Service</description>
@@ -14,15 +14,14 @@
<parent> <parent>
<groupId>com.jhinno</groupId> <groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-java-sdk-parent</artifactId> <artifactId>jhinno-openapi-java-sdk-parent</artifactId>
<version>1.0.2</version> <version>2.0.3</version>
</parent> </parent>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>com.jhinno</groupId> <groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-java-sdk</artifactId> <artifactId>jhinno-openapi-java-sdk</artifactId>
<version>1.0.2</version> <version>2.0.3</version>
</dependency> </dependency>
<dependency> <dependency>
@@ -44,22 +43,15 @@
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
</dependencies> </dependencies>
<distributionManagement>
<repository>
<id>jhinno-releases</id>
<url>http://192.168.87.22:8081/repository/maven-releases</url>
</repository>
</distributionManagement>
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<configuration> <configuration>
<compileSourceRoots>src/main/java</compileSourceRoots>
<source>${maven.compiler.source}</source> <source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target> <target>${maven.compiler.target}</target>
<encoding>${project.build.sourceEncoding}</encoding> <encoding>${project.build.sourceEncoding}</encoding>
@@ -84,7 +76,6 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
<configuration> <configuration>
<sourcepath>target/generated-sources/delombok</sourcepath> <sourcepath>target/generated-sources/delombok</sourcepath>
<encoding>${project.build.sourceEncoding}</encoding> <encoding>${project.build.sourceEncoding}</encoding>
@@ -99,38 +90,7 @@
</tags> </tags>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.3.0</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins> </plugins>
</build> </build>
<developers>
<developer>
<id>lqyan</id>
<name>lqyan</name>
<email>lqyan@jhinno.com</email>
</developer>
</developers>
<licenses>
<license>
<name>The Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
</project> </project>

View File

@@ -1,6 +1,7 @@
package com.jhinno.sdk.openapi.autoconfigure; package com.jhinno.sdk.openapi.autoconfigure;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.client.JHApiClient;
import com.jhinno.sdk.openapi.client.JHApiHttpClientImpl;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
@@ -8,6 +9,7 @@ import org.springframework.context.annotation.Configuration;
/** /**
* openapi客户端自动配置 * openapi客户端自动配置
*
* @author yanlongqi * @author yanlongqi
* @date 2024/6/4 16:01 * @date 2024/6/4 16:01
*/ */
@@ -18,15 +20,18 @@ public class JHOpenapiClientAutoConfigure {
@Bean @Bean
@ConditionalOnMissingBean @ConditionalOnMissingBean
public JHApiClient jhApiClient(JHOpenapiProperties properties){ public JHApiClient jhApiClient(JHOpenapiProperties properties) {
return JHApiClient.build( JHApiClient jhApiClient = new JHApiClient(properties.getServerUrl());
properties.getServerUrl(), JHApiHttpClientImpl jhApiHttpClient = new JHApiHttpClientImpl();
properties.getMaxTotal(), jhApiHttpClient.setMaxPerRoute(properties.getMaxPerRout());
properties.getMaxPerRout(), jhApiHttpClient.setSocketTimeout(properties.getSocketTimeout());
properties.getSocketTimeout(), jhApiHttpClient.setMaxTotal(properties.getMaxTotal());
properties.getConnectTimeout(), jhApiHttpClient.setConnectTimeout(properties.getConnectTimeout());
properties.getConnectRequestTimeout() jhApiHttpClient.setConnectRequestTimeout(properties.getConnectRequestTimeout());
); jhApiHttpClient.init();
jhApiHttpClient.createHttpClients();
jhApiClient.setApiHttpClient(jhApiHttpClient);
return jhApiClient;
} }
} }

View File

@@ -1,13 +1,12 @@
package com.jhinno.sdk.openapi.autoconfigure; package com.jhinno.sdk.openapi.autoconfigure;
import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.api.app.JHAppApiExecution; import com.jhinno.sdk.openapi.api.app.JHAppApiExecution;
import com.jhinno.sdk.openapi.api.data.JHDataApiExecution; import com.jhinno.sdk.openapi.api.data.JHDataApiExecution;
import com.jhinno.sdk.openapi.api.file.JHFileApiExecution; import com.jhinno.sdk.openapi.api.file.JHFileApiExecution;
import com.jhinno.sdk.openapi.api.job.JHJobApiExecution; import com.jhinno.sdk.openapi.api.job.JHJobApiExecution;
import com.jhinno.sdk.openapi.api.organization.JHDepartmentApiExecution; import com.jhinno.sdk.openapi.api.organization.JHDepartmentApiExecution;
import com.jhinno.sdk.openapi.api.organization.JHUserApiExecution; import com.jhinno.sdk.openapi.api.organization.JHUserApiExecution;
import com.jhinno.sdk.openapi.client.JHApiClient; import com.jhinno.sdk.openapi.utils.JHOpenApiConfig;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
@@ -23,63 +22,34 @@ import org.springframework.context.annotation.Configuration;
public class JHOpenapiExecutionAutoconfigure { public class JHOpenapiExecutionAutoconfigure {
private final JHOpenapiProperties properties;
private final JHApiClient client;
@Bean @Bean
public JHAppApiExecution appApiExecution() { public JHAppApiExecution appApiExecution(JHOpenApiConfig jhOpenApiConfig) {
JHAppApiExecution execution = new JHAppApiExecution(client); return jhOpenApiConfig.configJHApiExecution(new JHAppApiExecution());
execution.setTokenTimeout(properties.getTokenTimeout());
execution.setTokenResidueTime(properties.getTokenResidueTime());
execution.setUsedServerTime(properties.isUsedServerTime());
return execution;
} }
@Bean @Bean
public JHDataApiExecution dataApiExecution() { public JHDataApiExecution dataApiExecution(JHOpenApiConfig jhOpenApiConfig) {
JHDataApiExecution execution = new JHDataApiExecution(client); return jhOpenApiConfig.configJHApiExecution(new JHDataApiExecution());
execution.setTokenTimeout(properties.getTokenTimeout());
execution.setTokenResidueTime(properties.getTokenResidueTime());
execution.setUsedServerTime(properties.isUsedServerTime());
return execution;
} }
@Bean @Bean
public JHFileApiExecution fileApiExecution() { public JHFileApiExecution fileApiExecution(JHOpenApiConfig jhOpenApiConfig) {
JHFileApiExecution execution = new JHFileApiExecution(client); return jhOpenApiConfig.configJHApiExecution(new JHFileApiExecution());
execution.setTokenTimeout(properties.getTokenTimeout());
execution.setTokenResidueTime(properties.getTokenResidueTime());
execution.setUsedServerTime(properties.isUsedServerTime());
return execution;
} }
@Bean @Bean
public JHJobApiExecution jobApiExecution() { public JHJobApiExecution jobApiExecution(JHOpenApiConfig jhOpenApiConfig) {
JHJobApiExecution execution = new JHJobApiExecution(client); return jhOpenApiConfig.configJHApiExecution(new JHJobApiExecution());
execution.setTokenTimeout(properties.getTokenTimeout());
execution.setTokenResidueTime(properties.getTokenResidueTime());
execution.setUsedServerTime(properties.isUsedServerTime());
return execution;
} }
@Bean @Bean
public JHDepartmentApiExecution departmentApiExecution() { public JHDepartmentApiExecution departmentApiExecution(JHOpenApiConfig jhOpenApiConfig) {
JHDepartmentApiExecution execution = new JHDepartmentApiExecution(client); return jhOpenApiConfig.configJHApiExecution(new JHDepartmentApiExecution());
execution.setTokenTimeout(properties.getTokenTimeout());
execution.setTokenResidueTime(properties.getTokenResidueTime());
execution.setUsedServerTime(properties.isUsedServerTime());
return execution;
} }
@Bean @Bean
public JHUserApiExecution userApiExecution() { public JHUserApiExecution userApiExecution(JHOpenApiConfig jhOpenApiConfig) {
JHUserApiExecution execution = new JHUserApiExecution(client); return jhOpenApiConfig.configJHApiExecution(new JHUserApiExecution());
execution.setTokenTimeout(properties.getTokenTimeout());
execution.setTokenResidueTime(properties.getTokenResidueTime());
execution.setUsedServerTime(properties.isUsedServerTime());
return execution;
} }
} }

View File

@@ -1,6 +1,6 @@
package com.jhinno.sdk.openapi.autoconfigure; package com.jhinno.sdk.openapi.autoconfigure;
import com.jhinno.sdk.openapi.CommonConstant; import com.jhinno.sdk.openapi.AuthType;
import com.jhinno.sdk.openapi.client.DefaultHttpClientConfig; import com.jhinno.sdk.openapi.client.DefaultHttpClientConfig;
import com.jhinno.sdk.openapi.constant.CommonConstants; import com.jhinno.sdk.openapi.constant.CommonConstants;
import lombok.Data; import lombok.Data;
@@ -26,9 +26,9 @@ public class JHOpenapiProperties {
/** /**
* 设置服务每次能并行接收的请求数量,默认{@link DefaultHttpClientConfig#MAX_PER_ROUT} * 设置服务每次能并行接收的请求数量,默认{@link DefaultHttpClientConfig#MAX_PER_ROUTE}
*/ */
private int maxPerRout = DefaultHttpClientConfig.MAX_PER_ROUT; private int maxPerRout = DefaultHttpClientConfig.MAX_PER_ROUTE;
/** /**
* 设置服务socket连接超时的时间(单位:毫秒),默认{@link DefaultHttpClientConfig#SOCKET_TIMEOUT} * 设置服务socket连接超时的时间(单位:毫秒),默认{@link DefaultHttpClientConfig#SOCKET_TIMEOUT}
@@ -50,16 +50,38 @@ public class JHOpenapiProperties {
/** /**
* token的超时时间单位分钟 * token的超时时间单位分钟
*/ */
private int tokenTimeout = CommonConstant.DEFAULT_TOKEN_EFFECTIVE_TIME; private int tokenTimeout = DefaultHttpClientConfig.DEFAULT_TOKEN_EFFECTIVE_TIME;
/** /**
* token提前获取的时间单位分钟 * token提前获取的时间单位分钟
*/ */
private int tokenResidueTime = CommonConstant.DEFAULT_TOKEN_RESIDUE_TIME; private int tokenResidueTime = DefaultHttpClientConfig.DEFAULT_TOKEN_RESIDUE_TIME;
/** /**
* 是否使用服务器时间 * 是否使用服务器时间
*/ */
private boolean usedServerTime = CommonConstant.DEFAULT_IS_USED_SERVER_TIME; private boolean usedServerTime = DefaultHttpClientConfig.DEFAULT_IS_USED_SERVER_TIME;
/**
* 是否强制获取用户的token默认{@link DefaultHttpClientConfig#DEFAULT_IS_FORCE_GET_TOKEN},
* 如果强制获取token则每次请求都去获取token
*/
private boolean isForceGetToken = DefaultHttpClientConfig.DEFAULT_IS_FORCE_GET_TOKEN;
/**
* 接口请求的认证类型
*/
private AuthType authType = AuthType.ACCESS_SECRET_MODE;
/**
* 访问密钥
*/
private String accessKey;
/**
* 访问密钥密码
*/
private String accessKeySecret;
} }

View File

@@ -0,0 +1,35 @@
package com.jhinno.sdk.openapi.utils;
import com.jhinno.sdk.openapi.api.JHApiExecution;
import com.jhinno.sdk.openapi.autoconfigure.JHOpenapiProperties;
import com.jhinno.sdk.openapi.client.JHApiClient;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Configuration;
@Configuration
@RequiredArgsConstructor
public class JHOpenApiConfig {
private final JHApiClient client;
private final JHOpenapiProperties properties;
/**
* 配置执行器
*
* @param execution 执行器
* @param <T> 执行器类型
* @return 配置的执行器
*/
public <T extends JHApiExecution> T configJHApiExecution(T execution) {
execution.setJhApiClient(client);
execution.setForceGetToken(properties.isForceGetToken());
execution.setAuthType(properties.getAuthType());
execution.setAccessKey(properties.getAccessKey());
execution.setAccessKeySecret(properties.getAccessKeySecret());
execution.setTokenTimeout(properties.getTokenTimeout());
execution.setTokenResidueTime(properties.getTokenResidueTime());
execution.setUsedServerTime(properties.isUsedServerTime());
return execution;
}
}

View File

@@ -1,3 +1,4 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.jhinno.sdk.openapi.autoconfigure.JHOpenapiClientAutoConfigure,\ com.jhinno.sdk.openapi.autoconfigure.JHOpenapiClientAutoConfigure,\
com.jhinno.sdk.openapi.utils.JHOpenApiConfig,\
com.jhinno.sdk.openapi.autoconfigure.JHOpenapiExecutionAutoconfigure com.jhinno.sdk.openapi.autoconfigure.JHOpenapiExecutionAutoconfigure

View File

@@ -1,2 +1,3 @@
com.jhinno.sdk.openapi.autoconfigure.JHOpenapiClientAutoConfigure com.jhinno.sdk.openapi.autoconfigure.JHOpenapiClientAutoConfigure
com.jhinno.sdk.openapi.utils.JHOpenApiConfig
com.jhinno.sdk.openapi.autoconfigure.JHOpenapiExecutionAutoconfigure com.jhinno.sdk.openapi.autoconfigure.JHOpenapiExecutionAutoconfigure

74
pom.xml
View File

@@ -6,11 +6,11 @@
<groupId>com.jhinno</groupId> <groupId>com.jhinno</groupId>
<artifactId>jhinno-openapi-java-sdk-parent</artifactId> <artifactId>jhinno-openapi-java-sdk-parent</artifactId>
<version>1.0.2</version> <version>2.0.3</version>
<packaging>pom</packaging> <packaging>pom</packaging>
<name>Jhinno OpenAPI SDK for Java parent</name> <name>Jhinno OpenAPI SDK for Java parent</name>
<description>The Jhinno OpenAPI SDK for Java used for accessing Jhinno OpenApi Service</description> <description>The Jhinno OpenAPI SDK for Java used for accessing Jhinno OpenApi Service</description>
<url>http://jhinno.com</url> <url>https://github.com/yanlongqi/jhinno-openapi-java-sdk</url>
<properties> <properties>
@@ -27,19 +27,61 @@
<version>2.7.18</version> <version>2.7.18</version>
</parent> </parent>
<distributionManagement>
<repository>
<id>jhinno-releases</id>
<url>http://192.168.87.22:8081/repository/maven-releases</url>
</repository>
</distributionManagement>
<modules> <modules>
<module>jhinno-openapi-java-sdk</module> <module>jhinno-openapi-java-sdk</module>
<module>jhinno-openapi-sdk-spring-boot-starter</module> <module>jhinno-openapi-sdk-spring-boot-starter</module>
</modules> </modules>
<build>
<plugins>
<plugin>
<groupId>org.sonatype.central</groupId>
<artifactId>central-publishing-maven-plugin</artifactId>
<version>0.5.0</version>
<extensions>true</extensions>
<configuration>
<publishingServerId>central</publishingServerId>
<autoPublish>true</autoPublish>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<developers> <developers>
<developer> <developer>
@@ -56,4 +98,16 @@
</license> </license>
</licenses> </licenses>
<issueManagement>
<system>github</system>
<url>https://github.com/yanlongqi/jhinno-openapi-java-sdk/issues</url>
</issueManagement>
<scm>
<connection>scm:git:https://github.com/yanlongqi/jhinno-openapi-java-sdk.git</connection>
<developerConnection>scm:git:https://github.com/yanlongqi/jhinno-openapi-java-sdk.git</developerConnection>
<url>https://github.com/yanlongqi/jhinno-openapi-java-sdk</url>
</scm>
</project> </project>