实践总结｜前端架构设计的一点考究（中）

【显式架构】设计

这篇文档从【应用架构系统】的角度进行设计，我梳理重点拆分了两个核心概念【应用核心代码】、【组件】。

1、应用核心代码：主要设计项目的核心代码如何通过 DDD 层来组织逻辑架构

在软件工程中，DDD（Domain-Driven Design，领域驱动设计）层指的是软件系统中的一个重要组成部分。旨在将领域逻辑（Domain Logic）与应用程序的其他部分分离开来，使得系统的设计更加易于理解、维护和扩展。

【应用层】：项目架构的第一层直接对接用户，可以直接触发一系列核心的业务流程。例如应用程序服务、命令处理程序、展开用例 / 业务流程的逻辑等。

应用场景

- 操作领域库 - 查找/更改项目领域实体/模型的具体逻辑 - 操作领域层 - 实体/模型执行对应的领域逻辑 - 执行逻辑 - 具体执行业务实际逻辑，并处理额外的副作用

【领域层】：独立于应用层，是各个【业务领域】实体/模型对象包含数据和操作数据的逻辑。

这个层级细分了两个主要职责：1、领域服务 2、领域模型

【领域服务】：操作不同数据实体/模型的具体逻辑，独立于应用层且抽象可复用。
【领域模型】：代表业务领域具体实体/模型的数据，通常更新时会触发额外的逻辑操作。

应用场景

- 声明具体领域实体/模型的组合逻辑 - 操作实体/模型具体的数据，独立且抽象

上述【应用核心组织】以 DDD 的设计思路将代码进行层的的隔离划分，而通常一个项目会有很多不同的领域。我们不可能将所有领域的代码按层来进行设计隔离，也就是我们如何通过【组件】来抽象封装。
2、组件：以项目角度抽象封装上述不同层级的代码组织，最终形成一个项目应用。

组件致力于低耦合和高内聚的设计模式，一个完全解耦的组件，可以完全不引用 / 依赖另一个同层级的组件，要做到这一点意味着要有独立的【应用核心代码】。

例如：任务组件 ComA 依赖于账户组件 ComB 组件，那么可以通过【任务应用层】来组合【账户领域层】的形式，共享账户的领域实体进而触发不同组件在业务逻辑上的副作用，消除组件直接的依赖耦合。

🌟结果：一个项目有着多个低耦合高内聚的抽象组件，可独立触发核心应用逻辑，并消费所需的业务模型数据。

4.2 设计思考

上述一顿库库输出后，大概率还是一脸懵，直接用可不行，得要梳理下适合开发实践的设计思路来才行。

抽象设计

先具体分析上述开发示例，回到我们最初的几个疑惑，尝试解答：

Q：React 定位是一个用于渲染用户界面 (UI) 的 JavaScript 库，那么数据状态和业务逻辑与视图和交互无关怎么更好地设计结合？

A：React 是一个 UI 组件库，作为 UI 组件应该只消费业务状态/数据和 UI 视图交互的逻辑。本质上不应该在组件内部关心业务的生产逻辑。

Q：敏捷业务迭代中，不断变化的部分导致开发成本，能找出什么是敏捷在变，什么是敏捷在不变？

A：以视图和逻辑来抽象拆分

视图
视图组件 (变)
视图交互变
逻辑
业务逻辑变
接口协议一般只增不变
基础服务逻辑不变

Q：在敏捷迭代中，单看逻辑和视觉的变更都不难，为何结合起来迭代如此花费成本？

A：独立的逻辑/视觉变更开发成本不大，但因为业务逻辑通常耦合在视图组件中，通常在迭代过程需花大量改造和兼容成本，修改组件与业务状态/数据的结构，甚至需重构整体项目，

Q：面向视图开发，还是面向数据开发？

A：一般在业务迭代过程中都面向视图开发，基本开发流程大概如下：

1.绘制 UI 结构 + 样式 => 前端组件

2.组件中初始化业务主逻辑 => 声明接口 data 数据 state

3.根据视图动态数据 => 消费 data 数据

4.根据视图交互事件 => 声明并绑定交互逻辑（新的控制 state 状态）

面向视图开发，通常会导致视图组件与数据逻辑强耦合。

