如何使用TypeScript进行后端开发

我们经常使用 TypeScript 进行开发,webpack 会自动帮我们编译成浏览器可以执行的 JS 文件。相关的开发工具也很完善,但是进行后端开发的资料就比较少了,我们来讲解下如何使用 TypeScript 进行后端开发。

# 开发环境自动重新加载

前端有 HMR (opens new window) 技术可以实在自动热加载。后端实现这个功能其实也很简单。 首先需要按照 nodemonts-node。 我们使用 pnpm 进行包管理。

pnpm add nodemon ts-node -D
1

然后在 package.json 添加命令。

nodemon src/index.ts
1

nodemon 可以完成对文件的监控并且自动 reload,ts-node 完成对 TypeScript 的支持。并且不需要配置,nodemon 会自动调用 ts-node

# 支持绝对路径引用

前端开发中也经常使用绝对路径,所以希望后端也能使用绝对路径。TypeScript 默认不支持绝对路径的使用,我们需要引用第三方来完成这个操作。

pnpm add ttypescript typescript-transform-paths -D
1

ttypescript 支持在 build 过程中添加插件来完成很多功能,绝对路径转换成相对路径就是其中一个功能, typescript-transform-paths 这个插件就是用来完成绝对路径映射的。我们需要在 tsconfig.json 中进行相关的配置。

{
  "ts-node": {
    "transpileOnly": true,
    "require": ["typescript-transform-paths/register"]
  },
  "compilerOptions": {
    "target": "ESNext",
    "module": "commonjs",
    "moduleResolution": "Node",
    "outDir": "dist",
    "resolveJsonModule": true,
    "skipLibCheck": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"]
    },
    "plugins": [{ "transform": "typescript-transform-paths" }]
  },
  "include": ["src"]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

首先在 paths 自动下,映射文件夹路径,这样就可以使用 @/posts/index.ts 这种格式来引用模块。当然路径映射在开发环境下需要 ts-node 的支持,我们在 ts-noderequire 字段上引用我们安装的插件。最后是编译成 JS 文件的过程中添加绝对路径的支持。

ttsc -p tsconfig.json
1

使用增强版 ttsc 来完成路径的转换,可以看到生成的 JS 文件中已经是正常的相对路径引用了,前端的时候大多数都是 webpack 完成打包的,后端的话可以直接使用 ttsc 来完成编译过程。

# 总结

TypeScript 在类型定义上的支持可以让我们很方便开发大型项目,后端支持了 reload 和绝对路径之后开发效率也可以大大提高。

# 参考

ts-node で path alias が効かないにハマる (opens new window)

mapdoge-bot (opens new window)

如何编写Telegram Bot

最近在处理如何把经纬度转换成日本的 MAPCODE 的问题。在外出行的时候,经常使用的设备都是手机,如何在手机上方便的计算旅游景点的 MAPCODE 然后使用车载导航呢? 我的想法是做一个 Telegram Bot,输入景点的 Plus Code (opens new window), 然后返回 MAPCODE。

# 申请 Bot

首先,你要去找 BotFather (opens new window)申请 Bot。 通过简单的对话就可以创建 Bot。使用 /start 命令可以查看所有支持的指令。

输入, /newbot 就可以创建 Bot 了,通过对话模式可以设定 Bot 的名字。然后你可以得到一个属于这个 Bot 的 token,格式类似于 577XXXXX:AAEMUXqXrgRE9R2jPcOXXXXX。 拿到这个 token 就可以构建 Bot 了。

# 构建 Bot API

Bot API 本质是 HTTPS API,通过构建请求来实现功能。不过构造 HTTPS 请求本身很枯燥,已经有很多现成的框架可供我们使用。本人擅长使用 JavaScript,所以选择了 telegraf.js (opens new window) 这个框架。

# Bot 代码示例

import { Telegraf } from 'telegraf';

const bot = new Telegraf(process.env.BOT_TOKEN);

bot.start(ctx => {
  const message = `I can help you to query MAPCODE with Telegram.\nYou can copy plus code from Google Maps and paste it to tell me.`;
  ctx.reply(message);
});

bot.help(ctx => {
  ctx.replyWithMarkdownV2(
    'Send me a [plus code](https://maps.google.com/pluscodes/)'
  );
  ctx.reply(`MapDoge Version ${process.env.npm_package_version}`);
});

