【开发规范】前端开发中引用文件的方式

1. 介绍

在前端开发中，使用别名引用文件和使用相对路径引用文件是两种不同的方式，它们通常用于引用模块、组件或资源文件。这两种方式的区别主要在于它们的含义和用途。

2. 使用别名引用文件

@ 符号通常是一种别名，表示项目的根路径或者某个特定目录的路径。这通常是通过Webpack或其他构建工具配置的别名，以简化文件引用路径并提高代码可维护性。

使用 @ 可以使引用更加简洁，而且如果项目目录结构发生变化，只需调整构建工具的配置，而不需要修改大量代码，从而降低项目维护成本及迁移难度。

示例：

import MyComponent from '@/components/MyComponent';

在Webpack中配置别名是通过使用resolve.alias来实现的。添加别名的Webpack配置示例如下：

const path = require('path');

module.exports = {
  // 其它配置项...

  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src'), // '@' 别名代表 'src' 目录
    },
  },
};

3. 使用相对路径引用文件

引用文件还可以通过相对路径的方式来实现。‘…/…/’表示相对路径，其中每个‘…/’表示向上一级目录移动一层。这是一种相对于当前文件所在位置的路径引用方式。

相对路径的优点是相对于当前文件的位置更容易理解，但是在大型项目中可能会导致路径较长，且在文件移动时需要进行相对路径的调整。

示例：

import MyComponent from '../../components/MyComponent';

4. 总结

• 别名 ‘@’ 引用文件更具可读性和可维护性；
• 相对路径 ‘…/…/’ 引用文件能够更直接地表示相对路径；
• 通常来说，在大型项目中，使用 ‘@’ 引用文件是一种更现代和推荐的做法。