例如上述示例的需求四

具体设计

基于上述的构架思路以及抽象开发过程中的关注点，在于如何将视图组件和数据逻辑解耦，这是一个老生常谈的问题，重点在于如何通过合理的架构模式将其优雅地分层。

1.定义清楚两者的关系，在视图组件中只做数据的消费者，而数据逻辑只作为视图组件的生产者。

2.数据逻辑需关注点分离出独立的业务领域，并按照分层约定项目目录，做好职责划分。

目录约定

pages
├─UI // 视图组件

dataArea  // 数据领域
├─newHome  // newHome 页面挂钩的业务领域
|    ├─models  // 数据模型 => 业务数据/状态模型 & 约定
|    |   ├─Account  // 🌰 账户业务领域
|    |   |  └index.tsx

|    ├─server  // 数据服务 => 业务底层数据服务
|    |   └Account.ts  // 🌰 账户业务领域

|    ├─applications  // 应用服务 => 上层业务逻辑
|    |      └Account.ts  // 🌰 账户业务领域

├─common
|   ├─zustand  // 统一的全局数据管理库
|   ├─mtop  // 数据请求库

3.视图组件尽可能无状态、抽象可复用，视图组件内聚状态，通信交互则通过数据逻辑触发应用服务 applications，消费数据模型 models 即可。架构设计如下图：

实践

有了设计思路以及思考具体设计后，针对上边第三点做一次实践感受下实践体感。一样是核心关于【账户信息】的业务需求

5.1 需求一：金额账户

需求一：展示账户信息

解决一：1.数据逻辑：约定创建数据逻辑目录，声明业务领域【account】，并将业务层关注点分离职责。a.model 业务模型

import { create } from 'zustand';

interface IAccountModel {
  account: number;
}


/**
 * 账户模型
 */
const accountModel = create<IAccountModel>(() => ({
  account: undefined,
}));

export default accountModel;

b.server 业务服务

import accountModel from '../models/account';


/** 账户服务 */
const accountServer = {
  /**
   * @des 获取数据
   */
  getData: () => {
    setTimeout(() => {
      // 模拟接口请求
      accountModel.setState({ account: 12.34 });
    }, 1000);
  },
};


export default accountServer;

c.application 业务应用

import accountServer from '../server/account';

/**
 * @des 账户应用
 */
const accountApplication = {
  /**
   * @des 初始化
   */
  init: () => {
    accountServer.getData();
  },
};

export default accountApplication

2.视图组件：Accounta.触发业务应用逻辑 - 初始化b.消费业务模型数据

import accountApplication from '@/dataArea/home/applications/account';
import accountModel from '@/dataArea/home/models/account';
import styles from './index.module.less';

const Account = () => {
  // 账户应用初始化
  accountApplication.init();

  // 消费响应式数据
  const account = accountModel((state) => state.account);

  return (
    <div className={styles.stickyAccountWrap}>
      <div className={styles.stickyAccount}>
        <div className={styles.stickyAccountGoldPocketPic} />
        <div className={styles.stickyAccountTitleContainer}>
          <div className={styles.stickyAccountTitle}>
            <div>{account}</div>
            <div className={styles.unit}>元</div>
          </div>
        </div>
        <div className={styles.withdraw} />
      </div>
    </div>
  );
};

export default Account;

完成一：

5.2 需求二：互动效果

需求二：【权益氛围感】金币飞入动效

解决二：1.金币飞入通用组件


import { CSSProperties, FC, useRef, useEffect, useCallback } from 'react';
import anime from 'animejs';
import styles from './index.module.less';

interface ICoinsFly {
  style?: CSSProperties;
  onEnd: () => void;
}

/**
 * 金币飞动画组件
 */
