# jlpay-sdk-java

**Repository Path**: jlpaydemo/jlpay-sdk-java

## Basic Information

- **Project Name**: jlpay-sdk-java
- **Description**: 咕朵云开放平台sdk-java版本
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2025-07-14
- **Last Updated**: 2026-02-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 咕朵云 SDK Java 集成指引

本指南介绍如何在 Java 项目中引入咕朵云 SDK，接入咕朵云开放平台 API。本示例基于 **1.0.18** 版本，其他版本请根据实际情况调整 JAR 与 pom 文件名及版本号。

---

## 前提条件

- 已安装 **Java 8** 或更高版本
- 已安装 **Maven 3.x**（若使用 Maven 集成）
- 已配置 Java IDE（如 IntelliJ IDEA、Eclipse 或 VS Code）
- 已获取 **主 JAR**：`open-jlpay-sdk-java-1.0.18.jar`（`*-sources.jar` 仅用于 IDE 查看源码，不能替代主 JAR）

---

## 1. 引入 SDK

### 方式一：Maven + 本地 lib，自动带 SDK 依赖（推荐，本示例用法）

本仓库在构建时通过 **install-file** 将 `lib/` 下的 SDK JAR 与其 pom 安装到本地 Maven 仓库，再以**普通依赖**引用。Maven 会按 SDK 的 pom **自动带入传递依赖**（httpclient、bouncycastle、jackson 等），编译与运行 classpath 一致，无需手写传递依赖。

**步骤：**

1. **准备文件**
   - 将 `open-jlpay-sdk-java-1.0.18.jar` 放入项目根目录下的 `lib/` 文件夹。
   - 将同版本的 `open-jlpay-sdk-java-1.0.18.pom` 也放入 `lib/`（可从本仓库 `lib/` 获取，或从 SDK JAR 内 `META-INF/maven/com.jlpay/open-jlpay-sdk-java/pom.xml` 解出后重命名）。

2. **在 `pom.xml` 中仅添加普通依赖（无 system scope）**
   ```xml
   <dependency>
       <groupId>com.jlpay</groupId>
       <artifactId>open-jlpay-sdk-java</artifactId>
       <version>1.0.18</version>
   </dependency>
   ```

3. **在 `pom.xml` 的 `<build><plugins>` 中配置自动安装**（与本示例一致时）
   ```xml
   <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-install-plugin</artifactId>
       <version>3.1.1</version>
       <executions>
           <execution>
               <id>install-jlpay-sdk</id>
               <phase>initialize</phase>
               <goals>
                   <goal>install-file</goal>
               </goals>
               <configuration>
                   <file>${project.basedir}/lib/open-jlpay-sdk-java-1.0.18.jar</file>
                   <pomFile>${project.basedir}/lib/open-jlpay-sdk-java-1.0.18.pom</pomFile>
                   <createChecksum>true</createChecksum>
               </configuration>
           </execution>
       </executions>
   </plugin>
   ```

4. **执行构建并在 IDE 中刷新**
   - 在项目根目录执行：`mvn clean compile`（会先执行 install-file，再解析依赖）。
   - 在 IDE 中**重新加载 Maven 项目**（如 IntelliJ：右键 `pom.xml` → Maven → Reload Project）。

之后即可直接运行 Demo，不会再出现 `NoClassDefFoundError`（如 HttpClientConnectionManager、BouncyCastleProvider 等）。

---

### 方式二：手动安装到本地 Maven 仓库

不依赖构建时的自动 install-file 时，可先手动安装，再以普通依赖引用。

1. **准备 JAR 与 pom**（同上，放入 `lib/`）。
2. **执行一次 install-file**
   ```bash
   mvn install:install-file \
      -Dfile=lib/open-jlpay-sdk-java-1.0.18.jar \
      -DpomFile=lib/open-jlpay-sdk-java-1.0.18.pom
   ```
3. **在 `pom.xml` 中仅添加普通依赖**（同方式一第 2 步，无需 install 插件）。
4. **在 IDE 中刷新 Maven 项目**。

---

### 方式三：Gradle 项目

1. 将 `open-jlpay-sdk-java-1.0.18.jar` 放入项目 `libs/` 目录。
2. 在 `build.gradle` 中配置：
   ```gradle
   dependencies {
       implementation files('libs/open-jlpay-sdk-java-1.0.18.jar')
       // 需自行添加 SDK 的传递依赖，例如：
       // implementation 'org.apache.httpcomponents:httpclient:4.5.14'
       // implementation 'org.apache.httpcomponents:httpmime:4.5.14'
       // implementation 'org.bouncycastle:bcprov-jdk15on:1.70'
       // implementation 'org.bouncycastle:bcpkix-jdk15on:1.70'
       // implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.5'
       // implementation 'commons-codec:commons-codec:1.16.0'
       // implementation 'com.squareup.okhttp3:okhttp:4.12.0'
   }
   ```
   完整依赖可参考 SDK 内嵌 pom 或本仓库 `pom.xml`。

---

## 2. 使用示例

可直接运行本仓库中的 Demo，例如：

- 银联用户 ID 查询：`com.jlpay.openapi.demo.trans.union.GetUnionPayUserIdService`
- 设备查询：`com.jlpay.openapi.demo.openmerch.device.QueryService`
- 其他示例见 `src/main/java/com/jlpay/openapi/demo/` 下各包。

**方式一**：执行一次 `mvn clean compile` 并在 IDE 中刷新 Maven 后即可运行；**方式二**：需先执行一次 `mvn install:install-file` 再刷新 Maven。

---

## 3. 获取帮助

- 官方文档：[咕朵云开放平台](https://open.jlpay.com)