当前位置:   article > 正文

微信公众号开发-Java版学习笔记_微信公众号java开发教程

微信公众号java开发教程

微信公众号开发整体不难,主要是熟悉微信公众号常用的一些接口文档,然后会一门后端语言(比如java)即可。

罗召勇老师教程:微信公众号开发-Java版(蓝桥罗召勇)

微信公众号文档:微信公众号官方文档

1 微信公众号介绍


账号分为服务号、订阅号、小程序

服务号和订阅号开发类似,但是申请服务号必须是企业,所以学习的话申请一个订阅号+测试账号即可。为啥要申请测试账号呢?因为订阅号的接口功能有限,为了学习开发以及熟悉更多的接口,所以还需要申请一个测试号。

2 注册订阅号


第一步:访问:https://mp.weixin.qq.com/ 点击立即注册按钮

第二步:注册类型页面选择订阅号

第三步:填写相关信息,点击注册即可

3 注册测试号


因为订阅号的接口权限是有限的,为了熟悉更多的微信公众号接口,所以需要申请一个测试号。

第一步:用注册的订阅号登录

第二步:在目录中【设置与开发】—>【开发者工具】下选择公众平台测试账号,点击进入后申请即可。

申请成功之后,就可以配置相关信息进行开发了,具体怎么配置后面再解释

4 程序运行流程


用户在公众号发送请求到微信服务器

微信服务器将请求转发到我们自己的服务器

我们自己的服务器处理完之后再把结果发送到微信服务器

最后微信服务器再把结果响应给客户

5 搭建开发环境


罗老师用的是eclipse并且没有用maven环境,我用的是eclipse+maven+jdk7+tomcat8.0。maven的话可以兼容idea,而且下载依赖方便。

新建一个名为wx的maven项目(这个项目名字任意都行),pom.xml的依赖如下:

  1. <dependencies>
  2. <dependency>
  3. <groupId>junit</groupId>
  4. <artifactId>junit</artifactId>
  5. <version>4.12</version>
  6. <scope>test</scope>
  7. </dependency>
  8. <!-- 阿里云小蜜-自动回复机器人 -->
  9. <dependency>
  10. <groupId>com.aliyun</groupId>
  11. <artifactId>aliyun-java-sdk-chatbot</artifactId>
  12. <version>1.0.0</version>
  13. </dependency>
  14. <dependency>
  15. <groupId>com.aliyun</groupId>
  16. <artifactId>aliyun-java-sdk-core</artifactId>
  17. <version>4.5.2</version>
  18. </dependency>
  19. <!-- xml操作相关依赖 -->
  20. <dependency>
  21. <groupId>com.thoughtworks.xstream</groupId>
  22. <artifactId>xstream</artifactId>
  23. <version>1.4.11.1</version>
  24. </dependency>
  25. <dependency>
  26. <groupId>org.dom4j</groupId>
  27. <artifactId>dom4j</artifactId>
  28. <version>2.0.0</version>
  29. </dependency>
  30. <!-- 阿里json解析 -->
  31. <dependency>
  32. <groupId>com.alibaba</groupId>
  33. <artifactId>fastjson</artifactId>
  34. <version>1.2.28</version>
  35. </dependency>
  36. <!-- 这个是编码解码的 -->
  37. <dependency>
  38. <groupId>commons-codec</groupId>
  39. <artifactId>commons-codec</artifactId>
  40. <version>1.10</version>
  41. </dependency>
  42. </dependencies>

编写一个测试的servlet

  1. import java.io.IOException;
  2. import javax.servlet.ServletException;
  3. import javax.servlet.annotation.WebServlet;
  4. import javax.servlet.http.HttpServlet;
  5. import javax.servlet.http.HttpServletRequest;
  6. import javax.servlet.http.HttpServletResponse;
  7. @WebServlet("/test")
  8. public class TestServlet extends HttpServlet{
  9. @Override
  10. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  11. System.out.println("请求到达了");
  12. resp.getWriter().write("hello weixin");
  13. }
  14. @Override
  15. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  16. }
  17. }

启动项目访问:http://localhost:8080/wx/test

浏览器看到如下效果说明搭建成功

6 内外网穿透


外网默认是访问不到自己电脑上的项目的,为了让外网能够访问,所以需要做内外网穿透.这个不需要自己实现,可以借助一些工具,如花生壳、ngrok.这里用的是ngrok.

ngrok文档

第一步:访问ngrok官网,注册ngrok账号。

第二步:使用注册的账号登录

第三步:【隧道管理—>开通隧道】立即购买,可以购买最后那个免费的,也可以花10块钱买一个。免费的有时候不稳定,可以买一个10块。

开通之后在隧道管理下就可以看到刚刚开通的隧道

第四步:下载客户端工具,我电脑是windows的所以下载windows版

各版本工具下载地址:https://www.ngrok.cc/download.html

第五步:启动ngrok客户端工具,运行bat,输入隧道id,回车

看到下面这个状态为【online】表示启动成功

然后就可以通过http://heliufang.vipgz4.idcfengye.com这个域名访问本地8080端口上的项目了,比如访问之前搭建的wx项目

7 开发接入


接入之后微信服务器和我们自己的项目就接通了。那么如何接入呢?

接入的官方文档

上图中的url就是自己电脑的项目

点击上图的提交按钮之后,微信会向上图中的url发送一个get请求,请求参数如下:

参数

描述

signature

微信加密签名,signature结合了开发者填写的token参数和请求中的timestamp参数、nonce参数。

timestamp

时间戳

nonce

随机数

echostr

随机字符串

  • 第二步:编写代码校验,用代码实现下面的逻辑

1)将token、timestamp、nonce三个参数进行字典序排序

2)将三个参数字符串拼接成一个字符串进行sha1加密

3)开发者获得加密后的字符串可与signature对比,标识该请求来源于微信,如果比对成功,请原样返回echostr参数内容

在之前搭建的名为wx的项目中新建一个【WxServlet.java】

  1. import java.io.IOException;
  2. import java.io.PrintWriter;
  3. import javax.servlet.ServletException;
  4. import javax.servlet.annotation.WebServlet;
  5. import javax.servlet.http.HttpServlet;
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  8. import com.qy.service.WxService;
  9. @WebServlet("/api")
  10. public class WxServlet extends HttpServlet{
  11. @Override
  12. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  13. System.out.println("请求到达了");
  14. //取出微信服务器传过来的参数
  15. String signature = req.getParameter("signature");
  16. String timestamp = req.getParameter("timestamp");
  17. String nonce = req.getParameter("nonce");
  18. String echostr = req.getParameter("echostr");
  19. //自定义一个check方法用来校验接入
  20. boolean success = WxService.check(timestamp, nonce, signature);
  21. if(success){
  22. System.out.println("接入成功");
  23. PrintWriter writer = resp.getWriter();
  24. writer.write(echostr);//接入成功需要原样返回echostr
  25. }else{
  26. System.out.println("接入失败");
  27. }
  28. }
  29. @Override
  30. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  31. }
  32. }

新建一个【WxService.java】并添加一个check工具方法

  1. import java.util.Arrays;
  2. import org.apache.commons.codec.digest.DigestUtils;
  3. public class WxService {
  4. public static final String TOKEN = "hlf";//在微信配置界面自定义的token
  5. /**
  6. * 接入校验
  7. * @param timestamp
  8. * @param nonce
  9. * @param signature
  10. * @return
  11. */
  12. public static boolean check(String timestamp, String nonce, String signature) {
  13. //1.将token、timestamp、nonce三个参数进行字典序排序
  14. String[] arr = new String[]{TOKEN,timestamp,nonce};
  15. Arrays.sort(arr);
  16. //2.将三个参数字符串拼接成一个字符串进行sha1加密 https://www.cnblogs.com/2333/p/6405386.html
  17. String str = arr[0]+arr[1]+arr[2];
  18. str = DigestUtils.sha1Hex(str);//sha1加密,这里没有像罗老师那样手写,直接用的commons-codec包的工具类
  19. System.out.println("str:"+str);
  20. //3.将加密后的字符串和signature比较
  21. System.out.println(signature);
  22. return str.equalsIgnoreCase(signature);
  23. }
  24. }

