版本：3.0.0

Midway 应用迁移

Midway Serverless 提供了一套通用的应用迁移方案，将原有应用尽可能不修改代码，就可以发布到函数平台。使用此方案，可以将原有的 midway 应用尽可能快速简单的迁移到函数平台进行托管，享受云原生时代的弹性红利。

限制

当前只有纯 @midwayjs/koa, @midwayjs/express, @midwayjs/web 项目（纯 Http）才可迁移。

@midway/koa

Serverless 环境指的是阿里云 FC，腾讯云等函数环境。Midway 可以将现有的 Web 项目部署为 Serverless 应用，这里以部署到阿里云函数计算作为示例。

1、添加 f.yml 文件到你的项目根目录。

➜  hello_koa tree
.
├── src
├── dist
├── f.yml                               # Midway Serverless 部署配置文件
├── package.json
└── tsconfig.json

service: my-midway-app         ## 应用发布到云平台的名字，一般指应用名

provider:
  name: aliyun                 ## 发布的云平台，aliyun，tencent 等

deployType:
  type: koa                    ## 部署的应用类型
  version: 3.0.0

2、代码修改

将 bootstrap.js 重命名为 app.js，并返回一个 app。

修改后的代码如下：

// 获取框架
const WebFramework = require('@midwayjs/koa').Framework;
const { Bootstrap } = require('@midwayjs/bootstrap');

module.exports = async () => {
  // 加载框架并执行
  await Bootstrap.run();
  // 获取依赖注入容器
  const container = Bootstrap.getApplicationContext();
  // 获取 koa framework
  const framework = container.get(WebFramework);
  // 返回 app 对象
  return framework.getApplication();
};

3、添加发布时的构建钩子

在 package.json 加入下面的这段，用于在发布时自动执行 npm run build 。

  "midway-integration": {
    "lifecycle": {
      "before:package:cleanup": "npm run build"
    }
  },
    "scripts": {
    "deploy": "midway-bin deploy"
  }

3、执行 npm run deploy 即可，发布后，阿里云会输出一个临时可用的域名，打开浏览器访问即可。

如需更详细的发布文档，请查阅 Serverless 发布 FAQ。

@midway/express

1、添加 f.yml 文件到你的项目根目录。

➜  hello_express tree
.
├── src
├── dist
├── f.yml                               # Midway Serverless 部署配置文件
├── package.json
└── tsconfig.json

service: my-midway-app             ## 应用发布到云平台的名字，一般指应用名

provider:
  name: aliyun                     ## 发布的云平台，aliyun，tencent 等

deployType:
  type: express                    ## 部署的应用类型
  version: 3.0.0

2、代码修改

将 bootstrap.js 重命名为 app.js，并返回一个 app。

修改后的代码如下：

// 获取框架
const WebFramework = require('@midwayjs/express').Framework;
const { Bootstrap } = require('@midwayjs/bootstrap');

module.exports = async () => {
  // 加载框架并执行
  await Bootstrap.run();
  // 获取依赖注入容器
  const container = Bootstrap.getApplicationContext();
  // 获取 express framework
  const framework = container.get(WebFramework);
  // 返回 app 对象
  return framework.getApplication();
};

3、添加发布时的构建钩子

在 package.json 加入下面的这段，用于在发布时自动执行 npm run build 。

{
  "midway-integration": {
    "lifecycle": {
      "before:package:cleanup": "npm run build"
    }
  },
    "scripts": {
    "deploy": "midway-bin deploy"
  }
}

3、执行 npm run deploy 即可，发布后，阿里云会输出一个临时可用的域名，打开浏览器访问即可。

如需更详细的发布文档，请查阅 Serverless 发布 FAQ。

@midwayjs/web

1、在代码根目录新增加文件 f.yml，最为精简的内容如下。

service: my-egg-demo          ## 应用发布到云平台的名字

provider:
  name: aliyun                ## 发布的云平台，aliyun，tencent 等

deployType:
  type: egg                   ## 部署的应用类型
  version: 3.0.0

package:
  include:
    - public                  ## 如果有静态文件目录，写在这里会被自动拷贝
  exclude:
    - package-lock.json       ## 忽略 package-lock.json 文件

custom:
  customDomain:
    domainName: auto          ## 自动生成域名

信息

有时候 package-lock.json 文件会造成部署包过大（将 dev 依赖打入）。

