Skip to content

前端开发最佳实践总结

开发思路

前端开发时,应该如何考虑开发的主次先后,比如数据结构、数据流转、UI绘制,js逻辑等等,请给出你的最佳实践

在前端开发中,正确规划和安排各项任务的主次先后对于项目的顺利进行至关重要。以下是一个针对数据结构、数据流转、UI绘制以及JavaScript逻辑等方面的开发优先级与最佳实践建议:

  1. 需求分析与设计

    • 首要任务:理解业务需求,明确功能点和交互设计。这包括了解用户界面(UI)的设计稿或交互原型,确定页面布局、元素样式和动态效果。
  2. UI框架搭建与静态渲染

    • 次级任务:基于设计稿构建基础UI框架,采用HTML/CSS/JS等技术实现静态页面布局。此时并不涉及动态数据,而是先确保页面的基本结构和样式正确无误。
  3. 数据结构设计

    • 并行考虑:根据项目需求,设计和规划前后端接口所需的数据结构,并预定义前端需要处理的数据模型。例如,在React应用中可能需要创建Redux状态树,Vue应用中设计Vuex的状态管理结构等。
  4. API接口设计与对接

    • 重要阶段:与后端团队协作,制定API接口规范,完成前后端接口联调。此阶段前端通常会编写Mock数据以支持独立于后端的开发。
  5. 数据流转与状态管理

    • 核心工作:实现数据从服务器到前端组件的流转,设置合适的状态管理机制,确保数据能够在页面间传递和更新时保持一致性和效率。同时考虑数据缓存策略和优化加载性能。
  6. JavaScript逻辑编写

    • 详细实施:编写组件级别的JavaScript逻辑,处理用户交互、表单验证、数据变换、动画效果等。遵循模块化、可复用的原则,确保代码的清晰度和可维护性。
  7. 错误处理与异常边界

    • 不可或缺:在整个过程中及早考虑并实现错误处理机制,如网络请求失败、数据解析异常、用户操作异常等情况下的提示与反馈。
  8. 性能优化

    • 后期调整:在基本功能完成后,对项目进行性能优化,比如减少不必要的DOM操作、懒加载、资源压缩合并等,提升用户体验。
  9. 测试与调试

    • 贯穿始终:单元测试、集成测试、E2E测试都要逐步展开,确保每个功能模块稳定可靠,并通过持续集成和部署流程保证代码质量。

综上所述,尽管这些步骤并非严格线性,但在实际开发过程中,可以根据实际情况灵活调整优先级和顺序, 做到需求分析、UI构建、数据架构和逻辑处理并行推进,但总体上应遵循从静态到动态、从结构到行为、从整体到细节的渐进式开发原则。

代码思路

后端返回的数据结构可能是多样的,前端需要对数据进行处理,以适应页面展示的需求。请给出你的最佳实践

在前端开发中,针对后端返回的多变数据结构进行处理以适应页面展示需求的最佳实践包括以下几个方面:

  1. 定义清晰的数据模型

    • 在前端根据UI设计和功能需求明确所需的数据结构,并创建对应的JavaScript对象模型(或使用TypeScript等类型语言提供静态类型检查)。
    • 这有助于前端开发者预先了解并规划如何解析、转化和使用后端返回的数据。
  2. 数据预处理/清洗

    • 使用适配器模式或者单独的数据处理函数对后端返回的数据进行统一转换,确保数据格式符合前端组件的渲染要求。
    • 对于异构数据,可以通过编写可复用的方法来提取所需字段,或者整合多个数据源。
  3. 状态管理

    • 利用Redux、Vuex、React Hooks中的Context API等状态管理工具来集中处理数据。将从后端获取的数据存入全局状态树中,方便各组件按需取用。
  4. 异常处理

    • 对后端接口调用结果进行错误码校验和异常处理,对于不符合预期的数据结构或缺失字段的情况,提供合理的默认值或提示用户数据加载异常。
  5. 懒加载与分页处理

    • 针对大量数据,实现按需加载和分页逻辑,避免一次性加载所有数据导致性能问题,同时处理好数据合并和更新。
  6. 组件封装与抽象

    • 将数据处理逻辑封装到特定的UI组件内部,使组件具有自动处理响应数据的能力,提高代码的模块化程度。

定义前端展示的Vo实体类 处理后端返回的数据,转换为前端展示的Vo实体类 toVo 使用Vuex或Redux等状态管理工具统一管理数据 对于异常数据,提供默认值或友好提示 将数据处理逻辑封装到特定的UI组件内部

