专业的编程技术博客社区

网站首页 > 博客文章 正文

手把手搭建koa2后端服务器-项目结构调整

baijin 2024-12-25 09:58:21 博客文章 5 ℃ 0 评论

koa2可以完全使用单文件开发服务器,但是我相信没有人会这样做,为了方便开发,我们需要调整项目结构,使项目目录清晰明朗,为后期扩展打下基础。

初始化项目结构

在根目录下创建 src 目录,用来存储我们的项目逻辑,在 src 目录下创建 router 目录,将路由处理放在下面

- src
  - router
    - index.ts
  - app.ts
  - main.ts
- README.md

初始化路由配置

// src/router/index.ts
import KoaRouter from 'koa-router';

const router = new KoaRouter();

export default router;

初始化 koa 服务

// src/app.ts
import Koa from 'koa';
import router from './router';
import { Server } from 'http';

// 创建服务对象
const app = new Koa();

// 引入路由
app.use(router.routes());
app.use(router.allowedMethods());

// 启动服务
const runServer = (port: number): Server => {
  console.log('Server running on port 3000');
  return app.listen(port);
};

export default runServer;
// src/main.ts
import runServer from './app';

runServer(3000);

配置服务启动命令

// package.json
{
  ...
  "scripts": {
    "start": "ts-node ./src/main.ts"
  },
  "dependencies": {
    ...
  },
  "devDependencies": {
    ...
  }
}

服务热加载

安装 nodemon

yarn add -D nodemon

配置 nodemon

在根目录下增加 nodemon.json 文件

{
  // 延迟重载
  "delay": 1000,

  // 监听的目录和文件
  "watch": ["src/**/*.ts"],

  // 忽略的目录
  "ignore": ["node_modules"],

  // 执行的命令
  "exec": "ts-node ./src/main.ts",

  // 监听的文件后缀
  "ext": "ts"
}

配置环境变量读取

yarn add dotenv
yarn add -D @types/dotenv

加载环境变量

  • 创建环境变量文件 .env
// .env
NODE_ENV=dev
SERVER_PORT=3300
  • index.ts 中引入
// 在文件头部
import dotenv from 'dotenv';
dotenv.config();
  • 创建配置文件 src/config/index.ts
const config = {
  server: {
    port: Number(process.env.SERVER_PORT) || 3300,
  },
};

export default config;

使用环境变量

在 index.ts 中指定启动端口

import config from './src/config';

runServer(config.server.port);

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表