操作场景
Serverless SSR 为您提供了完整的命令行开发流程,该任务指导您通过 Serverless Framework 命令行工具完成 Nuxt.js 应用的部署与开发。
操作步骤
1. 安装
通过 npm 全局安装 Serverless CLI:
$ npm install -g serverless
2. 配置
初始化 nuxt.js 项目模版(可跳过,您可直接使用已有项目进行配置)
sls init nuxtjs-demo
在项目业务代码目录下创建 serverless.yml
文件:
$ touch serverless.yml
在 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 文件下的目录中运行以下指令进行部署:
$ sls deploy
部署时需要进行身份验证,如您的账号未 登录 或 注册 腾讯云,您可以直接通过微信扫描命令行中的二维码进行授权登录和注册。
说明:如果希望查看更多部署过程的信息,可以通过
sls deploy --debug
命令查看部署过程中的实时日志信息(sls
是serverless
命令的缩写)。
4. 查看部署状态
在serverless.yml
文件所在的目录下,通过如下命令查看部署状态:
$ serverless info
5. 移除
在serverless.yml
文件所在的目录下,通过以下命令移除部署通过以下命令移除部署的 API 网关,移除后该组件会对应删除云上部署时所创建的所有相关资源。
$ sls remove
和部署类似,支持通过 sls remove --debug
命令查看移除过程中的实时日志信息(sls
是 serverless
命令的缩写)。
更多操作
项目迁移
部署 Nuxt.js 应用时,Serverless SSR 会自动为您创建 sls.js
入口文件,如果您的项目本身运行是基于 express
自定义服务,您也可以在项目中自定义入口文件 sls.js
,需要参考您的服务启动文件进行修改,以下是一个 Nuxt.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
账号配置
当前默认支持 CLI 扫描二维码登录,如您希望配置持久的环境变量/密钥信息,也可以本地创建 .env
文件:
$ touch .env # 腾讯云的配置信息
在 .env
文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存:
# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123
说明:
- 如果没有腾讯云账号,请先 注册新账号。
- 如果已有腾讯云账号,可以在 API 密钥管理 中获取
SecretId
和SecretKey
。
自定义监控
当您在部署 Nuxt.js 应用时,如果 serverless.yml
中未指定 role
,默认会尝试绑定 QCS_SCFExcuteRole
,并且开启自定义监控,帮助用户收集应用监控指标。对于为自定义入口文件的项目,会默认上报除含有 /_next
和 /static
的路由。
如果您想自定义上报自己的路由性能,那么可以自定义 sls.js
入口文件。对于无需上报的路由,在 express 服务的 req
对象上添加 __SLS_NO_REPORT__
属性值为 true
即可。例如:
server.get('/no-report', (req, res) => {
req.__SLS_NO_REPORT__ = true
return handle(req, res)
})
配置后,用户在访问 GET /no-report
路由时,就不会上报自定义监控指标。