const CoinsFly: FC<ICoinsFly> = (props) => {
  const { style, onEnd } = props;
  const wrapRef = useRef<HTMLDivElement>(null);

  const rpx2px = useCallback((rpxNum: number) => (rpxNum / 750) * window.screen.width, []);

  useEffect(() => {
    // 金币动画
    anime({
      targets: wrapRef.current?.childNodes,
      delay: anime.stagger(90),
      translateY: [
        { value: 0 },
        {
          value: -rpx2px(334),
          easing: 'linear',
        },
      ],
      translateX: [
        { value: 0 },
        {
          value: -rpx2px(98),
          easing: 'cubicBezier(.05,.9,.8,1.5)',
        },
      ],
      scale: [
        { value: 1 },
        {
          value: 0.5,
          easing: 'linear',
        },
      ],
      opacity: [
        { value: 1 },
        {
          value: 0,
          easing: 'cubicBezier(1,0,1,0)',
        },
      ],
      duration: 900,
      complete: () => {
        onEnd();
      },
    });
  }, []);

  return (
    <div className={styles.container} style={style} ref={wrapRef}>
      {[1, 2, 3, 4, 5, 6, 7, 8].map((item) => (
        <div key={item} className={styles.coin} />
      ))}
    </div>
  );
};

export default CoinsFly;

.container {
  position: absolute;
  top: 100rpx;
  left: 100rpx;
  background-color: rgba(255, 255, 255, 0.6);
  .coin {
    width: 106rpx;
    height: 106rpx;
    background-image: url("https://gw.alicdn.com/imgextra/i4/O1CN01hVWasj25i4dZdV9sS_!!6000000007559-2-tps-160-160.png");
    background-position: center;
    background-size: contain;
    background-repeat: no-repeat;
    position: absolute;
    top: 0;
    left: 0;
  }
}

2.金币组件由账户组件消费，直接在组件内控制展示 state 状态即可。

import { useEffect, useState } from 'react';
import CoinsFly from '../CoinsFly';
import accountApplication from '@/dataArea/home/applications/account';
import accountModel from '@/dataArea/home/models/account';
import styles from './index.module.less';

const Account = () => {
  // 账户应用初始化
  accountApplication.init();

  // 消费响应式数据
  const account = accountModel((state) => state.account);
  // 金币飞入动画
  const [showCoinsFly, setShowCoinsFly] = useState(false);

  // 响应式更新金币飞入动效
  useEffect(() => {
    account && setShowCoinsFly(true);
  }, [account]);

  return (
    <div className={styles.stickyAccountWrap}>
      <div className={styles.stickyAccount}>
        <div className={styles.stickyAccountGoldPocketPic} />
        <div className={styles.stickyAccountTitleContainer}>
          <div className={styles.stickyAccountTitle}>
            <div>{account}</div>
            <div className={styles.unit}>元</div>
          </div>
        </div>
        <div className={styles.withdraw} />
      </div>
      {showCoinsFly && (
        <CoinsFly
          style={{
            top: '322rpx',
            left: '316rpx',
            zIndex: 1,
          }}
          onEnd={() => {
            setShowCoinsFly(false);
          }}
        />
      )}
    </div>
  );
};

export default Account;

实现二：

5.3 需求三：权益承接

需求三：提现弹窗承接

解决三：1.数据逻辑：相关 POP 弹窗，可以声明为一个业务领域【pop】a.model 业务模型

import { create } from 'zustand';

interface IPopModel {
  show: boolean;  // 是否展示
  popData?: Record<string, string | any>;  // POP 数据
  onCloseCallback?: () => void;
}

/** 初始化数据 */
export const DEFAULT_MODEL = {
  show: false,
  popData: undefined,
  onCloseCallback: () => {},
};

/**
 * pop 模型
 */
const popModel = create<IPopModel>(() => ({
  ...DEFAULT_MODEL,
}));

export default popModel;

b.server 业务服务

import popModel, { DEFAULT_MODEL } from '../models/pop';


/** 弹窗服务 */
const popServer = {
  setPopData: (data) => {
    popModel.setState({ popData: data });
  },
  openPop: () => {
    popModel.setState({ show: true });
  },
  closePop: () => {
    popModel.setState({ show: false });
  },
  /**
   * @des 重置数据
   */
  resetModel: () => {
    popModel.setState(DEFAULT_MODEL);
  },
};


export default popServer;

c.application 业务应用

import popServer from '../server/pop';
import popModel from '../models/pop';

/**
 * @des 弹窗应用
 */