通过以上实践,前端可以灵活地应对后端返回的不同数据结构,保持代码的整洁性和可维护性,并有效提高前端应用的响应速度和用户体验。

将数据处理逻辑封装到特定的UI组件内部的优点

将数据处理逻辑封装到特定的UI组件内部是一种常见的最佳实践。这样做的好处在于:

  1. 模块化和可复用性:每个组件负责自己的数据处理和渲染,使得组件更加独立,易于理解和复用。当需要在多个地方使用同一类型的数据时,只需要调用相同的组件即可。

  2. 职责单一原则(Single Responsibility Principle, SRP):遵循面向对象设计原则,每个组件专注于一项功能,即从原始数据中提取并格式化出满足自身渲染需求的数据,并展示给用户。

  3. 代码组织结构清晰:数据处理逻辑与视图层紧密关联,有利于保持代码的整洁性和可读性。开发者可以直接在组件内部看到数据是如何被处理和使用的,而无需去寻找分散在项目其他位置的数据处理函数。

  4. 提高响应式更新效率:React等框架提供了高效的虚拟DOM diff算法,在组件内部处理数据变化后可以立即触发视图更新,优化了用户体验。

示例:

jsx
// 假设有一个UserCard组件用于展示用户信息
function UserCard({ user }) {
  // 在组件内部进行数据处理
  const formattedDate = format(user.createdAt, 'yyyy-MM-dd');

  return (
    <div>
      <img src={user.avatarUrl} alt="Avatar" />
      <h2>{user.name}</h2>
      <p>
        注册日期:
        {formattedDate}
      </p>
    </div>
  );
}

// 后端返回的数据可能是这样的
const userDataFromBackend = {
  id: 1,
  name: 'John Doe',
  avatarUrl: '/avatars/john-doe.jpg',
  createdAt: '2022-01-01T00:00:00Z', // ISO 8601格式的时间戳
};

// 使用组件时,只需传递原始数据
  <UserCard user={userDataFromBackend} />;

在这个例子中,UserCard 组件内部对 createdAt 字段进行了格式化处理,确保了它能够以适合页面展示的方式呈现。 通过这种方式,数据处理逻辑和UI渲染紧密结合在一起,提高了代码的整体质量和维护性。

关于表单回显和数据绑定,你有什么最佳实践?

关于表单回显和数据绑定的最佳实践,可以遵循以下几点:

  1. 双向数据绑定

    • 使用现代前端框架(如Vue、React或Angular)提供的双向数据绑定功能。例如,在Vue中使用v-model 指令实现输入控件与组件状态的自动同步;在React中,可以通过useState hook或者第三方库如react-hook-form 来处理表单状态并与视图进行绑定。
  2. 初始化表单数据

    • 当页面加载时,从后端API获取数据后应立即初始化表单字段。确保这些值正确反映到对应的表单控件上,以实现回显效果。
  3. 响应式更新

    • 保持数据模型与UI之间的实时同步,当数据发生变化时,表单应当能够自动更新显示内容,反之亦然。
  4. 验证与错误提示

    • 在数据回显的同时,也要考虑表单验证逻辑,确保回显的数据符合业务规则。若初始数据不符合校验条件,应在回显的同时显示相应的错误信息。
  5. 异步数据处理

    • 对于异步获取的数据,可以在数据请求完成后再进行回显,避免因数据未准备好而导致的界面闪烁或不一致。
  6. 分层结构处理

    • 如果表单中有嵌套结构的数据,应适当处理数据层次关系,通过合适的属性名或对象结构映射到表单控件上。
  7. 性能优化

    • 对于大型表单或者大量数据回显的情况,可采用懒加载、虚拟滚动等技术提高性能,只对当前视窗内的表单元素进行渲染和数据绑定。
  8. 清晰分离关注点

    • 数据获取数据转换(如果需要)、数据绑定(赋初始值)以及表单验证、提交逻辑明确地分离在不同的函数或组件中,保证代码的可读性和可维护性。
  9. 事件驱动更新

    • 对于有关联的表单项,利用onChange、onBlur等事件监听用户交互,并实时更新数据模型,从而触发视图更新。
  10. 自定义控件兼容性

    • 如果使用了自定义的表单控件,确保它们支持数据绑定,并且在回显数据时能正确展示。

