一、自定义菜单创建接口说明

自定义菜单能够帮助公众号丰富界面,让用户更好更快地理解公众号的功能。开启自定义菜单后,公众号界面如图所示:
微信开发学习总结(四)——自定义菜单(1)——自定义菜单创建接口-LMLPHP

请注意:
①自定义菜单最多包括3个一级菜单,每个一级菜单最多包含5个二级菜单。
②一级菜单最多4个汉字,二级菜单最多7个汉字,多出来的部分将会以“…”代替。
③创建自定义菜单后,菜单的刷新策略是,在用户进入公众号会话页或公众号profile页时,如果发现上一次拉取菜单的请求在5分钟以前,就会拉取一下菜单,如果菜单有更新,就会刷新客户端的菜单。测试时可以尝试取消关注公众账号后再次关注,则可以看到创建后的效果。

自定义菜单接口可实现多种类型按钮,如下:
**1、click:**点击推事件用户点击click类型按钮后,微信服务器会通过消息接口推送消息类型为event的结构给开发者(参考消息接口指南),并且带上按钮中开发者填写的key值,开发者可以通过自定义的key值与用户进行交互;
**2、view:**跳转URL用户点击view类型按钮后,微信客户端将会打开开发者在按钮中填写的网页URL,可与网页授权获取用户基本信息接口结合,获得用户基本信息。
**3、scancode_push:**扫码推事件用户点击按钮后,微信客户端将调起扫一扫工具,完成扫码操作后显示扫描结果(如果是URL,将进入URL),且会将扫码的结果传给开发者,开发者可以下发消息。
**4、scancode_waitmsg:**扫码推事件且弹出“消息接收中”提示框用户点击按钮后,微信客户端将调起扫一扫工具,完成扫码操作后,将扫码的结果传给开发者,同时收起扫一扫工具,然后弹出“消息接收中”提示框,随后可能会收到开发者下发的消息。
**5、pic_sysphoto:**弹出系统拍照发图用户点击按钮后,微信客户端将调起系统相机,完成拍照操作后,会将拍摄的相片发送给开发者,并推送事件给开发者,同时收起系统相机,随后可能会收到开发者下发的消息。
**6、pic_photo_or_album:**弹出拍照或者相册发图用户点击按钮后,微信客户端将弹出选择器供用户选择“拍照”或者“从手机相册选择”。用户选择后即走其他两种流程。
**7、pic_weixin:**弹出微信相册发图器用户点击按钮后,微信客户端将调起微信相册,完成选择操作后,将选择的相片发送给开发者的服务器,并推送事件给开发者,同时收起相册,随后可能会收到开发者下发的消息。
**8、location_select:**弹出地理位置选择器用户点击按钮后,微信客户端将调起地理位置选择工具,完成选择操作后,将选择的地理位置发送给开发者的服务器,同时收起位置选择工具,随后可能会收到开发者下发的消息。
**9、media_id:**下发消息(除文本消息)用户点击media_id类型按钮后,微信服务器会将开发者填写的永久素材id对应的素材下发给用户,永久素材类型可以是图片、音频、视频、图文消息。请注意:永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。
**10、view_limited:**跳转图文消息URL用户点击view_limited类型按钮后,微信客户端将打开开发者在按钮中填写的永久素材id对应的图文消息URL,永久素材类型只支持图文消息。请注意:永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。
请注意,3到8的所有事件,仅支持微信iPhone5.4.1以上版本,和Android5.4以上版本的微信用户,旧版本微信用户点击后将没有回应,开发者也不能正常接收到事件推送。9和10,是专门给第三方平台旗下未微信认证(具体而言,是资质认证未通过)的订阅号准备的事件类型,它们是没有事件推送的,能力相对受限,其他类型的公众号不必使用。

接口调用请求说明

http请求方式:POST(请使用https协议)
https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN

click和view的请求示例

