腾讯云 Nuxt.js Serverless Component

简介

腾讯云Nuxt.js组件 - 通过使用Tencent Serverless Framework , 基于云上 Serverless 服务（如 API 网关、云函数等），实现“0”配置，便捷开发，极速部署采用 Nuxt.js 框架的网页应用，Nuxt.js 组件支持丰富的配置扩展，提供了目前便捷实用，开发成本低的网页应用项目的开发/托管能力。

特性介绍：

• 按需付费 - 按照请求的使用量进行收费，没有请求时无需付费
• "0"配置 - 只需要关心项目代码，之后部署即可，Serverless Framework 会搞定所有配置。
• 极速部署 - 部署速度快，仅需几秒，部署你的整个应用。
• 实时日志 - 通过实时日志的输出查看业务状态，便于直接在云端开发应用。
• 云端调试 - 可在云端直接进行项目调试，从而避免本地环境的差异。
• 便捷协作 - 通过云端控制台的状态信息和部署日志，方便进行多人协作开发。

快速开始

0. 准备
1. 安装
2. 配置
3. 部署
4. 开发调试
5. 查看状态
6. 移除

更多资源：

• 账号配置
• 更多组件
• FAQ

0. 准备

初始化 Nuxt.js 项目

首先，在本地创建根目录，并初始化一个 Nuxt.js 项目

$ npx create-nuxt-app serverless-nuxtjs
$ cd serverless-nuxtjs

注意：本教程中的 Nuxt 项目使用 JavaScript 与 Npm 安装包进行构建，初始化项目的时候请选择相应的选项

1. 安装

通过 npm 全局安装 serverless cli

$ npm install -g serverless

2. 配置

在项目根目录创建 serverless.yml 文件，在其中进行如下配置

$ touch serverless.yml

# serverless.yml
component: nuxtjs # (必填) 组件名称，此处为nuxtjs
name: nuxtjsDemo # (必填) 实例名称
org: orgDemo # (可选) 用于记录组织信息，默认值为您的腾讯云账户 appid
app: appDemo # (可选) 该 nuxt.js 项目名称
stage: dev # (可选) 用于区分环境信息，默认值是 dev

inputs:
  src:
    src: ./
    exclude:
      - .env
  region: ap-guangzhou
  runtime: Nodejs10.15
  apigatewayConf:
    protocols:
      - http
      - https
    environment: release

• 点此查看更多配置及说明

3. 部署

3.1 构建静态资源

进入到 nuxt 项目目录下，构建静态资源

$ cd src && npm run build

3.2 部署到云端

回到在 serverless.yml 文件所在的项目根目录，运行以下指令进行部署：

# 进入项目根目录 serverless-nuxtjs
$ sls deploy

serverless ⚡ framework
Action: "deploy" - Stage: "dev" - App: "appDemo" - Instance: "nuxtjsDemo"

region: ap-guangzhou
apigw:
  serviceId:   service-4v2jx72g
  subDomain:   service-4v2jx72g-1258834142.gz.apigw.tencentcs.com
  environment: release
  url:         https://xxxxxx.gz.apigw.tencentcs.com/release/
scf:
  functionName: nuxtjs_component_mm518kl
  runtime:      Nodejs10.15
  namespace:    default

139s › nuxtjsDemo › Success

部署时需要进行身份验证，如您的账号未 登陆 或 注册 腾讯云，您可以直接通过 微信 扫描命令行中的二维码进行授权登陆和注册。

注意: 如果希望查看更多部署过程的信息，可以通过sls deploy --debug 命令查看部署过程中的实时日志信息，sls是 serverless 命令的缩写。 sls 是 serverless 命令的简写。

4. 开发调试

部署了 Nuxt.js 应用后，可以通过开发调试能力对该项目进行二次开发，从而开发一个生产应用。在本地修改和更新代码后，不需要每次都运行 serverless deploy 命令来反复部署。你可以直接通过 serverless dev 命令对本地代码的改动进行检测和自动上传。

