快速开始

本篇章将介绍如何快速的在本地创建一个基于 ssr 框架的项目。由于我们是基于插件化的架构,所以我们能够支持任意前端框架与任意服务端框架的组合。目前官方提供了前端框架 ReactVue2Vue3与服务端框架 Midway.js Nest.js 的默认集成示例让大家迅速创建。

如果你想使用其他的服务端框架例如daruk.js 等。那么你可以参考默认的服务端框架插件示例来迅速的编写一个服务端插件。这是非常简单的一件事情。因为我们的服务端插件没有任何额外逻辑。

create-ssr-app

我们提供了 create-ssr-app 脚手架来让用户可以迅速的创建不同类型的应用。

目前官方提供了以下类型的模版给开发者直接使用。用户可根据自己的实际技术栈选择不同的模版进行开发。

虽然技术栈不同但开发思想是一致的,在任何技术栈的组合中我们的开发命令, 构建命令以及渲染原理都是完全一致的

注意: 在 Midway.js Nest.js 场景下我们都已实现了一键部署到 Serverless 平台的能力。但底层实现略有差异。更加详细的介绍可以阅读Serverless 章节。如需要大量使用 Serverless 平台提供的能力,我们建议创建 Midway.js 类型的应用

开发者可根据实际技术栈需要创建不同类型的应用快速开始

命令行创建项目

通过 npm init 命令我们可以创建上述的任意模版

$ npm init ssr-app my-ssr-project
$ cd my-ssr-project
$ npm install # 可以使用 yarn 不要使用 cnpm
$ npm start
$ open http://localhost:3000 # 访问应用
$ npm run build # 资源构建,等价于 npx ssr build
$ npm run start:vite # 以 vite 模式启动,等价于 npx ssr start --vite

快速写一个服务端渲染服务

通过 core 模块提供的 render 方法,我们可以快速的提供一个页面渲染的服务。这非常的简单,可以在所有 Node.js 框架中运行。具体的渲染原理查看本地开发章节

import { render } from 'ssr-core-xxx'

@Provide()
@Controller('/')
export class Index {
  @Inject()
  ctx: Context

  @Get('/') // http://localhost:3000
  @Get('/page') // http://localhost:3000/page,需创建需要渲染的 web/page/user/render.vue|tsx 文件 Midway 框架支持多装饰器,Nestjs 可采用中间件的形式来为多个 path 附加相同逻辑
  async handler (): Promise<void> {
    try {
        // 只需要传入 ctx 作为参数即可
        // 若无原生 ctx 可通过 request, response 手动构建 ctx
      const stream = await render<Readable>(this.ctx, {
        stream: true
      })
      this.ctx.body = stream
    } catch (error) {
      console.log(error)
      this.ctx.body = error
    }
  }
}

快速的写一个接口服务

开发者可以将 Node.js 作为 BFF 层去掉用其他语言的接口或者直接调用数据库拿到数据返回

@Provide()
@Controller('/api')
export class Index {
  @Inject()
  ctx: Context

  @Get('/data') // http://localhost:3000/api/data
  async handler (): Promise<void> {
    try {
      const data = await axios.get('xxx') // http 形式请求其他接口
      const data = await this.service.rpc.call('xxx') // rpc 形式请求其他接口
      this.ctx.body = data
    } catch (error) {
      console.log(error)
      this.ctx.body = error
    }
  }
}

应用部署

我们提供了传统 Node.js 应用部署以及 Serverless 形式部署两种方式。

当你选择了基于 Midway.js 的模版后,我们额外提供了 ssr deploy 命令来将你的应用迅速发布到阿里云或者腾讯云。需要了解详细的发布流程可以阅读应用部署章节

Serverless 部署

以 Serverless 形式迅速发布应用

$ npm run deploy # 应用发布, 等价于 npx ssr deploy
$ npm run deploy:tencent # 发布到腾讯云 等价于 npx ssr deploy --tencent

传统 Node.js 应用形式部署

Midway.js 场景下我们使用 egg-scripts 进行部署

Nest.js 场景下我们使用 pm2 进行部署

$ npm run prod