API 网关 Java（应用认证）-操作指南-文档中心-腾讯云

操作场景
该任务指导您使用 Java 语言，通过应用认证来对您的 API 进行认证管理。
操作步骤
1. 在 API 网关控制台，创建一个 API，选择鉴权类型为“应用认证”（参见 创建 API 概述）。
2. 将 API 所在服务发布至发布环境（参见 服务发布与下线）。
3. 在控制台 应用管理 界面创建应用。
4. 在应用列表中选中已经创建好的应用，单击绑定 API，选择服务和 API 后单击提交，即可将应用与 API 建立绑定关系。
5. 参见 示例代码，使用 Java 语言生成签名内容。
环境依赖
API 网关提供 JSON 请求方式和 form 请求方式的示例代码，请您根据自己业务的实际情况合理选择。
应用认证 Java Demo 中需要引入外部依赖，具体引入的依赖如下：
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.13</version>
</dependency>
<dependency>
    <groupId>commons-codec</groupId>
    <artifactId>commons-codec</artifactId>
    <version>1.11</version>
</dependency>
注意事项
应用生命周期管理，以及 API 向应用授权、应用绑定 API 等操作请您参见 应用管理。
应用生成签名过程请您参见 应用认证方式。
示例代码
注意：
以下 httpMethod = "GET"、acceptHeader = "application/json"、contentType = "application/json"均为示例，charset 按默认英文字符为例。其他httpMethod、charset类型请以实际请求为准。
JSON 请求方式示例代码
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.*;

public class AppAuthJavaDemo {
    private static final String MAC_NAME = "HmacSHA1";
    private static final String ENCODING = "UTF-8";
    private static final String HTTP_METHOD_GET = "GET";
    private static final String HTTP_METHOD_POST = "POST";

    private static String getGMTTime() {
        Calendar cd = Calendar.getInstance();
        SimpleDateFormat sdf = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss 'GMT'", Locale.US);
        sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
        String GMTTime = sdf.format(cd.getTime());
        return GMTTime;
    }

    private static String sortQueryParams(String queryParam) {
        // parameters should be in alphabetical order
        if (queryParam == null || queryParam == "") {
            return "";
        }

        String[] queryParams = queryParam.split("&");
        Map<String, String> queryPairs = new TreeMap<>();
        for (String query : queryParams) {
            String[] kv = query.split("=");
            queryPairs.put(kv[0], kv[1]);
        }

        StringBuilder sortedParamsBuilder = new StringBuilder();
        Iterator iter = queryPairs.entrySet().iterator();
        while (iter.hasNext()) {
            Map.Entry entry = (Map.Entry) iter.next();
            sortedParamsBuilder.append(entry.getKey());
            sortedParamsBuilder.append("=");
            sortedParamsBuilder.append(entry.getValue());
            sortedParamsBuilder.append("&");
        }
        String sortedParams = sortedParamsBuilder.toString();
        sortedParams = sortedParams.substring(0, sortedParams.length() - 1);

        return sortedParams;
    }

    private static byte[] HmacSHA1Encrypt(String encryptText, String encryptKey) throws Exception {
        byte[] data = encryptKey.getBytes(ENCODING);
        SecretKey secretKey = new SecretKeySpec(data, MAC_NAME);
        Mac mac = Mac.getInstance(MAC_NAME);
        mac.init(secretKey);

        byte[] text = encryptText.getBytes(ENCODING);
        return mac.doFinal(text);
    }

    private static String base64Encode(byte[] key) {
        final Base64.Encoder encoder = Base64.getEncoder();
        return encoder.encodeToString(key);
    }

    private static String getMD5(String str) {
        String md5Hex = DigestUtils.md5Hex(str);
        return md5Hex;
    }

