区块

优质

小牛编辑

126浏览

2023-12-01

2.3.0+ 中支持

在 umi 中，区块是快速搭建页面的代码片段。umi 定义了一个区块的规范，你可以开发自己的区块，也可以使用其它来源的区块。通过 umi 你能够快速简单的在你的项目中添加 umi 区块，用于快速初始化代码。

使用区块

在项目根目录使用如下命令可以添加一个区块到你的项目中：

$ umi block add [block url]  --path=[target path]

其中 [block url] 可以是一个 Github 或者 Gitlab 地址，也可以是一个 Git 仓库地址，也可以是一个本地相对或者绝对路径。只要对应的路径下是一个区块的代码，满足 umi 区块的规范，那么 umi 就可以通过该命令将区块的代码下载到你的项目中。

[target path] 是你要把区块添加到的路径。如果已经这个路径下已经存在路由组件，那么 umi 会把区块添加到它里面。如果没有那么 umi 会先创建一个路由组件，然后再把区块添加进去。

比如，你可以运行：

$ umi block add https://github.com/umijs/umi-blocks/tree/master/demo

来将官方的区块仓库中的 demo 区块下载到你的项目本地。对于官方区块仓库下的区块你可以使用更加简洁的命令，比如 umi block add demo 来下载区块。

如果你的项目正在本地调试，那么区块下载到项目中后你就可以访问相应的路径来查看效果了。区块代码会被默认下载到 pages/[name] 下面，其中 name 是默认取区块中的 package.json 中的 name 字段（会去掉/前的无效片段）。对于配置式路由，我们也会默认添加路由配置到你的配置中，所以也一样可以直接访问。

你可以通过 umi help block 来查看支持的更多配置。

需要注意的是，区块只是用于开发时新建页面时的提效工具，一般来说区块要实际应用都需要针对项目需求去修改最后的代码，之后的维护都将和普通页面一样由开发者来维护，不存在区块更新的说法。

区块会优先使用 config.js 的 block 属性配置。在 Pro 中有这样一个配置，执行npx umi block add DashboardAnalysis会从 https://github.com/ant-design/pro-blocks 这个仓库的去寻找 DashboardAnalysis 区块。

 block: {
    defaultGitUrl: 'https://github.com/ant-design/pro-blocks',
  },

使用 js 的区块

在新的版本中我们加入了 TypeScript 转化为 JavaScript 的功能,你可以在下载区块的时候添加 --js 参数。示例如下：

npx umi block add DashboardAnalysis --js

使用其他包管理工具

区块支持通过参数自定义包安装工具，默认使用 npm ，如果你的项目中有 yarn.lock 文件，我们将会使用 yarn 。如果你想使用 cnpm 或者 tnpm 可以通过如下命令使用

npx umi block add DashboardAnalysis --npm-client cnpm

在某些时候可能访问 npm 的官方源速度会很慢，block 会默认切换官方源和淘宝源。保证最后的速度，如果你要使用自定义源可以这样使用

 npx umi block add DashboardAnalysis  --registry myregistryUrl

注：在 umi 2.7 之前，同一个路径下只能添加一个区块，区块会作为整个页面的代码添加到你的项目中。在 2.7 及它之后我们支持重复添加区块，或者添加到当前项目中已有的页面中。对于原因的区块你可以通过在区块的 package.json 中配置 blockConfig.specVersion 为 0.1 来兼容或者通过 --page 来指定添加的方式。

区块开发

初始化区块

你可以通过 create-umi 快速创建一个区块的模板：

$ yarn create umi --type=block

区块的目录结构如下：

- root
  - src              // 区块的代码
    - index.js       // 区块入口，需要默认导出一个 React 组件
    - _mock.js       // 约定的 mock 文件
  - package.json     // 区块依赖等信息
  - .umirc.js        // 基于 umi 开发区块时的配置
  - thumb.[png|jpg]  // 区块的缩略图

其中 package.json 文件相关内容如下：

{
  name: '@umi-blocks/demo',
  description: '区块描述',
  // ... 更多其他 npm 包的相关定义
  dependencies: {
    // dependencies 里面是区块运行时阶段的依赖，比如 antd g2 这些包的依赖
    antd: '^3.0.0',
  },
  devDependencies: {
    // 用户调试区块时候的依赖，和区块没有直接关系，可以提供基于 umi 的开发方案
  },
  scripts: {
    // 开发区块调试时的命令，和区块没有直接关系
  }
}

区块添加逻辑

当执行 umi block add [block url] 的时候实际上是执行的如下步骤：

通过 git clone 下载区块代码（如果已经存在则会通过 git pull 更新）
检测区块的 package.json 中的依赖并自动安装到项目中
将区块代码复制到对应的页面目录，复制过程中会做一些宏替换
如果是配置式路由，那么会自动添加路由

另外，如果在项目中配置了 singular 为 true，那么这个处理过程也会将对应的复数目录改为单数。

宏替换

为了避免区块添加到应用中出现冲突，umi 提供了一些宏，当区块被添加到项目中时，区块代码中的宏也会按照区块对应的信息被替换。通过这个能力可以避免诸如 dva model 的 namespace 冲突等问题。

具体的宏如下，基于 --path=/Test_Hello/hello-Block 示例。

ROUTE_PATH /test_hello/hello-block
BLOCK_NAME test_hello-hello-block
PAGE_NAME hello-block
PAGE_NAME_UPPER_CAMEL_CASE HelloBlock
BLOCK_NAME_CAMEL_CASE testHelloHelloBlock

区块配置

在区块的 package.json 中你可以添加一些配置来指定一些特殊的逻辑，该字段通常是可以缺省的。

配置示例说明：

{
  "name": "youblockname",
  "blockConfig": {
    // 区块标准版本，默认是 1，当它为 0.1 时默认会把区块当做页面级区块添加
    // 未来不再推荐配置该字段，添加区块是你可以通过 --page 参数来实现作为页面添加
    "specVersion": "0.1",
    // 区块可以依赖其它区块，通常用于小的区块组成页面级的区块时使用
    // dependencies 中的路径相对于区块 git 仓库根目录
    // 添加依赖配置后你可以在区块中使用类似 `import SubBlock1 from SubBlock1` 的方式来引用其它区块
    "dependencies": ["path/to/subBlock1", "path/to/SubBlock2"]
  },
  "dependencies": {
    // 区块的依赖，在添加区块时会自动检测依赖冲突和安装缺少的依赖
    "antd": "^3.0.0"
  }
}

你可以参考 umi 的官方示例 demo-with-dependencies 了解更多。

区块调试

区块调试基于 umi-plugin-block-dev 这个插件，基于该插件你就可以把区块当做一个普通的 umi 项目来调试了。如下所示，在区块的根目录下添加 .umirc.js 文件（通过 create-umi 创建的区块脚手架会自带该文件）。

export default {
  plugins: [
    [
      'umi-plugin-block-dev',
      {
        layout: 'ant-design-pro',
      },
    ],
  ],
};

该插件会将区块的 src 目录作为 umi 的 pages 目录，这样你就可以在区块根目录下通过 umi dev 来开发调试区块了。

如果你觉得的区块质量较好，你可以通过提交 PR 来把它添加到官方区块仓库中。