• Home
• com.foxinmy
• weixin4j-mp
• 1.10.1
• source code
• MenuApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.foxinmy.weixin4j.mp.api.MenuApi Maven / Gradle / Ivy

package com.foxinmy.weixin4j.mp.api;

import java.util.ArrayList;
import java.util.List;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.parser.deserializer.ExtraProcessor;
import com.alibaba.fastjson.parser.deserializer.ParseProcess;
import com.alibaba.fastjson.serializer.NameFilter;
import com.foxinmy.weixin4j.exception.WeixinException;
import com.foxinmy.weixin4j.http.weixin.ApiResult;
import com.foxinmy.weixin4j.http.weixin.WeixinResponse;
import com.foxinmy.weixin4j.model.Button;
import com.foxinmy.weixin4j.model.Token;
import com.foxinmy.weixin4j.mp.model.Menu;
import com.foxinmy.weixin4j.mp.model.MenuMatchRule;
import com.foxinmy.weixin4j.token.TokenManager;
import com.foxinmy.weixin4j.type.ButtonType;
import com.foxinmy.weixin4j.util.StringUtil;

/**
 * 菜单相关API
 *
 * @className MenuApi
 * @author jinyu([email protected])
 * @date 2014年9月25日
 * @since JDK 1.6
 */
public class MenuApi extends MpApi {

    private final TokenManager tokenManager;

    public MenuApi(TokenManager tokenManager) {
        this.tokenManager = tokenManager;
    }

    /**
     * 自定义菜单
     *
     * @param buttons
     *            菜单列表
     * @throws WeixinException
     * @see 
     *      创建自定义菜单
     * @see com.foxinmy.weixin4j.model.Button
     * @return 处理结果
     */
    public ApiResult createMenu(List buttons) throws WeixinException {
        String menu_create_uri = getRequestUri("menu_create_uri");
        JSONObject obj = new JSONObject();
        obj.put("button", buttons);
        return createMenu0(menu_create_uri, obj).getAsResult();
    }

    private WeixinResponse createMenu0(String url, JSONObject data) throws WeixinException {
        return weixinExecutor.post(String.format(url, tokenManager.getAccessToken()),
                JSON.toJSONString(data, new NameFilter() {
                    @Override
                    public String process(Object object, String name, Object value) {
                        if (object instanceof Button && name.equals("content")
                                && StringUtil.isNotBlank(((Button) object).getType())) {
                            ButtonType buttonType = ButtonType.valueOf(((Button) object).getType());
                            if (ButtonType.view == buttonType || ButtonType.miniprogram == buttonType) {
                                return "url";
                            } else if (ButtonType.media_id == buttonType || ButtonType.view_limited == buttonType) {
                                return "media_id";
                            } else {
                                return "key";
                            }
                        }
                        return name;
                    }
                }));

    }

    /**
     * 查询菜单
     *
     * @throws WeixinException
     * @see 
     *      查询菜单
     * @see com.foxinmy.weixin4j.model.Button
     * @return 菜单集合
     */
    public List getMenu() throws WeixinException {
        return buttonsConvertor(getMenu0().getJSONObject("menu"));
    }

    private JSONObject getMenu0() throws WeixinException {
        String menu_get_uri = getRequestUri("menu_get_uri");
        Token token = tokenManager.getCache();
        WeixinResponse response = weixinExecutor.get(String.format(menu_get_uri, token.getAccessToken()));
        return response.getAsJson();
    }

