SpringBoot整合dataworks的實現過程

2022-08-12 14:00:18

注意事項

阿里雲的dataworks提供了OpenApi, 需要是企業版或旗艦版才能夠呼叫，也就是付費專案。

這裡測試主要是呼叫拉取dataworks上拉取的指令碼，並儲存到本地。
指令碼包含兩部分

1、開發的odps指令碼(通過OpenApi獲取)2、建表語句指令碼(通過dataworks資訊去連線maxCompute獲取建立語句)

阿里雲Dataworks的openApi分頁查詢限制，一次最多查詢100條。我們拉取指令碼需要分多頁查詢

該專案使用到了MaxCompute的SDK/JDBC方式連線，SpringBoot操作MaxCompute SDK/JDBC連線

整合實現

實現主要是編寫工具類，如果需要則可以設定成SpringBean，注入容器即可使用

依賴引入

<properties>
    <java.version>1.8</java.version>
    <!--maxCompute-sdk-版本號-->
    <max-compute-sdk.version>0.40.8-public</max-compute-sdk.version>
    <!--maxCompute-jdbc-版本號-->
    <max-compute-jdbc.version>3.0.1</max-compute-jdbc.version>
    <!--dataworks版本號-->
    <dataworks-sdk.version>3.4.2</dataworks-sdk.version>
    <aliyun-java-sdk.version>4.5.20</aliyun-java-sdk.version>
</properties>
<dependencies>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>
<!--max compute sdk-->
<dependency>
    <groupId>com.aliyun.odps</groupId>
    <artifactId>odps-sdk-core</artifactId>
    <version>${max-compute-sdk.version}</version>
</dependency>
<!--max compute jdbc-->
<dependency>
    <groupId>com.aliyun.odps</groupId>
    <artifactId>odps-jdbc</artifactId>
    <version>${max-compute-jdbc.version}</version>
    <classifier>jar-with-dependencies</classifier>
</dependency>
<!--dataworks需要引入aliyun-sdk和dataworks本身-->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>${aliyun-java-sdk.version}</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-dataworks-public</artifactId>
    <version>${dataworks-sdk.version}</version>
</dependency>
</dependencies>

請求引數類編寫

/**
 * @Description
 * @Author itdl
 * @Date 2022/08/09 15:12
 */
@Data
public class DataWorksOpenApiConnParam {
    /**
     * 區域 eg. cn-shanghai
     */
    private String region;

    /**
     * 存取keyId
     */
    private String aliyunAccessId;
    /**
     * 金鑰
     */
    private String aliyunAccessKey;

    /**
     * 存取端點  就是API的URL字首
     */
    private String endPoint;

    /**
     * 資料庫型別 如odps
     */
    private String datasourceType;

    /**
     * 所屬專案
     */
    private String project;

    /**
     * 專案環境 dev  prod
     */
    private String projectEnv;
}

工具類編寫

基礎類準備，拉取指令碼之後的回撥函數

為什麼需要回撥函數，因為拉取的是所有指令碼，如果合併每次分頁結果的話，會導致記憶體溢位，而使用回撥函數只是每次迴圈增加處理常式

/**
 * @Description
 * @Author itdl
 * @Date 2022/08/09 15:12
 */
@Data
public class DataWorksOpenApiConnParam {
    /**
     * 區域 eg. cn-shanghai
     */
    private String region;

    /**
     * 存取keyId
     */
    private String aliyunAccessId;
    /**
     * 金鑰
     */
    private String aliyunAccessKey;

    /**
     * 存取端點  就是API的URL字首
     */
    private String endPoint;

    /**
     * 資料庫型別 如odps
     */
    private String datasourceType;

    /**
     * 所屬專案
     */
    private String project;

    /**
     * 專案環境 dev  prod
     */
    private String projectEnv;
}

初始化操作

主要是範例化dataworks openApi介面的使用者端資訊，maxCompute連線的工具類初始化(包括JDBC,SDK方式)

