npm 包 wechat-common 使用教程

前言

WeChat 是目前国内最为流行和广泛使用的移动社交平台之一,其提供了强大的公共账号功能,让企业和开发者能够基于微信的生态体系快速构建和扩展各种基于微信的业务应用,成为了不少公司的重要的营销和服务渠道。

wechat-common 是一个基于 Node.js 平台,用于开发微信公众平台应用的常用功能库,封装了微信开发常用的 API、工具类等功能,提供了更为便捷的开发方式,让开发者能够专注于核心业务逻辑。

本篇文章将详细介绍 npm 包 wechat-common 的使用方法,包括安装、配置、使用等方面,希望对读者在微信公众平台开发过程中有所帮助。

安装

wechat-common 是一个 npm 包,可以通过 npm 命令进行安装。

--- ------- ------------- ------

执行上面的命令之后,会将 wechat-common 包安装到当前项目的 node_modules 目录下,并将其添加到项目的 package.json 文件中的 dependencies 中。

配置

wechat-common 库提供了一个配置对象,用于配置微信公众平台应用的基本信息和 API 调用凭证。

配置对象参数说明

-
  ------ --- -- -------------
  ---------- --- -- -----------
  ------ --- -- -------- -----
  --------------- --- -- -------
  ------------ --- -- --- ----- ----------------------------------------- ------------
  ---------- --- -- ------------ -----------
  ------------ --- -- -- ------ -----
  --------------------- --- -- ------ ---------------
-

配置示例

通过配置对象调用 wechat-common 库的 create 方法,即可创建一个 WeChat 对象,用于后续的 API 调用和消息交互。

----- ------ - ---------------------------------

----- ------ - -
  ------ --------------
  ---------- ------------------
  ------ -------------
  --------------- ------------------------
--

----- ------ - ----------------------

config 对象中的参数说明如下:

  • appId:微信公众平台应用的唯一标识,可以在微信公众平台开发者中心查看。
  • appSecret:微信公众平台应用的密码,可以在微信公众平台开发者中心查看。
  • token:验证服务器地址的 token,可以任意设置,但必须与微信公众平台后台配置的一致。
  • encodingAESKey:消息加解密密钥,在接收、发送加密的消息时需要使用该密钥进行加解密操作。
  • accessToken:API 调用凭证的 access_token,可以通过调用 wechat.getAccessToken() 方法获取,也可以手动设置。
  • expiresIn:access_token 的有效期(以秒为单位),默认为 7200 秒(2 小时)。
  • jsApiTicket:调用 js-sdk 接口的凭证,可以通过调用 wechat.getJsApiTicket() 方法获取,也可以手动设置。
  • jsApiTicketExpiresIn:js-sdk 接口凭证的有效期(以秒为单位),默认为 7200 秒(2 小时)。

API 调用

wechat-common 库封装了微信公众平台提供的大部分 API,开发者可以根据自己的业务需求灵活的调用这些 API。

获取 access_token

在调用微信公众平台其他 API 之前,需要先获取 API 调用凭证 access_token,才能完成后续的接口调用操作。wechat-common 库提供了 getAccessToken() 方法,用于获取 access_token

------------------------------------------ -- -
  --------------- ------------ ----- -------------
-------------- -- -
  ----------------- ------------ ----- -----
---

获取 js-sdk 接口凭证

如果需要调用微信 js-sdk 接口,例如获取用户信息、分享等操作,需要先获取 js-sdk 接口凭证 jsapi_ticket。wechat-common 库提供了 getJsApiTicket() 方法,用于获取 jsapi_ticket

------------------------------------------ -- -
  --------------- ------------ ----- -------------
-------------- -- -
  ----------------- ------------ ----- -----
---

发送消息

wechat-common 库提供了多种发送消息的方法,包括文本消息、图片消息、语音消息、视频消息、音乐消息、图文消息等。

-- ------
----- ----------- - -
  ----------- ------
  ------------- ------
  ----------- --- -----------------
  -------- -------
  -------- ------ --------
