TypeScript 中搜索字段名称与列名匹配的优雅解决方案：告别冗长的 if else 语句

2024-03-22 08:27:37

根据搜索字段名称与列名匹配：TypeScript中的优雅解决方案

作为一名软件工程师，我经常需要在数据库中进行搜索，而将搜索字段名称与数据库列名相匹配一直是一项繁琐的任务。如果您也遇到类似的问题，那么这篇博文将为您提供一种优雅的 TypeScript 解决方案。

背景

在 TypeScript 中，数据类型提供了强大的机制来对复杂数据进行建模和验证。在处理涉及数据库操作的场景时，映射类型可以成为一种有效的工具。

使用映射类型进行匹配

映射类型允许我们创建新的类型，其中现有类型的键映射到新类型的值。我们可以利用这种功能创建一个映射类型，将搜索字段名称映射到相应的数据库列名：

type SearchFieldToColumnMap = {
  name: 'username',
  memberNo: 'member_no',
  email: 'email',
  companyName: 'company_name',
};

在这个例子中，SearchFieldToColumnMap 是一个映射类型，将搜索字段名称（如 "name"、"memberNo"）映射到数据库列名（如 "username"、"member_no"）。

检索列名

有了这个映射类型，我们可以轻松地根据搜索字段名称检索列名：

const searchFieldName = req.query.searchField;
const columnName = SearchFieldToColumnMap[searchFieldName];

如果 searchFieldName 存在于映射类型中，columnName 将包含相应的列名。否则，columnName 将为 undefined。

执行搜索

现在，我们可以使用检索到的列名在数据库中执行搜索：

const results = await searchDatabase(columnName, searchValue);

其中 searchValue 是搜索字段的值，searchDatabase 是您的自定义搜索函数。

优点

使用映射类型进行匹配具有以下优点：

简洁优雅： 避免使用冗长的 if else 语句，使代码更加简洁。
可扩展性： 添加新列时，只需更新映射类型即可。
清晰性： 一目了然地了解搜索字段和列名之间的对应关系。

示例

下面是一个示例，演示如何使用映射类型进行匹配：

// 允许搜索的字段
const searchFields: SearchFieldType[] = ['name', 'memberNo', 'email', 'companyName'];

// 数据库列名
const dbColumns: string[] = ['username', 'member_no', 'email', 'company_name'];

// 映射类型
type SearchFieldToColumnMap = {
  [key in SearchFieldType]: string;
};

// 获取搜索字段
const searchField = req.query.searchField;

// 根据搜索字段检索列名
const column = SearchFieldToColumnMap[searchField];

// 执行搜索
const results = await searchDatabase(column, searchValue);

// 返回结果
res.json(results);