云托管

开发者工具 1.03.2010162 Nightly 起

云托管是云开发为开发者提供的原生容器服务，用户可面向代码/镜像等多种方式使用，无需维护复杂的容器环境，可专注于自身的业务，一键开通后即可享受能自动扩缩容的容器资源，并享有以下能力：

  1. 天然鉴权：
    1. 容器内免鉴权直接获取用户信息 openid，unionid（更多）
  2. 任意语言、任意框架：可以使用任意语言和框架进行开发，可实现业务平滑迁移至云开发
  3. 常驻运行：容器内监听请求，每个实例都常驻运行
  4. 自动扩缩：单实例多并发，并自动根据负载情况增加或减少实例数量
  5. 平滑迁移：基于容器，现有业务可以平滑迁移至云开发并享受微信天然鉴权、高可用、自动弹性扩缩容等优势
  6. 使用简易：免域名配置，小程序 / Web端使用 SDK cloud.callContainer 一行代码即可调用

云托管与云函数的对比可在此查看。

快速上手

本文将引导如何创建第一个云托管服务，部署发布，并在小程序和 Web 端调用云托管服务。

第一步：开通云托管

云托管 - 图1 开通云托管要求使用后付费，因此如果环境不是后付费，请先切换至后付费、或新创建一个后付费的环境。本功能需要云开发管理员或小程序管理员才可以开通。

云托管的开通入口首页更多-云托管中，也可以在 “设置 -> 拓展功能” 中开通。

第二步：创建服务

云托管是以服务为维度进行管理的。

云托管 - 图2

在云托管中，点击「创建服务」，可以创建一个新的云托管服务。点击「版本管理」可以进入到该服务中。

第三步：准备代码包

你可以点击下载 示例 Node.JS 代码包，或跟着如下的步骤手动创建一个示例容器。

  1. 创建一个空目录，本示例中为 helloworld
  1. mkdir helloworld
  2. cd helloworld
  1. 安装所需依赖
  1. npm init -y
  2. npm install express --save
  1. 创建 index.js 并写入示例内容

示例代码返回接收到 headers，并且提供了获取用户 openid 和 unionid 的示例，可在此文档查看所有微信特殊 header。

  1. const express = require('express');
  2. const app = express();
  4. app.get('/', (req, res) => {
  5.     console.log('Hello world received a request.');
  7.     res.send(JSON.stringify({
  8.       // 查看所有的 headers
  9.       headers: req.headers,
  10.       // 获取用户的 openid
  11.       // 此处使用小写访问是因为 node 中的 req.headers 默认转成了小写，原 header 输入是大写的
  12.       openid: req.headers['x-wx-openid'],
  13.       // 获取用户的 unionid（如果满足 unionid 获取条件）
  14.       unionid: req.headers['x-wx-unionid'],
  15.     }));
  16. });
  18. // 监听端口：容器需要针对一个端口监听 HTTP 请求，从而让小程序的请求访问到容器内部
  19. const port = process.env.PORT || 80; // 此处要与新建版本时的端口号相同
  20. app.listen(port, () => {
  21.     console.log('Hello world listening on port', port);
  22. });
  1. 创建 Dockerfile 并写入内容
  1. # https://hub.docker.com/_/node
  2. FROM node:12-slim
  4. # Create and change to the app directory.
  5. WORKDIR /usr/src/app
  7. # Copy application dependency manifests to the container image.
  8. # A wildcard is used to ensure both package.json AND package-lock.json are copied.
  9. # Copying this separately prevents re-running npm install on every code change.
  10. COPY package*.json ./
  12. # Install production dependencies.
  13. RUN npm install --only=production
  15. # Copy local code to the container image.
  16. COPY . ./
  18. # Run the web service on container startup.
  19. CMD [ "node", "index.js" ]

到此，即可完成代码包的创建。除 Node.JS 外，云容器还支持其他的后端语言，具体可以参照 Docker 的官方文档进行镜像包的构建。

第四步：创建版本

进入服务后，可以点击「新建版本」创建一个版本。

云托管 - 图3

云托管支持本地上传和代码库拉取两种方式：

  • 本地上传可以选择文件夹或 ZIP 压缩包进行上传。需要上传包含正确 Dockerfile 的代码目录，否则，将提示 Dockerfile 不合法。
  • 代码库拉取支持 GitHub，GitLab 和 Gitee 的代码库拉取，需要点击授权后，才可以看到自己的代码仓库。在弹出的界面完成代码授权后，关闭即可看到自己的代码仓库。

需要注意，文件夹或 ZIP 压缩包上传的代码中不能超过 2 MiB。

在创建版本时，可以选择「稍后配置」或「开启 100% 流量」两种流量配置，若选择「稍后配置」，该版本将不会被分配流量。

第五步：查看构建是否成功

云托管 - 图4

点击版本右侧的「详情」，可以查看版本的详细信息，包括版本的构建日志，版本详情以及实例信息：

  • 构建日志：提供版本构建日志信息。若版本构建失败，可以在下方建议处点击「重新构建」
  • 版本详情：可以针对版本的备注和扩缩容实例数量进行调整
  • 实例信息：可以看到当前容器的实例，对应的实例 ID 以及创建时间。点击「Web Shell」，可以在弹出的窗口中对实例进行操作。

第六步：调用云托管服务

首先，确认当前调试基础库版本为 2.13.1 以上。可以在开发者工具-详情-本地设置中查看当前的基础库版本。

云托管 - 图5

在小程序中，使用如下的代码就可以调用云托管容器：

  1. // 确认已经在 onLaunch 中调用过 wx.cloud.init 初始化环境
  2. const res = await wx.cloud.callContainer({
  3.   path: '/container-helloworld', // 填入容器的访问路径（云托管-服务列表-路径）
  4.   method: 'GET',
  5. })
  7. console.log(res)

在 Web 端，可以使用如下代码进行调用：

  1. // 初始化 Cloud 实例
  2. // 容器调用必填环境id，不能为空
  3. var c1 = new wx.cloud.Cloud({
  4.   resourceEnv: '环境id'
  5. })
  6. await c1.init()
  8. // 返回值同 wx.request
  9. const res = await c1.callContainer({
  10.   path: '/container-helloworld', // 填入容器的访问路径（云托管-服务列表-路径）
  11.   // 其余参数同 wx.request
  12.   method: 'POST',
  13. })
  15. console.log(res)

重新编译后，在控制台看到如下的输出，说明调用已经成功：

云托管 - 图6

流量策略

在版本管理中，点击「分配流量比例」，可以进行详细的流量比例管理。

一个服务最多可以有两个同时存在流量比例的版本。两个版本的流量比例之和需为 100%。

日志

云托管的日志与云函数的高级日志功能类似，在此不再赘述。

注销

云托管开通后可以随时注销，入口在 “设置 -> 拓展功能” 中。注意在注销之前，需要将所有云容器版本和服务删除，才可以继续进行。