const popApplication = {
  open: (data) => {
    popServer.setPopData(data);
    popServer.openPop();
  },
  /**
   * @des 关闭弹窗 => 触发自定义关闭回调 & 重置弹窗数据
   */
  close: () => {
    popServer.closePop();
    popModel.getState().onCloseCallback?.();
    popServer.resetModel();
  },
  setCustomCloseCallback: (callback) => {
    popModel.setState({ onCloseCallback: callback });
  },
};

export default popApplication;

2.抽象弹窗视图组件，而非【提现弹窗】的定制化视图组件a.消费弹窗数据模型 popModelb.触发弹窗业务应用 popApplication


import popApplication from '@/dataArea/home/applications/pop';
import popModel from '@/dataArea/home/models/pop';
import styles from './index.module.less';

// 弹窗
const Dialog = () => {
  const { close } = popApplication;
  const show = popModel((state) => state.show);
  const popData = popModel((state) => state.popData);

  const {
    a,
    b,
    c,
    d,
  } = popData || {};

  if (!show) return null;

  return (
    <div className={styles.popup}>
      <div className={styles.content}>
        {/* 头部提示 */}
        <div className={styles.header}>
          <div className={styles.icon} />
          <div className={styles.title}>{a}</div>
        </div>
        <div className={styles.body}>
          {/* 金额 */}
          <div className={styles.amountCon}>
            <div className={styles.amount}>{b || ''}</div>
            <div className={styles.unit}>元</div>
          </div>
          <div className={styles.dividing} />
          {/* 账户内容 */}
          <div className={styles.userContent}>
            <div className={styles.userItem}>
              <div className={styles.title}>提现账户</div>
              <div className={styles.userText}>{c || ''}</div>
            </div>
            <div className={styles.userItem}>
              <div className={styles.title}>打款方式</div>
              <div className={styles.userText}>{d || ''}</div>
            </div>
          </div>

          {/* 按钮 */}
          <div
            className={styles.btn}
            onClick={() => close()}
          >开心收下</div>
        </div>
      </div>
    </div >
  );
};

export default Dialog;

3.账户视图组件，通过弹窗的应用逻辑交互


import { useEffect, useState } from 'react';
import CoinsFly from '../CoinsFly';
import accountApplication from '@/dataArea/home/applications/account';
import accountModel from '@/dataArea/home/models/account';
import styles from './index.module.less';
import popApplication from '@/dataArea/home/applications/pop';

const Account = () => {
  // 账户应用初始化
  accountApplication.init();
  const { open: openWithdrawDialog } = popApplication;

  // 消费响应式数据
  const account = accountModel((state) => state.account);
  // 金币飞入动画
  const [showCoinsFly, setShowCoinsFly] = useState(false);

  // 响应式更新金币飞入动效
  useEffect(() => {
    account && setShowCoinsFly(true);
  }, [account]);

  return (
    <div className={styles.stickyAccountWrap}>
      <div className={styles.stickyAccount}>
        <div className={styles.stickyAccountGoldPocketPic} />
        <div className={styles.stickyAccountTitleContainer}>
          <div className={styles.stickyAccountTitle}>
            <div>{account}</div>
            <div className={styles.unit}>元</div>
          </div>
        </div>
        <div
          className={styles.withdraw}
          onClick={() => {
            openWithdrawDialog({
              a: '3000',
              b: '123456789123456789',
              c: '支付宝打款',
              d: '提现成功，预计2小时到账',
              e: '0.3',
            });
          }}
        />
      </div>
      {showCoinsFly && (
        <CoinsFly
          style={{
            top: '322rpx',
            left: '316rpx',
            zIndex: 1,
          }}
          onEnd={() => {
            setShowCoinsFly(false);
          }}
        />
      )}
    </div>
  );
};

export default Account;

实现三：

总结：至此，我们已经有了【account】和【pop】的业务领域数据逻辑，并且做到了【账户】和【弹窗】视图组件的完全解耦，而不需要内置 hook 状态来耦合视图组件。

5.4 需求四：任务体系

需求四：最后的交互需求中，按照前边铺垫好的架构，我们怎么快速实现～

完成任务后，点击完成任务弹出提现成功弹窗，收下弹窗金币飞入再金额刷新。解决四：1.本次需要刷新【账户】信息，添加 reFreshData 业务逻辑。

import accountModel from '../models/account';
import accountServer from '../server/account';

/**
 * @des 账户应用
 */