启动项目,点击提交按钮,出现下面这个代表接入成功。

8 接收用户消息


官方文档:接受普通消息

当普通微信用户向公众账号发消息时,微信服务器将POST消息的XML数据包到开发者填写的URL上。

也就是说用户发消息给微信服务器,微信服务器会发送post请求到我们自己的服务器,并且传送一个xml的数据给我们自己的服务器。

例如文本消息是这样的

  1. <xml>
  2. <ToUserName><![CDATA[toUser]]></ToUserName>
  3. <FromUserName><![CDATA[fromUser]]></FromUserName>
  4. <CreateTime>1348831860</CreateTime>
  5. <MsgType><![CDATA[text]]></MsgType>
  6. <Content><![CDATA[this is a test]]></Content>
  7. <MsgId>1234567890123456</MsgId>
  8. </xml>

参数

描述

ToUserName

开发者微信号

FromUserName

发送方帐号(一个OpenID)

CreateTime

消息创建时间 (整型)

MsgType

消息类型,文本为text

Content

文本消息内容

MsgId

消息id,64位整型

java中这样的数据读取并不方便。可以转换一下,先通过dom4j这个包转成dom对象,再把标签名和对应的标签的值保存到HashMap集合中,这样后面处理数据就很方便了,具体代码实现如下:

在【WxServlet】中编写doPost方法,在测试号管理界面,扫码关注测试公众号

  1. @Override
  2. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  3. Map<String,String> map = WxService.parseRequest(req.getInputStream());
  4. System.out.println(map);//关注测试号,给测试公众号发消息,就可以看到打印结果了
  5. }

在【WxService】中添加parseRequest方法

  1. /**
  2. * 将接受到的消息转化成map
  3. * @param req
  4. * @return
  5. */
  6. public static Map<String, String> parseRequest(InputStream is) {
  7. Map<String,String> map = new HashMap<String,String>();
  8. //1.通过io流得到文档对象
  9. SAXReader saxReader = new SAXReader();
  10. Document document = null;
  11. try {
  12. document = saxReader.read(is);
  13. } catch (DocumentException e) {
  14. e.printStackTrace();
  15. }
  16. //2.通过文档对象得到根节点对象
  17. Element root = document.getRootElement();
  18. //3.通过根节点对象获取所有子节点对象
  19. List<Element> elements = root.elements();
  20. //4.将所有节点放入map
  21. for (Element element : elements) {
  22. map.put(element.getName(), element.getStringValue());
  23. }
  24. return map;
  25. }

9 回复用户消息封装


官方文档:被动回复用户消息

当用户发送消息给公众号时(或某些特定的用户操作引发的事件推送时),会产生一个POST请求,开发者可以在响应包(Get)中返回特定XML结构,来对该消息进行响应(现支持回复文本、图片、图文、语音、视频、音乐)。严格来说,发送被动响应消息其实并不是一种接口,而是对微信服务器发过来消息的一次回复。
一旦遇到以下情况,微信都会在公众号会话中,向用户下发系统提示“该公众号暂时无法提供服务,请稍后再试”:
1、开发者在5秒内未回复任何内容 2、开发者回复了异常数据,比如JSON数据等

上面这段文字来自官方,可以看出

  • 回复必须是xml的类型

  • 可以回复多种类型的xml(文本、图片、图文、语音、视频、音乐)

  • 接收到消息没有做出响应就会抛出:该公众号暂时无法提供服务,请稍后再试

9.1 回复消息入门demo

这个demo就是给用户回复一个文本消息

回复的xml格式如下:

  1. <xml>
  2. <ToUserName><![CDATA[toUser]]></ToUserName>
  3. <FromUserName><![CDATA[fromUser]]></FromUserName>
  4. <CreateTime>12345678</CreateTime>
  5. <MsgType><![CDATA[text]]></MsgType>
  6. <Content><![CDATA[你好]]></Content>
  7. </xml>

参数

是否必须

描述

ToUserName

接收方帐号(收到的OpenID)

FromUserName

开发者微信号

CreateTime

消息创建时间 (整型)

MsgType

消息类型,文本为text

Content

回复的消息内容(换行:在content中能够换行,微信客户端就支持换行显示)

在wxservlet中doPost编写如下代码

  1. @Override
  2. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  3. //设置编码格式,不然中文会乱码
  4. req.setCharacterEncoding("UTF-8");
  5. resp.setCharacterEncoding("UTF-8");
  6. //将请求中的xml参数转成map
  7. Map<String,String> map = WxService.parseRequest(req.getInputStream());
  8. System.out.println(map);
  9. //回复消息
  10. String textMsg = "<xml><ToUserName><![CDATA["+map.get("FromUserName")+"]]></ToUserName><FromUserName><![CDATA["+map.get("ToUserName")+"]]></FromUserName><CreateTime>12345678</CreateTime><MsgType><![CDATA[text]]></MsgType><Content><![CDATA[你好]]></Content></xml>";
  11. resp.getWriter().print(textMsg);
  12. }

然后用测试号发消息,公众号都会回复一个 【你好】

这样写代码功能是可以实现,但是这样拼接字符串,再回复消息很不方便.然后自然就想到可以用java类来封装消息,响应的时候将java类转成xml(通过xstream这个工具包实现)。下面就以文本消息和图文消息为例进行封装,其它消息类似。

9.2 基础消息类的封装

把公共的属性放到基础消息类中,然后其它消息类继承即可。

@XStreamAlias 这个注解配置的就是转成xml时对应的节点名字

  1. public class BaseMsg {
  2. @XStreamAlias("ToUserName")
  3. private String toUserName;//接收方的账号(收到的openid)
  4. @XStreamAlias("FromUserName")
  5. private String fromUserName;//开发者的微信号
  6. @XStreamAlias("CreateTime")
  7. private String createTime;//消息创建时间
  8. @XStreamAlias("MsgType")
  9. private String msgType;//消息类型
  10. public BaseMsg(Map<String,String> requestMap) {
  11. super();
  12. this.toUserName = requestMap.get("FromUserName");
  13. this.fromUserName = requestMap.get("ToUserName");
  14. this.createTime = requestMap.get("CreateTime");
  15. }
  16. //get and set ...
  17. }

9.3 文本消息类封装

回复的xml的格式说明可以参考9.1入门demo.回复文本的封装类如下:

  1. @XStreamAlias("xml") //xml指的就是xml这个根节点名称
  2. public class TextMsg extends BaseMsg {
  3. @XStreamAlias("Content")
  4. private String content;//回复的文本内容
  5. public TextMsg(Map<String,String> requestMap,String content) {
  6. super(requestMap);
  7. this.setMsgType("text");
  8. this.content = content;
  9. }
  10. //get and set ...
  11. }

9.4 图文消息封装

图文消息格式说明

  1. <xml>
  2. <ToUserName><![CDATA[toUser]]></ToUserName>
  3. <FromUserName><![CDATA[fromUser]]></FromUserName>
  4. <CreateTime>12345678</CreateTime>
  5. <MsgType><![CDATA[news]]></MsgType>
  6. <ArticleCount>1</ArticleCount>
  7. <Articles>
  8. <item>
  9. <Title><![CDATA[title1]]></Title>
  10. <Description><![CDATA[description1]]></Description>
  11. <PicUrl><![CDATA[picurl]]></PicUrl>
  12. <Url><![CDATA[url]]></Url>
  13. </item>
  14. </Articles>
  15. </xml>

