Java微信公眾號推送模版訊息的方法示例

TechSynapse發表於2024-08-12
Java

要在Java中向微信公眾號推送模板訊息，首先需要確保我們已經有了微信公眾號，並且已經設定了模板訊息許可權和模板ID。模板訊息是一種向使用者傳送通知的服務，廣泛用於訂單狀態更新、服務提醒等場景。

下面，我將詳細介紹如何使用Java結合微信官方提供的API來實現模板訊息的推送。這通常涉及幾個步驟：獲取access_token、組裝模板訊息資料、傳送請求。

第一步：準備工作

  1. 微信公眾號配置：確保我們的公眾號已經開通模板訊息功能，並建立了相應的模板。

  2. 引入依賴：我們可能需要使用HTTP客戶端庫，如Apache HttpClient或OkHttp。這裡我們使用Apache HttpClient。

    在我們的pom.xml中新增依賴（如果使用Maven）：

    <dependency>  
    <groupId>org.apache.httpcomponents</groupId>  
    <artifactId>httpclient</artifactId>  
    <version>4.5.13</version>  
</dependency>

第二步：獲取Access Token

微信公眾號API的呼叫大多需要Access Token，這是一個臨時票據，用於呼叫介面的身份驗證。

import org.apache.http.client.methods.HttpGet;  
import org.apache.http.impl.client.CloseableHttpClient;  
import org.apache.http.impl.client.HttpClients;  
import org.apache.http.util.EntityUtils;  
  
public class WeChatUtil {  
  
    private static final String APP_ID = "我們的AppID";  
    private static final String APP_SECRET = "我們的AppSecret";  
    private static final String TOKEN_URL = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid={}&secret={}";  
  
    public static String getAccessToken() throws Exception {  
        String url = TOKEN_URL.replace("{}", APP_ID).replace("{}", APP_SECRET);  
        HttpGet request = new HttpGet(url);  
        CloseableHttpClient httpClient = HttpClients.createDefault();  
        String result = httpClient.execute(request, httpResponse ->  
                EntityUtils.toString(httpResponse.getEntity()));  
        // 解析JSON獲取access_token，這裡假設已經透過某種方式（如Jackson, Gson）解析  
        // 這裡簡單用String.split()模擬解析  
        String[] parts = result.split(",");  
        for (String part : parts) {  
            if (part.contains("access_token")) {  
                String[] tokenParts = part.split(":");  
                return tokenParts[1].trim().replace("\"", "");  
            }  
        }  
        return null;  
    }  
}

第三步：傳送模板訊息

import org.apache.http.client.methods.HttpPost;  
import org.apache.http.entity.StringEntity;  
import org.apache.http.message.BasicHeader;  
import org.apache.http.util.EntityUtils;  
  
public class TemplateMessageSender {  
  
    public static void sendTemplateMessage(String accessToken, String toUserOpenId, String templateId, String url, Map<String, TemplateData> data) throws Exception {  
        String json = "{\"touser\":\"" + toUserOpenId + "\",\"template_id\":\"" + templateId + "\",\"url\":\"" + url + "\",\"data\":{";  
        for (Map.Entry<String, TemplateData> entry : data.entrySet()) {  
            json += "\"" + entry.getKey() + "\":{\"value\":\"" + entry.getValue().getValue() + "\",\"color\":\"" + entry.getValue().getColor() + "\"},";  
        }  
        if (!json.endsWith(",")) {  
            json = json.substring(0, json.length() - 1);  
        }  
        json += "}}";  
  
        String messageUrl = "https://api.weixin.qq.com/cgi-bin/message/template/send?access_token=" + accessToken;  
        HttpPost request = new HttpPost(messageUrl);  
        request.setHeader(new BasicHeader("Content-Type", "application/json; charset=UTF-8"));  
        request.setEntity(new StringEntity(json, "UTF-8"));  
  
        CloseableHttpClient httpClient = HttpClients.createDefault();  
        String result = httpClient.execute(request, httpResponse ->  
                EntityUtils.toString(httpResponse.getEntity()));  
        System.out.println("傳送結果: " + result);  
    }  
  
    static class TemplateData {  
        private String value;  
        private String color;  
  
        // 構造器、getter和setter省略  
    }  
}

第四步：呼叫傳送模板訊息的方法

在完成了WeChatUtil類用於獲取access_token和TemplateMessageSender類用於傳送模板訊息後，我們需要在我們的應用邏輯中呼叫這些方法。以下是一個示例，展示如何整合這些步驟來傳送模板訊息。

首先，確保我們有一個包含模板訊息資料的Map，其中鍵是模板中定義的欄位名，值是TemplateData物件（包含具體的值和可選的顏色）。

import java.util.HashMap;  
import java.util.Map;  
  
public class WeChatTemplateMessageExample {  
  
    public static void main(String[] args) {  
        try {  
            // 獲取access_token  
            String accessToken = WeChatUtil.getAccessToken();  
            if (accessToken == null) {  
                System.out.println("獲取access_token失敗");  
                return;  
            }  
  
            // 準備模板訊息資料  
            Map<String, TemplateMessageSender.TemplateData> data = new HashMap<>();  
            data.put("first", new TemplateMessageSender.TemplateData("這是第一條訊息", "#173177"));  
            data.put("keyword1", new TemplateMessageSender.TemplateData("這是關鍵詞1的內容", "#173177"));  
            data.put("keyword2", new TemplateMessageSender.TemplateData("這是關鍵詞2的內容", "#173177"));  
            data.put("remark", new TemplateMessageSender.TemplateData("這是備註資訊", "#173177"));  
  
            // 傳送模板訊息  
            String toUserOpenId = "使用者的OpenID";  
            String templateId = "我們的模板ID";  
            String url = "點選後跳轉的連結";  
            TemplateMessageSender.sendTemplateMessage(accessToken, toUserOpenId, templateId, url, data);  
  
            System.out.println("模板訊息傳送成功");  
        } catch (Exception e) {  
            e.printStackTrace();  
            System.out.println("傳送模板訊息失敗：" + e.getMessage());  
        }  
    }  
}

注意事項

  1. 安全性：在實際應用中，應避免將APP_ID和APP_SECRET硬編碼在程式碼中，可以透過配置檔案或環境變數等方式來管理。
  2. 錯誤處理：上述示例中的錯誤處理非常簡單，僅列印了堆疊跟蹤和錯誤訊息。在生產環境中，我們可能需要更復雜的錯誤處理邏輯，比如重試機制、日誌記錄等。
  3. HTTP客戶端：示例中使用了Apache HttpClient，但我們也可以選擇其他HTTP客戶端庫，如OkHttp、Retrofit等。
  4. JSON解析：示例中使用了簡單的字串操作來模擬JSON解析，但在實際開發中，我們應該使用專門的JSON庫（如Jackson、Gson）來解析和構建JSON資料。
  5. 模板ID和OpenID：確保模板ID和使用者的OpenID是正確的，並且模板ID與我們要傳送的資料欄位相匹配。
  6. API限制：微信對API呼叫有頻率限制，請確保我們的應用不會超出這些限制。

透過上述步驟，我們應該能夠在Java中成功地向微信公眾號傳送模板訊息。

相關文章