--
------------------------------------------- -- -
  ------------------------
-------------- -- -
  -------------------------- -----
---

-- ------
----- ------------ - -
  ----------- ------
  ------------- ------
  ----------- --- -----------------
  -------- --------
  -------- ------
--
--------------------------------------------- -- -
  ------------------------
-------------- -- -
  -------------------------- -----
---

-- ------
----- ------------ - -
  ----------- ------
  ------------- ------
  ----------- --- -----------------
  -------- --------
  -------- ------
--
--------------------------------------------- -- -
  ------------------------
-------------- -- -
  -------------------------- -----
---

-- ------
----- ------------ - -
  ----------- ------
  ------------- ------
  ----------- --- -----------------
  -------- --------
  -------- ------
  ------ --------------
  ------------ --------------------
--
--------------------------------------------- -- -
  ------------------------
-------------- -- -
  -------------------------- -----
---

-- ------
----- ------------ - -
  ----------- ------
  ------------- ------
  ----------- --- -----------------
  -------- --------
  ------ --------------
  ------------ --------------------
  --------- ------------
  ----------- ---------------
  ------------- -----------------
--
--------------------------------------------- -- -
  ------------------------
-------------- -- -
  -------------------------- -----
---

-- ------
----- ----------- - -
  ----------- ------
  ------------- ------
  ----------- --- -----------------
  -------- -------
  --------- -
    -
      ------ --------------
      ------------ --------------------
      ------- -----------
      ---- -------
    --
    -
      ------ --------------
      ------------ --------------------
      ------- -----------
      ---- -------
    --
  --
--
------------------------------------------- -- -
  ------------------------
-------------- -- -
  -------------------------- -----
---

接收消息

wechat-common 库提供了 parseMessage() 方法,用于解析微信公众平台发送过来的 XML 格式的消息。

----- ---------- - -----------------
----- ------- - --------------------------------
---------------------- ---------

结语

本文介绍了 npm 包 wechat-common 的安装、配置和 API 调用等方面的内容。希望本文的内容对您在微信公众平台开发过程中有所帮助。

wechat-common 库提供的 API 不仅限于上面的示例,还包括用户信息、菜单管理、模板消息、二维码等功能。读者可以根据自己的业务需求,灵活调用这些 API。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005739d81e8991b448e992a


