New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typescript 在 Egg + Vue 应用中的实践 #11

Open
whxaxes opened this Issue Mar 4, 2018 · 12 comments

Comments

Projects
None yet
7 participants
@whxaxes
Owner

whxaxes commented Mar 4, 2018

最近团队准备尝试 typescript,于是找了个新项目来试水,目前那个项目也已经成功上线。在此总结一下我这个项目在开发途中遇到的一些问题以及自己是怎么解决的。

准备工作

编译构建

在构建方面,node 端的 ts 代码,我是直接用 tsc 构建,而前端的 ts 代码,则用 webpack 打包。构建流程如下图所示,还是比较简单的。

在 node 端中,是直接将 js 代码编译到同个目录,因此启动 ts 的 egg 应用就跟启动 js 差不多,因为结构是一致的,

为了在写代码时不受干扰,可以在 vscode 的配置中加一段配置,将编译后的 js 文件隐藏掉:

"files.exclude": {
    "**/*.js": {
      "when": "$(basename).ts"
    },
    "**/*.map": true
},

这里说明一下,node 端的开发期为什么不用 ts-node,因为 egg loader 机制会自动挂载模块,而这段逻辑里很多是写死了加载 *.js,所以暂不支持 ts-node(以后会支持),因此暂时还是使用 tsc 做编译。

前端的就直接通过 webpack 打包了,用的是我们团队同学写的 easywebpack 做前端打包,目前也已经支持 typescript 了。

在编译这快,还有个注意的点就是,因为 node 端和前端的 ts 配置是不一样的,所以需要两份 tsconfig.json,我就是在 node 目录放一个 tsconfig.json,然后在 web 目录放一份 tsconfig.json,然后两份 tsconfig.json 同时 extend 一份公共的 tsconfig.base.json。

项目结构如下。

.
├── app
│   ├── controller
│   ├── extend
│   ├── middleware
│   ├── service
│   ├── view
│   └── web
|       ├── webpack.config.ts
|       └── tsconfig.json
├── config
|   └── tsconfig.base.json
├── typings
|   └── index.d.ts
└── tsconfig.json

可以看到根目录有个 tsconfig.json,是给 node 用的,web 目录有个 tsconfig.json 是给前端用的。然后两者都继承 config/tsconfig.base.json

框架

如果是直接使用 egg 的项目,就可以直接从 egg 中 import 相关声明,不过很大一部分项目由于一些定制型的需求,都是会使用适合自己团队的 egg 上层封装模块。

我们团队也有自己的一个 egg 上层封装的框架 larva,在 egg 上添加了一些额外的方法、中间件等,但是目前有支持 typescript 的就只有 egg。我希望我的业务代码能够直接从 larva 中将 egg 中暴露的 interface 给引入进来,也就是能够

import { Context } from 'larva';

于是我以 egg 的声明文件为基础,将 egg 的声明全部导出的同时,在上层框架的声明文件中做拓展。

比如我的 larva 框架在 helper 中拓展了一个 formatDate 方法,又在 context 对象中拓展了一个 isProd 的属性。就直接使用 declare module 'egg' 在 egg module 上做拓展(不知道怎么拓展的同学,Declation Merging 了解一下)。

// larva/index.d.ts

import * as Egg from 'egg';

declare module 'egg' {
  export interface Context {
    isProd: boolean;
  }

  export interface IHelper {
    formatDate(data: Date | string | number, format: string): string;
  }
}

export = Egg;

最后再将 Egg 完整导出,就可以在 import 上层框架的时候,使用 egg 中的所有类和接口了。

起初我是用 export * from 'egg' 的方式导出,但是后来发现这样会导致插件的声明文件就很难写了,没法做到通用(因为没法同时合并到 egg 及上层框架中)。所以才使用 export = 的方式来导出,这样的话,就还是基于 egg 的声明,在插件中写声明文件的时候也就可以只给 egg 拓展也能在使用第三方框架的项目中生效。

基本上上层框架的声明文件都可以这么写,当然,如果有更好的写法也欢迎提出。

插件

项目中用到了很多 egg 插件,而其中大部分 egg 插件都是没有写 typescript 的声明文件的。因此我就一边给相关插件补充声明文件,一边开发项目,这个过程,也可以称作是渐进式开发,流程基本上像这样。

比如我有一个 egg 插件叫 egg-sfclient。我会先在项目中编写相关插件的声明文件,会将该文件放到项目的 typings 目录下:

// {project}/typings/sfclient.d.ts

import { Application } from 'egg';

export class Sfclient {
  constructor(app: Application);
  getConfig: (name: string) => string;
}

