脚手架，组件和 react hooks 的最佳实践

云牧2023-12-19 23:35

脚手架简介

脚手架（Scaffolding）是一种项目模板工具，旨在帮助开发者快速搭建新的项目结构，配置开发环境，以及生成一些基本的代码和文件结构。使用脚手架可以大大提高开发效率，避免重复性的工作，同时确保项目结构的一致性和遵循最佳实践。

脚手架工具通常提供以下功能：

  1. 生成项目结构：创建项目所需的目录和文件结构，包括配置文件、源代码目录、测试目录等。
  2. 配置开发环境：自动配置项目的开发环境，如安装依赖包、设置构建工具（如 Webpack、Babel 等）、配置代码格式化和校验工具（如 ESLint、Prettier 等）。
  3. 代码生成：根据预设模板生成基础的代码文件，如组件、服务、路由等，帮助开发者快速开始编写业务逻辑。
  4. 自定义和扩展：许多脚手架工具允许开发者根据自己的需求自定义模板和脚手架的行为，或者通过插件进行功能扩展。

现在流行的前端脚手架有：

  • Create React App：用于快速搭建 React 应用的脚手架工具，无需配置即可开始开发。
  • Vue CLI：Vue.js 的官方脚手架，提供了丰富的配置选项和插件系统，方便开发者搭建和维护 Vue 应用。
  • Angular CLI：Angular 的命令行接口，用于生成、开发、测试和部署 Angular 项目。
  • Yeoman：一个通用的脚手架系统，允许开发者创建自己的脚手架工具，支持多种前端框架和库。

脚手架的使用极大地简化了前端项目的初始搭建过程，帮助开发者专注于业务代码的编写，同时保证了项目的一致性和质量。


推荐使用 vite 作为脚手架构建工具

Vite 是一种现代化的前端构建工具，它利用浏览器原生的 ES 模块导入特性（ESM）来提供快速的开发服务器启动和模块热更新。

Vite 的主要优势包括：

  1. 快速的服务器启动：Vite 在开发模式下不需要打包操作，因此可以实现极快的冷启动，大幅缩短等待时间。
  2. 即时的模块热更新（HMR）：Vite 提供了高效的模块热更新机制，当文件发生变化时，只有改变的部分会被重新加载和渲染，这让开发过程更为流畅。
  3. 轻量级的构建：Vite 在生产环境下使用 Rollup 进行打包，这意味着最终的构建版本既轻量又高效，通常比传统的打包工具生成的文件更小。
  4. 原生 ESM 支持：Vite 利用浏览器对 ES 模块的原生支持，可以让你在开发过程中直接使用新的 JavaScript 特性而无需转译。
  5. 丰富的插件生态：Vite 支持 Rollup 插件，这意味着你可以利用已有的 Rollup 插件生态系统，同时 Vite 自己的插件生态也在快速增长。
  6. 易于配置：Vite 提供了一个简洁的配置文件 vite.config.js，使得对项目的配置变得简单直观。
  7. 内置功能丰富：Vite 内置了许多实用功能，如 CSS 预处理器支持、文件别名配置、环境变量加载等，无需额外配置即可使用。
  8. 框架无关：Vite 不仅仅适用于 Vue，还可以与 React、Svelte 等其他现代前端框架无缝集成。
  9. TypeScript 支持：Vite 提供开箱即用的 TypeScript 支持，无需额外安装插件或配置复杂的工具链。
  10. 优秀的 SSR 支持：Vite 对服务端渲染（SSR）的支持也非常友好，它可以帮助开发者更容易地构建 SSR 应用。
  11. 现代化的缓存策略：Vite 使用 HTTP 缓存来提高重载时的性能，因为它会利用浏览器缓存未改变的模块。

创建 react 项目

首先确保 Node.js 版本至少为 12.0.0。

然后命令行输入：

