请解释如何使用装饰器实现路由配置？

推荐答案

在 TypeScript 中，可以使用装饰器来实现路由配置。以下是一个简单的示例，展示了如何使用装饰器来定义路由：

// www.javascriptcn.com code example
import 'reflect-metadata';

const PATH_METADATA = 'path';
const METHOD_METADATA = 'method';

function Controller(path: string): ClassDecorator {
  return (target: any) => {
    Reflect.defineMetadata(PATH_METADATA, path, target);
  };
}

function createMethodDecorator(method: string) {
  return (path: string): MethodDecorator => {
    return (target: any, key: string | symbol, descriptor: PropertyDescriptor) => {
      Reflect.defineMetadata(PATH_METADATA, path, descriptor.value);
      Reflect.defineMetadata(METHOD_METADATA, method, descriptor.value);
    };
  };
}

const Get = createMethodDecorator('GET');
const Post = createMethodDecorator('POST');

@Controller('/user')
class UserController {
  @Get('/info')
  getUserInfo() {
    return 'User Info';
  }

  @Post('/create')
  createUser() {
    return 'User Created';
  }
}

function mapRoutes(instance: any) {
  const prototype = Object.getPrototypeOf(instance);
  const methods = Object.getOwnPropertyNames(prototype).filter(
    (item) => item !== 'constructor'
  );

  methods.forEach((methodName) => {
    const routeHandler = prototype[methodName];
    const path = Reflect.getMetadata(PATH_METADATA, routeHandler);
    const method = Reflect.getMetadata(METHOD_METADATA, routeHandler);

    if (path && method) {
      console.log(`Mapping route: ${method} ${path}`);
      // 这里可以将路由映射到具体的路由处理逻辑
    }
  });
}

const userController = new UserController();
mapRoutes(userController);

本题详细解读

1. 装饰器的作用

装饰器是一种特殊类型的声明，它可以被附加到类声明、方法、访问符、属性或参数上。装饰器使用 @expression 这种形式，expression 求值后必须为一个函数，它会在运行时被调用，被装饰的声明信息做为参数传入。

2. 路由配置的实现

• Controller 装饰器：Controller 是一个类装饰器，它接收一个路径参数，并将该路径存储在类的元数据中。
• createMethodDecorator 函数：这个函数用于创建方法装饰器。它接收一个 HTTP 方法（如 GET、POST），并返回一个方法装饰器。该装饰器将路径和 HTTP 方法存储在方法的元数据中。
• Get 和 Post 装饰器：通过 createMethodDecorator 函数创建的 Get 和 Post 装饰器，分别用于标记处理 GET 和 POST 请求的方法。
• mapRoutes 函数：这个函数用于遍历类的所有方法，并根据元数据中的路径和 HTTP 方法，将路由映射到具体的处理逻辑。

3. 元数据的使用

TypeScript 的 reflect-metadata 库允许我们在运行时存储和检索元数据。通过 Reflect.defineMetadata 和 Reflect.getMetadata，我们可以将路由信息存储在类或方法的元数据中，并在需要时读取这些信息。

4. 路由映射

在 mapRoutes 函数中，我们遍历类的所有方法，并根据元数据中的路径和 HTTP 方法，将路由映射到具体的处理逻辑。在实际应用中，可以将这些路由信息传递给路由框架（如 Express.js）来实现路由的注册和处理。

通过这种方式，我们可以使用装饰器来简化路由配置，使代码更加清晰和易于维护。