// 由于我的 larva 框架是基于 egg 的声明文件做拓展的,因此插件的也直接拓展 egg
declare module 'egg' {
  interface Application {
    sfclient: Sfclient;
  }
}

写完这个声明文件之后,在 vscode 中如果能获得该提示,就说明没问题了

当写完这个声明文件,并且觉得没什么问题了,就可以将该声明文件直接提个 PR 到插件库,合并并且发版之后,就把本地的声明文件删掉,再在 typings 中将插件 import 进来即可(因为 typescript 是通过 import 去加载模块的声明文件的)。

如果是框架内置的插件,还可以在框架的声明文件中,直接将插件的声明 import 进来,在项目中就可以直接使用了。

// larva/index.d.ts

import * as Egg from 'egg';
import 'egg-sfclient';

declare module 'egg' {
  ...
}

export = Egg;

开发 - Node 端

Controller & Service

egg 一个很方便的能力是自动挂载,可以通过 loader 将 controller、service 自动注入到 Context 对象中,但是这个能力对于写 ts 来说又会带来一定问题,就是 ts 在做静态类型分析的时候,不知道这些模块会被自动注入,所以我们需要用声明文件来告诉 ts 这些模块被挂载到了相关对象中。

比如当我写一个 controller

// app/controller/account.ts

import { Controller } from 'larva';

export default class AccountController extends Controller {
  public async login() {
    // login
  }
}

如果在 router.ts 中想使用该 controller 的时候,如果在 js 中,就可以直接 app.controller.account.login 获取到这个路由方法,但是在 ts 中由于强类型检查,会提醒 IController 中不存在该实例。

所以我们要通过 d.ts 将这个实例注入到 IController 中。

// app/controller/index.d.ts

import AccountController from './account';
declare module 'larva' {
  interface IController {
    account: AccountController;
  }
}

加上这个之后,就能愉快的得到代码提示并且能够成功编译了。

在 Service 中亦是如此。

当然,由于这种 d.ts 是有规律的,只需要知道目录结构就能够生成这种 d.ts,所以完全可以通过工具来自动生成,我写了一个小工具:egg-ts-helper 可以用来自动生成 controller、service、proxy 目录的声明文件。

Extend

egg 可以很方便的被拓展,只需要在 extend 目录下添加包含拓展方法的的代码文件即可。

但是在 ts 中的话,这些拓展的方法如何注入到 egg 对象中,并且在拓展的逻辑中能够得到相关代码提示呢?比如我要拓展 Context 对象。我是这么做的。

// app/extend/context.ts

const extendContext = {
  get isProd(): boolean {
    const ctx = this as any as Context;
    return ctx.app.config.env === 'prod';
  },
  
  sfRequest(this: Context, name) {
    return this.app.sfclient.request(name);
  }
};

export default extendContext;

declare module 'larva' {
  interface Context {
    isProd: typeof extendContext.isProd;
    sfRequest: typeof extendContext.sfRequest;
  }
}

如果是方法,就直接用 ts 的 ThisType 来实现,否则就使用类型指定,将 this 指定为 Context。

而给 egg 对象中注入的方式就有点不是很优雅了,得一个一个方法来写,这个目前是还没想到什么好的办法,唯一想到的就是跟 Controller 那个一样,通过工具来自动生成,不过这个就得做语法分析了。

egg-ts-helper 最新版本已经支持 extend 下的代码的 d.ts 的自动生成了,通过 babylon 做 ts 语义分析.

Application 还有 Helper 等的拓展也一样。

Middleware & Config & Unittest

而像 middleware、config、unittest 这些,就跟 js 的编写方式类似。所以倒没什么可展开讲的,直接贴出示例代码。

Middleware

// app/middleware/mymid.ts

import { Context } from 'larva';

export default () => {
  return async function mymid(ctx: Context, next: () => Promise<any>) {
    // do something

    await next();
  };
};

Config

// app/config/config.default.ts

import { Context, EggAppConfig } from 'larva';
import * as path from 'path';

export default (appInfo: EggAppConfig) => {
  const config: any = {};

  config.keys = appInfo.name + '_1513135333623_4128';

  config.static = {
    prefix: '/public',
    dir: path.join(appInfo.baseDir, 'public'),
  };

  return config;
};

Unittest

// test/app/controller/account.test.ts

import mm from 'egg-mock';
import { app, assert } from 'egg-mock/bootstrap';

describe('test/app/controller/account.test.js', () => {
  afterEach(() => {
    mm.restore();
  });

  it('访问 login 会应该正常', () => {
    return app.httpRequest()
      .get('/account/login')
      .expect(200);
  });
});

