微信 JS-SDK 的圖片上傳看起來只是兩個 API 呼叫,但中間牽涉到簽名計算、jsapi_ticket 取得、media_id 保存期限等好幾個環節。本文以 Java 為例,把整個鏈路串起來。
官方文件:https://mp.weixin.qq.com/wiki? t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
任何 JS 介面在呼叫前,都必須先透過 wx.config 注入權限設定。這裡我沒有額外用 checkJsApi 去判斷用戶端是否支援指定介面,而是直接進入 config 流程。
<code class="hljs cs">wx.config({
debug: true, // 開啟調試模式,所有 api 的回傳值會在客戶端 alert 出來;
// 傳入參數則會在 PC 端透過 log 印出
appId: '', // 必填,公眾號的唯一標識
timestamp: , // 必填,產生簽名的時間戳
nonceStr: '',// 必填,產生簽名的隨機字串
signature: '',// 必填,簽名(見附錄1)
jsApiList: [] // 必填,需要使用的 JS 介面列表(見附錄2)
});</code>
簽名的演算法是把 jsapi_ticket、noncestr、timestamp、url 四個參數按字典序拼成字串,再做 SHA-1。注意 URL 必須是動態取得,不能寫死,而且要用「前端實際載入頁面時的 URL」(不含 # 及其後部分)。
<code class="hljs avrasm">import java.util.UUID;
import java.util.Map;
import java.util.HashMap;
import java.util.Formatter;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.io.UnsupportedEncodingException;
public class WxConfig {
public static void main(String[] args) {
String jsapi_ticket = "jsapi_ticket";
// 注意 URL 一定要動態獲取,不能 hardcode
String url = "https://example.com";
Map<String, String> ret = sign(jsapi_ticket, url);
for (Map.Entry entry : ret.entrySet()) {
System.out.println(entry.getKey() + ", " + entry.getValue());
}
}
public static Map<String, String> sign(String jsapi_ticket, String url) {
Map<String, String> ret = new HashMap<String, String>();
String nonce_str = create_nonce_str();
String timestamp = create_timestamp();
String string1;
String signature = "";
//注意這裡參數名必須全部小寫,且必須有序
string1 = "jsapi_ticket=" + jsapi_ticket + "&noncestr=" + nonce_str
+ "×tamp=" + timestamp + "&url=" + url;
System.out.println(string1);
try {
MessageDigest crypt = MessageDigest.getInstance("SHA-1");
crypt.reset();
crypt.update(string1.getBytes("UTF-8"));
signature = byteToHex(crypt.digest());
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
ret.put("url", url);
ret.put("jsapi_ticket", jsapi_ticket);
ret.put("nonceStr", nonce_str);
ret.put("timestamp", timestamp);
ret.put("signature", signature);
return ret;
}
private static String byteToHex(final byte[] hash) {
Formatter formatter = new Formatter();
for (byte b : hash) {
formatter.format("%02x", b);
}
String result = formatter.toString();
formatter.close();
return result;
}
private static String create_nonce_str() {
return UUID.randomUUID().toString();
}
private static String create_timestamp() {
return Long.toString(System.currentTimeMillis() / 1000);
}
}</string,></string,></string,></string,></code>
三個關鍵要求:參數名全部小寫、參數按字典序排列、拼出的字串再做 SHA-1。任何一項出錯,簽名就會對不上,而微信只會回「config 失敗」,不會告訴你哪裡錯。
ticket 需要用 access_token 去換:
<code class="hljs cs">public static String getTicket(String accessToken) throws ParseException, IOException {
public final static String sign_ticket_create_url =
"https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi";
JSONObject jsonObject = new JSONObject();
JSONObject postjson = new JSONObject();
String ticket = null;
String url = sign_ticket_create_url.replace("ACCESS_TOKEN", accessToken);
System.out.print("url=" + url);
try {
jsonObject = WeixinUtil.httpsRequest(url, "POST", postjson.toString());
ticket = jsonObject.getString("ticket");
System.out.println("ticket:" + ticket);
} catch (Exception e) {
e.printStackTrace();
}
return ticket;
};</code>
這裡的 type=jsapi 參數不能漏,否則拿到的是其他類型的 ticket,簽名一樣會失敗。另外,jsapi_ticket 也需要快取——它和 access_token 一樣有呼叫次數配額,每次都重新請求很快就會被限流。
權限驗證成功後會進入 ready 回呼,後續操作都寫在這裡。這個範例只用到 chooseImage(拍照或從相冊選圖)與 uploadImage(上傳圖片),所以 jsApiList 也只列這兩個。
<code class="hljs javascript">wx.ready(function(){
//拍照或從手機相冊中選圖介面
wx.chooseImage({
count: 1, //最多能選擇幾張,預設 9
sizeType: ['original', 'compressed'], //可指定原圖或壓縮圖,預設兩者都有
sourceType: ['album', 'camera'], //可指定來源是相冊還是相機,預設兩者都有
success: function (res) {
var localIds = res.localIds;
//回傳選定照片的本地 ID 清單,localId 可作為 img 標籤的 src 顯示圖片
//上傳圖片介面
wx.uploadImage({
localId: localIds.toString(), //由 chooseImage 獲得的本地 ID
isShowProgressTips: 1, //預設為 1,顯示進度提示
success: function (res) {
var serverId = res.serverId; //回傳圖片的伺服器端 ID
}
});
}
});
});</code>
走到這一步,圖片已經在微信伺服器上了。但這些圖片只會保存 3 天,所以必須在 serverId 拿到後儘快轉存到自己這邊。這裡用到多媒體下載介面:
https://file.api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
其中 media_id 就是前面拿到的 serverId。
<code class="hljs java">import org.apache.log4j.Level;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
import org.apache.log4j.Priority;
import org.springframework.util.StringUtils;
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
public class DloadImgUtil {
/**
* 根據內容類型判斷檔案副檔名
* @param contentType 內容類型
* @return 副檔名
*/
public static String getFileexpandedName(String contentType) {
String fileEndWitsh = "";
if ("image/jpeg".equals(contentType)) fileEndWitsh = ".jpg";
else if ("audio/mpeg".equals(contentType)) fileEndWitsh = ".mp3";
else if ("audio/amr".equals(contentType)) fileEndWitsh = ".amr";
else if ("video/mp4".equals(contentType)) fileEndWitsh = ".mp4";
else if ("video/mpeg4".equals(contentType)) fileEndWitsh = ".mp4";
return fileEndWitsh;
}
/**
* 獲取媒體檔案
* @param accessToken 介面訪問憑證
* @param mediaId 媒體檔案 id
* @param savePath 檔案在本機伺服器上的儲存路徑
*/
public static String downloadMedia(String accessToken, String mediaId, String savePath) {
try {
accessToken = WeixinUtil.getAccessToken1().getToken();
} catch (IOException e) {
e.printStackTrace();
}
String filePath = null;
// 拼接請求位址
String requestUrl = "https://file.api.weixin.qq.com/cgi-bin/media/get"
+ "?access_token=ACCESS_TOKEN&media_id=MEDIA_ID";
requestUrl = requestUrl.replace("ACCESS_TOKEN", accessToken)
.replace("MEDIA_ID", mediaId);
try {
URL url = new URL(requestUrl);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setDoInput(true);
conn.setRequestMethod("GET");
if (!savePath.endsWith("/")) {
savePath += "/";
}
// 根據內容類型取得副檔名
String fileExt = DloadImgUtil.getFileexpandedName(conn.getHeaderField("Content-Type"));
// 以 mediaId 作為檔案名稱
filePath = savePath + mediaId + fileExt;
BufferedInputStream bis = new BufferedInputStream(conn.getInputStream());
FileOutputStream fos = new FileOutputStream(new File(filePath));
byte[] buf = new byte[8096];
int size = 0;
while ((size = bis.read(buf)) != -1) fos.write(buf, 0, size);
fos.close();
bis.close();
conn.disconnect();
String info = String.format("下載媒體檔案成功,filePath=" + filePath);
System.out.println(info);
} catch (Exception e) {
filePath = null;
String error = String.format("下載媒體檔案失敗:%s", e);
System.out.println(error);
}
return filePath;
}
}</code>
用 Content-Type 判斷副檔名是個不錯的習慣——微信回傳的 header 裡會標明實際的媒體類型,比自己猜檔名格式可靠。以 mediaId 作為檔名則保證了唯一性,不必另外產生。
整體串起來是:access_token → jsapi_ticket → 計算簽名 → wx.config → chooseImage → uploadImage → 取得 serverId → 後端下載存檔。
debug 關掉,並在 wx.error 中統一記錄錯誤。