参数

是否必须

说明

ToUserName

接收方帐号(收到的OpenID)

FromUserName

开发者微信号

CreateTime

消息创建时间 (整型)

MsgType

消息类型,图文为news

ArticleCount

图文消息个数;当用户发送文本、图片、语音、视频、图文、地理位置这六种消息时,开发者只能回复1条图文消息;其余场景最多可回复8条图文消息

Articles

图文消息信息,注意,如果图文数超过限制,则将只发限制内的条数

Title

图文消息标题

Description

图文消息描述

PicUrl

图片链接,支持JPG、PNG格式,较好的效果为大图360200,小图200200

Url

点击图文消息跳转链接

首先封装一个article类,对应就是xml中的item这个节点

  1. @XStreamAlias("item")//映射到xml中的item这个节点
  2. public class Article {
  3. @XStreamAlias("Title")
  4. private String title;//图文消息标题
  5. @XStreamAlias("Description")
  6. private String description;//图文消息描述
  7. @XStreamAlias("PicUrl")
  8. private String picUrl;//图片链接
  9. @XStreamAlias("Url")
  10. private String url;//点击图文消息跳转链接
  11. //get and set ...
  12. }

然后再封装一个图文消息类

  1. @XStreamAlias("xml")
  2. public class NewsMsg extends BaseMsg {
  3. @XStreamAlias("ArticleCount")
  4. private String articleCount;//图文消息个数
  5. @XStreamAlias("Articles")
  6. private List<Article> articles;
  7. public NewsMsg(Map<String, String> requestMap,List<Article> articles) {
  8. super(requestMap);
  9. this.setMsgType("news");
  10. this.articles = articles;
  11. this.setArticleCount(this.articles.size()+"");
  12. }
  13. //get and set ...
  14. }

9.5 测试

前面已经将基础消息和图文消息封装好了,现在用封装好的消息类来回复

第一步:将wxservlet的doPost方法改成如下

  1. @Override
  2. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  3. //设置编码格式,不然中文会乱码
  4. req.setCharacterEncoding("UTF-8");
  5. resp.setCharacterEncoding("UTF-8");
  6. //将请求中的xml参数转成map
  7. Map<String,String> map = WxService.parseRequest(req.getInputStream());
  8. System.out.println(map);
  9. //处理完将响应一个xml给微信
  10. String respXml = WxService.getRespose(map);
  11. System.out.println(respXml);
  12. resp.getWriter().print(respXml);
  13. }

第二步:WxService添加如下方法:

  1. /**
  2. * 事件消息回复
  3. */
  4. public static String getRespose(Map<String, String> requestMap) {
  5. BaseMsg msg = null;
  6. // 根据用户发送消息的类型,做不同的处理
  7. String msgType = requestMap.get("MsgType");
  8. switch (msgType) {
  9. case "text":
  10. msg = dealTextMsg(requestMap);
  11. break;
  12. case "news":
  13. break;
  14. default:
  15. break;
  16. }
  17. // System.out.println(msg);
  18. // 将处理结果转化成xml的字符串返回
  19. if (null != msg) {
  20. return beanToXml(msg);
  21. }
  22. return null;
  23. }
  24. /**
  25. * 将回复的消息类转成xml字符串
  26. *
  27. * @param msg
  28. * @return
  29. */
  30. public static String beanToXml(BaseMsg msg) {
  31. XStream stream = new XStream();
  32. stream.processAnnotations(TextMsg.class);
  33. stream.processAnnotations(NewsMsg.class);
  34. String xml = stream.toXML(msg);
  35. return xml;
  36. }
  37. /**
  38. * 当用户发送是文本消息的处理逻辑
  39. *
  40. * @param map
  41. * @return
  42. */
  43. private static BaseMsg dealTextMsg(Map<String, String> requestMap) {
  44. // 获取用户发送的消息内容
  45. String msg = requestMap.get("Content");
  46. // 如果是图文回复一个图文消息
  47. if (msg.equals("图文")) {
  48. List<Article> articles = new ArrayList<Article>();
  49. articles.add(new Article("码云博客", "这个是我个人的码云博客,基于hexo搭建,里面的文章都是使用markdown编写",
  50. "https://heliufang.gitee.io/uploads/banner.jpg", "https://heliufang.gitee.io/"));
  51. return new NewsMsg(requestMap, articles);
  52. }
  53. //否则回复一个文本消息,文本内容为'当前时间+你好'
  54. //当然这个内容可以自定义,在这里也可以接入自动回复机器人
  55. TextMsg textMsg = new TextMsg(requestMap, new Date(System.currentTimeMillis()).toLocaleString() + "你好");
  56. return textMsg;
  57. }

然后分别给公众号发一个1和图文

9.6 自动回复机器人

罗老师教程中的图灵机器人已经要收费.我使用的是阿里云的阿里云小蜜这个机器人来做的回复.

阿里云小蜜机器人可以免费体验三个月。

具体代码可以查看阿里云小蜜的文档:阿里云产品服务协议(云小蜜)

10 ★access token的获取


access_token是公众号的全局唯一接口调用凭据,公众号调用各接口时都需使用access_token。开发者需要进行妥善保存.access_token的有效期目前为2个小时,需定时刷新,重复获取将导致上次获取的access_token失效

access token文档

目前access_token的有效期通过返回的expire_in来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新access_token

总结:调用很多接口需要access_token,获取access_token之后需要保存起来,过期了再重新获取,而不是每次都重新获取。

接口调用请求说明

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

参数说明

参数

是否必须

说明

grant_type

获取access_token填写client_credential

appid

第三方用户唯一凭证

secret

第三方用户唯一凭证密钥,即appsecret

返回说明

正常情况下,微信会返回下述JSON数据包给公众号:

{"access_token":"ACCESS_TOKEN","expires_in":7200}

参数说明

参数

说明

access_token

获取到的凭证

expires_in

凭证有效时间,单位:秒

10.1 ★封装请求工具类

因为需要发送请求给微信服务器,所以需要有请求的工具类。罗老师用的是java自带的请求类,相对来说比较繁琐。所以我这里采用的是Apache HttpClient,这个用起来更加的简单。

第一步:pom.xml中导入依赖

  1. <!--httpClient需要的依赖-->
  2. <dependency>
  3. <groupId>org.apache.httpcomponents</groupId>
  4. <artifactId>httpclient</artifactId>
  5. <version>4.5.2</version>
  6. </dependency>
  7. <!--//httpclient缓存-->
  8. <dependency>
  9. <groupId>org.apache.httpcomponents</groupId>
  10. <artifactId>httpclient-cache</artifactId>
  11. <version>4.5</version>
  12. </dependency>
  13. <!--//http的mime类型都在这里面-->
  14. <dependency>
  15. <groupId>org.apache.httpcomponents</groupId>
  16. <artifactId>httpmime</artifactId>
  17. <version>4.3.2</version>
  18. </dependency>

第二步:基于Apache HttpClient封装HttpUtils工具类,我封装了4个方法,可以支持get请求和post请求。后面很多需要用的地方直接调用即可。

