前言
WeChat 是目前国内最为流行和广泛使用的移动社交平台之一，其提供了强大的公共账号功能，让企业和开发者能够基于微信的生态体系快速构建和扩展各种基于微信的业务应用，成为了不少公司的重要的营销和服务渠道。
wechat-common 是一个基于 Node.js 平台，用于开发微信公众平台应用的常用功能库，封装了微信开发常用的 API、工具类等功能，提供了更为便捷的开发方式，让开发者能够专注于核心业务逻辑。
本篇文章将详细介绍 npm 包 wechat-common 的使用方法，包括安装、配置、使用等方面，希望对读者在微信公众平台开发过程中有所帮助。
安装
wechat-common 是一个 npm 包，可以通过 npm 命令进行安装。
npm install wechat-common --save
执行上面的命令之后，会将 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。
wechat.getAccessToken().then((accessToken) => {
console.log('获取 access_token 成功：', accessToken);
}).catch((err) => {
console.error('获取 access_token 失败：', err);
});获取 js-sdk 接口凭证
如果需要调用微信 js-sdk 接口，例如获取用户信息、分享等操作，需要先获取 js-sdk 接口凭证 jsapi_ticket。wechat-common 库提供了 getJsApiTicket() 方法，用于获取 jsapi_ticket。
wechat.getJsApiTicket().then((jsApiTicket) => {
console.log('获取 jsapi_ticket 成功：', jsApiTicket);
}).catch((err) => {
console.error('获取 jsapi_ticket 失败：', err);
});发送消息
wechat-common 库提供了多种发送消息的方法，包括文本消息、图片消息、语音消息、视频消息、音乐消息、图文消息等。
-- -------------------- ---- -------
-- ------
----- ----------- - -
----------- ------
------------- ------
----------- --- -----------------
-------- -------
-------- ------ --------
--
------------------------------------------- -- -
------------------------
-------------- -- -
-------------------------- -----
---
-- ------
----- ------------ - -
----------- ------
------------- ------
----------- --- -----------------
-------- --------
-------- ------
--
--------------------------------------------- -- -
------------------------
-------------- -- -
-------------------------- -----
---
-- ------
----- ------------ - -
----------- ------
------------- ------
----------- --- -----------------
-------- --------
-------- ------
--
--------------------------------------------- -- -
------------------------
-------------- -- -
-------------------------- -----
---
-- ------
----- ------------ - -
----------- ------
------------- ------
----------- --- -----------------
-------- --------
-------- ------
------ --------------
------------ --------------------
--
--------------------------------------------- -- -
------------------------
-------------- -- -
-------------------------- -----
---
-- ------
----- ------------ - -
----------- ------
------------- ------
----------- --- -----------------
-------- --------
------ --------------
------------ --------------------
--------- ------------
----------- ---------------
------------- -----------------
--
--------------------------------------------- -- -
------------------------
-------------- -- -
-------------------------- -----
---
-- ------
----- ----------- - -
----------- ------
------------- ------
----------- --- -----------------
-------- -------
--------- -
-
------ --------------
------------ --------------------
------- -----------
---- -------
--
-
------ --------------
------------ --------------------
------- -----------
---- -------
--
--
--
------------------------------------------- -- -
------------------------
-------------- -- -
-------------------------- -----
---接收消息
wechat-common 库提供了 parseMessage() 方法，用于解析微信公众平台发送过来的 XML 格式的消息。
const xmlMessage = '<xml>...</xml>';
const message = wechat.parseMessage(xmlMessage);
console.log('解析后的消息：', message);结语
本文介绍了 npm 包 wechat-common 的安装、配置和 API 调用等方面的内容。希望本文的内容对您在微信公众平台开发过程中有所帮助。
wechat-common 库提供的 API 不仅限于上面的示例，还包括用户信息、菜单管理、模板消息、二维码等功能。读者可以根据自己的业务需求，灵活调用这些 API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005739d81e8991b448e992a