private static final String MAX_COMPUTE_JDBC_URL_FORMAT = "http://service.%s.maxcompute.aliyun.com/api";
/**預設的odps介面地址 在Odps中也可以看到該變數*/
private static final String defaultEndpoint = "http://service.odps.aliyun.com/api";
/**
 * dataworks連線引數
 *
 */
private final DataWorksOpenApiConnParam connParam;

/**
 * 可以使用dataworks去連線maxCompute 如果連線的引擎是maxCompute的話
 */
private final MaxComputeJdbcUtil maxComputeJdbcUtil;

private final MaxComputeSdkUtil maxComputeSdkUtil;

private final boolean odpsSdk;


/**
 * 使用者端
 */
private final IAcsClient client;

public DataWorksOpenApiUtil(DataWorksOpenApiConnParam connParam, boolean odpsSdk) {
    this.connParam = connParam;
    this.client = buildClient();
    this.odpsSdk = odpsSdk;
    if (odpsSdk){
        this.maxComputeJdbcUtil = null;
        this.maxComputeSdkUtil = buildMaxComputeSdkUtil();
    }else {
        this.maxComputeJdbcUtil = buildMaxComputeJdbcUtil();
        this.maxComputeSdkUtil = null;
    }
}

private MaxComputeSdkUtil buildMaxComputeSdkUtil() {
    final MaxComputeSdkConnParam param = new MaxComputeSdkConnParam();

    // 設定賬號密碼
    param.setAliyunAccessId(connParam.getAliyunAccessId());
    param.setAliyunAccessKey(connParam.getAliyunAccessKey());

    // 設定endpoint
    param.setMaxComputeEndpoint(defaultEndpoint);

    // 目前只處理odps的引擎
    final String datasourceType = connParam.getDatasourceType();
    if (!"odps".equals(datasourceType)){
        throw new BizException(ResultCode.DATA_WORKS_ENGINE_SUPPORT_ERR);
    }

    // 獲取專案環境，根據專案環境連線不同的maxCompute
    final String projectEnv = connParam.getProjectEnv();

    if ("dev".equals(projectEnv)){
        // 開發環境dataworks + _dev就是maxCompute的專案名
        param.setProjectName(String.join("_", connParam.getProject(), projectEnv));
    }else {
        // 生產環境dataworks的專案名和maxCompute一致
        param.setProjectName(connParam.getProject());
    }

    return new MaxComputeSdkUtil(param);
}

private MaxComputeJdbcUtil buildMaxComputeJdbcUtil() {
    final MaxComputeJdbcConnParam param = new MaxComputeJdbcConnParam();

    // 設定賬號密碼
    param.setAliyunAccessId(connParam.getAliyunAccessId());
    param.setAliyunAccessKey(connParam.getAliyunAccessKey());

    // 設定endpoint
    param.setEndpoint(String.format(MAX_COMPUTE_JDBC_URL_FORMAT, connParam.getRegion()));

    // 目前只處理odps的引擎
    final String datasourceType = connParam.getDatasourceType();
    if (!"odps".equals(datasourceType)){
        throw new BizException(ResultCode.DATA_WORKS_ENGINE_SUPPORT_ERR);
    }

    // 獲取專案環境，根據專案環境連線不同的maxCompute
    final String projectEnv = connParam.getProjectEnv();

    if ("dev".equals(projectEnv)){
        // 開發環境dataworks + _dev就是maxCompute的專案名
        param.setProjectName(String.join("_", connParam.getProject(), projectEnv));
    }else {
        // 生產環境dataworks的專案名和maxCompute一致
        param.setProjectName(connParam.getProject());
    }

    return new MaxComputeJdbcUtil(param);
}

呼叫OpenApi拉取所有指令碼