    /**
     * 查询全部菜单(包含个性化菜单)
     *
     * @throws WeixinException
     * @see 
     *      普通菜单
     * @see 
     *      个性化菜单
     * @see com.foxinmy.weixin4j.model.Button
     * @see com.foxinmy.weixin4j.mp.model.Menu
     * @return 菜单集合
     */
    public List getAllMenu() throws WeixinException {
        JSONObject response = getMenu0();
        List menus = new ArrayList();
        // 普通菜单
        JSONObject menuObj = response.getJSONObject("menu");
        menus.add(new Menu(menuObj.getString("menuid"), buttonsConvertor(menuObj), null));
        // 个性化菜单
        JSONArray menuObjs = response.getJSONArray("conditionalmenu");
        if (menuObjs != null && !menuObjs.isEmpty()) {
            for (int i = 0; i < menuObjs.size(); i++) {
                menuObj = menuObjs.getJSONObject(i);
                menus.add(new Menu(menuObj.getString("menuid"), buttonsConvertor(menuObj),
                        menuObj.getObject("matchrule", MenuMatchRule.class)));
            }
        }
        return menus;
    }

    /**
     * 删除菜单
     *
     * @return 处理结果
     * @throws WeixinException
     * @see 
     *      删除菜单
     * @return 处理结果
     */
    public ApiResult deleteMenu() throws WeixinException {
        String menu_delete_uri = getRequestUri("menu_delete_uri");
        Token token = tokenManager.getCache();
        WeixinResponse response = weixinExecutor.get(String.format(menu_delete_uri, token.getAccessToken()));

        return response.getAsResult();
    }

    /**
     * 创建个性化菜单
     *
     * @param buttons
     *            菜单列表
     * @param matchRule
     *            匹配规则 至少要有一个匹配信息是不为空
     * @throws WeixinException
     * @see 
     *      创建个性化菜单
     * @see com.foxinmy.weixin4j.model.Button
     * @return 菜单ID
     */
    public String createCustomMenu(List buttons, MenuMatchRule matchRule) throws WeixinException {
        String menu_create_uri = getRequestUri("menu_custom_create_uri");
        JSONObject obj = new JSONObject();
        obj.put("button", buttons);
        obj.put("matchrule", matchRule.getRule());
        return createMenu0(menu_create_uri, obj).getAsJson().getString("menuid");
    }

    /**
     * 删除个性化菜单
     *
     * @throws WeixinException
     * @see 
     *      删除个性化菜单
     * @return 处理结果
     */
    public ApiResult deleteCustomMenu(String menuId) throws WeixinException {
        String menu_delete_uri = getRequestUri("menu_delete_custom_uri");
        Token token = tokenManager.getCache();
        JSONObject obj = new JSONObject();
        obj.put("menuid", menuId);
        WeixinResponse response = weixinExecutor.post(String.format(menu_delete_uri, token.getAccessToken()),
                obj.toJSONString());

        return response.getAsResult();
    }

    /**
     * 测试个性化菜单匹配结果
     *
     * @param userId
     *            可以是粉丝的OpenID，也可以是粉丝的微信号。
     * @return 匹配到的菜单配置
     * @see 
     *      测试个性化菜单
     * @see com.foxinmy.weixin4j.model.Button
     * @throws WeixinException
     */
    public List matchCustomMenu(String userId) throws WeixinException {
        String menu_trymatch_uri = getRequestUri("menu_trymatch_uri");
        Token token = tokenManager.getCache();
        JSONObject obj = new JSONObject();
        obj.put("user_id", userId);
        WeixinResponse response = weixinExecutor.post(String.format(menu_trymatch_uri, token.getAccessToken()),
                obj.toJSONString());

        return buttonsConvertor(response.getAsJson().getJSONObject("menu"));
    }

    private final ParseProcess buttonProcess = new ExtraProcessor() {
        @Override
        public void processExtra(Object object, String key, Object value) {
            ((Button) object).setContent(String.valueOf(value));
        }
    };

    private List buttonsConvertor(JSONObject menu) {
        JSONArray buttons = menu.getJSONArray("button");
        List buttonList = new ArrayList(buttons.size());
        for (int i = 0; i < buttons.size(); i++) {
            buttonList.add(JSON.parseObject(buttons.getString(i), Button.class, buttonProcess));
        }
        return buttonList;
    }
}