进入目录，安装依赖后：

  1. node_modules：这个目录包含所有项目依赖的库和模块。当你运行 npm install 或 pnpm install 时，这些依赖会被安装在这个目录下。
  2. public：通常用来存放静态资源，比如 HTML 文件、图像、字体等，这些资源在构建过程中通常不会被修改。
  3. src：这是源代码目录，包含了项目的主要开发文件。
    • assets：用来存放项目中使用的静态资源文件，如图片、样式文件等。
    • App.css：这是React组件App的样式表。
    • App.tsx：这是一个 TypeScript 文件，定义了 React 的 App 组件。
    • index.css：这个样式表通常用于定义全局或常用的 CSS 样式。
    • main.tsx：这是项目的入口文件，它引导应用程序的渲染。
    • vite-env.d.ts：TypeScript 声明文件，包含 Vite 相关的类型定义，用于支持 TypeScript 的类型检查。
    • .eslintrc.cjs：ESLint 的配置文件，用于定义代码质量和风格规则。
    • .gitignore：Git 的配置文件，指定了不需要加入版本控制的文件和目录。
    • index.html：应用程序的 HTML 骨架文件，通常包含挂载点，如
      。
    • package.json：定义了项目的元数据和依赖关系，以及可执行的脚本命令。
    • pnpm-lock.yaml：锁文件，确保依赖项的版本一致性，这表明项目使用 pnpm 作为包管理器。
    • README.md：Markdown 文件，通常包含项目说明、安装步骤和使用指南。
    • tsconfig.json：TypeScript 的编译选项配置文件。
    • tsconfig.node.json：可能是为 Node 环境定制的 TypeScript 编译选项配置文件。
    • vite.config.ts：Vite 的配置文件，用于定制 Vite 构建工具的行为，如插件、服务端渲染等。

react hooks 最佳实践方法

组件发展趋势

  1. 类组件（Class Component）：这是 React 等前端框架早期的组件编写方式。类组件是使用 ES6 的类语法定义的，并且通常包含了生命周期方法（如componentDidMount，componentDidUpdate，componentWillUnmount等），状态（state），以及其他逻辑。类组件可以使用 this 关键字来访问组件实例的属性和方法。
  2. 函数组件（Function Component）：随着 React 16.8 的更新，函数组件的能力得到了极大的扩展，特别是通过引入了 Hooks。函数组件是使用普通 JavaScript 函数或箭头函数定义的，它们可以接收 props 作为参数，返回需要渲染的 React 元素。在引入 Hooks 之前，函数组件通常被认为是无状态的，只能用于呈现 UI，不能持有状态或执行副作用。
  3. 钩子（Hooks）：Hooks 是 React 16.8 中引入的新特性，它允许函数组件使用状态（通过 useState）和其他 React 特性（如生命周期特性，通过 useEffect等）。Hooks 的引入使得函数组件的能力与类组件相当，甚至更加灵活和强大。

现在前端 UI 编程，更倾向使用函数组合的方式。

一个典型组件应该包含什么

  1. useState 为主的状态管理
  2. useEffect 为主的副作用管理
  3. useCallback 为主的事件 handler
  4. UI 部分
  5. 转换函数：用于请求返回数据的转换，或者一些不具有通用性的工具函数

如何拆分组件功能模块

  1. hooks.js ------ 该文件用于定义组件内部使用的自定义 hooks，这些 hooks 可以处理状态逻辑或副作用。
jsx 复制代码 
// hooks.js
import { useState, useEffect } from 'react';

export function useCustomHook() {
  const [state, setState] = useState(null);

  useEffect(() => {
    // 副作用逻辑，例如数据获取
    fetchData().then(data => {
      setState(data);
    });
  }, []);

  return state;
}

async function fetchData() {
  // 假设的数据获取函数
  return { data: 'sample data' };
}

handler.js ------ 该文件包含不依赖于 hooks 的纯函数处理逻辑，比如事件处理器或者数据格式化函数。

jsx 复制代码 
// handler.js
export function formatData(data) {
  // 对数据进行格式化
  return data.toUpperCase();
}

export function handleSubmit(event) {
  // 处理提交事件
  event.preventDefault();
  // 实际的提交逻辑
}

index.js ------ 主组件文件，用于组装 hooks 和 handlers，并提供UI。

jsx 复制代码 
// index.js
import React from 'react';
import { useCustomHook } from './hooks';
import { formatData, handleSubmit } from './handler';
import './index.css';

