微信开发手册(8)

2025-12-16 11:47:45

1、自定义菜单的创建步骤

1、找到AppId和AppSecret。

2、根据AppId和AppSecret,以https get方式获取访问特殊接口所必须的凭证access_token;

3、根据access_token,将json格式的菜单数据通过https post方式提交。

2、分析创建菜单的难点

原来创建菜单这么简单,三步就能搞定?跟把大象放冰箱差不多。呵呵,当然没有这么简单,那我们一步步来看,到底难在哪里?

首先,第1步肯定都没有问题,只要成功申请了自定义菜单,一定能拿到AppId和AppSecret这两个值。

再来看第2步,由于是get方式获取access_token,很多人直接把拼好的url放在浏览器里执行,access_token就拿到了。抛开是不是用编程方式实现的来说,这真是个好办法,显然大家在第二步上也没有问题。

最后再看第3步,拼装json格式的菜单数据,虽然繁锁一点,但基本上也都没有什么问题的,因为官方给了个例子,照猫画虎就行了。那问题一定就出现在https post提交上了。

3、结论:不知道如何创建自定义菜单的朋友,大都可以归为以下三种情况:

1)根本不看或者没看懂公众平台API文档中关于“通用接口”、“自定义菜单接口”和“使用限制”部分的说明;

2)不知道如何发起HTTPS请求(平时的http请求,直接使用HttpUrlConnection就可以轻松搞定,但https请求要复杂一点);

3)不知道如何通过POST方式提交json格式的菜单数据。

正在看文章的你,不知道是属于哪一种,或者几种情况都有,不妨留言说出来,也可以做个调查。不管属于哪一种情况,既然看到了这篇文章,相信一定会让你弄明白的。

4、解读通用接口文档---凭证的获取

我们先来看通用接口文档的简介部分,如下图所示。

微信开发手册(8)

5、图中已经表达的很清楚了,获取access_token是通过GET方式访问如下链接:

https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET 

链接中有三个参数,分别是grant_type、appid和secret。根据图中的参数说明,grant_type传固定值client_credential,而appid和secret就是申请完自定义菜单后微信分配给我们的。

请求发送成功后,微信服务器会返回一个json串,包含access_token和expires_in两个元素。其中,access_token就是我们最终需要的凭证,而expires_in是凭证的有效期,单位是秒,7200秒也就是2个小时。这就意味着,不是每次访问特殊接口,都需要重新获取一次access_token,只要access_token还在有效期内,就一直可以使用。

6、解读自定义菜单接口文档

还是一样,先来看看自定义菜单接口的简介部分,如下图所示。

微信开发手册(8)

7、从图中我们能够获取到以下信息:

1)拿到凭证access_token后,我们能对菜单执行三种操作:创建、查询和删除;

2)自定义菜单目前支持click,view2种事件,即用户点击后回复某种类型的消息;

3)由于微信客户端缓存的原因,菜单创建后并不会立即在微信上显示出来,需要过24小时。在测试菜单创建时,可以通过取消关注后,再关注的方式达到立即看菜单的目的。

继续往下看,就是关于菜单怎么创建的介绍了,如下图所示。

微信开发手册(8)

8、其实就是向地址https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN以POST方式提交一个JSON格式的菜单字符串。

后面,关于参数说明的部分我就不一一贴图说明了,把重点说一下:

1)自定义菜单是一个3x5结构的,即菜单最多只能有二级,一级菜单最多只能有3个,每个一级菜单下最多可以有5个二级菜单项;

2)菜单项都有一个key值。当用户点击某个菜单项时,微信会将该菜单项的key值以事件推送的方式发送给我们的后台处理程序。

关于菜单的查询、创建我就不提了,这两个接口使用的频率非常小,一般都用不上。如果需要,再按照我上面提供的思路也不难理解。

9、封装通用的请求方法

读到这里,就默认大家已经掌握了上面讲到的所有关于自定义菜单的理论知识,下面就进入代码实战讲解的部分。

