NPM 包 egg-weapp-sdk 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

随着小程序的流行，更多的开发者开始接触和使用小程序。在小程序的开发过程中，我们会遇到一些问题，例如如何快速开发小程序后端接口。针对这个问题，蚂蚁金服基于 Egg.js 开发了 egg-weapp-sdk，它是一个小程序服务端 SDK，提供了一些方便的 API，可以让我们开发小程序后端接口更加简单。

安装

使用 npm 安装 egg-weapp-sdk：

npm install egg-weapp-sdk --save

使用

你可以在 Egg.js 的插件配置文件中启用 egg-weapp-sdk 插件：

// config/plugin.js
exports.weapp = {
  enable: true,
  package: 'egg-weapp-sdk',
};

然后在 Egg.js 的配置文件中进行配置：

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

appId 和 secret 是你的小程序的 AppID 和 AppSecret。
getToken 是一个异步函数，用于从数据库获取 access_token。
saveToken 是一个异步函数，用于将 access_token 保存到数据库中。

配置完成后，你就可以使用 egg-weapp-sdk 提供的 API 了。

API

weapp.getAccessToken()

用于获取小程序的 access_token。

const { weapp } = app;
const token = await weapp.getAccessToken();
console.log(token);

返回值为 access_token，可用于调用小程序的接口。

weapp.code2session(code)

用于将登录凭证 code 换取 session_key 和 openid。

const { weapp } = app;
const { sessionKey, openid } = await weapp.code2session(code);
console.log(sessionKey, openid);

返回值为一个对象，包括 session_key 和 openid。

weapp.decryptUserInfo(encryptedData, sessionKey, iv)

用于解密用户信息。

const { weapp } = app;
const { userInfo } = await weapp.decryptUserInfo(encryptedData, sessionKey, iv);
console.log(userInfo);

返回值为一个对象，包括用户信息。

示例代码

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

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

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

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

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

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

// app/router.js
module.exports = app => {
  const { router, controller } = app;
  router.get('/weapp/login', controller.weapp.login);
};

总结

通过本次 egg-weapp-sdk 的使用教程，我们了解到了如何在 Egg.js 中使用 egg-weapp-sdk 快速开发小程序后端接口。同时也看到了 egg-weapp-sdk 提供的几个方便的 API，包括获取 access_token、换取 session_key 和 openid、解密用户信息等。在实际开发中，我们可以根据自己的需求进行更多的调用。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6005581181e8991b448d5375