标记生成权
前端架构师的第一个挑战是标记的规范化:希望开发人员写出或 CMS 产出什么样的标记。初始标记做得不好,就要写大量不必要的 CSS 和 JavaScript 去弥补。常见困境是前端没有标记控制权:前端参与前功能开发已进行数周,标记经复杂渲染来自不同模板,后端又已转去别的任务,更新标记异常困难。发散:前端应尽早参与内容模型和模板输出。
主题对照
比较标记控制权、CSS 方法论、组件与布局分离、单一样式来源、模式库、样式文档与模板数据模式等构建可维护前端设计系统的做法。
前端架构师的第一个挑战是标记的规范化:希望开发人员写出或 CMS 产出什么样的标记。初始标记做得不好,就要写大量不必要的 CSS 和 JavaScript 去弥补。常见困境是前端没有标记控制权:前端参与前功能开发已进行数周,标记经复杂渲染来自不同模板,后端又已转去别的任务,更新标记异常困难。发散:前端应尽早参与内容模型和模板输出。
标记有三种生成方式:程序式标记完全由 CMS 自动生成,自动化程度高但前端几乎无控制权;静态标记由前端手写,完全可控却无法自动化;模块化标记追求两者兼得,不完全任由 CMS 决定输出,并通过一套类名系统给标记添加样式,而不再依赖元素标签和层级关系决定外观。发散:好的模板系统本质上是协作协议。
单独的静态“网页”其实并不存在,越早意识到工作是设计整个系统,越早能做出好作品。设计系统是网站视觉语言的程序化呈现:视觉语言由颜色、字体、按钮、排版等组成,前端要像把句子拆成名词、动词一样,把它拆成最小单元,再建立重组规则,使代码库能如实重现视觉语言表达的任何内容。
OOCSS、SMACSS、BEM 等 CSS 方法论各有亮点,但没有哪个是完美的,一个项目适合这种,另一个项目可能适合那种,完全可以改造或混合,Red Hat 就混用了 SMACSS 和 BEM。选择时不要因为流行或别人在用,而要理解背后的原则,说明它为什么能解决当前项目的挑战,并确保团队乐于统一使用。
传统 CSS 从全局作用域开始,一层层增加细节,先写通用标签样式,再按页面区域覆盖。问题随之而来:重写选择器总要计算优先级;要恢复原样式得再次覆盖;样式依赖位置,组件挪到页尾就变样;一个标题的样式来源多达三四个,改主体或侧边栏都会波及它。发散:样式 bug 要全站搜索才能定位时,系统已失去局部推理能力。
现代模块化 CSS 从三种方法中各取一条原则:OOCSS 分离容器和内容,不再用位置作为样式的限定词;SMACSS 把布局和组件分到不同文件夹,侧边栏只承担布局角色;BEM 给每个类名独一无二的标识。再加上单一职责原则:每个选择器里的样式只为一个高度聚焦的目的而写。发散:边界越清楚,团队越敢重构。
单一样式来源是单一职责原则的深化:不仅每个类名只有一个用途,每个标签的样式也只有一个来源。在模块化设计中,组件长什么样必须由组件本身决定,而不是被父级类名限制;即使要按上下文变化,变体也写在组件自己的样式文件里。发散:这会失去“随手覆盖”的便利,换来长期可追踪性。
组件修饰符(又叫皮肤或子组件)让一个组件在不同情况下呈现多种变化,修饰符属于组件自身,而不是由父级上下文强加。Red Hat 的规则更进一步:每一个样式变更都必须可选,给组件 B 定义了修饰符 A,组件 C 除非自己选用 A,否则不受影响。发散:设计系统允许变化,但每种变化都要有登记入口。
旧 Redhat.com 按内容版块自上而下设计:每个版块有自己的样式文件,新设计或新布局就得再建一个版块,完善的视觉语言从未被“翻译”成可模块化生成样式的系统。重建时的首要任务是把设计分解成尽可能小的单位:先对比常用版块,找出带侧边栏、等宽列、每行五张图等几种共用布局模式。发散:分解是为了找到真正稳定的变化轴。
布局和组件各管一件事:布局只负责垂直对齐、水平对齐和间距,永远不给子内容强加内边距和元素样式;组件只描述一小块内容的外观,不设背景、宽度、浮动和内外边距,贴着父容器四边。这样把三个组件放进三列布局,不写代码就能自动对齐。发散:这是前端版的职责分离,边界清楚才能自由组合。
起草设计系统规则时,作者发现规则越写越多,其实是在写整个系统的说明文档。真正需要的是精简、固定的规则列表,并给规则本身定规范:只包含不可变的规则,而不是笼统的说明;先说规则,再说不遵守会怎样;每条都要含“总是、永远不要、只有、每一个”这类词。新布局和组件的每次合并请求都按这些规则检查。
通用、万能的 CSS 类在项目壮大后很难维护:改一处样式可能影响很多地方,于是大家宁可新建类也不敢改旧类。Red Hat 规则要求每个元素有且只有一个唯一、作用域只在组件内的类名,每个类只服务单一目的、单一位置。这样修改某个类只会影响它所在的组件,删除组件时也能放心删掉全部关联 CSS。
Red Hat 把所有修饰符都改用数据属性表达,例如用 data-rh-theme 设置深浅主题、data-rh-justify 设置对齐方式,而不再给元素加额外的类。这样类只表示“它是什么”,不会与修饰符混淆;而且类是一维的,只有应用或不应用,数据属性是二维的,有明确的命名空间,还能传递不同的值。发散:这让设计系统更容易列举合法状态。
语义化网格把布局信息放在父节点的数据属性上,例如 data-rh-layout=“gallery5” 让所有子节点各占约 20% 宽度。子组件不用添加类,也不用包进行、列容器,布局与组件彻底分离。把商标墙从 5 列改为 4 列,只需在父标签上改一个属性;一组图片集和 12 列布局组合覆盖了 99% 的需求。发散:好的布局接口描述意图,而不是泄露实现。
过去前端用 Mustache 或 Twig 模板做原型,再让后端在 PHP、Ruby 等模板里输出同样的标记,一半开发时间都花在让 CMS 输出与原型一致上。即使对齐了,两边也会各自变化、逐渐不同步,最终原型不再被信任。根源在于 CMS 和原型工具用的是不同的 HTML 模板,哪怕共享了 CSS 和 JavaScript。这就是 Red Hat 重构时要解决的“最后一英里”问题。
数据和模板的关系成为设计系统的核心后,开发人员开始要求模板变量列表、内容类型和必选项。于是每个组件和布局都附带一组标准产出:定义属性与必选项的 JSON 模式、接收数据的 Twig 模板、单一来源的 Sass 文件、回归测试配置与测试数据、文档文件和文档数据。其中 JSON 模式最能描述功能的需求和能力,是整个流程的奠基石,通常最先创建。
每当组件的功能变化,都先改 JSON 模式,再扩展到组件的其他文件,所以这个流程叫模式驱动的设计系统。它与测试驱动开发相似:测试驱动先写测试用例描述正确功能,模式驱动先用 JSON 定义组件的正确数据结构,首先关注内容和用户接口,而不是标记和 CSS。模式还能校验数据、生成编辑界面,免去逐级交付中的主观猜测。
Red Hat 选用成熟稳定、同时有 PHP 和 Node 编译引擎的 Twig 作为通用渲染引擎,原型工具和 Drupal 等实际平台使用同一份模板文件,不再需要在系统之间转换模板。样式文档里的样例对应一组数据,后端只需按这组数据实现。这相当于设计系统的 API:输入数据,输出相同的 HTML,跨平台一致。发散:生产模板和文档示例越接近,交接时越不容易失真。
样式表已演化成有变量、函数和逻辑的系统,文档也要跟上。Hologram 让开发者在写代码时直接在 Sass 或 JavaScript 文件中写文档注释,再自动收集,生成带渲染示例和代码示例的网站。样式文档与设计系统因此合为一体,不用维护两套代码库,哪段代码注释不足也一眼可见。发散:文档离代码越远,越容易从知识变成历史。
两类文档工具各有所长:Hologram 格式非常自由,不关心写什么、写在哪种文件里,像一张白纸,适合写组件示例、入门文档和团队规则;SassDoc 专门记录 Sass 的变量、混入、继承和函数,对注释后的代码要求严格,还能自动列出依赖关系和被引用关系,适合大型 Sass 框架。现代样式文档常组合多种工具,各自展示系统的不同部分。
代码示例及其在浏览器中的渲染效果是样式文档的核心。Hologram 用特殊的代码块关键字同时输出两样东西:渲染示例直接显示组件在页面中的样子,代码示例放在 pre 标签里并加语法高亮,读者既能看效果,又能直接拿到正确的标记。发散:示例越接近真实模板,使用者越少猜测;无法直接复用的示例会慢慢偏离生产现实。
样式文档不只列组件。Hologram 允许在样式文档中放标准 Markdown 文件,用来写入门文档、项目规则和章程、联系方式,以及其他需要整理给团队的信息。生成的小型网站还能个性化定制,添加搜索、过滤,或改成企业品牌风格。发散:设计系统文档本身也是产品,服务开发、设计、测试和内容人员。
原子设计不一次性设计整个页面,而是把网页元素分解成不同尺寸的模式:原子是标题、图片等最小单元,原子组合成搜索表单、导航栏等分子,分子组合成有机体,再组成布局和页面。Pattern Lab 把这些模式变成可浏览的网页,还能用自定义内容生成样例页面。它既是开发平台,也是团队成员沟通的通用语言。
模式库最好与生产站点共享 CSS、JavaScript 和模板资源。这样在模式库里验证过的组件,进入真实站点时不会重新翻译一遍。发散:模式库如果只是静态展览,就很难约束生产实现。
Pattern Lab 用 Mustache 模板加 JSON 数据生成页面:页面文件只负责把一组数据和模板关联起来,模板通过导入标签引用各级模式,并切换数据上下文。连一个图片标签也值得抽成原子模板:将来要给所有图片加类名或 data 属性时,只需更新这一个原子,所有用到它的地方自动更新。发散:模板负责结构、数据负责内容,能减少手写标记的漂移。
有了模式库,构建新页面时不再面对一张白纸,而是用已有的原子、分子、有机体和模板拼出完整页面;整个网站共享代码,要调整“发布日期”的行高,只改一个原子就应用到全站。只做一个个网页,工作会随时间越来越难;专注于用 Pattern Lab 这类工具构建系统,工作会随时间越来越简单。发散:设计系统的回报往往滞后出现。
Red Hat 最初把标记复制进 Markdown 文档,用来说明品牌 logo、视频区块等的组合方式。但每复制一次,标记被改动的概率就增加一分,很快难以维护。解决办法是让 HTML 片段只有一个来源、按需重用:文档交给 Hologram 之前先用 Twig 处理,用 include 传不同参数输出同一个 CTA 模板。改 CTA 时只更新一个 Twig 文件,全系统随之生效。
卡片布局要容纳不同组件时,与其为每种组合复制一份布局,不如用数据决定引入哪些模板:数据里写明每个组件使用的模板和属性,卡片模板遍历数据逐个引入。这与 Pattern Lab 把模板信息硬编码在布局里不同,同一个布局可以承载任意内容组合。代价是渲染开始后,除了数据无法控制标记,但正是这些限制让系统健壮。
模式库和样式文档共用一个仓库时,大量只影响文档的改动也要打预发布标签,还得先确认模板、样式有没有变,给后端带来困扰。拆成两个仓库后,文档可以全天候推送而不影响生产服务器,模式库的拉取请求少了,团队能更专注于它对生产的影响;生产环境和样式文档都通过 Bower 平等地依赖模式库。发散:仓库边界应反映变更风险。
Drupal 的渲染流程复杂,前端要么写最终被忽略的静态标记,要么先在 CMS 建内容再写样式。拆分模式库后,Red Hat 发现自己得到了一个基于 Twig 的渲染引擎,Drupal 和样式文档都能用:传入同样的 JSON 数据就返回同样的 HTML,无论数据来自静态文件还是复杂的 CMS。模式库因此可安装到任何能编译 Twig 的系统中。
点击箭头逐层展开,点击卡片标题查看详情。路径上下文仅用于连接层级,不计入主题卡片数。
来源书籍
前端架构与设计系统类
书籍类型:工程实践
清单覆盖 7/7
71 张卡片
来源书籍
前端架构与设计系统类
书籍类型:工程实践
清单覆盖 7/7
98 张卡片
来源书籍
书籍类型:工程实践
30 张卡片