bot.launch();

// Enable graceful stop
process.once('SIGINT', () => bot.stop('SIGINT'));
process.once('SIGTERM', () => bot.stop('SIGTERM'));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Telegram Bot 默认都支持 /start/help 命令。所以我就贴出了这两个命令的简单写法。使用成熟的框架可以大大简化编写 Bot 的复杂度。

# 总结

Telegram Bot 有完善的文档和生态,编写一个 Bot 并没有想象的那么难。大家都可以尝试下,非常方便实现在手机端的一些自定义功能。

# 参考

Bot Code Examples (opens new window)

mapdoge-bot (opens new window)

使用MobX管理React的状态

使用 PWA 框架进行应用开发,不论是 Vue 还是 React,最关注的设计应该就是状态的管理了。React 生态下状态管理的框架可谓是五花八门,本人目前用过两个,分别是 @reduxjs/toolkit (opens new window)mobx-react (opens new window)。 个人感觉 Mobx 用起来更简洁,所以本文着重介绍 Mobx。

# 安装 MobX

MobX 本来就可以独立 PWA 框架来使用,所以安装的时候需要安装本体和 React 集成库。

pnpm install mobx-react-lite mobx
1

# 设计 Store

为了测试 MobX 的使用,我写了一个简单的 Todo 例子,接下来讲解如何设计 Store 方便使用。

export class TodoList {
  @observable.shallow list: TodoItem[] = [];

  constructor() {
    makeObservable(this);
  }

  @action
  private fromJS = () => {
    this.list = this.list.map(
      todo => new TodoItem(todo.title, todo.id, todo.completed)
    );
  };

  @action
  addTodo = (text: string) => {
    this.list.push(new TodoItem(text));
  };

  @action
  removeTodo = (todo: TodoItem) => {
    this.list.splice(this.list.indexOf(todo), 1);
  };

  @action
  removeCompleted = () => {
    this.list = this.activeTodos;
  };

  @action
  toggleAll = (value: boolean) => {
    this.list.forEach(todo => {
      todo.updateCompleted(value);
    });
  };

  @computed
  get showTodo(): boolean {
    return this.list.length > 0;
  }

  @computed
  get allTodos(): TodoItem[] {
    return this.list;
  }

  @computed
  get completedTodos(): TodoItem[] {
    return this.list.filter(todo => todo.completed);
  }

  @computed
  get activeTodos(): TodoItem[] {
    return this.list.filter(todo => !todo.completed);
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

不同于 React Hooks 函数式声明,Mobx 我们推荐使用 Class 方式来声明,通过修饰符来绑定属性和方法对应 MobX 的相关概念。MobX 推荐使用 action 进行数据的更改,使用 computed 完成对数据的筛选和处理。不建议直接更改声明的数据。

# 设计全局 Store

export type RootStore = {
  todoList: TodoList;
};

export const store: RootStore = {
  todoList
};

const StoreContext = React.createContext<RootStore>(store);

export const StoreProvider = StoreContext.Provider;

export const useStore = () => React.useContext(StoreContext);
1
2
3
4
5
6
7
8
9
10
11
12
13

通过声明全局 Store,模块化设计各个子 Store,这里虽然只有一个 todoList, 但可以根据应用规模添加子模块,方便扩展。

# Root 导入 Store

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <StoreProvider value={store}>
      <App />
    </StoreProvider>
  </React.StrictMode>
);
1
2
3
4
5
6
7

在 React 根节点声明 Store, 保证整个应用都可以同步到 store 的数据。

# 封装 View

我们需要在使用 store 的地方,调用 observer 保证状态的更新能及时反应到视图上。

const TodoView = () => {
  const { todoList } = useStore();

  return (
    <section className="todoapp">
      <header className="header">
        <h1>todos</h1>
      </header>
    </section>
  );
};

export default observer(TodoView);
1
2
3
4
5
6
7
8
9
10
11
12
13

# 总结

MobX 的状态更新原理是基于 Proxy (opens new window)。 通过代理声明的数据对象,在读取和写入的时候执行相关回调进行更新。

# 参考

mobx-react-todo (opens new window)