function MyComponent() {
  const data = useCustomHook();

  return (
    <div className="my-component">
      <form onSubmit={handleSubmit}>
        <input type="text" value={formatData(data)} readOnly />
        <button type="submit">Submit</button>
      </form>
    </div>
  );
}

export default MyComponent;
  1. index.css ------ 包含组件的样式，确保组件的外观和样式隔离。
css 复制代码 
/* index.css */
.my-component {
  border: 1px solid #ddd;
  padding: 20px;
}

.my-component input {
  margin-bottom: 10px;
}

.my-component button {
  background-color: blue;
  color: white;
  padding: 5px 10px;
  border: none;
  cursor: pointer;
}

通过这种方式，我们可以将组件的逻辑、样式和状态管理分离开来，使得代码更加模块化和可维护。每个文件都有明确的职责，这样也便于团队协作和单元测试。

这也符合编码价值观 ETC（让你的代码易于变更。Easier To Change，简称 ETC。）

自定义 Hooks 是一种自然遵循 React Hooks 设计的函数，它们可以让你在函数组件中钩入 React 的状态及生命周期特性。下面我将分别为你介绍如何实现 useMount、useUnmount、useLatest 和 useRequest 这四个自定义 Hooks。

写几个自定义 hooks

useMount

useMount 是一个在组件初次渲染时执行一次的 Hook。它类似于 componentDidMount 生命周期方法。

typescript 复制代码 
import { useEffect } from 'react';

/**
 * 组件加载时运行
 * @param fn
 */
const useMount = (fn: () => void) => {
  useEffect(() => {
    fn?.();
  }, []);
};

export default useMount;

useUnmount

useUnmount 是一个在组件卸载时执行的 Hook，类似于 componentWillUnmount 生命周期方法。

typescript 复制代码 
import { useEffect } from 'react';
import useLatest from './useLatest';

/**
 * 组件卸载时运行
 * @param fn
 */
const useUnmount = (fn: () => void) => {
  const fnRef = useLatest(fn);
  useEffect(() => () => fnRef.current(), []);
};

export default useUnmount;

useLatest

useLatest 是一个用于始终获取最新的值或函数的 Hook，无论这些值或函数何时何地更新。

typescript 复制代码 
import { useRef } from 'react';

/**
 * 获取最新 value
 */
const useLatest = <T>(value: T) => {
  const ref = useRef(value);
  ref.current = value;
  return ref;
};

export default useLatest;

useRequest

useRequest 是一个用于处理异步请求的 Hook，它可以管理请求的生命周期，如加载状态、结果、错误处理等。

typescript 复制代码 
import { useCallback, useState } from 'react';
import useMount from './useMount';

interface IOptions {
	params: Record<string, string>;
	manual?: boolean;
	onSuccess?: (res: unknown) => void;
	onError?: (err: unknown) => void;
}

/**
 * 1 实现组件初始化，发送请求获取数据
 * 2 手动触发请求
 */
const useRequest = (
	service: (params: Record<string, string>) => Promise<unknown>,
	options: IOptions
) => {
	const [data, setData] = useState<unknown>();
	const [loading, setLoading] = useState<boolean>(false);

	const init = useCallback(
		(curParams: Record<string, string>) => {
			setLoading(true);
			return service(curParams)
				.then(res => {
					setData(res);
					if (options.onSuccess) {
						options.onSuccess(res);
					}
				})
				.catch(error => {
					if (options.onError) {
						options.onError(error);
					}
				})
				.finally(() => {
					setLoading(false);
				});
		},
		[service]
	);

	useMount(() => {
		if (!options.manual) {
			init(options.params);
		}
	});

	const run = (runParams: Record<string, string>) => init(runParams);

	return { loading, data, run };
};

export default useRequest;

注意这些 hooks 使用时要放在组件函数的顶层，不能放在循环判断里面执行。

实现 ESLint 规范

安装：

bash 复制代码 
pnpm i eslint eslint-config-airbnb eslint-config-airbnb-typescript eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks @typescript-eslint/parser @typescript-eslint/eslint-plugin -D

创建 .eslintrc.cjs：