可以参考这个博客:HttpClient发送get/post请求

  1. public class HttpUtils {
  2. public static void main(String[] args) {
  3. // 1.测试get请求
  4. /*
  5. String getUrl = "http://localhost:8080/user/searchPage?pageNum=1&pageSize=2";
  6. System.out.println(sendGet(getUrl));
  7. */
  8. // 2.测试post请求 携带x-www-form-urlencoded数据格式
  9. /*String postUrlForm = "http://localhost:8080/user";
  10. Map paramMap = new HashMap();
  11. paramMap.put("name", "杰克");
  12. paramMap.put("age", "20");
  13. paramMap.put("gender", "1");
  14. System.out.println(sendPost(postUrlForm, paramMap));*/
  15. //3.测试post请求 携带json数据格式
  16. /*String postUrlJson = "http://localhost:8080/user";
  17. String jsonParam = "{\"name\":\"jack\",\"age\":\"18\",\"gender\":\"2\"}";
  18. System.out.println(sendPost(postUrlJson,jsonParam));*/
  19. //4 测试post 携带文件
  20. String postUrlFile = "http://localhost:8080/user/upload";
  21. Map paramMap = new HashMap();
  22. paramMap.put("name", "tom");
  23. String localFile = "d:\\logo.png";
  24. String fileParamName = "file";
  25. System.out.println(sendPost(postUrlFile, paramMap,localFile,fileParamName));
  26. }
  27. // 1.httpClient发送get请求
  28. public static String sendGet(String url) {
  29. String result = "";
  30. CloseableHttpResponse response = null;
  31. try {
  32. // 根据地址获取请求
  33. HttpGet request = new HttpGet(url);// 这里发送get请求
  34. // 获取当前客户端对象
  35. CloseableHttpClient httpClient = HttpClients.createDefault();
  36. // 通过请求对象获取响应对象
  37. response = httpClient.execute(request);
  38. // 判断网络连接状态码是否正常(0--200都数正常)
  39. if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
  40. result = EntityUtils.toString(response.getEntity(), "utf-8");
  41. }
  42. } catch (Exception e) {
  43. e.printStackTrace();
  44. } finally {
  45. if (null != response) {
  46. try {
  47. response.close();
  48. } catch (IOException e) {
  49. e.printStackTrace();
  50. }
  51. }
  52. }
  53. return result;
  54. }
  55. // 2.httpClient发送post请求 携带x-www-form-urlencoded数据格式
  56. public static String sendPost(String url, Map<String, String> map) {
  57. CloseableHttpResponse httpResponse = null;
  58. String result = "";
  59. try {
  60. // 1、创建一个httpClient客户端对象
  61. CloseableHttpClient httpClient = HttpClients.createDefault();
  62. // 2、创建一个HttpPost请求
  63. HttpPost httpPost = new HttpPost(url);
  64. // 设置请求头
  65. httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded"); // 设置传输的数据格式
  66. // 携带普通的参数params的方式
  67. List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
  68. Set<String> keys = map.keySet();
  69. for (String key : keys) {
  70. params.add(new BasicNameValuePair(key, map.get(key)));
  71. }
  72. String str = EntityUtils.toString(new UrlEncodedFormEntity(params, Consts.UTF_8));
  73. // 这里就是:username=kylin&password=123456
  74. System.out.println(str);
  75. // 放参数进post请求里面 从名字可以知道 这个类是专门处理x-www-form-urlencoded 添加参数的
  76. httpPost.setEntity(new UrlEncodedFormEntity(params, "UTF-8"));
  77. // 7、执行post请求操作,并拿到结果
  78. httpResponse = httpClient.execute(httpPost);
  79. // 获取结果实体
  80. HttpEntity entity = httpResponse.getEntity();
  81. if (entity != null) {
  82. result = EntityUtils.toString(entity, "UTF-8");
  83. } else {
  84. EntityUtils.consume(entity); 如果entity为空,那么直接消化掉即可
  85. }
  86. } catch (Exception e) {
  87. e.printStackTrace();
  88. } finally {
  89. if (null != httpResponse) {
  90. try {
  91. httpResponse.close();
  92. } catch (IOException e) {
  93. e.printStackTrace();
  94. }
  95. }
  96. }
  97. return result;
  98. }
  99. // 3.httpClient发送post请求 携带json数据格式
  100. public static String sendPost(String url, String jsonStr) {
  101. CloseableHttpResponse httpResponse = null;
  102. String result = "";
  103. try {
  104. // 1.创建httpClient
  105. CloseableHttpClient httpClient = HttpClients.createDefault();
  106. // 2.创建post请求方式实例
  107. HttpPost httpPost = new HttpPost(url);
  108. // 2.1设置请求头 发送的是json数据格式
  109. httpPost.setHeader("Content-type", "application/json;charset=utf-8");
  110. httpPost.setHeader("Connection", "Close");
  111. // 3.设置参数---设置消息实体 也就是携带的数据
  112. /*
  113. * 比如传递: { "username": "aries", "password": "666666" }
  114. */
  115. //String jsonStr = " {\"username\":\"aries\",\"password\":\"666666\"}";
  116. StringEntity entity = new StringEntity(jsonStr.toString(), Charset.forName("UTF-8"));
  117. entity.setContentEncoding("UTF-8"); // 设置编码格式
  118. // 发送Json格式的数据请求
  119. entity.setContentType("application/json");
  120. // 把请求消息实体塞进去
  121. httpPost.setEntity(entity);
  122. // 4.执行http的post请求
  123. // 4.执行post请求操作,并拿到结果
  124. httpResponse = httpClient.execute(httpPost);
  125. // 获取结果实体
  126. HttpEntity httpEntity = httpResponse.getEntity();
  127. if (httpEntity != null) {
  128. result = EntityUtils.toString(httpEntity, "UTF-8");
  129. } else {
  130. EntityUtils.consume(httpEntity); 如果httpEntity为空,那么直接消化掉即可
  131. }
  132. } catch (Exception e) {
  133. e.printStackTrace();
  134. } finally {
  135. if (null != httpResponse) {
  136. try {
  137. httpResponse.close();
  138. } catch (IOException e) {
  139. e.printStackTrace();
  140. }
  141. }
  142. }
  143. return result;
  144. }
  145. // 4.httpClient发送post请求 携带文件
  146. public static String sendPost(String url, Map<String, String> map,String localFile, String fileParamName) {
  147. HttpPost httpPost = new HttpPost(url);
  148. CloseableHttpClient httpClient = HttpClients.createDefault();
  149. String resultString = "";
  150. CloseableHttpResponse response = null;
  151. try {
  152. // 把文件转换成流对象FileBody
  153. FileBody bin = new FileBody(new File(localFile));
  154. MultipartEntityBuilder builder = MultipartEntityBuilder.create();
  155. // 相当于<input type="file" name="fileParamName"/> 其中fileParamName以传进来的为准
  156. builder.addPart(fileParamName, bin);
  157. // 相当于<input type="text" name="userName" value=userName>
  158. /*builder.addPart("filesFileName",
  159. new StringBody(fileParamName, ContentType.create("text/plain", Consts.UTF_8)));*/
  160. if (map != null) {
  161. for (String key : map.keySet()) {
  162. builder.addPart(key,
  163. new StringBody(map.get(key), ContentType.create("text/plain", Consts.UTF_8)));
  164. }
  165. }
  166. HttpEntity reqEntity = builder.build();
  167. httpPost.setEntity(reqEntity);
  168. // 发起请求 并返回请求的响应
  169. response = httpClient.execute(httpPost, HttpClientContext.create());
  170. resultString = EntityUtils.toString(response.getEntity(), "utf-8");
  171. } catch (Exception e) {
  172. e.printStackTrace();
  173. } finally {
  174. try {
  175. if (response != null)
  176. response.close();
  177. } catch (IOException e) {
  178. e.printStackTrace();
  179. }
  180. }
  181. return resultString;
  182. }
  183. }