综上所述,最佳实践不仅包括合理利用框架特性进行高效的数据绑定,还包括对用户体验、性能、可维护性的综合考量。

数据获取 - 存储到状态管理或者逐层传递给子组件 - 转为Vo作为初始值 - 绑定到表单控件 - 响应式更新 - 表单验证 - 数据转为Dto - 提交逻辑

如果表单中有嵌套结构的数据,应如何处理数据层次关系

在表单中有嵌套结构的数据时,处理数据层次关系通常需要遵循以下步骤:

  1. 数据模型设计

    • 根据后端返回的数据结构以及前端展示的需求,设计一个适应于UI渲染和用户交互的前端数据模型。这个模型可能包含对象、数组或其他嵌套结构。
  2. 状态管理

    • 使用React的状态管理工具如useStateuseReducer或第三方库如Redux、MobX、Zustand等来存储和管理这些嵌套结构的数据。确保能够方便地访问和更新各个层级的数据。
  3. 递归组件或遍历数据

  • 对于复杂的嵌套结构,可以创建递归组件来动态生成对应的表单元素。例如,在React中,可以编写一个递归函数组件,该组件能根据数据深度和结构自动生成子表单和控件。
jsx
function RecursiveForm({ data }) {
  return (
    <div>
      {Object.entries(data).map(([key, value]) => (
        // 处理基本类型值
        typeof value === 'string' || typeof value === 'number'
          ? <input key={key} type="text" value={value} />

          // 处理对象类型值(继续递归)
          : <RecursiveForm key={key} data={value} />
      ))}
    </div>
  );
}
  1. v-model或者onChange绑定

    • 如果使用Vue,可以利用v-model指令对嵌套对象进行双向数据绑定;在React中,可以通过useState hook或者其他状态管理方式监听每个表单控件的更改事件,并更新相应层级的数据。
  2. 表单验证

    • 针对嵌套结构的数据,验证逻辑也需要处理不同层级的数据校验规则。可以为每个层级定义独立的验证方法,并在数据发生变化时触发验证。
  3. 数据提交前的预处理

    • 在表单提交之前,将已修改过的嵌套数据扁平化处理,转换成符合后端接口要求的格式,以便发送到服务器保存。
  4. 优化性能与用户体验

    • 对于大型嵌套表单,考虑只渲染当前视窗内的表单部分,避免一次性加载大量数据导致性能下降。同时,提供清晰的界面导航以帮助用户理解和操作复杂的表单结构。

通过以上策略,您可以有效地管理和显示具有嵌套结构的表单数据,并确保用户能够流畅地完成数据编辑和提交过程。

后端返回的以及需要传递给后端的,都是嵌套数据结构,为啥 在表单提交之前,将已修改过的嵌套数据扁平化处理

后端返回的以及需要传递给后端的嵌套数据结构在表单提交之前进行扁平化处理,主要有以下几个原因:

  1. 接口约定

    • 有时,后端接口可能要求以扁平化的键值对形式接收数据,而不是复杂的嵌套对象或数组。扁平化能够确保提交的数据格式与接口规范一致。
  2. 简化验证和错误处理

    • 扁平化数据更容易进行统一和标准化的验证。每个字段可以单独验证,而不必处理不同层级的嵌套关系,这有助于减少验证逻辑的复杂性。
  3. 减少传输数据量

    • 尽管对于JSON格式而言,嵌套并不会显著增加传输大小,但在某些情况下,特别是当有大量重复或冗余键时,扁平化可以通过将共用属性提升到顶层来减少数据量。
  4. 易于数据库操作

    • 对于一些数据库设计,尤其是那些不支持嵌套结构(如NoSQL数据库)或者设计上倾向于使用关联表来表示关系的传统SQL数据库,扁平化的数据更便于插入、更新和查询。
  5. 前端状态管理

    • 在前端应用中,特别是在状态管理较为复杂的情况下,扁平化数据可以简化状态树,使得状态变更检测更加高效,并且方便地利用现有的工具库实现双向绑定或状态变化监听。
  6. 防止深层嵌套带来的问题

    • 深度嵌套的对象可能导致序列化和反序列化过程中出现问题,尤其是在处理不同语言或框架之间交互时。扁平化可以降低这类问题的风险。

尽管如此,是否需要扁平化取决于具体的应用场景和架构设计。在现代前后端开发中,通常能很好地处理嵌套数据,不一定非得扁平化;而在特定条件下,扁平化处理则能带来实际的好处。