{
     "button":[
     {
          "type":"click",
          "name":"今日歌曲",
          "key":"V1001_TODAY_MUSIC"
      },
      {
           "name":"菜单",
           "sub_button":[
           {
               "type":"view",
               "name":"搜索",
               "url":"http://www.soso.com/"
            },
            {
                 "type":"miniprogram",
                 "name":"wxa",
                 "url":"http://mp.weixin.qq.com",
                 "appid":"wx286b93c14bbf93aa",
                 "pagepath":"pages/lunar/index"
             },
            {
               "type":"click",
               "name":"赞一下我们",
               "key":"V1001_GOOD"
            }]
       }]
 }

其他新增按钮类型的请求示例

{
    "button": [
        {
            "name": "扫码",
            "sub_button": [
                {
                    "type": "scancode_waitmsg",
                    "name": "扫码带提示",
                    "key": "rselfmenu_0_0",
                    "sub_button": [ ]
                },
                {
                    "type": "scancode_push",
                    "name": "扫码推事件",
                    "key": "rselfmenu_0_1",
                    "sub_button": [ ]
                }
            ]
        },
        {
            "name": "发图",
            "sub_button": [
                {
                    "type": "pic_sysphoto",
                    "name": "系统拍照发图",
                    "key": "rselfmenu_1_0",
                   "sub_button": [ ]
                 },
                {
                    "type": "pic_photo_or_album",
                    "name": "拍照或者相册发图",
                    "key": "rselfmenu_1_1",
                    "sub_button": [ ]
                },
                {
                    "type": "pic_weixin",
                    "name": "微信相册发图",
                    "key": "rselfmenu_1_2",
                    "sub_button": [ ]
                }
            ]
        },
        {
            "name": "发送位置",
            "type": "location_select",
            "key": "rselfmenu_2_0"
        },
        {
           "type": "media_id",
           "name": "图片",
           "media_id": "MEDIA_ID1"
        },
        {
           "type": "view_limited",
           "name": "图文消息",
           "media_id": "MEDIA_ID2"
        }
    ]
}

参数说明

返回结果

正确时的返回JSON数据包如下:

{"errcode":0,"errmsg":"ok"}

错误时的返回JSON数据包如下(示例为无效菜单名长度):

{"errcode":40018,"errmsg":"invalid button name size"}

二、自定义菜单实体类的封装

接下来是对菜单结构的封装。因为我们是采用面向对象的编程方式,最终提交的json格式菜单数据就应该是由对象直接转换得到,而不是在程序代码中拼一大堆json数据。菜单结构封装的依据是公众平台API文档中给出的那一段json格式的菜单结构,如下所示:
菜单结构的封装有多种方式,因人而异,我介绍一种。
微信开发学习总结(四)——自定义菜单(1)——自定义菜单创建接口-LMLPHP

package weixin.entity.menu;

/**
 * @所属类别:实体类
 * @用途:微信公众号开发中自定义菜单-自定义菜单创建接口(所有菜单共有属性)
 * @author yilei
 * @version:1.0
 */
public class Button {

	private String type;//菜单的响应类型
	private String name;//菜单标题
	private Button[] sub_button;//	二级菜单数组
	public String getType() {
		return type;
	}
	public void setType(String type) {
		this.type = type;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public Button[] getSub_button() {
		return sub_button;
	}
	public void setSub_button(Button[] sub_button) {
		this.sub_button = sub_button;
	}
	/**
	 * @param type
	 * @param name
	 * @param sub_button
	 */
	public Button(String type, String name, Button[] sub_button) {
		this.type = type;
		this.name = name;
		this.sub_button = sub_button;
	}
	public Button(){

	}

}

package weixin.entity.menu;

/**
 * @所属类别:实体类
 * @用途:微信公众号开发中自定义菜单-自定义菜单创建接口(view/clike/scancode_push/scancode_waitmsg/pic_sysphoto/pic_photo_or_album/pic_weixin,)
 * @author yilei
 * @version:1.0
 */
public class TypeButton extends Button{

	 private String key;//click等点击类型必须	菜单KEY值,用于消息接口推送,不超过128字节

	 private String url;//view、miniprogram类型必须	网页 链接,用户点击菜单可打开链接,不超过1024字节。 type为miniprogram时,不支持小程序的老版本客户端将打开本url。