10.2 创建AccessToken类

  1. public class AccessToken {
  2. private String token;
  3. private long expiresTime;//过期时间
  4. public AccessToken(String token, String expiresIn) {
  5. super();
  6. this.token = token;
  7. //当前时间+有效期 = 过期时间
  8. this.expiresTime = System.currentTimeMillis()+Integer.parseInt(expiresIn);
  9. }
  10. /**
  11. * 判断token是否过期
  12. * @return
  13. */
  14. public boolean isExpire() {
  15. return System.currentTimeMillis() > expiresTime;
  16. }
  17. //get and set ...
  18. }

10.3 WxService中添加获取AccessToken的方法

  1. private static AccessToken at;//token获取的次数有限,有效期也有限,所以需要保存起来
  2. private static String GET_TOKEN_URL = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET";
  3. //登录测试号管理界面-测试号信息下面可以得到你的APPID和APPSECRET
  4. private static String APPID = "wx7bf783afc5150a5a";
  5. private static String APPSECRET = "8d9930d60717c7aaa0620ad993d984d8";
  6. /**
  7. * 发送get请求获取AccessToken
  8. */
  9. private static void getToken() {
  10. String url = GET_TOKEN_URL.replace("APPID", APPID).replace("APPSECRET", APPSECRET);
  11. String tokenStr = HttpUtils.sendGet(url);//调用工具类发get请求
  12. System.out.println(tokenStr);
  13. JSONObject jsonObject = JSONObject.parseObject(tokenStr);
  14. String token = jsonObject.getString("access_token");
  15. String expiresIn = jsonObject.getString("expires_in");
  16. at = new AccessToken(token, expiresIn);
  17. }
  18. /**
  19. * 获取AccessToken 向外提供
  20. */
  21. public static String getAccessToken() {
  22. //过期了或者没有值再去发送请求获取
  23. if(at == null || at.isExpire()) {
  24. getToken();
  25. }
  26. return at.getToken();
  27. }

编写一个测试类获取AccessToken

  1. import org.junit.Test;
  2. import com.qy.service.WxService;
  3. public class TestToken {
  4. @Test
  5. public void getAccessToken() {
  6. //可以看到下面两次获取的值一致
  7. System.out.println(WxService.getAccessToken());
  8. System.out.println(WxService.getAccessToken());
  9. }
  10. }

11 自定义菜单


自定义菜单文档

请注意:

自定义菜单最多包括3个一级菜单,每个一级菜单最多包含5个二级菜单。

一级菜单最多4个汉字,二级菜单最多8个汉字,多出来的部分将会以“…”代替。

创建自定义菜单后,菜单的刷新策略是,在用户进入公众号会话页或公众号profile页时,如果发现上一次拉取菜单的请求在5分钟以前,就会拉取一下菜单,如果菜单有更新,就会刷新客户端的菜单。测试时可以尝试取消关注公众账号后再次关注,则可以看到创建后的效果。

自定义菜单接口可实现多种类型按钮,如下:

click:点击推事件用户点击click类型按钮后,微信服务器会通过消息接口推送消息类型为event的结构给开发者(参考消息接口指南),并且带上按钮中开发者填写的key值,开发者可以通过自定义的key值与用户进行交互;

view:跳转URL用户点击view类型按钮后,微信客户端将会打开开发者在按钮中填写的网页URL,可与网页授权获取用户基本信息接口结合,获得用户基本信息。

scancode_push:扫码推事件用户点击按钮后,微信客户端将调起扫一扫工具,完成扫码操作后显示扫描结果(如果是URL,将进入URL),且会将扫码的结果传给开发者,开发者可以下发消息。

scancode_waitmsg:扫码推事件且弹出“消息接收中”提示框用户点击按钮后,微信客户端将调起扫一扫工具,完成扫码操作后,将扫码的结果传给开发者,同时收起扫一扫工具,然后弹出“消息接收中”提示框,随后可能会收到开发者下发的消息。

pic_sysphoto:弹出系统拍照发图用户点击按钮后,微信客户端将调起系统相机,完成拍照操作后,会将拍摄的相片发送给开发者,并推送事件给开发者,同时收起系统相机,随后可能会收到开发者下发的消息。

pic_photo_or_album:弹出拍照或者相册发图用户点击按钮后,微信客户端将弹出选择器供用户选择“拍照”或者“从手机相册选择”。用户选择后即走其他两种流程。

pic_weixin:弹出微信相册发图器用户点击按钮后,微信客户端将调起微信相册,完成选择操作后,将选择的相片发送给开发者的服务器,并推送事件给开发者,同时收起相册,随后可能会收到开发者下发的消息。

location_select:弹出地理位置选择器用户点击按钮后,微信客户端将调起地理位置选择工具,完成选择操作后,将选择的地理位置发送给开发者的服务器,同时收起位置选择工具,随后可能会收到开发者下发的消息。

media_id:下发消息(除文本消息)用户点击media_id类型按钮后,微信服务器会将开发者填写的永久素材id对应的素材下发给用户,永久素材类型可以是图片、音频、视频、图文消息。请注意:永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。

view_limited:跳转图文消息URL用户点击view_limited类型按钮后,微信客户端将打开开发者在按钮中填写的永久素材id对应的图文消息URL,永久素材类型只支持图文消息。请注意:永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。

接口调用请求说明

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

url中的ACCESS_TOKEN就是之前获取的,调用这个接口需要带上

请求需携带json参数

  1. {
  2. "button":[
  3. {
  4. "type":"click",
  5. "name":"一级点击",
  6. "key":"1"
  7. },
  8. {
  9. "type":"view",
  10. "name":"个人博客",
  11. "url":"https://heliufang.gitee.io/"
  12. },
  13. {
  14. "name":"有子菜单",
  15. "sub_button":[
  16. {
  17. "type":"click",
  18. "name":"三一点击",
  19. "key":"31"
  20. },
  21. {
  22. "type":"view",
  23. "name":"码云博客",
  24. "url":"https://heliufang.gitee.io/"
  25. },
  26. {
  27. "type":"pic_photo_or_album",
  28. "name":"拍照或发图",
  29. "key":"33"
  30. }
  31. ]
  32. }
  33. ]
  34. }

参数说明

参数

是否必须

说明

button

一级菜单数组,个数应为1~3个

sub_button

二级菜单数组,个数应为1~5个

type

菜单的响应动作类型,view表示网页类型,click表示点击类型,miniprogram表示小程序类型

name

菜单标题,不超过16个字节,子菜单不超过60个字节

key

click等点击类型必须

菜单KEY值,用于消息接口推送,不超过128字节

url

view、miniprogram类型必须

网页 链接,用户点击菜单可打开链接,不超过1024字节。 type为miniprogram时,不支持小程序的老版本客户端将打开本url。

media_id

media_id类型和view_limited类型必须

调用新增永久素材接口返回的合法media_id

appid

miniprogram类型必须

小程序的appid(仅认证公众号可配置)

pagepath

miniprogram类型必须

小程序的页面路径

返回结果

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

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

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

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

和前面xml的类似,我们需要对着请求的json数据封装按钮类,这样后面操作起来就比较方便,而且也方便维护。

11.1 封装菜单类

<1>AbstractButton类

  1. //所有菜单(按钮)的父类
  2. public abstract class AbstractButton {
  3. private String name;//按钮标题
  4. public String getName() {
  5. return this.name;
  6. }
  7. public void setName(final String name) {
  8. this.name = name;
  9. }
  10. public AbstractButton(final String name) {
  11. this.name = name;
  12. }
  13. }

<2>Button类

  1. //一级菜单对象
  2. public class Button {
  3. private List<AbstractButton> button;
  4. public Button() {
  5. this.button = new ArrayList<AbstractButton>();
  6. }
  7. public List<AbstractButton> getButton() {
  8. return this.button;
  9. }
  10. public void setButton(final List<AbstractButton> button) {
  11. this.button = button;
  12. }
  13. }