比如组件嵌套的场景,表单校验是放在各个子组件自己维护还是在父组件中点击保存的时候如何校验?

在组件嵌套的场景中,表单校验可以在子组件内部自行维护,也可以在父组件中集中处理。这两种方式各有优缺点,可以根据项目的具体需求和复杂度来选择合适的方法。

子组件自身维护校验:

  • 优点

    • 每个子组件独立性更强,易于理解和复用。
    • 可以实现局部即时校验,用户输入时实时反馈错误信息,提升用户体验。
    • 遵循“单一职责原则”,每个组件只负责自己相关的数据验证。
  • 实现方法

    • 使用如react-hook-formFormik等第三方库中的useFormwithFormik等高阶组件进行本地表单字段的注册与验证。
    • 在子组件内部使用状态(如useState)或上下文API管理验证状态,并通过事件监听更新验证结果。

父组件集中校验:

  • 优点

    • 能够统一控制整个表单的数据流和验证逻辑,避免分散导致的问题。
    • 更容易处理复杂的跨字段校验,比如依赖于多个子组件之间关联关系的校验规则。
    • 提交时一次性完成所有校验,确保整体数据的一致性和完整性。
  • 实现方法

    • 父组件可以通过props向下传递回调函数给子组件,子组件在需要时调用这些回调函数报告其内部的验证结果。
    • 或者使用Context API或者Redux等集中式状态管理工具,在父组件中收集所有子组件的状态,然后在提交时进行全局校验。

实际开发中,通常会结合两种方式:

  1. 局部即时校验:子组件内实现基本的、独立的表单字段校验,提供良好的实时交互体验。
  2. 全局提交校验:父组件在点击保存按钮触发提交操作时,再次进行全局性的数据一致性检查和补充校验。

这样既保证了用户体验,又确保了数据的有效性和完整性。

对于下拉框的数据获取,需要单独拆分出一个hooks吗

对于下拉框的数据获取,是否需要单独拆分出一个hook取决于项目的具体需求和代码组织结构。以下是一些考虑因素:

  1. 复用性

    • 如果项目中多个地方都需要从同一个API或者同一个数据源获取下拉框选项数据,并且处理逻辑相同,那么创建一个专门的hooks用于获取并处理下拉框数据是合理的。这样可以避免代码重复,提高代码可读性和维护性。
  2. 异步加载与缓存

    如果下拉框数据是从后端异步获取,并且可能频繁请求,那么将数据获取封装成一个hook,内部包含异步请求、错误处理、以及缓存机制(如使用useMemouseRef来存储已获取过的数据),有助于优化性能和用户体验。

  3. 业务逻辑复杂度

    • 如果获取下拉框数据涉及复杂的业务逻辑,比如需要根据其他状态变量动态查询不同的数据源,或者数据转换过程比较复杂,那么封装成一个独立的hook可以让这部分逻辑更易于管理。

示例代码(基于React Hooks):

jsx
import { useEffect, useState } from 'react';

// 假设有个API接口返回下拉框选项列表
const fetchOptions = () => axios.get('/api/options');

function useDropdownOptions() {
  const [options, setOptions] = useState([]);
  const [loading, setLoading] = useState(true);
  const [error, setError] = useState(null);

  useEffect(() => {
    let didCancel = false;

    async function fetchData() {
      try {
        setLoading(true);
        const response = await fetchOptions();
        if (!didCancel) {
          setOptions(response.data);
          setLoading(false);
        }
      }
      catch (err) {
        if (!didCancel) {
          setError(err);
          setLoading(false);
        }
      }
    }

    fetchData();

    // 清理函数,防止组件卸载时仍有网络请求
    return () => {
      didCancel = true;
    };
  }, []); // 空依赖数组确保只在组件挂载时执行一次

  return { options, loading, error };
}

// 使用该hook
function DropdownComponent() {
  const { options, loading, error } = useDropdownOptions();

  // 根据loading和error状态展示合适的UI
  // 并将options传递给下拉框组件进行渲染

  return (
    <select>
      {loading ? <option>Loading...</option> : null}
      {error ? <option>Error fetching data</option> : null}
      {options.map(option => (
        <option key={option.id} value={option.value}>
          {option.label}
        </option>
      ))}
    </select>
  );
}

总之,在合适的情况下,为下拉框数据获取创建一个自定义hook可以帮助提升代码的模块化程度,简化数据处理流程,并便于后期维护和扩展。