/**
 * 根據資料夾路徑分頁查詢該路徑下的檔案（指令碼）
 * @param pageSize 每頁查詢多少資料
 * @param folderPath 檔案所在目錄
 * @param userType 檔案所屬功能模組 可不傳
 * @param fileTypes 設定檔案程式碼型別 逗號分割 可不傳
 */
public void listAllFiles(Integer pageSize, String folderPath, String userType, String fileTypes, CallBack.FileCallBack callBack) throws ClientException {
    pageSize = setPageSize(pageSize);
    // 建立請求
    final ListFilesRequest request = new ListFilesRequest();

    // 設定分頁引數
    request.setPageNumber(1);
    request.setPageSize(pageSize);

    // 設定上級資料夾
    request.setFileFolderPath(folderPath);

    // 設定區域和專案名稱
    request.setSysRegionId(connParam.getRegion());
    request.setProjectIdentifier(connParam.getProject());

    // 設定檔案所屬功能模組
    if (!ObjectUtils.isEmpty(userType)){
        request.setUseType(userType);
    }
    // 設定檔案程式碼型別
    if (!ObjectUtils.isEmpty(fileTypes)){
        request.setFileTypes(fileTypes);
    }

    // 發起請求
    ListFilesResponse res = client.getAcsResponse(request);

    // 獲取分頁總數
    final Integer totalCount = res.getData().getTotalCount();
    // 返回結果
    final List<ListFilesResponse.Data.File> resultList = res.getData().getFiles();
    // 計算能分幾頁
    long pages = totalCount % pageSize == 0 ? (totalCount / pageSize) : (totalCount / pageSize) + 1;
    // 只有1頁 直接返回
    if (pages <= 1){
        callBack.handle(resultList);
        return;
    }

    // 第一頁執行回撥
    callBack.handle(resultList);

    // 分頁資料 從第二頁開始查詢 同步拉取，可以優化為多執行緒拉取
    for (int i = 2; i <= pages; i++) {
        //第1頁
        request.setPageNumber(i);
        //每頁大小
        request.setPageSize(pageSize);
        // 發起請求
        res = client.getAcsResponse(request);
        final List<ListFilesResponse.Data.File> tableEntityList = res.getData().getFiles();
        if (!ObjectUtils.isEmpty(tableEntityList)){
            // 執行回撥函數
            callBack.handle(tableEntityList);
        }
    }
}

內部連線MaxCompute拉取所有DDL指令碼內容

DataWorks工具類程式碼，通過回撥函數處理

    /**
     * 獲取所有的DDL指令碼
     * @param callBack 回撥處理常式
     */
    public void listAllDdl(CallBack.DdlCallBack callBack){
        if (odpsSdk){
            final List<TableMetaInfo> tableInfos = maxComputeSdkUtil.getTableInfos();
            for (TableMetaInfo tableInfo : tableInfos) {
                final String tableName = tableInfo.getTableName();
                final String sqlCreateDesc = maxComputeSdkUtil.getSqlCreateDesc(tableName);
                callBack.handle(tableName, sqlCreateDesc);
            }
        }
    }

MaxCompute工具類程式碼，根據表名獲取建表語句, 以SDK為例， JDBC直接執行show create table即可拿到建表語句

/**
 * 根據表名獲取建表語句
 * @param tableName 表名
 * @return
 */