const accountApplication = {
  /**
   * @des 初始化
   */
  init: () => {
    accountServer.getData();
  },
  reFreshData: (account) => {
    accountModel.setState({ account });
  },
};

export default accountApplication;

2.沉浸式写一个任务组件 Task

a.通过 pop 业务应用 open 更新数据并打开弹窗

b.关闭时调用 reFreshData 刷新账户信息


import { useCallback, useEffect, useState } from 'react';
import popApplication from '@/dataArea/home/applications/pop';
import accountApplication from '@/dataArea/home/applications/account';
import styles from './index.module.less';

// 任务状态枚举
enum TASK_STATUS {
  PROGRESS = 'progress',
  COMPLETE = 'complete',
}

// 任务信息
const TASK_INFO_MAP = {
  [TASK_STATUS.PROGRESS]: {
    btn: '进行中',
  },
  [TASK_STATUS.COMPLETE]: {
    btn: '已完成',
  },
};

/** 任务组件 */
const Task = () => {
  const { open: openDialog, setCustomCloseCallback } = popApplication;
  const { reFreshData } = accountApplication;

  // 任务状态
  const [state, setState] = useState<TASK_STATUS>(TASK_STATUS.PROGRESS);

  const btnCallback = useCallback(() => {
    if (state === TASK_STATUS.COMPLETE) {
      openDialog({
        a: '3000',
        b: '123456789123456789',
        c: '支付宝打款',
        d: '提现成功，预计2小时到账',
        e: '0.3',
      });
      setCustomCloseCallback(() => {
        reFreshData(12.04);
      });
    }
  }, [openDialog, state]);

  useEffect(() => {
    setTimeout(() => {
      alert('完成任务');
      setState(TASK_STATUS.COMPLETE);
    }, 3000);
  }, []);

  return (
    <div className={styles.taskWrap}>
      {/* icon */}
      <div className={styles.taskImg} />
      {/* 详情 */}
      <div className={styles.taskDesc}>
        <div className={styles.action}> 完成任务节即可提现 </div>
        <div className={styles.detailText}>
          <div className={styles.detailTextDetail}>完成后可提现 0.6 元</div>
        </div>
      </div>

      {/* 按钮 */}
      <div
        className={styles.taskBtn}
        onClick={() => btnCallback()}
      >
        {TASK_INFO_MAP[state]?.btn || ''}
      </div>
    </div>
  );
};

export default Task;

实现四：

总结：能明显看到在业务敏捷迭代过程 & 复杂的需求中，只要抓住了业务的关注点，明确变与不变构造好一个干净的前端架构，就能释放绝大部分的开发人力。

5.5 思考

整体的架构一定有设计者核心的逻辑和目的，而上层的设计只是过程中的关键路径/方法论。

现阶段我粗浅地认为核心的逻辑和目的在于：【找出业务迭代的关键因子，以最短路径 & 最小影响达到目的】

综上实践过程有几点关键路径/方法论可以梳理总结下：

1.以业务需求定义前端页面为导向，抽象定义其业务领域模型。

领域驱动设计（Domain-Driven Design）：将软件系统的核心逻辑和业务规则放在领域模型中，通过领域模型来驱动项目设计和开发，领域驱动设计强调对业务领域的深入理解和模型化。

2.关注点分离，以业务领域模型来驱动通用服务 / 应用逻辑 / UI 组件等分层处理。

分层架构（Layered Architecture）：将系统划分为多个层次，每个层次具有不同的关注点和责任，分层架构提供了松耦合、可测试和可维护的系统结构。

3.自内向外的通信处理，数据流和业务逻辑清晰可见。

完整架构分层：

pages // 视图组件
├─components
|    ├─Account  // 账户视图组件
|    ├─CoinsFly  // 互动视图组件
|    ├─Dialog    // 弹窗视图组件
|    ├─Task      // 任务视图组件
├─home


dataArea  // 数据领域
├─newHome
|    ├─models
|    |   └account.ts  // 🌰 账户业务模型
|    |   └common.ts  // 🌰 基础能力模型（如关注、订阅、全局状态数据）

|    ├─server
|    |   └account.ts  // 🌰 账户业务服务
|    |   └common.ts  // 🌰 基础能力服务