2、修改代码根目录 bootstrap.js 为下面的代码

const { Bootstrap } = require('@midwayjs/bootstrap');
const { MidwayFrameworkService } = require('@midwayjs/core');
const { join } = require('path');

module.exports = async (options) => {
  // 加载框架并执行
  await Bootstrap
    .configure({
      appDir: __dirname,
      baseDir: join(__dirname, './dist'),
      ...options
    })
    .run();
  const applicationContext = Bootstrap.getApplicationContext();
  const frameworkService = applicationContext.get(MidwayFrameworkService);
  // 返回 app 对象
  return frameworkService.getMainApp();
};

3、为了在发布时自动执行编译，在 package.json 配置如下。

{
  "name": "xxxxxx",
  "version": "xxxx",
  .....
  "scripts": {
        "deploy": "midway-bin deploy",
    ....
    },
  "midway-integration": {
    "lifecycle": {
      "before:package:cleanup": "npm run build"
    }
  },
    "egg": {
    "framework": "@midwayjs/web"
  }
}

这里的要点有两个：

1、这里指定了 egg 字段，用于指定特定的 egg 上层框架
2、这里配置了 midway-integration 字段，用于支持 midway 应用体系下原来的编译。
3、增加 deploy 脚本

信息

如果使用了自己的 egg 上层框架，这里的 egg.framework 可以变为自己的包名。

迁移方案的 Egg 默认配置

当前迁移方案会增加一些默认配置，用于在函数体系下更好运行，一般情况下，用户无需修改。

// config.default
const os = require('os');
exports.logger = {
  dir: os.tmpdir(),
};

exports.rundir = os.tmpdir();

exports.static = {
  buffer: true,
};

由于函数环境磁盘不可写，我们将默认的日志目录都调整为了临时目录。

// plugin

'use strict';

exports.i18n = false;
exports.watcher = false;
exports.development = false;
exports.logrotator = false;
exports.schedule = false;
exports.static = false;

和默认 egg 不同的是，这里默认关闭了 static 插件，原因是，如果默认没有 app/public 目录，插件启动时会创建一个，由于服务器磁盘不可写，就会报错。

如果有 static 插件的需求，请手动打开，并务必保证存在 app/public 或者相应的目录。

如果 public 目录在根目录，请配置 f.yml 中的 package.include 字段。

service: my-egg-demo         ## 应用发布到云平台的名字

provider:
  name: aliyun               ## 发布的云平台，aliyun，tencent 等

deployType: egg              ## 部署的应用类型

package:
  include:
    - public                 ## 如果有静态文件目录，写在这里会被自动拷贝
  exclude:
    - package-lock.json      ## 忽略 package-lock.json 文件

部署

在 package.json 配置 Scripts 脚本和 dev 依赖 @midwayjs/cli ，执行 npm run deploy 。

{
  "devDependencies": {
    "@midwayjs/cli": "^1.2.36"
    ...
  },
  "scripts": {
    "deploy": "midway-bin deploy",
    ...
  }
}

或者使用不同的 npm 包加速。

{
  "scripts": {
    "deploy": "midway-bin deploy --npm=cnpm",
    ...
  }
}

也可以单独执行命令。

$ npx midway-bin deploy                   ## deploy by npm
$ npx midway-bin deploy --npm=cnpm        ## deploy by cnpm

默认情况

修改默认部署的函数名

可以通过 name 字段。

service: my-demo              ## 应用发布到云平台的名字

provider:
  name: aliyun                ## 发布的云平台，aliyun，tencent 等

deployType:
  type: egg
  name: app_idx               ## 函数名

信息

使用 deployType 时 aggregation 字段不生效。

阿里云

默认发布为 http 触发器，如果需要 API 网关，可以自行按照 f.yml 的格式进行 functions 结构的修改配置，同时，在 API 网关处配置路由 /* 中转到该函数即可。

腾讯云

默认发布为 API 网关触发器，同时会自动配置网关路由。

一些限制

不支持 egg-socketio 等
不支持文件上传等网关无法支持的能力

Midway 应用迁移

限制​

@midway/koa​

@midway/express​

@midwayjs/web​

迁移方案的 Egg 默认配置​

部署​

默认情况​

修改默认部署的函数名​

阿里云​

腾讯云​

一些限制​

限制