先前我们了解到,创建菜单需要调用二个接口,并且都是https请求,而非http。如果要封装一个通用的请求方法,该方法至少需要具备以下能力:

1)支持HTTPS请求;

2)支持GET、POST两种方式;

3)支持参数提交,也支持无参数的情况;

对于https请求,我们需要一个证书信任管理器,这个管理器类需要自己定义,但需要实现X509TrustManager接口,代码如下:

package edu.siso.util;

import java.security.cert.CertificateException;

import java.security.cert.X509Certificate;

import javax.net.ssl.X509TrustManager;

public class MyX509TrustManager implements X509TrustManager {

@Override

public void checkClientTrusted(X509Certificate[] arg0, String arg1)

throws CertificateException {

// TODO Auto-generated method stub

}

@Override

public void checkServerTrusted(X509Certificate[] arg0, String arg1)

throws CertificateException {

// TODO Auto-generated method stub

}

@Override

public X509Certificate[] getAcceptedIssuers() {

// TODO Auto-generated method stub

return null;

}

}

10、这个证书管理器的作用就是让它信任我们指定的证书,上面的代码意味着信任所有证书,不管是否权威机构颁发。

证书有了,通用的https请求方法就不难实现了,实现代码如下:

package edu.siso.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 org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import net.sf.json.JSONException;

import net.sf.json.JSONObject;

import edu.siso.pojo.AccessToken;

import edu.siso.pojo.Menu;

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";  

 

/** 

* 获取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;  

   }  

// 菜单创建(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;  

}  

}

代码说明:

1)解决https请求的问题,很多人问题就出在这里;

2)兼容GET、POST两种方式;

3)兼容有数据提交、无数据提交两种情况,也有相当一部分人不知道如何POST提交数据;

11、Pojo类的封装

在获取凭证创建菜单前,我们还需要封装一些pojo,这会让我们的代码更美观,有条理。

首先是调用获取凭证接口后,微信服务器会返回json格式的数据:{"access_token":"ACCESS_TOKEN","expires_in":7200},我们将其封装为一个AccessToken对象,对象有二个属性:token和expiresIn,代码如下:

package edu.siso.pojo;

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;

}  

    

}

12、接下来是对菜单结构的封装。

package edu.siso.pojo;

public class Button {

private String name;

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}  

}

13、接着是子菜单项的封装。这里对子菜单是这样定义的:没有子菜单的菜单项,有可能是二级菜单项,也有可能是不含二级菜单的一级菜单。这类子菜单项一定会包含三个属性:type、name和key,封装的代码如下:

package edu.siso.pojo;

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;

}

}

14、ViewButton的封装

public class ViewButton extends Button {

private String type;  

    private String url;

public String getType() {

return type;

}

public void setType(String type) {

this.type = type;

}

public String getUrl() {

return url;

}

public void setUrl(String url) {

this.url = url;

    

}

15、再往下是父菜单项的封装。对父菜单项的定义:包含有二级菜单项的一级菜单。这类菜单项包含有二个属性:name和sub_button,而sub_button以是一个子菜单项数组。父菜单项的封装代码如下:

package edu.siso.pojo;

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;

}

16、最后是整个菜单对象的封装,菜单对象包含多个菜单项(最多只能有3个),这些菜单项即可以是子菜单项(不含二级菜单的一级菜单),也可以是父菜单项(包含二级菜单的菜单项),如果能明白上面所讲的,再来看封装后的代码就很容易理解了:

package edu.siso.pojo;

public class Menu {

private Button[] button;

public Button[] getButton() {

return button;

}

public void setButton(Button[] button) {

this.button = button;

}

}

声明:本网站引用、摘录或转载内容仅供网站访问者交流或参考,不代表本站立场,如存在版权或非法内容,请联系站长删除,联系邮箱:site.kefu@qq.com。
猜你喜欢