javascript 复制代码 
module.exports = {
	// 设置 ESLint 配置为基础配置
	root: true,
	// 继承一系列 ESLint 规则集
	extends: [
		// 引入 Airbnb 的 ESLint 规则
		require.resolve('eslint-config-airbnb'),
		// 引入 Airbnb 的 React Hooks ESLint 规则
		require.resolve('eslint-config-airbnb/hooks'),
		// 引入 Airbnb 的 TypeScript ESLint 规则
		require.resolve('eslint-config-airbnb-typescript'),
	],
	// 自定义规则配置
	rules: {
		// 关闭对函数组件定义方式的限制
		'react/function-component-definition': 0,
		// 关闭必须在 JSX 文件中导入 React 的规则
		'react/react-in-jsx-scope': 0,
		// 关闭对使用默认导出的偏好规则
		'import/prefer-default-export': 0,
		// 将 React Hooks 的依赖项检查规则设置为警告级别
		'react-hooks/exhaustive-deps': 1,
		// 关闭禁止使用制表符的检查。
		'no-tabs': 0,
		// 关闭规则，不进行逗号末尾的检查。
		'@typescript-eslint/comma-dangle': 0,
		'react/jsx-wrap-multilines': 0,
		// 关闭 TypeScript 文件中的缩进规则检查
		'@typescript-eslint/indent': 0,
		'react/jsx-indent': 0,
		'react/jsx-indent-props': 0,
	},
	// 指定 ESLint 的解析器为 TypeScript 的解析器
	parser: require.resolve('@typescript-eslint/parser'),
	// 配置解析器选项
	parserOptions: {
		// 指定 TypeScript 的配置文件路径
		project: require.resolve('./tsconfig.json'),
	},
	// 配置 ESLint 的环境设置
	settings: {
		react: {
			// 自动检测 React 的版本
			version: 'detect',
		},
	},
};

vite 支持 eslint：

markdown 复制代码 
pnpm i vite-plugin-eslint -D

vite.config.ts：

typescript 复制代码 
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import eslint from 'vite-plugin-eslint';

// https://vitejs.dev/config/
export default defineConfig({
	plugins: [react(), eslint()]
});
相关推荐
破z晓2 分钟前
OpenLayers 开源的Web GIS引擎 - 地图初始化
前端·开源
好看资源平台11 分钟前
JavaScript 数据可视化：前端开发的核心工具
开发语言·javascript·信息可视化
维生素C++22 分钟前
【可变模板参数】
linux·服务器·c语言·前端·数据结构·c++·算法
vah10128 分钟前
python队列操作
开发语言·前端·python
项目題供诗28 分钟前
尚品汇-H5移动端整合系统（五十五）
java·服务器·前端
会蹦的鱼1 小时前
React学习day07-ReactRouter-抽象路由模块、路由导航、路由导航传参、嵌套路由、默认二级路由的设置、两种路由模式
javascript·学习·react.js
DT——6 小时前
Vite项目中eslint的简单配置
前端·javascript·代码规范
学习ing小白8 小时前
JavaWeb - 5 - 前端工程化
前端·elementui·vue
真的很上进8 小时前
【Git必看系列】—— Git巨好用的神器之git stash篇
java·前端·javascript·数据结构·git·react.js
胖虎哥er8 小时前
Html&Css 基础总结（基础好了才是最能打的）三
前端·css·html
热门推荐
01CCF-CSP认证考试 202406-3 文本分词 100分题解02RAG 实践- Ollama+RagFlow 部署本地知识库032024年高教社杯数学建模国赛C题超详细解题思路分析04实战 | 基于YOLOv9和OpenCV实现车辆跟踪计数（步骤 + 源码）05组基轨迹建模 GBTM的介绍与实现（Stata 或 R）06【2024数模国赛赛题思路公开】国赛B题思路丨附可运行代码丨无偿自提07【数据分享】1961—2022年全国范围的逐日降水栅格数据08苍穹外卖面试总结09【2024高教社杯全国大学生数学建模竞赛】B题 生产过程中的决策问题——解题思路 代码 论文10yolov8实战第五天——yolov8+ffmpg实时视频流检测并进行实时推流——（推流，保姆教学）