<3>ClickButton类

  1. //点击类型的菜单
  2. public class ClickButton extends AbstractButton {
  3. private String type;
  4. private String key;
  5. public String getType() {
  6. return this.type;
  7. }
  8. public void setType(final String type) {
  9. this.type = type;
  10. }
  11. public String getKey() {
  12. return this.key;
  13. }
  14. public void setKey(final String key) {
  15. this.key = key;
  16. }
  17. public ClickButton(final String name, final String key) {
  18. super(name);
  19. this.type = "click";//点击类型
  20. this.key = key;
  21. }
  22. }

<4>ViewButton类

  1. //网页类型的菜单
  2. public class ViewButton extends AbstractButton {
  3. private String type;
  4. private String url;
  5. public String getType() {
  6. return this.type;
  7. }
  8. public void setType(final String type) {
  9. this.type = type;
  10. }
  11. public String getUrl() {
  12. return this.url;
  13. }
  14. public void setUrl(final String url) {
  15. this.url = url;
  16. }
  17. public ViewButton(final String name, final String url) {
  18. super(name);
  19. this.type = "view";//网页类型
  20. this.url = url;
  21. }
  22. }

<5> PhotoOrAlbumButton

  1. //拍照或传图菜单
  2. public class PhotoOrAlbumButton extends AbstractButton{
  3. private String type;
  4. private String key;
  5. public PhotoOrAlbumButton(String name,String key) {
  6. super(name);
  7. this.type = "pic_photo_or_album";//拍照获取传图
  8. this.key = key;
  9. }
  10. public String getType() {
  11. return type;
  12. }
  13. public void setType(String type) {
  14. this.type = type;
  15. }
  16. public String getKey() {
  17. return key;
  18. }
  19. public void setKey(String key) {
  20. this.key = key;
  21. }
  22. }

<6>SubButton

  1. import java.util.ArrayList;
  2. import java.util.List;
  3. //二级菜单对象
  4. public class SubButton extends AbstractButton {
  5. private List<AbstractButton> sub_button;
  6. public List<AbstractButton> getSub_button() {
  7. return this.sub_button;
  8. }
  9. public void setSub_button(final List<AbstractButton> sub_button) {
  10. this.sub_button = sub_button;
  11. }
  12. public SubButton(final String name) {
  13. super(name);
  14. this.sub_button = new ArrayList<AbstractButton>();
  15. }
  16. }

11.2 测试

新增一个Test方法

  1. package com.qy.test;
  2. import java.util.ArrayList;
  3. import java.util.List;
  4. import org.junit.Test;
  5. import com.alibaba.fastjson.JSONObject;
  6. import com.qy.entity.button.AbstractButton;
  7. import com.qy.entity.button.Button;
  8. import com.qy.entity.button.ClickButton;
  9. import com.qy.entity.button.PhotoOrAlbumButton;
  10. import com.qy.entity.button.SubButton;
  11. import com.qy.entity.button.ViewButton;
  12. import com.qy.service.WxService;
  13. import com.qy.utils.HttpUtils;
  14. public class TestButton {
  15. @Test
  16. public void setButton() {
  17. //创建一级菜单
  18. Button button = new Button();
  19. //在第三个菜单中创建二级菜单
  20. SubButton subButton = new SubButton("有子菜单");
  21. List<AbstractButton> list2 = new ArrayList();
  22. list2.add(new ClickButton("三一点击", "31"));
  23. list2.add(new ViewButton("码云博客", "https://heliufang.gitee.io/"));
  24. list2.add(new PhotoOrAlbumButton("拍照或发图","33"));
  25. subButton.setSub_button(list2);
  26. //在一级菜单中添加三个按钮,
  27. List<AbstractButton> list = new ArrayList();
  28. list.add(new ClickButton("一级点击", "1"));
  29. list.add(new ViewButton("个人博客", "https://heliufang.gitee.io/"));
  30. list.add(subButton);
  31. button.setButton(list);
  32. //转成json格式字符串
  33. String jsonString = JSONObject.toJSONString(button);
  34. //System.out.println(jsonString);
  35. //发送请求
  36. String url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN";
  37. url = url.replace("ACCESS_TOKEN", WxService.getAccessToken());//把token带上
  38. String result = HttpUtils.sendPost(url, jsonString);
  39. System.out.println(result);
  40. }
  41. }

运行效果如下:

12 设置和获取行业信息


12.1 设置行业信息

如果要发送模板消息,那么首先就得设置行业信息,如何设置和获取可以看下面接口。

模板消息文档

设置行业可在微信公众平台后台完成,每月可修改行业1次,帐号仅可使用所属行业中相关的模板,为方便第三方开发者,提供通过接口调用的方式来修改账号所属行业,具体如下:

接口调用请求说明

http请求方式: POST https://api.weixin.qq.com/cgi-bin/template/api_set_industry?access_token=ACCESS_TOKEN

POST数据说明

POST数据示例如下:

  1. {
  2. "industry_id1":"1",
  3. "industry_id2":"4"
  4. }

参数说明

参数

是否必须

说明

access_token

接口调用凭证

industry_id1

公众号模板消息所属行业编号-主行业

industry_id2

公众号模板消息所属行业编号-副行业

行业代码查询,更多代码可以查询文档

主行业

副行业

代码

IT科技

互联网/电子商务

1

IT科技

IT软件与服务

2

IT科技

IT硬件与设备

3

编写测试代码

  1. @Test
  2. public void setIndustry() {
  3. String url = "https://api.weixin.qq.com/cgi-bin/template/api_set_industry?access_token=ACCESS_TOKEN";
  4. url = url.replace("ACCESS_TOKEN", WxService.getAccessToken());
  5. String jsonStr = "{\"industry_id1\":\"1\",\"industry_id2\":\"4\"}";
  6. String rString = HttpUtils.sendPost(url, jsonStr);
  7. System.out.println(rString);
  8. }

12.2 获取行业信息

获取帐号设置的行业信息。可登录微信公众平台,在公众号后台中查看行业信息。为方便第三方开发者,提供通过接口调用的方式来获取帐号所设置的行业信息,具体如下:

接口调用请求说明

http请求方式:GET https://api.weixin.qq.com/cgi-bin/template/get_industry?access_token=ACCESS_TOKEN

参数说明

参数

是否必须

说明

access_token

接口调用凭证

返回说明

正确调用后的返回示例:

  1. {
  2. "primary_industry":{"first_class":"运输与仓储","second_class":"快递"},
  3. "secondary_industry":{"first_class":"IT科技","second_class":"互联网|电子商务"}
  4. }

返回参数说明

参数

是否必填

说明

access_token

接口调用凭证

primary_industry

帐号设置的主营行业

secondary_industry

帐号设置的副营行业

编写测试代码

  1. @Test
  2. public void getIndustry() {
  3. String url = "https://api.weixin.qq.com/cgi-bin/template/get_industry?access_token=ACCESS_TOKEN";
  4. url = url.replace("ACCESS_TOKEN", WxService.getAccessToken());
  5. String string = HttpUtils.sendGet(url);
  6. System.out.println(string);
  7. }

13 发送模板消息


模板消息接口

就是微信主动给用户推送消息,不需要像之前那样被动(用户发送之后再回复).

接口调用请求说明

http请求方式: POST https://api.weixin.qq.com/cgi-bin/message/template/send?access_token=ACCESS_TOKEN

