微信公众号发模板消息(spring集成)
引入依赖:
<dependency> <groupId>me.chanjar</groupId> <artifactId>weixin-java-mp</artifactId> <version>1.3.3</version> </dependency>
其中已实现的功能:
public interface WxMpService { public static final SimpleDateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd"); /** * <pre> * 验证推送过来的消息的正确性 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性 * </pre> * @param timestamp * @param nonce * @param signature * @return */ public boolean checkSignature(String timestamp, String nonce, String signature); /** * 获取access_token, 不强制刷新access_token * @see #getAccessToken(boolean) * @return * @throws WxErrorException */ public String getAccessToken() throws WxErrorException; /** * <pre> * 获取access_token,本方法线程安全 * 且在多线程同时刷新时只刷新一次,避免超出2000次/日的调用次数上限 * * 另:本service的所有方法都会在access_token过期是调用此方法 * * 程序员在非必要情况下尽量不要主动调用此方法 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取access_token * </pre> * @param forceRefresh 强制刷新 * @return * @throws me.chanjar.weixin.common.exception.WxErrorException */ public String getAccessToken(boolean forceRefresh) throws WxErrorException; /** * 获得jsapi_ticket,不强制刷新jsapi_ticket * @see #getJsapiTicket(boolean) * @return * @throws WxErrorException */ public String getJsapiTicket() throws WxErrorException; /** * <pre> * 获得jsapi_ticket * 获得时会检查jsapiToken是否过期,如果过期了,那么就刷新一下,否则就什么都不干 * * 详情请见:http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95 * </pre> * @param forceRefresh 强制刷新 * @return * @throws WxErrorException */ public String getJsapiTicket(boolean forceRefresh) throws WxErrorException; /** * <pre> * 创建调用jsapi时所需要的签名 * * 详情请见:http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95 * </pre> * @param url url * @return */ public WxJsapiSignature createJsapiSignature(String url) throws WxErrorException; /** * <pre> * 上传多媒体文件 * * 上传的多媒体文件有格式和大小限制,如下: * 图片(image): 1M,支持JPG格式 * 语音(voice):2M,播放长度不超过60s,支持AMR\MP3格式 * 视频(video):10MB,支持MP4格式 * 缩略图(thumb):64KB,支持JPG格式 * * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件 * </pre> * @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts} * @param fileType 文件类型,请看{@link me.chanjar.weixin.common.api.WxConsts} * @param inputStream 输入流 * @throws WxErrorException */ public WxMediaUploadResult mediaUpload(String mediaType, String fileType, InputStream inputStream) throws WxErrorException, IOException; /** * <pre> * 上传非图文永久素材 * * 上传的多媒体文件有格式和大小限制,如下: * 图片(image): 图片大小不超过2M,支持bmp/png/jpeg/jpg/gif格式 * 语音(voice):语音大小不超过5M,长度不超过60秒,支持mp3/wma/wav/amr格式 * 视频(video):在上传视频素材时需要POST另一个表单,id为description,包含素材的描述信息,内容格式为JSON * 缩略图(thumb):文档未说明 * * 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html * </pre> * @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts} * @param material 上传的素材, 请看{@link me.chanjar.weixin.mp.bean.WxMpMaterial} * @return * @throws WxErrorException */ public WxMpMaterialUploadResult materialFileUpload(String mediaType, WxMpMaterial material) throws WxErrorException; /** * <pre> * 上传永久图文素材 * * 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html * </pre> * @param news 上传的图文消息, 请看{@link me.chanjar.weixin.mp.bean.WxMpMaterialNews} * @return * @throws WxErrorException */ public WxMpMaterialUploadResult materialNewsUpload(WxMpMaterialNews news) throws WxErrorException; /** * <pre> * 下载声音或者图片永久素材 * * 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html * </pre> * @param media_id 永久素材的id * @return * @throws WxErrorException */ public InputStream materialImageOrVoiceDownload(String media_id) throws WxErrorException; /** * <pre> * 获取视频永久素材的信息和下载地址 * * 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html * </pre> * @param media_id 永久素材的id * @return * @throws WxErrorException */ public WxMpMaterialVideoInfoResult materialVideoInfo(String media_id) throws WxErrorException; /** * <pre> * 获取图文永久素材的信息 * * 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html * </pre> * @param media_id 永久素材的id * @return * @throws WxErrorException */ public WxMpMaterialNews materialNewsInfo(String media_id) throws WxErrorException; /** * <pre> * 更新图文永久素材 * * 详情请见: http://mp.weixin.qq.com/wiki/4/19a59cba020d506e767360ca1be29450.html * </pre> * @param wxMpMaterialArticleUpdate 用来更新图文素材的bean, 请看{@link me.chanjar.weixin.mp.bean.WxMpMaterialArticleUpdate} * @return * @throws WxErrorException */ public boolean materialNewsUpdate(WxMpMaterialArticleUpdate wxMpMaterialArticleUpdate) throws WxErrorException; /** * <pre> * 删除永久素材 * * 详情请见: http://mp.weixin.qq.com/wiki/5/e66f61c303db51a6c0f90f46b15af5f5.html * </pre> * @param media_id 永久素材的id * @return * @throws WxErrorException */ public boolean materialDelete(String media_id) throws WxErrorException; /** * <pre> * 获取各类素材总数 * * 详情请见: http://mp.weixin.qq.com/wiki/16/8cc64f8c189674b421bee3ed403993b8.html * </pre> * @return * @throws WxErrorException */ public WxMpMaterialCountResult materialCount() throws WxErrorException; /** * <pre> * 分页获取图文素材列表 * * 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html * </pre> * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回 * @param count 返回素材的数量,取值在1到20之间 * @return * @throws WxErrorException */ public WxMpMaterialNewsBatchGetResult materialNewsBatchGet(int offset, int count) throws WxErrorException; /** * <pre> * 分页获取其他媒体素材列表 * * 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html * </pre> * @param type 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts} * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回 * @param count 返回素材的数量,取值在1到20之间 * @return * @throws WxErrorException */ public WxMpMaterialFileBatchGetResult materialFileBatchGet(String type, int offset, int count) throws WxErrorException; /** * @see #mediaUpload(String, String, InputStream) * @param mediaType * @param file * @throws WxErrorException */ public WxMediaUploadResult mediaUpload(String mediaType, File file) throws WxErrorException; /** * <pre> * 下载多媒体文件 * 根据微信文档,视频文件下载不了,会返回null * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件 * </pre> * @params media_id * @return 保存到本地的临时文件 * @throws WxErrorException */ public File mediaDownload(String media_id) throws WxErrorException; /** * <pre> * 发送客服消息 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息 * </pre> * @param message * @throws WxErrorException */ public void customMessageSend(WxMpCustomMessage message) throws WxErrorException; /** * <pre> * 上传群发用的图文消息,上传后才能群发图文消息 * * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口 * </pre> * @param news * @throws WxErrorException * @see #massGroupMessageSend(me.chanjar.weixin.mp.bean.WxMpMassGroupMessage) * @see #massOpenIdsMessageSend(me.chanjar.weixin.mp.bean.WxMpMassOpenIdsMessage) */ public WxMpMassUploadResult massNewsUpload(WxMpMassNews news) throws WxErrorException; /** * <pre> * 上传群发用的视频,上传后才能群发视频消息 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口 * </pre> * @return * @throws WxErrorException * @see #massGroupMessageSend(me.chanjar.weixin.mp.bean.WxMpMassGroupMessage) * @see #massOpenIdsMessageSend(me.chanjar.weixin.mp.bean.WxMpMassOpenIdsMessage) */ public WxMpMassUploadResult massVideoUpload(WxMpMassVideo video) throws WxErrorException; /** * <pre> * 分组群发消息 * 如果发送图文消息,必须先使用 {@link #massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews)} 获得media_id,然后再发送 * 如果发送视频消息,必须先使用 {@link #massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo)} 获得media_id,然后再发送 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口 * </pre> * @param message * @throws WxErrorException * @return */ public WxMpMassSendResult massGroupMessageSend(WxMpMassGroupMessage message) throws WxErrorException; /** * <pre> * 按openId列表群发消息 * 如果发送图文消息,必须先使用 {@link #massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews)} 获得media_id,然后再发送 * 如果发送视频消息,必须先使用 {@link #massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo)} 获得media_id,然后再发送 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口 * </pre> * @param message * @return * @throws WxErrorException */ public WxMpMassSendResult massOpenIdsMessageSend(WxMpMassOpenIdsMessage message) throws WxErrorException; /** * <pre> * 自定义菜单创建接口 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口 * 如果要创建个性化菜单,请设置matchrule属性 * 详情请见:http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html * </pre> * @param menu * @throws WxErrorException */ public void menuCreate(WxMenu menu) throws WxErrorException; /** * <pre> * 自定义菜单删除接口 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口 * </pre> * @throws WxErrorException */ public void menuDelete() throws WxErrorException; /** * <pre> * 删除个性化菜单接口 * 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html * </pre> * @param menuid * @throws WxErrorException */ public void menuDelete(String menuid) throws WxErrorException; /** * <pre> * 自定义菜单查询接口 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口 * </pre> * @return * @throws WxErrorException */ public WxMenu menuGet() throws WxErrorException; /** * <pre> * 测试个性化菜单匹配结果 * 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html * </pre> * @param userid 可以是粉丝的OpenID,也可以是粉丝的微信号。 * @throws WxErrorException */ public WxMenu menuTryMatch(String userid) throws WxErrorException; /** * <pre> * 分组管理接口 - 创建分组 * 最多支持创建500个分组 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口 * </pre> * @param name 分组名字(30个字符以内) * @throws WxErrorException */ public WxMpGroup groupCreate(String name) throws WxErrorException; /** * <pre> * 分组管理接口 - 查询所有分组 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口 * </pre> * @return * @throws WxErrorException */ public List<WxMpGroup> groupGet() throws WxErrorException; /** * <pre> * 分组管理接口 - 查询用户所在分组 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口 * </pre> * @param openid 微信用户的openid * @throws WxErrorException */ public long userGetGroup(String openid) throws WxErrorException; /** * <pre> * 分组管理接口 - 修改分组名 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口 * * 如果id为0(未分组),1(黑名单),2(星标组),或者不存在的id,微信会返回系统繁忙的错误 * </pre> * @param group 要更新的group,group的id,name必须设置 * @throws WxErrorException */ public void groupUpdate(WxMpGroup group) throws WxErrorException; /** * <pre> * 分组管理接口 - 移动用户分组 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口 * * 如果to_groupid为0(未分组),1(黑名单),2(星标组),或者不存在的id,微信会返回系统繁忙的错误 * </pre> * @param openid 用户openid * @param to_groupid 移动到的分组id * @throws WxErrorException */ public void userUpdateGroup(String openid, long to_groupid) throws WxErrorException; /** * <pre> * 设置用户备注名接口 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=设置用户备注名接口 * </pre> * @param openid 用户openid * @param remark 备注名 * @throws WxErrorException */ public void userUpdateRemark(String openid, String remark) throws WxErrorException; /** * <pre> * 获取用户基本信息 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取用户基本信息 * </pre> * @param openid 用户openid * @param lang 语言,zh_CN 简体(默认),zh_TW 繁体,en 英语 * @return * @throws WxErrorException */ public WxMpUser userInfo(String openid, String lang) throws WxErrorException; /** * <pre> * 获取关注者列表 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取关注者列表 * </pre> * @param next_openid 可选,第一个拉取的OPENID,null为从头开始拉取 * @return * @throws WxErrorException */ public WxMpUserList userList(String next_openid) throws WxErrorException; /** * <pre> * 换取临时二维码ticket * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码 * </pre> * @param scene_id 参数。 * @param expire_seconds 过期秒数,默认60秒,最小60秒,最大1800秒 * @return * @throws WxErrorException */ public WxMpQrCodeTicket qrCodeCreateTmpTicket(int scene_id, Integer expire_seconds) throws WxErrorException; /** * <pre> * 换取永久二维码ticket * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码 * </pre> * @param scene_id 参数。永久二维码时最大值为100000(目前参数只支持1--100000) * @return * @throws WxErrorException */ public WxMpQrCodeTicket qrCodeCreateLastTicket(int scene_id) throws WxErrorException; /** * <pre> * 换取永久字符串二维码ticket * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码 * </pre> * * @param scene_str 参数。字符串类型长度现在为1到64 * @return * @throws WxErrorException */ public WxMpQrCodeTicket qrCodeCreateLastTicket(String scene_str) throws WxErrorException; /** * <pre> * 换取二维码图片文件,jpg格式 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码 * </pre> * @param ticket 二维码ticket * @return * @throws WxErrorException */ public File qrCodePicture(WxMpQrCodeTicket ticket) throws WxErrorException; /** * <pre> * 长链接转短链接接口 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=长链接转短链接接口 * </pre> * @param long_url * @return * @throws WxErrorException */ public String shortUrl(String long_url) throws WxErrorException; /** * <pre> * 发送模板消息 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=模板消息接口 * </pre> * @param templateMessage * @throws WxErrorException * @return msgid */ public String templateSend(WxMpTemplateMessage templateMessage) throws WxErrorException; /** * <pre> * 语义查询接口 * 详情请见:http://mp.weixin.qq.com/wiki/index.php?title=语义理解 * </pre> * @param semanticQuery * @return * @throws WxErrorException */ WxMpSemanticQueryResult semanticQuery(WxMpSemanticQuery semanticQuery) throws WxErrorException; /** * <pre> * 构造oauth2授权的url连接 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息 * </pre> * @param scope * @param state * @return url */ public String oauth2buildAuthorizationUrl(String scope, String state); /** * <pre> * 构造oauth2授权的url连接 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息 * </pre> * @param redirectURI * 用户授权完成后的重定向链接,无需urlencode, 方法内会进行encode * @param scope * @param state * @return url */ public String oauth2buildAuthorizationUrl(String redirectURI, String scope, String state); /** * <pre> * 用code换取oauth2的access token * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息 * </pre> * @param code * @return */ public WxMpOAuth2AccessToken oauth2getAccessToken(String code) throws WxErrorException; /** * <pre> * 刷新oauth2的access token * </pre> * @param refreshToken * @return */ public WxMpOAuth2AccessToken oauth2refreshAccessToken(String refreshToken) throws WxErrorException; /** * <pre> * 用oauth2获取用户信息, 当前面引导授权时的scope是snsapi_userinfo的时候才可以 * </pre> * @param oAuth2AccessToken * @param lang zh_CN, zh_TW, en */ public WxMpUser oauth2getUserInfo(WxMpOAuth2AccessToken oAuth2AccessToken, String lang) throws WxErrorException; /** * <pre> * 验证oauth2的access token是否有效 * </pre> * @param oAuth2AccessToken * @return */ public boolean oauth2validateAccessToken(WxMpOAuth2AccessToken oAuth2AccessToken); /** * <pre> * 获取微信服务器IP地址 * http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html * </pre> * @return * @throws WxErrorException */ String[] getCallbackIP() throws WxErrorException; /** * <pre> * 获取用户增减数据 * http://mp.weixin.qq.com/wiki/3/ecfed6e1a0a03b5f35e5efac98e864b7.html * </pre> * @param beginDate 最大时间跨度7天 * @param endDate endDate不能早于begingDate * @return * @throws WxErrorException */ List<WxMpUserSummary> getUserSummary(Date beginDate, Date endDate) throws WxErrorException; /** * <pre> * 获取累计用户数据 * http://mp.weixin.qq.com/wiki/3/ecfed6e1a0a03b5f35e5efac98e864b7.html * </pre> * @param beginDate 最大时间跨度7天 * @param endDate endDate不能早于begingDate * @return * @throws WxErrorException */ List<WxMpUserCumulate> getUserCumulate(Date beginDate, Date endDate) throws WxErrorException; /** * 当本Service没有实现某个API的时候,可以用这个,针对所有微信API中的GET请求 * @param url * @param queryParam * @return * @throws WxErrorException */ String get(String url, String queryParam) throws WxErrorException; /** * 当本Service没有实现某个API的时候,可以用这个,针对所有微信API中的POST请求 * @param url * @param postData * @return * @throws WxErrorException */ String post(String url, String postData) throws WxErrorException; /** * <pre> * Service没有实现某个API的时候,可以用这个, * 比{@link #get}和{@link #post}方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。 * 可以参考,{@link me.chanjar.weixin.common.util.http.MediaUploadRequestExecutor}的实现方法 * </pre> * @param executor * @param uri * @param data * @param <T> * @param <E> * @return * @throws WxErrorException */ public <T, E> T execute(RequestExecutor<T, E> executor, String uri, E data) throws WxErrorException; /** * 注入 {@link WxMpConfigStorage} 的实现 * @param wxConfigProvider */ public void setWxMpConfigStorage(WxMpConfigStorage wxConfigProvider); /** * <pre> * 设置当微信系统响应系统繁忙时,要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试 * 默认:1000ms * </pre> * @param retrySleepMillis */ void setRetrySleepMillis(int retrySleepMillis); /** * <pre> * 设置当微信系统响应系统繁忙时,最大重试次数 * 默认:5次 * </pre> * @param maxRetryTimes */ void setMaxRetryTimes(int maxRetryTimes); /** * 统一下单(详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1) * 在发起微信支付前,需要调用统一下单接口,获取"预支付交易会话标识" * @param openId 支付人openId * @param outTradeNo 商户端对应订单号 * @param amt 金额(单位元) * @param body 商品描述 * @param tradeType 交易类型 JSAPI,NATIVE,APP,WAP * @param ip 发起支付的客户端IP * @param notifyUrl 通知地址 * @return * @deprecated Use me.chanjar.weixin.mp.api.WxMpService.getPrepayId(Map<String, String>) instead */ @Deprecated WxMpPrepayIdResult getPrepayId(String openId, String outTradeNo, double amt, String body, String tradeType, String ip, String notifyUrl); /** * 统一下单(详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1) * 在发起微信支付前,需要调用统一下单接口,获取"预支付交易会话标识" * * @param parameters * All required/optional parameters for weixin payment * @return * @throws IllegalArgumentException */ WxMpPrepayIdResult getPrepayId(Map<String, String> parameters); /** * 该接口调用“统一下单”接口,并拼装JSSDK发起支付请求需要的参数 * 详见http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E5.8F.91.E8.B5.B7.E4.B8.80.E4.B8.AA.E5.BE.AE.E4.BF.A1.E6.94.AF.E4.BB.98.E8.AF.B7.E6.B1.82 * @param parameters * the required or optional parameters * @return */ Map<String, String> getJSSDKPayInfo(Map<String, String> parameters); /** * 该接口调用“统一下单”接口,并拼装JSSDK发起支付请求需要的参数 * 详见http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E5.8F.91.E8.B5.B7.E4.B8.80.E4.B8.AA.E5.BE.AE.E4.BF.A1.E6.94.AF.E4.BB.98.E8.AF.B7.E6.B1.82 * @param openId 支付人openId * @param outTradeNo 商户端对应订单号 * @param amt 金额(单位元) * @param body 商品描述 * @param tradeType 交易类型 JSAPI,NATIVE,APP,WAP * @param ip 发起支付的客户端IP * @param notifyUrl 通知地址 * @return * @deprecated Use me.chanjar.weixin.mp.api.WxMpService.getJSSDKPayInfo(Map<String, String>) instead */ @Deprecated Map<String, String> getJSSDKPayInfo(String openId, String outTradeNo, double amt, String body, String tradeType, String ip, String notifyUrl); /** * 该接口提供所有微信支付订单的查询,当支付通知处理异常戒丢失的情冴,商户可以通过该接口查询订单支付状态。 * 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2 * @param transactionId * @param outTradeNo */ WxMpPayResult getJSSDKPayResult(String transactionId, String outTradeNo); /** * 读取支付结果通知 * 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_7 * @param xmlData * @return */ WxMpPayCallback getJSSDKCallbackData(String xmlData); /** * <pre> * 计算Map键值对是否和签名相符, * 按照字段名的 ASCII 码从小到大排序(字典序)后,使用 URL 键值对的 格式(即 key1=value1&key2=value2...)拼接成字符串 * </pre> * @param kvm * @param signature * @return */ public boolean checkJSSDKCallbackDataSignature(Map<String, String> kvm, String signature); /** * 发送微信红包给个人用户 * @param parameters * @return * @throws WxErrorException */ public WxRedpackResult sendRedpack(Map<String, String> parameters) throws WxErrorException;
import java.util.ArrayList; import java.util.List; import xxx.mgt.wechat.common.TemplateParam; import lombok.Getter; import lombok.Setter; import me.chanjar.weixin.common.exception.WxErrorException; import me.chanjar.weixin.mp.api.WxMpService; import me.chanjar.weixin.mp.bean.WxMpTemplateData; import me.chanjar.weixin.mp.bean.WxMpTemplateMessage; import me.chanjar.weixin.mp.bean.result.WxMpUser; import me.chanjar.weixin.mp.bean.result.WxMpUserList; public class WechatManager { @Getter @Setter private static WxMpService wxMpService; /** * 发送模板消息 * @param templateId 模板ID,获取方法见 https://mp.weixin.qq.com/advanced/tmplmsg * @param openid 公众号用户的openid * @param link 模板消息的链接 * @param params 模板参数 */ public static void sendMsg(String templateId, String openid, String link, TemplateParam ... params) { WxMpTemplateMessage templateMessage = new WxMpTemplateMessage(); templateMessage.setTemplateId(templateId); templateMessage.setToUser(openid); templateMessage.setUrl(link); List<WxMpTemplateData> datas = new ArrayList<WxMpTemplateData>(); if(params != null) { for (TemplateParam param : params) { WxMpTemplateData data = new WxMpTemplateData(); data.setName(param.getK()); data.setValue(param.getV()); datas.add(data); } } templateMessage.setDatas(datas); try { wxMpService.templateSend(templateMessage); } catch (WxErrorException e) { throw new RuntimeException(e.getMessage(),e); } } /** * 获取用户列表(一次拉取调用最多拉取10000) * @param nextOpenid * @return */ public static List<String> openids(String nextOpenid){ try { WxMpUserList userList = wxMpService.userList(nextOpenid); return userList.getOpenIds(); } catch (WxErrorException e) { throw new RuntimeException(e.getMessage(),e); } } public static WxMpUser userDetail(String openid) { try { WxMpUser userInfo = wxMpService.userInfo(openid, "zh_CN"); return userInfo; } catch (WxErrorException e) { throw new RuntimeException(e.getMessage(),e); } } }
public class TemplateParam { private String k; private String v; public TemplateParam() { } public TemplateParam(String k, String v) { this.k = k; this.v = v; } public String getK() { return k; } public void setK(String k) { this.k = k; } public String getV() { return v; } public void setV(String v) { this.v = v; } }
import java.io.IOException; import java.util.Properties; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Bean; import org.springframework.core.env.Environment; import org.springframework.core.io.ClassPathResource; import org.springframework.stereotype.Component; /** * WechatProperties * @author zxg * @date 2023 */ @Component public class WechatProperties { public static String wechatAppid; public static String wechatSecret; @Autowired public void setWechatAppid(@Value("#{wechat['wechat.appId']}") String wechatAppid) { WechatProperties.wechatAppid = wechatAppid; } @Autowired public void setWechatSecret(@Value("#{wechat['wechat.secret']}") String wechatSecret) { WechatProperties.wechatSecret = wechatSecret; } @Bean(name = "wechat") public Properties getProperties(ApplicationContext ac) { Properties properties = new Properties(); try { ClassPathResource res = new ClassPathResource("wechat.properties"); if(res.exists()) { properties.load(res.getInputStream()); }else { Environment env = ac.getEnvironment(); properties.put("wechat.appId", env.getProperty("wechat.appId")); properties.put("wechat.secret", env.getProperty("wechat.secret")); properties.put("wechat.accessToken", env.getProperty("wechat.accessToken")); } } catch (IOException e) { throw new RuntimeException("failed for loading file", e); } return properties; } }
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <context:component-scan base-package="xxx.mgt.wechat"></context:component-scan> <bean class="xxx.mgt.wechat.WechatManager"> <property name="wxMpService" ref="wxMpServiceImpl"></property> </bean> <bean id="wxMpServiceImpl" class="me.chanjar.weixin.mp.api.WxMpServiceImpl"> <property name="wxMpConfigStorage" ref="wxMpInMemoryConfigStorage"></property> <property name="maxRetryTimes" value="5"></property> <property name="retrySleepMillis" value="1000"></property> </bean> <bean id="wxMpInMemoryConfigStorage" class="me.chanjar.weixin.mp.api.WxMpInMemoryConfigStorage"> <property name="appId" value="#{wechat['wechat.appId']}"></property> <property name="secret" value="#{wechat['wechat.secret']}"></property> <property name="accessToken" value="#{wechat['wechat.accessToken']}"></property> </bean> </beans>
import java.util.Date; import java.util.List; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; import xxx.bas.util.DateUtils; import xxx.mgt.wechat.common.TemplateParam; import me.chanjar.weixin.mp.bean.result.WxMpUser; @ContextConfiguration(locations = {"classpath:spring/root/public-wechat.xml"}) @RunWith(SpringJUnit4ClassRunner.class) public class WechatManagerTest { //{{first.DATA}} //工单号:{{keyword1.DATA}} //当前状态:{{keyword2.DATA}} //{{remark.DATA}} @Test public void testSendMsg() { WechatManager.sendMsg("TzGhmOuwcllTdWhUwJxxx", "oENl8wGkZ3a6N_xxx", null, new TemplateParam("first", "标题123"), new TemplateParam("keyword1", "wo123123123"), new TemplateParam("keyword2", "已完成"), new TemplateParam("remark", "无链接") ); } @Test public void testOpenids() { List<String> openids = WechatManager.openids(null); for (String openid : openids) { WxMpUser userDetail = WechatManager.userDetail(openid); System.out.println(DateUtils.nullFormat(new Date(userDetail.getSubscribeTime()*1000L))); System.out.println(userDetail.getOpenId()); } } public static void main(String[] args) { System.out.println(DateUtils.nullFormat(new Date(1646990861L*1000L))); } }
wechat.properties
wechat.appId = wxda75xxxx wechat.secret = 00b8ae06cc0xxxxxx
效果:
补充:模板消息的模板ID如何获取?
答:进入公众号管理后台 -> 广告与服务 -> 模板消息 ,根据自己公众号所在行业筛选合适的模板消息,使用后进入到我的模板消息,可以查看id和模板内容
日志:
14:27:01.003 [main] DEBUG org.apache.http.client.protocol.RequestAddCookies - CookieSpec selected: default 14:27:01.003 [main] DEBUG org.apache.http.client.protocol.RequestAuthCache - Auth cache not set in the context 14:27:01.003 [main] DEBUG org.apache.http.impl.conn.PoolingHttpClientConnectionManager - Connection request: [route: {s}->https://api.weixin.qq.com:443][total kept alive: 1; route allocated: 1 of 2; total allocated: 1 of 20] 14:27:01.003 [main] DEBUG org.apache.http.impl.conn.PoolingHttpClientConnectionManager - Connection leased: [id: 0][route: {s}->https://api.weixin.qq.com:443][total kept alive: 0; route allocated: 1 of 2; total allocated: 1 of 20] 14:27:01.003 [main] DEBUG org.apache.http.impl.conn.DefaultManagedHttpClientConnection - http-outgoing-0: set socket timeout to 0 14:27:01.003 [main] DEBUG org.apache.http.impl.execchain.MainClientExec - Executing request GET /cgi-bin/user/info?access_token=66_V9dpu5k7cbIy-BuYLr6jrktrMo__55Hgu0S0fnTf-lCJCIsH2ayoYufgebiQm1zdHaikUGzthUdyhWm3vivVMOXzr6kNbpWBeeuxxxx&openid=oENl8wGkZ3a6N_YUAyxxx&lang=zh_CN HTTP/1.1 14:27:01.003 [main] DEBUG org.apache.http.impl.execchain.MainClientExec - Target auth state: UNCHALLENGED 14:27:01.003 [main] DEBUG org.apache.http.impl.execchain.MainClientExec - Proxy auth state: UNCHALLENGED 14:27:01.003 [main] DEBUG org.apache.http.headers - http-outgoing-0 >> GET /cgi-bin/user/info?access_token=66_V9dpu5k7cbIy-BuYLr6jrktrMo__55Hgu0S0fnTf-lCJCIsH2ayoYufgebiQm1zdHaikUGzthUdyhWm3vivVMOXzr6kNbpWBeeuxxxx&openid=oENl8wGkZ3a6N_YUAyxxx&lang=zh_CN HTTP/1.1 14:27:01.003 [main] DEBUG org.apache.http.headers - http-outgoing-0 >> Host: api.weixin.qq.com 14:27:01.003 [main] DEBUG org.apache.http.headers - http-outgoing-0 >> Connection: Keep-Alive 14:27:01.003 [main] DEBUG org.apache.http.headers - http-outgoing-0 >> User-Agent: Apache-HttpClient/4.5.8 (Java/1.8.0_191) 14:27:01.003 [main] DEBUG org.apache.http.headers - http-outgoing-0 >> Accept-Encoding: gzip,deflate 14:27:01.003 [main] DEBUG org.apache.http.wire - http-outgoing-0 >> "GET /cgi-bin/user/info?access_token=66_V9dpu5k7cbIy-BuYLr6jrktrMo__55Hgu0S0fnTf-lCJCIsH2ayoYufgebiQm1zdHaikUGzthUdyhWm3vivVMOXzr6kNbpWBeeuxxxx&openid=oENl8wGkZ3a6N_YUAyxxx&lang=zh_CN HTTP/1.1[\r][\n]" 14:27:01.003 [main] DEBUG org.apache.http.wire - http-outgoing-0 >> "Host: api.weixin.qq.com[\r][\n]" 14:27:01.003 [main] DEBUG org.apache.http.wire - http-outgoing-0 >> "Connection: Keep-Alive[\r][\n]" 14:27:01.003 [main] DEBUG org.apache.http.wire - http-outgoing-0 >> "User-Agent: Apache-HttpClient/4.5.8 (Java/1.8.0_191)[\r][\n]" 14:27:01.003 [main] DEBUG org.apache.http.wire - http-outgoing-0 >> "Accept-Encoding: gzip,deflate[\r][\n]" 14:27:01.003 [main] DEBUG org.apache.http.wire - http-outgoing-0 >> "[\r][\n]" 14:27:01.152 [main] DEBUG org.apache.http.wire - http-outgoing-0 << "HTTP/1.1 200 OK[\r][\n]" 14:27:01.152 [main] DEBUG org.apache.http.wire - http-outgoing-0 << "Connection: keep-alive[\r][\n]" 14:27:01.152 [main] DEBUG org.apache.http.wire - http-outgoing-0 << "Content-Type: application/json; encoding=utf-8[\r][\n]" 14:27:01.152 [main] DEBUG org.apache.http.wire - http-outgoing-0 << "Date: Fri, 03 Mar 2023 06:27:00 GMT[\r][\n]" 14:27:01.152 [main] DEBUG org.apache.http.wire - http-outgoing-0 << "Content-Length: 285[\r][\n]" 14:27:01.152 [main] DEBUG org.apache.http.wire - http-outgoing-0 << "[\r][\n]" 14:27:01.152 [main] DEBUG org.apache.http.wire - http-outgoing-0 << "{"subscribe":1,"openid":"oENl8wGkZ3a6N_YUAyxxx","nickname":"","sex":0,"language":"zh_CN","city":"","province":"","country":"","headimgurl":"","subscribe_time":1677824799,"remark":"","groupid":0,"tagid_list":[],"subscribe_scene":"ADD_SCENE_SEARCH","qr_scene":0,"qr_scene_str":""}" 14:27:01.152 [main] DEBUG org.apache.http.headers - http-outgoing-0 << HTTP/1.1 200 OK 14:27:01.152 [main] DEBUG org.apache.http.headers - http-outgoing-0 << Connection: keep-alive 14:27:01.152 [main] DEBUG org.apache.http.headers - http-outgoing-0 << Content-Type: application/json; encoding=utf-8 14:27:01.152 [main] DEBUG org.apache.http.headers - http-outgoing-0 << Date: Fri, 03 Mar 2023 06:27:00 GMT 14:27:01.152 [main] DEBUG org.apache.http.headers - http-outgoing-0 << Content-Length: 285 14:27:01.152 [main] DEBUG org.apache.http.impl.execchain.MainClientExec - Connection can be kept alive indefinitely 14:27:01.153 [main] DEBUG org.apache.http.impl.conn.PoolingHttpClientConnectionManager - Connection [id: 0][route: {s}->https://api.weixin.qq.com:443] can be kept alive indefinitely 14:27:01.153 [main] DEBUG org.apache.http.impl.conn.DefaultManagedHttpClientConnection - http-outgoing-0: set socket timeout to 0 14:27:01.153 [main] DEBUG org.apache.http.impl.conn.PoolingHttpClientConnectionManager - Connection released: [id: 0][route: {s}->https://api.weixin.qq.com:443][total kept alive: 1; route allocated: 1 of 2; total allocated: 1 of 20]