跳转至

准备工作

一、需要准备的环境及工具

1. Java 1.8 (必须)

建议使用zulu-jdk（oracle-jdk也是可以的），从官网下载，也可使用IDEA直接下载(File->Project Structure->SDKS，然后选择"+"，选择Download JDK)， 选择Azul-zulu-community，jdk-8。

需要配置环境变量，或者在编译器中指定当前版本jdk。

2. Maven项目构建管理工具 (必须)

Maven 是一个项目管理工具，可以对 Java 项目进行构建、依赖管理，是一个自动化构建工具。

自动化构建工具：将原材料（java、js、css、html....）->产品（可发布项目）

编译-打包-部署-测试 -> 自动构建可从官网下载并配置相关信息。

注意

  • 需要将Maven的配置到系统的环境变量中，以方便在终端中使用maven命令。
  • 需要将同一个Maven地址配置到使用的编译器中，防止项目构建时出现其他问题。

3. Gradle项目构建管理工具 (必须)

Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化构建开源工具。可通过示例代码中的gradlew脚本进行下载。

需要使用者先进行一定的学习。

4. IDE (必须)

编译器，可根据自己使用情况进行选择，推荐使用最新版IDEA。

5. Lombok (必须)

Java简化代码的工具，需要将Lombok插件安装到IDE中，具体可查看Lombok官网。

6. RepChain (必须)

需要有一套已经在运行的RepChain组件环境，若已有RepChain环境可忽略。

快速搭建方法可查看此处。

如果需要详细的RepChain文档，可查看RepChain文档。

7. RepChain Dashboard (必须)

RepChain管理控制台，请参考部署视频，文档更新中...

8. RCJava-core (必须)

与RepChain 连接的Java客户端及代码示例。

具体使用说明请查看此处。

注意

此处需要使用 mvn clean install 方式发布到本地仓库。

9. 接入中间件客户端(必须)

  • 下载代码 middleware 分支 

    1
    git clone https://gitee.com/BTAJL/api-coord.git -b mid-client

  • 进入到代码文件夹，执行脚本将代码发布到maven本地仓库

Win

1
2
cd .\api-coord\
.\gradlew.bat publishLibraryPublicationToMavenLocal

Mac/Linux

1
2
cd api-coord
./gradlew publishLibraryPublicationToMavenLocal
  • 引入项目

Maven

1
2
3
4
5
<dependency>
  <groupId>repchain.interface.cooperation</groupId>
  <artifactId>Interface-Cooperation-Client</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Gradle

1
    implementation 'repchain.interface.cooperation:Interface-Cooperation-Client:1.0-SNAPSHOT'

二、接口协同所需代码

1. RepChain主程序

注意：RepChain需要使用2.0版本

Gitee地址：https://gitee.com/BTAJL/repchain/tree/dev_jdk13_2.0.0.0/

2. RepChain-Dashboard管理平台

未开源，需要请联系Repchain Gitee

3. RCJava-core

与RepChain相关的Java 客户端

Gitee地址：https://gitee.com/BTAJL/RCJava-core

4.Api-coord

接入中间件代码，

代码暂未开源，未经许可禁止商用。

middleware_rc2.0.0分支为中间件代码

mid-client分支为客户端代码

Gitee地址：https://gitee.com/BTAJL/api-coord

三、通过RepChain-Dashboard进行账号注册及授权

提示

请通过RepChain-Dashboard进行账号注册及授权操作，具体文档请参考RepChain-Dashboard使用文档。

四、OpenAPI接口定义语言

1. OpenAPI

openApi用于接口协同中接口描述，可在接口定义中起到描述约束的作用。请先了解相关定义，官网。

2. 生成OpenAPI描述JSON

如果项目中用到了Swagger-UI相关功能，可通过SwaggerUI进行接口描述内容生成。根据Swagger版本访问相对应的接口即可获取OpenAPI生成的Json数据。

例：

Swagger 2.0中，通过以下接口即可获取OpenApi的接口描述的json数据。

http://localhost:8081/example/v2/api-docs

回到页面顶部