POST数据如下:

  1. {
  2. "touser": "oQxvI51GI5t9wBaBjmBXgJZZVM3A",
  3. "template_id": "tQ0G9Pmd_n_ylmplYsEnexgabkJXH1S3J7BXahK454g",
  4. "url": "https://heliufang.gitee.io/",
  5. "data": {
  6. "first": {
  7. "value": "您好!您投递的简历有新的反馈",
  8. "color": "#173177"
  9. },
  10. "company": {
  11. "value": "广州壹新网络科技有限公司",
  12. "color": "#173177"
  13. },
  14. "time": {
  15. "value": "2021-8-5 23:31:23",
  16. "color": "#173177"
  17. },
  18. "result": {
  19. "value": "已通过",
  20. "color": "#ff0000"
  21. },
  22. "remark": {
  23. "value": "带身份证",
  24. "color": "#173177"
  25. }
  26. }
  27. }

参数说明

参数

是否必填

说明

touser

接收者openid

template_id

模板ID,这个需要在管理界面配置

url

模板跳转链接(海外帐号没有跳转能力)

data

模板数据

color

模板内容字体颜色,不填默认为黑色

返回码说明

在调用模板消息接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

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

★第一步:在微信测试号管理后台配置模板:

  • 模板标题: 简历反馈提醒

  • 模板内容:

  1. {{first.DATA}}
  2. 公司名:{{company.DATA}}
  3. 投递时间:{{time.DATA}}
  4. 反馈结果:{{result.DATA}} {{remark.DATA}}

创建好之后是下面这个样子

第二步:编写代码

  1. @Test
  2. public void sendTemplateMsg() {
  3. String url = "https://api.weixin.qq.com/cgi-bin/message/template/send?access_token=ACCESS_TOKEN";
  4. url = url.replace("ACCESS_TOKEN", WxService.getAccessToken());
  5. //实际开发中应封装成java类,再把java对象转成类似下面的jsonstr
  6. String jsonStr = "{\r\n" +
  7. " \"touser\": \"oQxvI51GI5t9wBaBjmBXgJZZVM3A\",\r\n" +
  8. " \"template_id\": \"tQ0G9Pmd_n_ylmplYsEnexgabkJXH1S3J7BXahK454g\",\r\n" +
  9. " \"url\": \"https://heliufang.gitee.io/\",\r\n" +
  10. " \"data\": {\r\n" +
  11. " \"first\": {\r\n" +
  12. " \"value\": \"您好!您投递的简历有新的反馈\",\r\n" +
  13. " \"color\": \"#173177\"\r\n" +
  14. " },\r\n" +
  15. " \"company\": {\r\n" +
  16. " \"value\": \"广州壹新网络科技有限公司\",\r\n" +
  17. " \"color\": \"#173177\"\r\n" +
  18. " },\r\n" +
  19. " \"time\": {\r\n" +
  20. " \"value\": \"2021-8-5 23:31:23\",\r\n" +
  21. " \"color\": \"#173177\"\r\n" +
  22. " },\r\n" +
  23. " \"result\": {\r\n" +
  24. " \"value\": \"已通过\",\r\n" +
  25. " \"color\": \"#ff0000\"\r\n" +
  26. " },\r\n" +
  27. " \"remark\": {\r\n" +
  28. " \"value\": \"带身份证\",\r\n" +
  29. " \"color\": \"#173177\"\r\n" +
  30. " }\r\n" +
  31. " }\r\n" +
  32. "}";
  33. String rString = HttpUtils.sendPost(url, jsonStr);
  34. System.out.println(rString);
  35. }

测试结果如下

14 新增和获取临时素材


公众号经常有需要用到一些临时性的多媒体素材的场景,例如在使用接口特别是发送消息时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的。素材管理接口对所有认证的订阅号和服务号开放。

注意点:

1、临时素材media_id是可复用的。

2、媒体文件在微信后台保存时间为3天,即3天后media_id失效。

3、上传临时素材的格式、大小限制与公众平台官网一致。

图片(image): 10M,支持PNG\JPEG\JPG\GIF格式

语音(voice):2M,播放长度不超过60s,支持AMR\MP3格式

视频(video):10MB,支持MP4格式

缩略图(thumb):64KB,支持JPG格式

14.1 新增临时素材

新增临时素材文档

罗老师用的是java自带的文件类上传,代码比较繁琐。而我使用HttpClient封装的HttpUtils上传就很简单了。

接口调用请求说明

http请求方式: POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE

参数说明

参数

是否必须

说明

access_token

调用接口凭证

type

媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb)

media

form-data中媒体文件标识,有filename、filelength、content-type等信息

返回说明

正确情况下的返回JSON数据包结果如下:

{"type":"image","media_id":"atL80WWRNpMWhivoIGf9KTUUUO5pm6RxML8OPEUd7cbfb1Rs0kl2Yv0319KMQI-0","created_at":1628933345,"item":[]}

参数

描述

type

媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb,主要用于视频与音乐格式的缩略图)

media_id

媒体文件上传后,获取标识

created_at

媒体文件上传时间戳

编写测试代码

  1. //上传图片
  2. @Test
  3. public void uploadMedia() {
  4. String url = "https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE";
  5. url = url.replace("ACCESS_TOKEN", WxService.getAccessToken());
  6. url = url.replace("TYPE", "image");
  7. String string = HttpUtils.sendPost(url, null, "C:\\Users\\Administrator\\Desktop\\2.jpg", "");
  8. System.out.println(string);
  9. }

14.2 获取临时素材

获取临时素材文档

接口调用请求说明

http请求方式: GET,https调用 https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID 请求示例(示例为通过curl命令获取多媒体文件) curl -I -G “ https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID"

把ACCESS_TOKEN和MEDIA_ID替换到url的位置,然后浏览器打开就可以下载了

参数说明

参数

是否必须

说明

access_token

调用接口凭证

media_id

媒体文件ID

返回说明

正确情况下的返回HTTP头如下:

  1. HTTP/1.1 200 OK
  2. Connection: close
  3. Content-Type: image/jpeg
  4. Content-disposition: attachment; filename="MEDIA_ID.jpg"
  5. Date: Sun, 06 Jan 2013 10:20:18 GMT
  6. Cache-Control: no-cache, must-revalidate
  7. Content-Length: 339721
  8. curl -G "https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID"

15 二维码生成和扫描


15.1 生成带参数的临时二维码

为了满足用户渠道推广分析和用户帐号绑定等场景的需要,公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码,用户扫描后,公众号可以接收到事件推送。

目前有2种类型的二维码:

1、临时二维码,是有过期时间的,最长可以设置为在二维码生成后的30天(即2592000秒)后过期,但能够生成较多数量。临时二维码主要用于帐号绑定等不要求二维码永久保存的业务场景 2、永久二维码,是无过期时间的,但数量较少(目前为最多10万个)。永久二维码主要用于适用于帐号绑定、用户来源统计等场景。

获取带参数的二维码的过程包括两步,首先创建二维码ticket,然后凭借ticket到指定URL换取二维码。

生成带参数的二维码文档

测试代码将实现下面这样一个功能,点击页面上的生成按钮,在页面展示生成好的二维码

【index.jsp】

  1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5. <meta charset="UTF-8">
  6. <title>二维码测试页面</title>
  7. </head>
  8. <body>
  9. <button type="button">生成二维码</button><br>
  10. <img alt="暂无图片" src="">
  11. </body>
  12. <script src="jquery.js"></script>
  13. <script>
  14. $("button").click(function(){
  15. $.ajax({
  16. url: "/wx/getQrCode",
  17. type: "get",
  18. dataType: "json",
  19. success: function(resp){
  20. console.log(resp);
  21. //通过ticket获取图片
  22. var src = "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket="+resp.ticket;
  23. $("img").attr("src",src)
  24. }
  25. })
  26. })
  27. </script>
  28. </html>

