React / 系统课时
认识项目目录
认识项目目录
本课带你读懂 Vite React TypeScript 项目的主要目录和文件。重点不是背文件名,而是理解浏览器入口、React 入口、组件代码、静态资源和工具配置各自负责什么,避免后续把业务代码放错位置。
学习目标
- 识别项目入口与根组件之间的调用关系
- 区分
src、public和构建产物目录 - 理解主要配置文件的职责边界
先看整体结构
不同版本模板可能略有差异,但典型结构如下。node_modules 内容很多,日常无需手动修改,也不应提交到版本库。
react-starter/
├─ public/
├─ src/
│ ├─ assets/
│ ├─ App.tsx
│ ├─ index.css
│ └─ main.tsx
├─ index.html
├─ eslint.config.js
├─ package.json
├─ tsconfig.app.json
├─ tsconfig.node.json
└─ vite.config.ts预期结果:在 VS Code 资源管理器或文件系统中能找到这些核心条目。若个别图标文件或样式文件名称不同,以当前模板实际生成内容为准。
浏览器入口与 React 入口
根目录的 index.html 是浏览器首先加载的 HTML。它通常只提供挂载节点,并通过模块脚本加载 src/main.tsx。业务页面不应全部写进这个 HTML 文件。
src/main.tsx 创建 React 根节点,再把根组件渲染到页面。一个常见入口如下:
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import "./index.css";
import App from "./App";
// 挂载节点名称必须与 index.html 保持一致。
const rootElement = document.getElementById("root");
if (!rootElement) {
throw new Error("未找到 #root 挂载节点");
}
// StrictMode 只提供开发期检查,不会额外生成 DOM 包装节点。
createRoot(rootElement).render(
<StrictMode>
<App />
</StrictMode>,
);生效行为:浏览器加载 index.html 后执行此模块,找到 #root 节点并渲染 App。若挂载节点不存在,页面不会静默失败,而会抛出明确错误。
src 中放什么
src 是需要参与编译的源代码目录。页面、组件、Hooks、请求封装、类型定义和被代码导入的图片通常放在这里。随着项目增长,可以按业务领域组织,而不是长期把所有组件堆在一个 components 目录中。
App.tsx 是模板提供的根组件,不代表所有页面都必须写在这里。后续加入路由后,App 往往负责全局布局和路由出口,具体页面再放到独立目录。
src/assets 适合存放会被模块导入的资源。构建工具能够分析引用关系、处理文件名和生成最终地址。
public 与静态资源
public 中的文件会按原始名称复制到构建结果根目录,代码通常使用 /文件名 访问。它适合必须保持固定名称、无需被模块系统处理的资源,例如站点图标或外部系统约定的验证文件。
普通业务图片优先放在 src/assets 并通过 import 引用,这样删除未使用代码时更容易发现无效资源。不要把所有图片都放进 public,否则构建工具无法完整追踪依赖。
配置文件分别负责什么
package.json 记录项目脚本和依赖,是 npm 理解项目的入口。锁文件记录实际安装版本,应与 package.json 一起提交,保证团队安装结果尽量一致。
vite.config.ts 负责开发服务器、插件、路径别名和构建选项。tsconfig.app.json 约束浏览器端 TypeScript 代码,tsconfig.node.json 通常服务于 Vite 配置等 Node.js 环境代码。
eslint.config.js 定义静态检查规则。它负责发现潜在错误和不符合约定的代码,不等同于 TypeScript 编译,也不等同于代码格式化。
建议的扩展方式
项目刚开始时保持结构简单即可。当页面和业务增多,可以在 src 下增加 components、pages、services 和 types,但每个目录都应有明确职责。
不要直接修改 node_modules 中的代码,重新安装依赖后修改会丢失。也不要把 dist 当作源代码目录,dist 是构建命令生成的可部署产物,可以随时重新生成。