开发 - 前端

我们的前端是使用 Vue 来开发,而 Vue 2.5 以上对 typescript 的支持已经很好了,社区相关文档也蛮齐全。

在我的项目中,就是直接用 vue-property-decorator 提供的装饰器来写 vue 组件。举个例子:

vue

// app/web/page/home/index.vue

<template>
  <div>hello {{ name }} {{ count }}</div>
</template>

<script lang="ts">
  import vm from './vm';
  export default vm;
</script>

ts

// app/web/page/home/vm.ts

import Vue from 'vue';
import { Component } from 'vue-property-decorator';

@Component({
  name: 'Home',
})
export default class Home extends Vue {
  name = 'typescript';
  count = 0;
  
  countNum() {
    setInterval(() => {
      this.count++;
    }, 1000);
  }
  
  mounted() {
    this.countNum();
  }
}

我个人是喜欢将 ts 的逻辑抽离出来一个单独的文件 vm.ts,而且这样的话,当我在页面中想使用某个组件的实例的时候,可以使用类型指定的方式来达到代码提示的能力,比如:

// app/web/page/account/vm.ts

import Vue from 'vue';
import { Component } from 'vue-property-decorator';

// 将 Home 引入的同时,也引入 vm
import Home from '../home/index.vue';
import HomeVm from '../home/vm';

@Component({
  name: 'Account',
  components: { Home },
})
export default class Account extends Vue {
  mounted() {
    // 强制指定为 HomeVm
    const home = this.$refs.home as HomeVm;

    // 就可以有代码提示了
    home.countNum();
  }
}

之所以这样写,就是为了在 vscode 中开发的时候,有良好的代码提示,虽然说不强制指定类型也是可以编译的,因为 $refs.xx 的类型是 any,但是有代码提示的话还是方便很多的。

最后

以上基本上就是此次在 egg 中使用 ts 的尝试经验了,以后应该会有更多的项目去尝试用 ts,如果有更好的想法会继续写一些文章进行分享。

本文同步发布于:#11

@geekdada

This comment has been minimized.

geekdada commented Mar 5, 2018

imgur-deck-built-FFQegRpaJSRaw

@hhpop

This comment has been minimized.

hhpop commented Mar 5, 2018

学习中~~~如果有例子就最好了~~~

@whxaxes

This comment has been minimized.

Owner

whxaxes commented Mar 5, 2018

@hhpop8 其实是有脚手架的,只是在团队内部的,不方便开源,我抽空抽离个开源版的

@atian25

This comment has been minimized.

atian25 commented Mar 5, 2018

context 那个要试下 jsdoc

@hhpop

This comment has been minimized.

hhpop commented Mar 9, 2018

什么时候能发布可开源版的例子呀,十分期待

@whxaxes

This comment has been minimized.

Owner

whxaxes commented Mar 11, 2018

@hhpop8 已经将一个精简版(不包含前端部分)的例子发到了 github,有兴趣可以下载下来看一下:https://github.com/whxaxes/egg-boilerplate-d-ts

@hhpop

This comment has been minimized.

hhpop commented Mar 11, 2018

太棒子,福利呀~~~

@popomore

This comment has been minimized.

popomore commented Mar 13, 2018

没有 app/web?

@dengnan123

This comment has been minimized.

dengnan123 commented Mar 31, 2018

学习了

@whxaxes

This comment has been minimized.

Owner

whxaxes commented Apr 1, 2018

更新~~

关于 config

我们习惯写 egg 的 config 都是这么写

// app/config/config.default.ts

import { Context, EggAppConfig } from 'egg';
import * as path from 'path';

export default (appInfo: EggAppConfig) => {
  const config: any = {};

  config.keys = appInfo.name + '_1513135333623_4128';

  config.static = {
    prefix: '/public',
    dir: path.join(appInfo.baseDir, 'public'),
  };

  return config;
};

但是由于 config 是在运行时返回的,这样就会导致我想在 controller 中,或者 service 中拿到配置的时候,没法通过 d.ts 来注入。

为了解决这个问题,我昨天在想能否跟 Controller 一样用类的方式来写 config。这样的话,就又能通过 d.ts 来实现注入,在日后也能通过依赖注入来实现注入。

而实现也不复杂,可以通过装饰器来 hack 一下,也就是在装饰器中,将返回的 Config 类实例化,并且传入 appInfo,再取出所有配置返回。

于是我实现了一个装饰器 Config 以及一个 BaseConfig 的类。

// config/utils.ts
import { EggAppConfig } from 'egg';