    public static void main(String[] args) throws Exception {
        String environment = "";
        // Url中包含Schema，域名,路径及Query参数，不能包含80或443端口
        // 错误的Url: http://service-xxxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com:80/appParam?name=clare&password=333
        // 正确的Url: http://service-xxxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com/appParam?name=clare&password=333
        String url = "http://service-xxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com/appParam?name=clare&password=333";

        // Host中只包含域名，不能包含Schema和路径及Query参数
        // 错误的Host: "http://service-xxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com/appParam?name=clare&password=333"
        // 正确的Host: "service-xxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com"
        String host = "service-xxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com";
        String apiAppKey = "APIDoMSRiefxxxxxxxxxxxxGz6AEEaFB";
        String apiAppSecret = "I0IDUmr6xxxxxxxxxxxxxx3C5GUsN2Rjvp";

        String httpMethod = "GET";
        String acceptHeader = "application/json";
        String contentType = "application/json";
        String reqBody = "{\\"current\\":1,\\"size\\":10,\\"businessType\\":\\"4\\"}";
        String contentMD5 = base64Encode(getMD5(reqBody).getBytes());
        if (httpMethod.equalsIgnoreCase(HTTP_METHOD_GET)) {
            reqBody = "";
        }
        // ContentType and contentMd5 should be empty if request body is not present
        if (reqBody.length() == 0) {
            contentType = "";
            contentMD5 = "";
            reqBody = "";
        }


        // Parse URL and assemble string to sign
        URL parsedUrl = new URL(url);
        String pathAndParams = parsedUrl.getPath();
        if (environment != "") {
            pathAndParams = pathAndParams.substring(pathAndParams.indexOf(environment) + environment.length());
        }


        if (parsedUrl.getQuery() != null) {
            pathAndParams = pathAndParams + "?" + sortQueryParams(parsedUrl.getQuery());
        }


        System.out.println("pathAndParams:" + pathAndParams);


        String xDate = getGMTTime();
        String stringToSign = String.format("x-date: %s\\n%s\\n%s\\n%s\\n%s\\n%s", xDate, httpMethod, acceptHeader, contentType, contentMD5, pathAndParams);
        // Encode string with HMAC and base64
        byte[] hmacStr = HmacSHA1Encrypt(stringToSign, apiAppSecret);
        String signature = base64Encode(hmacStr);
        String authHeader = String.format("hmac id=\\"%s\\", algorithm=\\"hmac-sha1\\", headers=\\"x-date\\", signature=\\"%s\\"", apiAppKey, signature);


        System.out.println(stringToSign);
        // Generate request
        CloseableHttpClient httpClient = HttpClients.createDefault();
        CloseableHttpResponse response = null;
        // Send request
        if (httpMethod.equalsIgnoreCase(HTTP_METHOD_GET)) {
            HttpGet httpGet = new HttpGet(url);
            httpGet.setHeader("Accept", acceptHeader);
            httpGet.setHeader("Host", host);
            httpGet.setHeader("Content-Type", contentType);
            httpGet.setHeader("x-date", xDate);
            httpGet.setHeader("Authorization", authHeader);
            response = httpClient.execute(httpGet);
        }


        if (httpMethod.equalsIgnoreCase(HTTP_METHOD_POST)) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Accept", acceptHeader);
            httpPost.setHeader("Host", host);
            httpPost.setHeader("x-date", xDate);
            httpPost.setHeader("Content-Type", contentType);
            httpPost.setHeader("Content-MD5", contentMD5);
            httpPost.setHeader("Authorization", authHeader);
            StringEntity stringEntity = new StringEntity(reqBody, ENCODING);
            httpPost.setEntity(stringEntity);
            response = httpClient.execute(httpPost);
        }


        // Receive response
        HttpEntity responseEntity = response.getEntity();
        if (responseEntity != null) {
            System.out.println("Response status code: " + response.getStatusLine());
            System.out.println("Response body: " + EntityUtils.toString(responseEntity));
        }
    }
}
form 请求方式示例代码
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
﻿
import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.*;
﻿
public class AppAuthJavaFormDemo {
    private static final String MAC_NAME = "HmacSHA1";
    private static final String ENCODING = "UTF-8";
    private static final String HTTP_METHOD_GET = "GET";
    private static final String HTTP_METHOD_POST = "POST";
﻿
    private static String getGMTTime(){
        Calendar cd = Calendar.getInstance();
        SimpleDateFormat sdf = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss 'GMT'", Locale.US);
        sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
        String GMTTime = sdf.format(cd.getTime());
        return GMTTime;
    }
﻿
    private static String sortQueryParams(String queryParam){
        // parameters should be in alphabetical order
        if (queryParam == null || queryParam == ""){
            return "";
        }
﻿
        String[] queryParams = queryParam.split("&");
        Map<String, String> queryPairs = new TreeMap<>();
        for(String query: queryParams){
            String[] kv = query.split("=");
            queryPairs.put(kv[0], kv[1]);
        }
﻿
        StringBuilder sortedParamsBuilder = new StringBuilder();
        Iterator iter = queryPairs.entrySet().iterator();
        while(iter.hasNext()){
            Map.Entry entry = (Map.Entry) iter.next();
            sortedParamsBuilder.append(entry.getKey());
            sortedParamsBuilder.append("=");
            sortedParamsBuilder.append(entry.getValue());
            sortedParamsBuilder.append("&");
        }
        String sortedParams = sortedParamsBuilder.toString();
        sortedParams = sortedParams.substring(0, sortedParams.length() - 1);
﻿
        return sortedParams;
    }
﻿
    private static byte[] HmacSHA1Encrypt(String encryptText, String encryptKey) throws Exception {
        byte[] data = encryptKey.getBytes(ENCODING);
        SecretKey secretKey = new SecretKeySpec(data, MAC_NAME);
        Mac mac = Mac.getInstance(MAC_NAME);
        mac.init(secretKey);
﻿
        byte[] text = encryptText.getBytes(ENCODING);
        return mac.doFinal(text);
    }
﻿
    private static String base64Encode(byte[] key) {
        final Base64.Encoder encoder = Base64.getEncoder();
        return encoder.encodeToString(key);
    }
﻿
﻿
    public static void main(String[] args) throws Exception {
        String environment = "";
        String url = "http://service-xxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com/appParam?name=clare&password=333";
        String host = "service-xxxxxxx-xxxxxxxxxx.cq.apigw.tencentcs.com";
        String apiAppKey = "APIDoMSRiefxxxxxxxxxxxxGz6AEEaFB";
        String apiAppSecret = "I0IDUmr6xxxxxxxxxxxxxx3C5GUsN2Rjvp";
        String httpMethod = "POST";
        String acceptHeader = "application/json";
﻿
        String reqBody = "";
        String contentType = "application/x-www-form-urlencoded";
        String contentMD5 = "";
﻿
        if (httpMethod.toUpperCase() == HTTP_METHOD_POST) {
            // Parse form data and assemble request body
            Map<String, String> reqBodyMap = new TreeMap<>();
            reqBodyMap.put("type", "fruit");
            reqBodyMap.put("fruitname", "apple");
﻿
            StringBuffer reqBodyBuffer = new StringBuffer();
            for (Map.Entry<String, String> e : reqBodyMap.entrySet()) {
                reqBodyBuffer.append(e.getKey());
                reqBodyBuffer.append("=");
                reqBodyBuffer.append(e.getValue());
                reqBodyBuffer.append("&");
            }
            reqBody = reqBodyBuffer.toString();
            reqBody = reqBody.substring(0, reqBody.length() - 1);
        }
﻿
        // ContentType should be empty if request body is not present
        if (reqBody.length() == 0) {
            contentType = "";
            reqBody = "";
        }      
﻿
        // Parse URL and assemble string to sign
        URL parsedUrl = new URL(url);
        String pathAndParams = parsedUrl.getPath();
        if (environment != ""){
            pathAndParams = pathAndParams.substring(pathAndParams.indexOf(environment) + environment.length());
        }
﻿
        String queryParams = "";
        if (parsedUrl.getQuery() != null) {
            queryParams = parsedUrl.getQuery();
        }
        if (reqBody != "" && reqBody.length() > 0){
            if(queryParams.length() > 0){
                queryParams = queryParams + "&" + reqBody;
            } else {
                queryParams = reqBody;
            }
        }
        if (queryParams != ""){
            pathAndParams = pathAndParams + "?" + sortQueryParams(queryParams);
        }
﻿
        String xDate = getGMTTime();
        String stringToSign = String.format("x-date: %s\\n%s\\n%s\\n%s\\n%s\\n%s", xDate, httpMethod, acceptHeader, contentType, contentMD5, pathAndParams);
        System.out.println("stringToSign:" + stringToSign);
﻿
        // Encode string with HMAC and base64
        byte[] hmacStr = HmacSHA1Encrypt(stringToSign, apiAppSecret);
        String signature = base64Encode(hmacStr);
        String authHeader = String.format("hmac id=\\"%s\\", algorithm=\\"hmac-sha1\\", headers=\\"x-date\\", signature=\\"%s\\"", apiAppKey, signature);
﻿
        // Generate request
        CloseableHttpClient httpClient = HttpClients.createDefault();
        CloseableHttpResponse response = null;
﻿
        // Send request
        if (httpMethod.toUpperCase() == HTTP_METHOD_GET) {
            HttpGet httpGet = new HttpGet(url);
            httpGet.setHeader("Accept", acceptHeader);
            httpGet.setHeader("Host", host);
            httpGet.setHeader("x-date", xDate);
            httpGet.setHeader("Authorization", authHeader);
            response = httpClient.execute(httpGet);
        }
﻿
        if (httpMethod.toUpperCase() == HTTP_METHOD_POST) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Accept", acceptHeader);
            httpPost.setHeader("Host", host);
            httpPost.setHeader("x-date", xDate);
            httpPost.setHeader("Content-Type", contentType);
            httpPost.setHeader("Content-MD5", contentMD5);
            httpPost.setHeader("Authorization", authHeader);
            StringEntity stringEntity = new StringEntity(reqBody, ENCODING);
            httpPost.setEntity(stringEntity);
            response = httpClient.execute(httpPost);
        }
﻿
        // Receive response
        HttpEntity responseEntity = response.getEntity();
﻿
        if (responseEntity != null) {
            System.out.println("Response status code: " + response.getStatusLine());
            System.out.println("Response body: " + EntityUtils.toString(responseEntity));
        }
    }
}
formdata 上传文件示例代码
package com.example.demo;
﻿
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
﻿
import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
import java.io.File;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.*;
﻿
public class AppAuthDemo {
﻿
    private static final String MAC_NAME = "HmacSHA1";
    private static final String ENCODING = "UTF-8";
    private static final String HTTP_METHOD_GET = "GET";
    private static final String HTTP_METHOD_POST = "POST";
﻿
    private static String getGMTTime(){
        Calendar cd = Calendar.getInstance();
        SimpleDateFormat sdf = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss 'GMT'", Locale.US);
        sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
        String GMTTime = sdf.format(cd.getTime());
        return GMTTime;
    }
﻿
    private static String sortQueryParams(String queryParam){
        // parameters should be in alphabetical order
        if (queryParam == null || queryParam == ""){
            return "";
        }
﻿
        String[] queryParams = queryParam.split("&");
        Map<String, String> queryPairs = new TreeMap<>();
        for(String query: queryParams){
            String[] kv = query.split("=");
            queryPairs.put(kv[0], kv[1]);
        }
﻿
        StringBuilder sortedParamsBuilder = new StringBuilder();
        Iterator iter = queryPairs.entrySet().iterator();
        while(iter.hasNext()){
            Map.Entry entry = (Map.Entry) iter.next();
            sortedParamsBuilder.append(entry.getKey());
            sortedParamsBuilder.append("=");
            sortedParamsBuilder.append(entry.getValue());
            sortedParamsBuilder.append("&");
        }
        String sortedParams = sortedParamsBuilder.toString();
        sortedParams = sortedParams.substring(0, sortedParams.length() - 1);
﻿
        return sortedParams;
    }
﻿
    private static byte[] HmacSHA1Encrypt(String encryptText, String encryptKey) throws Exception {
        byte[] data = encryptKey.getBytes(ENCODING);
        SecretKey secretKey = new SecretKeySpec(data, MAC_NAME);
        Mac mac = Mac.getInstance(MAC_NAME);
        mac.init(secretKey);
﻿
        byte[] text = encryptText.getBytes(ENCODING);
        return mac.doFinal(text);
    }
﻿
    private static String base64Encode(byte[] key) {
        final Base64.Encoder encoder = Base64.getEncoder();
        return encoder.encodeToString(key);
    }
﻿
﻿
﻿
    public static void main(String[] args) throws Exception {
        String environment = "";
        String url = "http://service-xxxx-xxxx.gz.apigw.tencentcs.com:80/";
        String host = "service-xxxx-xxxx.gz.apigw.tencentcs.com";
        String apiAppKey = "";
        String apiAppSecret = "";
        String httpMethod = "POST";
        String acceptHeader =     ContentType.APPLICATION_OCTET_STREAM.toString();
        String contentType =  ContentType.APPLICATION_OCTET_STREAM.toString();
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
        FileBody file = new FileBody(new File("demo.file"));
        builder.addPart("file", file);
        HttpEntity entity = builder.build();
        String contentMD5 = base64Encode(DigestUtils.md5Hex(entity.getContent()).getBytes());
﻿
        // Parse URL and assemble string to sign
        URL parsedUrl = new URL(url);
        String pathAndParams = parsedUrl.getPath();
        if (environment != ""){
            pathAndParams = pathAndParams.substring(pathAndParams.indexOf(environment) + environment.length());
        }
﻿
        if (parsedUrl.getQuery() != null) {
            pathAndParams = pathAndParams + "?" + sortQueryParams(parsedUrl.getQuery());
        }
﻿
        System.out.println("pathAndParams:"+ pathAndParams);
﻿
        String xDate = getGMTTime();
        String stringToSign = String.format("x-date: %s\\n%s\\n%s\\n%s\\n%s\\n%s", xDate, httpMethod, acceptHeader, contentType, contentMD5, pathAndParams);
        // Encode string with HMAC and base64
        byte[] hmacStr = HmacSHA1Encrypt(stringToSign, apiAppSecret);
        String signature = base64Encode(hmacStr);
        String authHeader = String.format("hmac id=\\"%s\\", algorithm=\\"hmac-sha1\\", headers=\\"x-date\\", signature=\\"%s\\"", apiAppKey, signature);
﻿
        System.out.println(stringToSign);
        // Generate request
        CloseableHttpClient httpClient = HttpClients.createDefault();
        CloseableHttpResponse response = null;
        if (httpMethod.toUpperCase() == HTTP_METHOD_POST) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Accept", acceptHeader);
            httpPost.setHeader("Host", host);
            httpPost.setHeader("x-date", xDate);
            httpPost.setHeader("Content-Type", contentType);
            httpPost.setHeader("Content-MD5", contentMD5);
            httpPost.setHeader("Authorization", authHeader);
            httpPost.setEntity(entity);
            response = httpClient.execute(httpPost);
        }
﻿
        // Receive response
        HttpEntity responseEntity = response.getEntity();
        if (responseEntity != null) {
            System.out.println("Response status code: " + response.getStatusLine());
            System.out.println("Response body: " + EntityUtils.toString(responseEntity));
        }
    }
﻿
}
﻿
Java（应用认证）

本页目录：

操作场景

操作步骤

环境依赖

注意事项

示例代码