可以通过在 serverless.yml文件所在的目录下运行 serverless dev 命令开启开发调试能力。

serverless dev 同时支持实时输出云端日志，每次部署完毕后，对项目进行访问，即可在命令行中实时输出调用日志，便于查看业务情况和排障。

5. 查看部署状态

在serverless.yml文件所在的目录下，通过如下命令查看部署状态：

$ serverless info

6. 移除

在serverless.yml文件所在的目录下，通过以下命令移除部署通过以下命令移除部署的 API 网关，移除后该组件会对应删除云上部署时所创建的所有相关资源。

$ sls remove

和部署类似，支持通过 sls remove --debug 命令查看移除过程中的实时日志信息，sls是 serverless 命令的缩写。

账号配置

当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 .env 文件

$ touch .env # 腾讯云的配置信息

在 .env 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存

如果没有腾讯云账号，可以在此 注册新账号。

如果已有腾讯云账号，可以在 API 密钥管理 中获取 SecretId 和SecretKey.

# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123

注意：海外 ip 登录时，需要在.env文件中添加SERVERLESS_PLATFORM_VENDOR=tencent ，使 sls 默认使用 tencent 组件

更多组件

可以在 Serverless Components repo 中查询更多组件的信息。

项目迁移

如果项目使用了自定义 Node.js 服务，比如 express 或者 koa，你需要做如下改造工作。

自定义 express 服务

如果你的 Nuxt.js 项目本身运行就是基于 express 自定义服务的，那么你需要在项目中自定义入口文件 sls.js，需要参考你的服务启动文件进行修改，以下是一个模板文件：

const express = require('express')
const { loadNuxt } = require('nuxt')

async function createServer() {
  // not report route for custom monitor
  const noReportRoutes = ['/_nuxt', '/static', '/favicon.ico']

  const server = express()
  const nuxt = await loadNuxt('start')

  server.all('*', (req, res, next) => {
    noReportRoutes.forEach((route) => {
      if (req.path.indexOf(route) === 0) {
        req.__SLS_NO_REPORT__ = true
      }
    })
    return nuxt.render(req, res, next)
  })

  // define binary type for response
  // if includes, will return base64 encoded, very useful for images
  server.binaryTypes = ['*/*']

  return server
}

module.exports = createServer

自定义 koa 服务

如果你的项目使用的是 Koa 作为 Node.js 服务，需要在项目中自定义入口文件 sls.js，需要参考你的服务启动文件进行修改，以下是一个模板文件：

const Koa = require('koa')
const { loadNuxt } = require('nuxt')

async function createServer() {
  const server = new Koa()
  const nuxt = await loadNuxt('start')

  server.use((ctx) => {
    ctx.status = 200
    ctx.respond = false
    ctx.req.ctx = ctx

    nuxt.render(ctx.req, ctx.res)
  })

  // define binary type for response
  // if includes, will return base64 encoded, very useful for images
  server.binaryTypes = ['*/*']

  return server
}

module.exports = createServer

自定义监控

目前仅支持自定义 Express 服务的项目

当在部署 Nuxt.js 应用时，如果 serverless.yml 中未指定 role，默认会尝试绑定 QCS_SCFExcuteRole，并且开启自定义监控，帮助用户收集应用监控指标。对于为自定义入口文件的项目，会默认上报除含有 /_nuxt、/static 和 /favicon.ico 的路由。如果你想自定义上报自己的路由性能，那么可以自定义 sls.js 入口文件，对于无需上报的路由，在 express 服务的 req 对象上添加 __SLS_NO_REPORT__ 属性值为 true 即可。比如：

server.get('/no-report', (req, res, next) => {
  req.__SLS_NO_REPORT__ = true
  return nuxt.render(req, res, next)
})

那么用户在访问 GET /no-report 路由时，就不会上报自定义监控指标。

License

MIT License

Copyright (c) 2020 Tencent Cloud, Inc.