密密麻麻的import语句不仅仅是一种视觉上的冲击,更是对代码组织结构的一种考验。 我们是如何做到让import“占领满屏”的了,又该如何优雅地管理这些import语句呢? 本文将从产生大量import语句的原因、可能带来的问题以及如何优化和管理import语句几个角度来进行探讨。
import是如何“占领满屏”的?
拒绝使用模块重导(Re-export)
模块重导是一种通用的技术。在腾讯、字节、阿里等各大厂的组件库中都有大量使用。
如:字节的arco-design组件库中的组件:github.com/arco-design
通过重导在comonents/index.tsx文件暴露所有组件,在使用一个 import就可以使用N个组件了。
// 不使用重导
import Modal from '@arco-design/web-react/es/Modal'
import Checkbox from '@arco-design/web-react/es/Checkbox'
import Message from '@arco-design/web-react/es/Message'
...
// 使用模块重导
import {Modal,Checkbox,Message}from '@arco-design/web-react'
Re-export 一般用于收拢同类型的模块、一般都是以文件夹为单位,如components、routes、utils、hooks、stories等都通过各自的index.tsx暴露,这样就能极大程度的简化导入路径、提升代码可读性、可维护性。
Re-export的几种形式
- 直接重导出
直接从另一个模块重导出特定的成员。
export {foo,bar} from './moduleA';
- 重命名并重导出(含默认导出)
从另一个模块导入成员,可能会重命名它们,然后再导出。
默认导出也可以重命名并重导出
// 通过export导出的
export {foo as newFoo,bar as newBar} from './moduleA';
// 通过export default导出的
export {default as ModuleDDefault} from './moduleD';
3.重导出整个模块(不含默认导出)
将另一个模块的所有导出成员作为单个对象重导出。(注意:整个导出不会包含export default)
export * from './moduleA';
- 收拢、结合导入与重导出
首先导入模块中的成员,然后使用它们,最后将其重导出。
import {foo,bar} from './moduleA';
export {foo,bar};
通过这些形式,我们可以灵活地组织和管理代码模块。每种形式都有其适用场景、选择合适的方式可以帮助我们构建出更清晰、更高效的代码结构。
从不使用require.context
require.context是一个非常有用的功能,它允许我们动态地导入一组模块,而不需要显式地一个接一个地导入。
只需一段代码让你只管增减文件、组件,将自动收拢重导。
在项目路由、状态管理等固定场景下极其好使(能提效、尽可能避免了增加一个配置要动N个文件的情况)
尤其是在配置路由时、产生大批量的import(多少个页面就得导入多少个import)
// 不使用require.context
import A form '@/pages/A'
import B form '@/pages/B'
...
//routes/index.ts文件统一处理
//创建一个context来导入routes目录下所有的.ts文件
const routesContext = require.context('./routes',false,/.ts$/);
const routes = [];
//遍历context中的每个模块
routesContext.keys().forEach(modulePath => {
// 获取模块的导出
const route = routesContext(modulePath);
// 获取组件名称【如果需要话】,例如:从 "./Header.ts" 提取 "Header"
// const routeName = modulePath.replace(/^./(.*).\w+$/, '$1');
// 将组件存储在组件对象中
routes.push(route.default || route)
});
export default routes;
在大项目、多路由的情况下,使用require.context在处理路由导入上大有可为。
从不使用import动态导入
动态import也能实现类似require.context的功能、动态收拢模块。
对ProvidePlugin不感兴趣
webpack.ProvidePlugin是个好东西,但也不能滥用.
项目中用到的变量/函数/库或工具,只要配置后就可以在任何地方使用了。
const webpack = require('webpack');
module.exports = {
// 其他配置...
plugins: [
new webpack.ProvidePlugin({
React: 'react',
_: 'lodash',
dayjs: 'dayjs',
// 假设项目中自己定义的utils.js在src目录下
Utils: path.resolve(__dirname, 'src/utils.js')
})
})
]
// 其他配置...
};
现在你可以在任何地方使用dayjs、lodash、Utils等,而不需要导入它。
小结:
- webpack.ProvidePlugin是一个强大的工具,它可以帮助我们减少重复的导入语句,使代码更加干净整洁。但是,它不会减少构建大小,因为这些库仍然会被包含在你的最终打包文件中。正确使用这个插件可以提高开发效率,但需要谨慎使用,以避免隐藏依赖关系,导致代码难以理解和维护。
- 对于需要按需加载的模块或组件,考虑使用动态import()语法,这样可以更有效地控制代码的加载时机和减少打包体积。
- 谨慎使用ProvidePlugin,只为那些确实需要在多个地方使用的模块配置全局变量,以避免不必要的代码打包。
另外,如果是Vite项目可以使用vite-plugin-inject代替ProvidePlugin的功能
// 配置
import inject from 'vite-plugin-inject'; // 实测暂不可用,有替代方案再更新
...
plugins: [
inject({
// 键是你想要提供的全局变量,值是你要提供的模块
dayjs: 'dayjs', // 例如,这将在全局范围内提供 'dayjs',可以通过 dayjs 访问
// 你可以继续添加其他需要全局提供的模块
}),
]
...
如果使用了TS,记得配置下类型:
// globals.d.ts文件 处理全局类型
import dayjs from 'dayjs';
declare global {
const dayjs: typeof dayjs;
}
// tsconfig.json文件 也配置一下
{
"compilerOptions": {
// 编译选项...
},
"include": [ "src/**/*", "globals.d.ts" // 确保 TypeScript 包括这个文件 ]
}