public String getSqlCreateDesc(String tableName) {
    final Table table = odps.tables().get(tableName);
    // 建表語句
    StringBuilder mssqlDDL = new StringBuilder();

    // 獲取表結構
    TableSchema tableSchema = table.getSchema();
    // 獲取表名錶註釋
    String tableComment = table.getComment();

    //獲取列名列註釋
    List<Column> columns = tableSchema.getColumns();
    /*組裝成mssql的DDL*/
    // 表名
    mssqlDDL.append("CREATE TABLE IF NOT EXISTS ");
    mssqlDDL.append(tableName).append("n");
    mssqlDDL.append(" (n");
    //列欄位
    int index = 1;
    for (Column column : columns) {
        mssqlDDL.append("  ").append(column.getName()).append("tt").append(column.getTypeInfo().getTypeName());
        if (!ObjectUtils.isEmpty(column.getComment())) {
            mssqlDDL.append(" COMMENT '").append(column.getComment()).append("'");
        }
        if (index == columns.size()) {
            mssqlDDL.append("n");
        } else {
            mssqlDDL.append(",n");
        }
        index++;
    }
    mssqlDDL.append(" )n");
    //獲取分割區
    List<Column> partitionColumns = tableSchema.getPartitionColumns();
    int partitionIndex = 1;
    if (!ObjectUtils.isEmpty(partitionColumns)) {
        mssqlDDL.append("PARTITIONED BY (");
    }
    for (Column partitionColumn : partitionColumns) {
        final String format = String.format("%s %s COMMENT '%s'", partitionColumn.getName(), partitionColumn.getTypeInfo().getTypeName(), partitionColumn.getComment());
        mssqlDDL.append(format);
        if (partitionIndex == partitionColumns.size()) {
            mssqlDDL.append("n");
        } else {
            mssqlDDL.append(",n");
        }
        partitionIndex++;
    }

    if (!ObjectUtils.isEmpty(partitionColumns)) {
        mssqlDDL.append(")n");
    }
//        mssqlDDL.append("STORED AS ALIORC  n");
//        mssqlDDL.append("TBLPROPERTIES ('comment'='").append(tableComment).append("');");
    mssqlDDL.append(";");
    return mssqlDDL.toString();
}

測試程式碼

public static void main(String[] args) throws ClientException {
    final DataWorksOpenApiConnParam connParam = new DataWorksOpenApiConnParam();
    connParam.setAliyunAccessId("您的阿里雲賬號accessId");
    connParam.setAliyunAccessKey("您的阿里雲賬號accessKey");
    // dataworks所在區域
    connParam.setRegion("cn-chengdu");
    // dataworks所屬專案
    connParam.setProject("dataworks所屬專案");
    // dataworks所屬專案環境 如果不分環境的話設定為生產即可
    connParam.setProjectEnv("dev");
    // 資料引擎型別 odps
    connParam.setDatasourceType("odps");
    // ddataworks介面地址
    connParam.setEndPoint("dataworks.cn-chengdu.aliyuncs.com");
    final DataWorksOpenApiUtil dataWorksOpenApiUtil = new DataWorksOpenApiUtil(connParam, true);

    // 拉取所有ODPS指令碼
    dataWorksOpenApiUtil.listAllFiles(100, "", "", "10", files -> {
        // 處理檔案
        for (ListFilesResponse.Data.File file : files) {
            final String fileName = file.getFileName();
            System.out.println(fileName);
        }
    });

    // 拉取所有表的建表語句
    dataWorksOpenApiUtil.listAllDdl((tableName, tableDdlContent) -> {
        System.out.println("=======================================");
        System.out.println("表名：" + tableName + "內容如下：n");
        System.out.println(tableDdlContent);
        System.out.println("=======================================");
    });
}

測試結果

test_001指令碼
test_002指令碼
test_003指令碼
test_004指令碼
test_005指令碼
=======================================
表名：test_abc_info內容如下：

CREATE TABLE IF NOT EXISTS test_abc_info
(
test_abc1       STRING COMMENT '欄位1',
test_abc2       STRING COMMENT '欄位2',
test_abc3       STRING COMMENT '欄位3',
test_abc4       STRING COMMENT '欄位4',
test_abc5       STRING COMMENT '欄位5',
test_abc6       STRING COMMENT '欄位6',
test_abc7       STRING COMMENT '欄位7',
test_abc8       STRING COMMENT '欄位8'
)
PARTITIONED BY (p_date STRING COMMENT '資料日期'
)
;
=======================================
Disconnected from the target VM, address: '127.0.0.1:59509', transport: 'socket'