如果需要在初始化渲染第一次获取到下拉框数据的时候,下拉框获取到值后,更新某个表单项的字段或者进行计算,展示计算后的结果,如何封装hooks

实际上,即使在初始化渲染时需要处理获取到的下拉框数据,并执行特定逻辑(如更新表单项或进行计算),依然可以将获取下拉框数据的部分抽成一个hook。关键在于如何设计和使用这个hook。

以下是一个例子:

jsx
// 创建一个自定义hook来获取下拉框数据
function useDropdownOptions(initialSelectedValue) {
  const [options, setOptions] = useState([]);
  const [selectedOption, setSelectedOption] = useState(initialSelectedValue);

  useEffect(() => {
    async function fetchOptions() {
      const fetchedOptions = await getDropdownOptions();
      setOptions(fetchedOptions);

      // 如果有默认选项需要选中,在这里设置
      if (fetchedOptions.length > 0 && !initialSelectedValue) {
        setSelectedOption(fetchedOptions[0].value); // 假设第一个是默认值
      }
    }

    fetchOptions();
  }, []); // 空依赖数组确保只在挂载时执行一次

  // 返回用于处理选择事件的方法以及当前选中的选项值
  return { options, handleSelectChange, selectedOption };
}

// 在组件内部使用该hook
function DropdownComponent() {
  // 使用自定义hook获取下拉框数据并传递初始值
  const { options, handleSelectChange, selectedOption } = useDropdownOptions();

  // 获取下拉框数据后立即执行的逻辑
  useEffect(() => {
    performCalculation(selectedOption);
    updateFormField(selectedOption);
  }, [selectedOption]); // 当selectedOption改变时重新执行此effect

  // 处理选项变化的事件
  const handleSelection = (event) => {
    handleSelectChange(event.target.value);
  };

  return (
    <select value={selectedOption} onChange={handleSelection}>
      {options.map(option => (
        <option key={option.id} value={option.value}>
          {option.label}
        </option>
      ))}
    </select>
  );
}

// 下拉框选项改变后的操作函数
function performCalculation(selectedOption) {
  // 根据selectedOption进行计算...
}

// 更新表单字段的函数
function updateFormField(selectedOption) {
  // 更新表单字段...
}

这样,我们仍然可以在useDropdownOptions hook 中获取并设置下拉框选项,同时在组件内部通过另一个useEffect 监听selectedOption的变化以执行相应的计算和更新操作。

在前端开发过程中如果函数参数很多,该如何精简

在前端开发中,如果函数的参数超过三个,可能会使函数难以阅读和维护。

为了提高代码的可读性和可维护性,可以采取以下几种策略来精简函数参数:

1.1. 对象参数(对象字面量):

将多个参数封装成一个对象作为单个参数传递。这样不仅可以减少参数数量,还能让参数的意义更明确。

ts
// 原始方式
function calculate(a, b, operation) {
  // ...
}

// 改进后
function calculate(options) {
  const { a, b, operation } = options;
  // ...
}

calculate({ a: 1, b: 2, operation: 'add' });

1.2. 默认参数和解构赋值:

结合使用默认参数和解构赋值可以在简化参数的同时,提供灵活的参数配置。

ts
function calculate({ a = 0, b = 0, operation = 'add' }) {
  // ...
}

1.3. 使用类或构造函数:

如果函数操作的数据是一组紧密相关的属性,可以考虑创建一个类或者使用构造函数来封装这些数据和操作。

ts
class Calculator {
  constructor(a, b, operation) {
    this.a = a;
    this.b = b;
    this.operation = operation;
  }

  calculate() {
    // ...
  }
}

const calc = new Calculator(1, 2, 'add');
calc.calculate();

1.4. 利用闭包或者高阶函数:

在某些场景下,可以通过闭包来隐藏一些参数,或者使用高阶函数来传递处理数据的逻辑而不是直接的数据。

1.5. 利用ES6的扩展运算符:

当需要将数组或对象的属性作为参数传递时,可以使用扩展运算符简洁地实现。

ts
function sum(x, y, ...numbers) {
  // x, y 为必填,numbers 为额外数字数组
}

选择哪种方法取决于具体场景和需求,但总体目标是提高代码的清晰度和可维护性。

Contributors

作者:Long Mo
字数统计:6k 字
阅读时长:18 分钟
Long Mo
文章作者:Long Mo
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 Longmo Docs