|    ├─applications
|    |   └account.ts  // 🌰 账户业务应用
|    |   └common.ts  // 🌰 基础能力应用

协同

当实现了一个自认为合理的架构设计时，不出意外会在过程中逐渐尝到甜头。但往往事情总是相对的，在项目新参与的同学协作过程中初次接触则需要理解和熟悉相关架构。因此以协作的目的（读懂项目业务代码），来简单介绍一下你该怎么看。1.看一下 models 里都有哪一些，理解这个项目定义了哪些业务模型。

如：预告页项目 - （项目注释很重要～ 👀 ） liveReplayModel：播回放模型 previewInfoModel：主播预告信息模型 1.主播 Header 信息、2.预告条信息、3.预告商品信息 commonModel：通用业务能力模型 1.全局配置、2.关注 / 分享 / 订阅

2.看主逻辑在哪调用，业务应用的初始化都做了什么～

一般来说会在项目入口处调用初始化的主逻辑：initApplication.init(data)顺着主应用的初始化方法，顺着往下看就能知道具体的主逻辑了～



/**
 * @des 初始化应用
 */
const initApplication = {
  /**
   * @des 预告页初始化
   * - 初始化机型状态数值
   * - 兜底主接口 mtop（可选）
   * - 页面整体兜底状态（可选）
   * - 初始化业务模型数据
   * - 初始化回放 Feeds 无尽流服务（可选）
   * - ALive 服务
   * @param initData
   */
  init: async (initData) => {
    const { isInitFlag } = commonModel.getState();
    if (isInitFlag) return;

    commonModel.setState({ statusBarHeight: initData?.statusBarHeight || getNavbarHeight().statusBarHeight });

    let data;
    if (initData) {
      data = initData;
    } else {
      // 兜底请求
      try {
        data = await initApplication.getData();
      } catch (error) {
        console.error('🔥 初始化主接口失败', error);
        data = null;
      }
    }

    const { broadCaster, preLives, modules, onlineLiveId } = data || {};
    const { liveReplay } = modules || {};

    /** 初始化业务模型数据 */
    commonApplication.setCommonData({ liveDetail: data, isInitFlag: true });
    previewInfoApplication.setData({
      onlineLiveId,
      anchorInfo: broadCaster,
      preLives,
    });
    liveReplayApplication.setData({
      hasMore: liveReplay?.hasMore,
      data: liveReplay?.data,
    });

    /** 更多回放，则初始化无尽流服务 */
    if (isTrue(liveReplay?.hasMore)) {
      liveReplayApplication.initFeedsServer();
    }

    /** 初始化 ALive 配置 */
    const aLiveConfigRes = await commonApplication.initAlive();
    commonApplication.setCommonData({ targetLandingDetail: aLiveConfigRes });
  },
  
  /** 页面销毁 */
  remove: () => {
    commonServer.resetData();
    liveReplayServer.resetData();
    previewInfoServer.resetData();
  },
};

export default initApplication;

3.看视图组件是怎么抽象的，也就能知道整个页面的结构布局。4.上面整体过一轮基本可以了解个大概，最后详情可以看每一个业务领域的 application 和 server 做了什么，以及在哪一些视图组件监听/触发/消费的即可。看完之后怎么打代码，该怎么做？

可以看一下这一篇文章hhh，这就是写这个的一点 🤏 意义了。

规划

总得来说是实践过程夹杂着一些想法和小心思，但方法论和约束还是过于浅显。如何制定框架层面的架构 SOP 的规范（如 🥚 egg 围绕企业的开发规范范式），以及简单/准确/快速地找到并且划分业务领域模型的方法论。

Ref

▐ 架构理念

Yet another timer use React
What I wish I knew about React | bitsofcode
Clean Coder Blog
DDD, Hexagonal, Onion, Clean, CQRS, … How I put it all together
《我们是否对现代前端开发框架过于崇拜了》

▐ 架构实践

实践总结｜前端架构设计的一点考究（下）

4.2 设计思考

实践

5.1 需求一：金额账户

5.2 需求二：互动效果

5.3 需求三：权益承接

5.4 需求四：任务体系

5.5 思考

协同

规划

Ref

相关文章

相关实验场景

相关课程

热门文章

最新文章

相关电子书