猜你喜欢

  • npm 包 batch-jobs 使用教程

    在前端开发过程中,我们经常需要用到异步任务的批量处理。这时候,npm 包 batch-jobs 就可以派上用场。batch-jobs 提供了一种方便的方式来管理和运行异步批处理任务。

    3 年前
  • npm 包 metadata-website 使用教程

    在前端开发中,经常需要获取一些网站的元数据用于展示,如网站标题、描述、关键词等。此时,我们可以使用一个名为 metadata-website 的 npm 包来快速获取网站的元数据。

    3 年前
  • npm 包 rms-meteor-scroll-controller-producer-decorator 使用教程

    介绍 npm 包 rms-meteor-scroll-controller-producer-decorator 是一个基于 Meteor 框架的滚动控制器,它包含了生产者和装饰者模式的设计,可以帮助...

    3 年前
  • npm 包 rms-meteor-server-context-decorator 使用教程

    介绍 rms-meteor-server-context-decorator 是一个适用于 Meteor 项目后端的 npm 包,它提供了一种简单而有效的方式来为你的 server 方法提供 cont...

    3 年前
  • npm 包 react-stringify 使用教程

    前言 在前端开发中,我们常常会涉及到数据的处理和展示,特别是在 React 应用中,数据的展示和传递是其中的一个核心问题。在这个过程中,不可避免地需要将数据转换成字符串并进行展示,而 npm 包 re...

    3 年前
  • npm 包 sha224 使用教程

    在前端开发中,我们经常需要对敏感信息进行加密处理,其中 sha224 算法是一种非常常见的加密算法。npm 中提供了 sha224 包可以快速实现 sha224 加密。

    3 年前
  • npm 包 crypticons 使用教程

    在前端开发中,我们经常需要使用一些图标来装饰我们的页面。然而,在寻找适合的图标时,我们常常会遇到尺寸不匹配、颜色不统一等问题。为了解决这个问题,我们可以使用一个名为 "crypticons" 的 np...

    3 年前
  • npm 包 muti-thread 的使用教程

    在编写前端应用时,我们常常需要进行耗时的计算和操作。这些操作如果在单线程下执行,就可能导致页面卡顿和用户体验下降。而 muti-thread 就是一个帮助我们在前端应用中进行多线程处理的 npm 包。

    3 年前
  • npm 包 passport-google-token-loopback 使用教程

    本文将介绍如何使用 npm 包 passport-google-token-loopback 实现基于 Google 帐号的 LoopBack 应用程序的授权。 简介 passport-google-...

    3 年前
  • npm 包 @deli/redux-form 使用教程

    前言 @deli/redux-form是一个React组件,它可以协助你轻松地为你的表单提供Redux数据管理和处理。 在这篇文章中,我们将介绍如何使用@deli/redux-form来创建一个基本的...

    3 年前
  • npm 包 windup 使用教程

    前言 在前端开发中,我们经常需要处理文本内容,而针对文本处理,往往需要使用到一些功能强大并且易于使用的工具。市场上有很多文本处理工具,其中 npm 包 windup 就是一款非常优秀的工具,它提供了很...

    3 年前
  • npm 包 float-truncate 使用教程

    前言 在前端开发中,我们经常需要处理浮点数,并对其进行格式化,例如将浮点数截断到指定小数位。然而,由于 JavaScript 中对浮点数的处理存在精度问题,因此我们需要借助第三方库来完成这项工作。

    3 年前
  • npm 包 gucci-gang 使用教程

    前言 随着前端技术的飞速发展,npm 成为前端项目不可或缺的一部分。在使用 npm 过程中,经常遇到需要使用第三方包来增强项目功能的需求,而 gucci-gang 就是其中一款非常优秀的 npm 包...

    3 年前
  • npm 包 bui-css 使用教程

    在前端开发中,我们经常需要使用 CSS 框架来快速搭建网站的界面。bui-css 是一款基于 Bootstrap 的 CSS 框架,它包含了许多常用的 UI 组件和样式,可以大大提高我们的开发效率。

    3 年前
  • npm包observable-proxy使用教程

    1. 前言 observable-proxy是一个npm包,它允许你快速地把一个对象变成observable对象,当这个对象的属性发生变化的时候,你可以方便地监听到这个变化。

    3 年前
  • npm 包 exmo 使用教程

    在前端开发中,我们经常需要使用各种各样的 npm 包来帮助我们完成一些常规性的任务。其中,exmo 是一款常用的 npm 包,它可以帮助我们快速方便地调用 exmo 交易所提供的 API 接口。

    3 年前
  • npm 包 gitbook-plugin-gensum 使用教程

    简介 在前端工程中,使用 GitBook 工具来编写文档是一个比较流行的方式。GitBook 提供了很多的插件,使得文档编写更加方便和专业。其中,gitbook-plugin-gensum 这个插件是...

    3 年前
  • npm 包 ha-confirmation 使用教程

    前言 在前端开发中,弹窗是非常常见的需求。常见的弹窗类型包括 alert、confirm、dialog 等。这些弹窗可以利用 JavaScript 原生函数来实现,但是需要编写大量重复的代码。

    3 年前
  • npm 包 homebridge-gpio-ledstrip 使用教程

    在前端开发中,有很多需要使用 GPIO 输出的场景,比如控制 LED 灯条的开关、颜色等。在这种情况下,我们通常会用到 homebridge-gpio-ledstrip 这个 npm 包。

    3 年前
  • npm包socket-msg使用教程

    前言 随着 Web 应用的普及,前端的工作越来越重要。其中,Socket 技术在很多应用中都得到了广泛的应用。本文将介绍 npm 包 socket-msg 的使用方法,帮助前端更便捷地使用 Socke...

    3 年前

相关推荐

    暂无文章