export class BaseConfig {
  constructor(public appInfo: EggAppConfig) {}
}

export function Config<T extends { new (appInfo: EggAppConfig): BaseConfig }>(constructor: T) {
  const returnFunc = (appInfo: EggAppConfig) => {
    const keys = Object.getOwnPropertyNames(constructor.prototype);
    const config = new constructor(appInfo);
    const ret = { ...config };
    // add getter
    for (const key of keys) {
      if (key === 'constructor') {
        continue;
      }
      ret[key] = config[key];
    }
    return ret;
  };
  return (returnFunc as any) as T;
}

这个装饰器很简单,就是将传进来的 Config 对象,取出里面的所有属性,包括 getter 属性,组成一个 PlainObject 返回。

然后我的 config.default.ts 就可以这么写:

// config/config.default.ts
import { BaseConfig, Config } from './utils';

@Config
export default class DefaultConfig extends BaseConfig {
  get keys() {
    return this.appInfo.name + '_1513135333623_4128';
  }

  middleware = [
    'uuid',
  ];
}

可以返回 Class 了之后,注入就很简单了,在 d.ts 中通过交叉类型就可以注入到应用中了。

// config/index.d.ts

import { EggAppConfig } from 'egg';
import DefaultConfig from './config.default';
import LocalConfig from './config.local';
import ProdConfig from './config.prod';

type NewEggAppConfig = EggAppConfig & DefaultConfig & LocalConfig & ProdConfig;
declare module 'egg' {
  interface Application {
    config: NewEggAppConfig;
  }

  interface EggApplication {
    config: NewEggAppConfig;
  }

  interface Controller {
    config: NewEggAppConfig;
  }

  interface Service {
    config: NewEggAppConfig;
  }
}

这样的好处就是我定义的一些业务配置,也能进行深度合并。

比如我在 config.local.ts 中这么配置

// config.local.ts
import { BaseConfig, Config } from './utils';

@Config
export default class LocalConfig extends BaseConfig {
  local = {
    msg: 'local config',
    go: {
      test: 'yoyo',
    },
  };
}

然后在 config.prod.ts 中这么配置

// config.prod.ts
import { BaseConfig, Config } from './utils';

@Config
export default class ProdConfig extends BaseConfig {
  local = {
    msg2: 'prod config',
    go: {
      test2: 'yoyo',
    },
  };
}

然后我在 controller 中使用的时候,就能得到 msg、msg2、go.test、go.test2 的代码提示了,如图:

image

image

感觉还蛮方便,代码已经更新到了 https://github.com/whxaxes/egg-boilerplate-d-ts 。有兴趣的可以 clone 下来玩玩。

而且现在 egg 也已经支持 ts-node,在开发期不需要跑 tsc 也不需要生成 js 了,这个也已经更新到了我那个骨架中。

@whxaxes

This comment has been minimized.

Owner

whxaxes commented Apr 1, 2018

再更新~~

刚在同事的介绍下,发现 typescript 2.8 版本开始引入了个 ReturnType 可以拿到方法的返回类型。所以这样一来,配置又不用写这么麻烦了。

可以这么写

// config/config.default.ts

'use strict';

import { EggAppConfig } from 'egg';

export default function(appInfo: EggAppConfig) {
  return {
    keys: appInfo.name + '_1513135333623_4128',
    middleware: [
      'uuid',
    ],
  };
}

然后在 d.ts 中

// config/index.d.ts
import { EggAppConfig } from 'egg';
import defaultConfig from './config.default';
import localConfig from './config.local';
import prodConfig from './config.prod';

type NewEggAppConfig = EggAppConfig &
  ReturnType<typeof defaultConfig> &
  ReturnType<typeof localConfig> &
  ReturnType<typeof prodConfig>;

declare module 'egg' {
  interface Application {
    config: NewEggAppConfig;
  }

  interface EggApplication {
    config: NewEggAppConfig;
  }

  interface Controller {
    config: NewEggAppConfig;
  }

  interface Service {
    config: NewEggAppConfig;
  }
}

it's fucking cool!

@zysam

This comment has been minimized.

zysam commented Aug 5, 2018

用 jsdoc 的话,可以考虑这么写。

/**
 * @param { import('egg').Application } app - egg application
 */
module.exports = app => {
 const {router, controller} = app
}

另外 ts-helper,还没有办法自动处理 js 文件吧?
还有 mongoose 为 orm 的话。虽然 egg-mongoose 提供 index.d.ts, 但不能拿的 models。如 ctx.model.User 的提示。但是 model.User.find() 是有提示的。不知道怎么处理。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment