導入jar包
首先是 菜單項的基類,所有一級菜單、二級菜單都共有一個相同的屬性,那就是name。菜單項基類的封裝代碼如下:
package com.souvc.weixin.menu; /** * 類名: Button </br> * 包名: com.souvc.weixin.menu * 描述: 菜單項的基類 </br> * 開發人員: souvc </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class Button { private String name;//所有一級菜單、二級菜單都共有一個相同的屬性,那就是name public String getName() { return name; } public void setName(String name) { this.name = name; } }
接着是子菜單項的封裝。這裏對子菜單是這樣定義的:沒有子菜單的菜單項,有可能是二級菜單項,也有可能是不含二級菜單的一級菜單。這類子菜單項一定會包含三個屬性:type、name和key,封裝的代碼如下:
package com.souvc.weixin.menu; /** * 類名: CommonButton </br> * 包名: com.souvc.weixin.menu * 描述: 子菜單項 :沒有子菜單的菜單項,有可能是二級菜單項,也有可能是不含二級菜單的一級菜單。 </br> * 開發人員: souvc </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class CommonButton extends Button { private String type; private String key; public String getType() { return type; } public void setType(String type) { this.type = type; } public String getKey() { return key; } public void setKey(String key) { this.key = key; } }
再往下是父菜單項的封裝。對父菜單項的定義:包含有二級菜單項的一級菜單。這類菜單項包含有二個屬性:name和sub_button,而sub_button以是一個子菜單項數組。父菜單項的封裝代碼如下:
package com.souvc.weixin.menu; /** * 類名: ComplexButton </br> * 包名: com.souvc.weixin.menu * 描述: 父菜單項 :包含有二級菜單項的一級菜單。這類菜單項包含有二個屬性:name和sub_button,而sub_button以是一個子菜單項數組 </br> * 開發人員: souvc </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class ComplexButton extends Button { private Button[] sub_button; public Button[] getSub_button() { return sub_button; } public void setSub_button(Button[] sub_button) { this.sub_button = sub_button; } }
最後是整個菜單對象的封裝,菜單對象包含多個菜單項(最多隻能有3個),這些菜單項即可以是子菜單項(不含二級菜單的一級菜單),也可以是父菜單項(包含二級菜單的菜單項),如果能明白上面所講的,再來看封裝後的代碼就很容易理解了:
package com.souvc.weixin.menu; /** * 類名: Menu </br> * 包名: com.souvc.weixin.menu * 描述: 整個菜單對象的封裝 </br> * 開發人員:souvc </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class Menu { private Button[] button; public Button[] getButton() { return button; } public void setButton(Button[] button) { this.button = button; } }
關於菜單的POJO類的封裝就介紹完了。
AccessToken 的POJO的封裝:
package com.souvc.weixin.pojo; /** * 類名: AccessToken </br> * 包名: com.souvc.weixin.pojo * 描述: 微信通用接口憑證 </br> * 開發人員:souvc </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class AccessToken { // 獲取到的憑證 private String token; // 憑證有效時間,單位:秒 private int expiresIn; public String getToken() { return token; } public void setToken(String token) { this.token = token; } public int getExpiresIn() { return expiresIn; } public void setExpiresIn(int expiresIn) { this.expiresIn = expiresIn; } }
封裝通用的請求方法
讀到這裏,就默認大家已經掌握了上面講到的所有關於自定義菜單的理論知識,下面就進入代碼實戰講解的部分。
先前我們瞭解到,創建菜單需要調用二個接口,並且都是https請求,而非http。如果要封裝一個通用的請求方法,該方法至少需要具備以下能力:
1)支持HTTPS請求;
2)支持GET、POST兩種方式;
3)支持參數提交,也支持無參數的情況;
對於https請求,我們需要一個證書信任管理器,這個管理器類需要自己定義,但需要實現X509TrustManager接口,代碼如下:
package com.souvc.weixin.util; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import javax.net.ssl.X509TrustManager; /** * 類名: MyX509TrustManager </br> * 包名: com.souvc.weixin.util * 描述: 證書信任管理器(用於https請求) </br> * 開發人員:souvc </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class MyX509TrustManager implements X509TrustManager { public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { } public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { } public X509Certificate[] getAcceptedIssuers() { return null; } }
這個證書管理器的作用就是讓它信任我們指定的證書,上面的代碼意味着信任所有證書,不管是否權威機構頒發。
證書有了,通用的https請求方法就不難實現了,實現代碼如下:
package com.souvc.weixin.util; import java.io.BufferedReader; import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStream; import java.net.ConnectException; import java.net.URL; import javax.net.ssl.HttpsURLConnection; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSocketFactory; import javax.net.ssl.TrustManager; import net.sf.json.JSONException; import net.sf.json.JSONObject; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.souvc.weixin.menu.Menu; import com.souvc.weixin.pojo.AccessToken; /** * 類名: WeixinUtil </br> * 包名: com.souvc.weixin.util * 描述: 公衆平臺通用接口工具類 </br> * 開發人員: souvc </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class WeixinUtil { private static Logger log = LoggerFactory.getLogger(WeixinUtil.class); // 獲取access_token的接口地址(GET) 限200(次/天) public final static String access_token_url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET"; // 菜單創建(POST) 限100(次/天) public static String menu_create_url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN"; /** * 創建菜單 * * @param menu 菜單實例 * @param accessToken 有效的access_token * @return 0表示成功,其他值表示失敗 */ public static int createMenu(Menu menu, String accessToken) { int result = 0; // 拼裝創建菜單的url String url = menu_create_url.replace("ACCESS_TOKEN", accessToken); // 將菜單對象轉換成json字符串 String jsonMenu = JSONObject.fromObject(menu).toString(); // 調用接口創建菜單 JSONObject jsonObject = httpRequest(url, "POST", jsonMenu); if (null != jsonObject) { if (0 != jsonObject.getInt("errcode")) { result = jsonObject.getInt("errcode"); log.error("創建菜單失敗 errcode:{} errmsg:{}", jsonObject.getInt("errcode"), jsonObject.getString("errmsg")); } } return result; } /** * 獲取access_token * * @param appid 憑證 * @param appsecret 密鑰 * @return */ public static AccessToken getAccessToken(String appid, String appsecret) { AccessToken accessToken = null; String requestUrl = access_token_url.replace("APPID", appid).replace("APPSECRET", appsecret); JSONObject jsonObject = httpRequest(requestUrl, "GET", null); // 如果請求成功 if (null != jsonObject) { try { accessToken = new AccessToken(); accessToken.setToken(jsonObject.getString("access_token")); accessToken.setExpiresIn(jsonObject.getInt("expires_in")); } catch (JSONException e) { accessToken = null; // 獲取token失敗 log.error("獲取token失敗 errcode:{} errmsg:{}", jsonObject.getInt("errcode"), jsonObject.getString("errmsg")); } } return accessToken; } /** * 描述: 發起https請求並獲取結果 * @param requestUrl 請求地址 * @param requestMethod 請求方式(GET、POST) * @param outputStr 提交的數據 * @return JSONObject(通過JSONObject.get(key)的方式獲取json對象的屬性值) */ public static JSONObject httpRequest(String requestUrl, String requestMethod, String outputStr) { JSONObject jsonObject = null; StringBuffer buffer = new StringBuffer(); try { // 創建SSLContext對象,並使用我們指定的信任管理器初始化 TrustManager[] tm = { new MyX509TrustManager() }; SSLContext sslContext = SSLContext.getInstance("SSL", "SunJSSE"); sslContext.init(null, tm, new java.security.SecureRandom()); // 從上述SSLContext對象中得到SSLSocketFactory對象 SSLSocketFactory ssf = sslContext.getSocketFactory(); URL url = new URL(requestUrl); HttpsURLConnection httpUrlConn = (HttpsURLConnection) url.openConnection(); httpUrlConn.setSSLSocketFactory(ssf); httpUrlConn.setDoOutput(true); httpUrlConn.setDoInput(true); httpUrlConn.setUseCaches(false); // 設置請求方式(GET/POST) httpUrlConn.setRequestMethod(requestMethod); if ("GET".equalsIgnoreCase(requestMethod)) httpUrlConn.connect(); // 當有數據需要提交時 if (null != outputStr) { OutputStream outputStream = httpUrlConn.getOutputStream(); // 注意編碼格式,防止中文亂碼 outputStream.write(outputStr.getBytes("UTF-8")); outputStream.close(); } // 將返回的輸入流轉換成字符串 InputStream inputStream = httpUrlConn.getInputStream(); InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "utf-8"); BufferedReader bufferedReader = new BufferedReader(inputStreamReader); String str = null; while ((str = bufferedReader.readLine()) != null) { buffer.append(str); } bufferedReader.close(); inputStreamReader.close(); // 釋放資源 inputStream.close(); inputStream = null; httpUrlConn.disconnect(); jsonObject = JSONObject.fromObject(buffer.toString()); } catch (ConnectException ce) { log.error("Weixin server connection timed out."); } catch (Exception e) { log.error("https request error:{}", e); } return jsonObject; } }
添加菜單管理器:
添加菜單管理器:
package com.souvc.weixin.main; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.souvc.weixin.menu.Button; import com.souvc.weixin.menu.CommonButton; import com.souvc.weixin.menu.ComplexButton; import com.souvc.weixin.menu.Menu; import com.souvc.weixin.pojo.AccessToken; import com.souvc.weixin.util.WeixinUtil; /** * 類名: MenuManager </br> * 包名: com.souvc.weixin.main * 描述:菜單管理器類 </br> * 開發人員: liuhf </br> * 創建時間: 2015-12-1 </br> * 發佈版本:V1.0 </br> */ public class MenuManager { private static Logger log = LoggerFactory.getLogger(MenuManager.class); public static void main(String[] args) { // 第三方用戶唯一憑證 String appId = "000000000000000000"; // 第三方用戶唯一憑證密鑰 String appSecret = "00000000000000000000000000000000"; // 調用接口獲取access_token AccessToken at = WeixinUtil.getAccessToken(appId, appSecret); if (null != at) { // 調用接口創建菜單 int result = WeixinUtil.createMenu(getMenu(), at.getToken()); // 判斷菜單創建結果 if (0 == result) log.info("菜單創建成功!"); else log.info("菜單創建失敗,錯誤碼:" + result); } } /** * 組裝菜單數據 * * @return */ private static Menu getMenu() { CommonButton btn11 = new CommonButton(); btn11.setName("天氣預報"); btn11.setType("click"); btn11.setKey("11"); CommonButton btn12 = new CommonButton(); btn12.setName("公交查詢"); btn12.setType("click"); btn12.setKey("12"); CommonButton btn13 = new CommonButton(); btn13.setName("周邊搜索"); btn13.setType("click"); btn13.setKey("13"); CommonButton btn14 = new CommonButton(); btn14.setName("歷史上的今天"); btn14.setType("click"); btn14.setKey("14"); CommonButton btn21 = new CommonButton(); btn21.setName("歌曲點播"); btn21.setType("click");