【Java】開發一個Java-SDK

前提

　　實際上開發一個Java-SDK的過程，實際上也就是開發一個基本java項目並打包成jar包的過程，然后可以被其它項目引入使用。

開發Java-SDK

　　本例介紹開發一個向某一數據接口發送請求並返回結果的SDK

　　1、新建一個Maven工程test-sdk-java

　　　　

　　2、編輯pom文件，引入需要的jar包，若不需要第三方jar包也可以不引入

　　　　本例使用了hutool工具包

<?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>org.example</groupId>
    <artifactId>test-sdk-java</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.3.7</version>
        </dependency>
    </dependencies>

</project>

　　3、編輯封裝類，可以封裝一些必要的邏輯

　　　　MyHttpRequest.java

package com.test.api.bean;

import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;

public class MyHttpRequest {

    private HttpRequest httpRequest;

    public MyHttpRequest(String url){
        httpRequest = HttpRequest.get(url);
        // 可以封裝其他邏輯
    }

    public MyHttpResponse execute(){
        if(httpRequest == null) {
            throw new NullPointerException("httpRequest is empty !");
        }
        HttpResponse httpResponse = httpRequest.execute();
        MyHttpResponse myHttpResponse = new MyHttpResponse();
        myHttpResponse.setHttpResponse(httpResponse);
        return myHttpResponse;
    }

    public static void main(String[] args) {
        MyHttpRequest myHttpRequest = new MyHttpRequest("https://www.sina.com");
        MyHttpResponse myHttpResponse = myHttpRequest.execute();
        int status = myHttpResponse.getStatus();
        if(status == 200) {
            System.out.println(myHttpResponse.body());
        }else {
            System.out.println("status === " + status );
            System.out.println("請求失敗！");
        }
    }
}

　　　　MyHttpResponse.java

package com.test.api.bean;

import cn.hutool.http.HttpResponse;

public class MyHttpResponse{

    HttpResponse httpResponse;

    public HttpResponse getHttpResponse() {
        return httpResponse;
    }

    public void setHttpResponse(HttpResponse httpResponse) {
        this.httpResponse = httpResponse;

    }

    public int getStatus() {
        if(httpResponse == null) {
            throw new NullPointerException("httpResponse is empty !");
        }
        return httpResponse.getStatus();
    }

    public String body(){
        if(httpResponse == null) {
            throw new NullPointerException("httpResponse is empty !");
        }
        return httpResponse.body();
    }
}

　　4、編輯一個客戶端MyHttpClient.java

package com.test.api;

import com.test.api.bean.MyHttpRequest;
import com.test.api.bean.MyHttpResponse;

public class MyHttpClient {

    private static MyHttpClient myHttpClient;

    /**
     * @return  Instance
     */
    public static MyHttpClient getInstance() {
        synchronized (MyHttpClient.class) {
            if(myHttpClient == null) {
                myHttpClient = new MyHttpClient();
            }
        }
        return myHttpClient;
    }

    public MyHttpResponse execute(String url){
        MyHttpRequest myHttpRequest = new MyHttpRequest(url);
        return myHttpRequest.execute();
    }

}

　　5、打包

　　　　1）調用方是maven工程，調用時直接使用依賴引入的方法使用sdk

　　　　使用mvn命令：mvn clean install打包安裝

　　　　2）調用方是非maven工程，調用時直使用 sdk jar包

　　　　需要使用其他方式打包：見【Java】Maven 打包可運行jar包

使用Java-SDK

　　1、新建一個Maven工程test-sdk-java-test　　

　　2、引入sdk依賴

<?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>org.example</groupId>
    <artifactId>test-sdk-java-test</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>test-sdk-java</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

　　3、編寫主類進行測試

public class MyMain {
    public static void main(String[] args) {
        // 配置
        String url = "https://www.sina.com";
        // 獲取SDK中客戶端
        MyHttpClient myHttpClient = MyHttpClient.getInstance();
        // 執行業務
        MyHttpResponse myHttpResponse = myHttpClient.execute(url);
        int status = myHttpResponse.getStatus();
        if(status == 200) {
            System.out.println("請求成功");
            System.out.println(myHttpResponse.body());
        }else {
            System.out.println("status === " + status );
            System.out.println("請求失敗！");
        }
    }
}

　　4、運行主類的主方法