	public String getKey() {
		return key;
	}

	public void setKey(String key) {
		this.key = key;
	}

	public String getUrl() {
		return url;
	}

	public void setUrl(String url) {
		this.url = url;
	}

}

package weixin.entity.menu;

/**
 * @所属类别:实体类
 * @用途:微信公众号开发中自定义菜单-自定义菜单创建接口(Menu类代表整个微信公众号自定义菜单)
 * @author yilei
 * @version:1.0
 */
public class Menu {

	private Button[] button;//button	是	一级菜单数组,个数应为1~3个

	public Button[] getButton() {
		return button;
	}

	public void setButton(Button[] button) {
		this.button = button;
	}

	/**
	 * @param button
	 */
	public Menu(Button[] button) {
		this.button = button;
	}

	public Menu(){

	}

}

三、自定义菜单的创建

   /**
     * 组装菜单
     * @return
     */

    public static Menu initMenu(){
    Menu menu = new Menu();

    //---------菜单1、点击类型菜单-------------------//
    TypeButton c1 = new TypeButton();
    c1.setName("点击类型菜单1");
    c1.setType("click");
    c1.setKey("1");

    Button b1 = new Button();
    b1.setName("菜单标题1");
    b1.setSub_button(new Button[]{c1});

    //---------菜单2,具有2个子菜单(一个点击类型、一个是网页类型)   -------------------//
    TypeButton c2 = new TypeButton();
    c2.setName("点击类型菜单1");
    c2.setType("click");
    c2.setKey("11");

    TypeButton v1 = new TypeButton();
    v1.setName("点击网页类型1");
    v1.setType("view");
    v1.setUrl("http://www.baidu.com");

    Button b2 = new Button();
    b2.setName("菜单标题2");
    b2.setSub_button(new Button[]{c2,v1});

    //---------菜单3,具有5个子菜单(scancode_push/scancode_waitmsg/pic_sysphoto/pic_photo_or_album/pic_weixin/location_select)   -------------------//
    TypeButton t1 = new TypeButton();
    t1.setName("扫码推事件");
    t1.setType("scancode_push");
    t1.setKey("scancode_push");

    TypeButton t2 = new TypeButton();
    t2.setName("扫码带提示");
    t2.setType("scancode_waitmsg");
    t2.setKey("scancode_waitmsg");

    TypeButton t3 = new TypeButton();
    t3.setName("系统拍照发图");
    t3.setType("pic_sysphoto");
    t3.setKey("pic_sysphoto");

    TypeButton t4 = new TypeButton();
    t4.setName("拍照或者相册发图");
    t4.setType("pic_photo_or_album");
    t4.setKey("pic_photo_or_album");

    TypeButton t5 = new TypeButton();
    t5.setName("微信相册发图");
    t5.setType("pic_weixin");
    t5.setKey("pic_weixin");

    TypeButton t6 = new TypeButton();
    t6.setName("发送位置");
    t6.setType("location_select");
    t6.setKey("location_select");

    Button b3 = new Button();
    b3.setName("菜单标题3");
    b3.setSub_button(new Button[]{t1,t2,t3,t4,t5});

    menu.setButton(new Button[]{b1,b2,b3});//
    return menu;

    }


    /**
     * 创建菜单
     * @param token(ACCESS_TOKEN)
     * @param menu(已经转换为json格式的Meun类型的字符串)
     * @return result =0,表示创建成功,否则失败
     */
    public static int createMenu(String token,String menu){
    	int errcode = 0;
    	String url = WeiXin.MENU_CREATE.replace("ACCESS_TOKEN", token);
    	JSONObject jsonObject = doPostStr(url, menu);
    	if(jsonObject != null){
    		errcode = jsonObject.getInt("errcode");
    	}
    	return errcode;
    }
	/**
	 * 发起Http请求, 通过POST方式访问网络用到的方法
	 * @param url,请求的URL地址
	 * @return 响应后的字符串
	 */
	public static JSONObject doPostStr(String url,String outstr){
		DefaultHttpClient httpClient = new DefaultHttpClient();
        HttpPost httpPost = new HttpPost(url);
        JSONObject jsonObject = null;
		try {
			httpPost.setEntity(new StringEntity(outstr, "UTF-8"));
			HttpResponse response = httpClient.execute(httpPost);
			HttpEntity entity = response.getEntity();
			String result=EntityUtils.toString(entity,"UTF-8");
			jsonObject = JSONObject.fromObject(result);

		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		return jsonObject;

	}
	/**
	 * 自定义菜单-自定义创建菜单接口
	 */
    public static final String MENU_CREATE="https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN";
	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 点击推事件
	 */
	public static final String  MENU_CLICK="click";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 跳转URL
	 */
	public static final String  MENU_VIEW="view";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 扫码推事件
	 */
	public static final String  MENU_SCANCODE_PUSH="scancode_push";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 扫码推事件且弹出“消息接收中”提示框
	 */
	public static final String  MENU_SCANCODE_WAITMSG="scancode_waitmsg";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 弹出系统拍照发图
	 */
	public static final String  MENU_PIC_SYSPHOTO="pic_sysphoto";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 弹出拍照或者相册发图
	 */
	public static final String  MENU_PIC_PHOTO_OR_ALBUM="pic_photo_or_album";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 弹出微信相册发图器
	 */
	public static final String  MENU_PIC_WEIXIN="pic_weixin";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 弹出地理位置选择器
	 */
	public static final String  MENU_LOCATION_SELECT="location_select";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 下发消息(除文本消息)
	 */
	public static final String  MENU_MEDIA_ID="media_id";

	/**
	 * @变量类别 自定义菜单接口可实现多种类型按钮
	 * @变量含义 跳转图文消息URL
	 */
	public static final String  MENU_VIEW_LIMITED="view_limited";

微信服务器配置URL指向路径

	/**
	 * 处理微信服务器发post请求发来的xml格式消息
	 */
    @Override
	public void doPost(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {
    	ServletContext context = getServletContext();
    	AccessToken accessToken = (AccessToken) context.getAttribute("access_token");
    	String menu = JSONObject.fromObject(WeiXinCheck.initMenu()).toString();
    	int errcode = WeiXinCheck.createMenu(accessToken.getAccessToken() , menu);
    	if(errcode==0){
    		System.out.println("菜单创建成功!");
    		long startTime=System.currentTimeMillis();   //获取开始时间
            // TODO 接收、处理、响应由微信服务器转发的用户发送给公众帐号的消息
            // 将请求、响应的编码均设置为UTF-8(防止中文乱码)
            request.setCharacterEncoding("UTF-8");
            response.setCharacterEncoding("UTF-8");
            System.out.println("微信的post请求进入了本地服务器了");
            String result = "";
            try {
                Map<String,String> map = WeiXinCheck.parseXml(request);
                System.out.println("微信公众号要开始发送消息");
                result =  WeiXinCheck.buildResponseMessage(map);

                if(result.equals("")){
                    result = "未正确响应";
                }
            } catch (Exception e) {
                e.printStackTrace();
                System.out.println("发生异常:"+ e.getMessage());
            }

            response.getWriter().println(result);
            System.out.println( result) ;
            long endTime=System.currentTimeMillis(); //获取结束时间
            System.out.println("程序运行时间: "+(endTime-startTime)+"ms");
    	}else{
    		System.out.println("菜单创建失败");
    	}

    }

四、自定义菜单的创建成功

如果已经关注了微信公众号,可以先取消关注,重新扫描关注,就可以直接查看最新菜单
微信开发学习总结(四)——自定义菜单(1)——自定义菜单创建接口-LMLPHP

微信开发学习总结(四)——自定义菜单(1)——自定义菜单创建接口-LMLPHP

微信开发学习总结(四)——自定义菜单(1)——自定义菜单创建接口-LMLPHP

本节代码:
微信开发学习总结(四)——自定义菜单——自定义菜单创建接口——项目源码
下载地址:
https://download.csdn.net/download/qq_29914837/10700209

10-02 22:19