【后端servlet】

  1. @WebServlet("/getQrCode")
  2. public class QrCodeServlet extends HttpServlet {
  3. @Override
  4. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  5. //设置编码格式,不然中文会乱码
  6. req.setCharacterEncoding("UTF-8");
  7. resp.setCharacterEncoding("UTF-8");
  8. //发送post请求获取ticket,页面通过ticket就可以展示二维码图片了
  9. String url = "https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN";
  10. url = url.replace("TOKEN", WxService.getAccessToken());
  11. /*600表示10分钟有效 scene_str是一个唯一标识,类似点击事件的key, QR_STR_SCENE表示临时二维码
  12. * {
  13. "expire_seconds": 600,
  14. "action_name": "QR_STR_SCENE",
  15. "action_info": {
  16. "scene": {
  17. "scene_str": "test"
  18. }
  19. }
  20. }
  21. */
  22. String jsonStr = "{\r\n" +
  23. " \"expire_seconds\": 600, \r\n" +
  24. " \"action_name\": \"QR_STR_SCENE\", \r\n" +
  25. " \"action_info\": {\r\n" +
  26. " \"scene\": {\r\n" +
  27. " \"scene_str\": \"test\"\r\n" +
  28. " \r\n" +
  29. " }\r\n" +
  30. " }\r\n" +
  31. "}";
  32. String string = HttpUtils.sendPost(url, jsonStr);
  33. JSONObject object = JSONObject.parseObject(string);
  34. //将响应结果返回页面,用于显示二维码
  35. resp.getWriter().write(string);
  36. }
  37. @Override
  38. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  39. }
  40. }

访问页面,点击按钮就可以看到如下效果

15.2 扫描二维码

用户扫描带场景值二维码时,可能推送以下两种事件:

如果用户还未关注公众号,则用户可以关注公众号,关注后微信会将带场景值关注事件推送给开发者。

如果用户已经关注公众号,在用户扫描后会自动进入会话,微信也会将带场景值扫描事件推送给开发者

扫描临时二维码之后,会向服务器推送一个xml数据包,解析之后打印效果如下:

  1. {
  2. Ticket=gQFr8DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAya1JKeDQ2M3JmOEQxOGlybk54Y08AAgS6mBdhAwRYAgAA,
  3. FromUserName=oQxvI51GI5t9wBaBjmBXgJZZVM3A,
  4. EventKey=test,
  5. Event=SCAN,
  6. CreateTime=1628936703,
  7. ToUserName=gh_c8af0521f09a,
  8. MsgType=event
  9. }

实现扫码之后给用户回复一个[你扫码了]

修改【WxService】的代码,修改getRespose方法,新增dealEvent和dealScanEvent方法

  1. /**
  2. * 事件消息回复
  3. */
  4. public static String getRespose(Map<String, String> requestMap) {
  5. BaseMsg msg = null;
  6. // 根据用户发送消息的类型,做不同的处理
  7. String msgType = requestMap.get("MsgType");
  8. switch (msgType) {
  9. case "text":
  10. msg = dealTextMsg(requestMap);
  11. break;
  12. case "news":
  13. break;
  14. case "event":
  15. //新增处理事件的方法
  16. msg = dealEvent(requestMap);
  17. break;
  18. default:
  19. break;
  20. }
  21. // System.out.println(msg);
  22. // 将处理结果转化成xml的字符串返回
  23. if (null != msg) {
  24. return beanToXml(msg);
  25. }
  26. return null;
  27. }
  28. //处理事件
  29. private static BaseMsg dealEvent(Map<String, String> requestMap) {
  30. String event = requestMap.get("Event");
  31. BaseMsg msg = null;
  32. //switch分发到具体事件
  33. switch (event) {
  34. case "SCAN":
  35. msg = dealScanEvent(requestMap);
  36. break;
  37. default:
  38. break;
  39. }
  40. return msg;
  41. }
  42. //处理SCAN事件
  43. private static BaseMsg dealScanEvent(Map<String, String> requestMap) {
  44. String eventKey = requestMap.get("EventKey");
  45. if("test".equals(eventKey)) {
  46. return new TextMsg(requestMap, "你扫码了");
  47. }
  48. return new TextMsg(requestMap, requestMap.toString());
  49. }

扫码之后效果如下:

16 获取用户信息


一般在做网页授权的时候,会用到这个功能。

16.1 获取已关注的用户信息

获取用户基本信息(UnionID机制)

在关注者与公众号产生消息交互后,公众号可获得关注者的OpenID(加密后的微信号,每个用户对每个公众号的OpenID是唯一的。对于不同公众号,同一用户的openid不同)。公众号可通过本接口来根据OpenID获取用户基本信息,包括昵称、头像、性别、所在城市、语言和关注时间。

获取用户基本信息(包括UnionID机制)

开发者可通过OpenID来获取用户基本信息。请使用https协议。

接口调用请求说明 http请求方式: GET https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN

参数说明

参数

是否必须

说明

access_token

调用接口凭证

openid

普通用户的标识,对当前公众号唯一

lang

返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语

openid可以登录测试号管理界面获取,对应关注者的微信号

测试代码

  1. @Test
  2. public void getUserInfo() {
  3. String url = "https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN";
  4. url = url.replace("ACCESS_TOKEN", WxService.getAccessToken());
  5. url = url.replace("OPENID", "oQxvI51GI5t9wBaBjmBXgJZZVM3A");
  6. String string = HttpUtils.sendGet(url);
  7. System.out.println(string);//这里就可以看到打印的用户信息了
  8. }

16.2 网页授权

可以获取未关注的用户信息,这部分需要有域名才能测试。

网页授权

因为ngrok默认域名已经被微信封了,所以需要申请一个域名来测试

第一步:在ngrok中使用自定义域名。

第二步:微信测试号管理界面修改成自定义的域名

第三步:测试号接口权限中配置网页授权的域名

第四步:阿里云域名解析到ngrok的域名

测试代码:

【WxService】修改dealTextMsg方法

新增一个【getUserInfo】的servlet,这个就是用户点击之后重定向的servlet

  1. @WebServlet("/getUserInfo")
  2. public class GetUserInfoServlet extends HttpServlet {
  3. private static final long serialVersionUID = 1L;
  4. protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
  5. //1.用户同意授权,获取code
  6. String code = request.getParameter("code");
  7. //2.通过code获取网页授权的access_token
  8. String url = " https://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code";
  9. url = url.replace("APPID", WxService.APPID).replace("CODE", code).replace("SECRET", WxService.APPSECRET);
  10. String string = HttpUtils.sendGet(url);
  11. JSONObject jsonObject = JSONObject.parseObject(string);
  12. String accessToken = jsonObject.getString("access_token");
  13. String openid = jsonObject.getString("openid");
  14. //3.刷新access_token(如果需要)
  15. //4.通过token获取用户信息
  16. String getUserInfoUrl = "https://api.weixin.qq.com/sns/userinfo?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN";
  17. getUserInfoUrl = getUserInfoUrl.replace("ACCESS_TOKEN", accessToken).replace("OPENID", openid);
  18. String userInfoJsonStr = HttpUtils.sendGet(getUserInfoUrl);
  19. System.out.println(userInfoJsonStr);
  20. }
  21. protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
  22. doGet(request, response);
  23. }
  24. }

17 微信公众号开发框架


前面的开发都是原生的写法,github上有很多现成的公众号开发框架。

比如这个基于springboot的公众号开发框架:

仓库:https://github.com/binarywang/weixin-java-mp-demo

文档:https://github.com/Wechat-Group/WxJava/wiki/%E5%85%AC%E4%BC%97%E5%8F%B7%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3

最后多说一句只有把原生的基础打好了,才能更好的理解和使用框架,所以建议先学原生的公众号开发,再上手框架。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/繁依Fanyi0/article/detail/467297
推荐阅读
相关标签
  

闽ICP备14008679号