如何实现马良的标注功能

452次阅读  |  发布于2年以前

在很早之前的前端需求开发中,UI 会通过 Sketch 做图,然后导出给我们一个页面标注的 zip 包;在往后,公司用上了“蓝湖”,设计师不用再给我们发标注的zip压缩包了,直接丢给我们一个链接地址。当时在接触“蓝湖”时也被它惊艳到了,这也太方便了,太好用了吧,未曾想到后面自己也会去写一个类似的。

回到早前的zip包时代,我们看看里面的目录结构,很简单:

.
├── assets
├── index.html
├── links
└── preview

点开 index.html 就可以查看到页面的标注了。这个标注如何生成的呢,这就要用到sketch-measure这个工具了,它会把 sketch 的各个画板导出,每个画板页面包含了详细的“标注数据”,这里的“标注数据”可以简单理解成层的集合,画板里面由 N 多个 layers 层组成,每个 layer 还可以简单看成一个 html 标签(div、span、img),每个层有大小,以及摆放位置(使用的是绝对定位,定位的中心点在画板的左上角(0,0))。sketch-measure导出的标注文件里,把这一部分的数据存放在 index.html 的 head 里了,通过搜索 SMApp 就可以看到“标注数据”

我们这边使用的数据是自己开发的一个 Sketch 的插件(名曰:神笔)提取的,神笔做的是提取和解析 Sketch 数据、优化数据、处理图标图片等工作。《神笔马良》是一个相对大的系统,本文的标注功能只是马良其中的一个功能点,想了解的可以看下之前的文章:[转转智能代码平台神笔马良的研发与实践] 。不过标注相对独立,使用的“标注数据”结构和sketch-measure导出的差不了太多(ps.其实就是sketch文件解压后的一个.json的数据)。

把这一部分数据拷贝出来(其实就是 json),格式化一下就能看到数据结构:

其结构里面artboards存放的是当前 sketch 里所有画板(这里便于理解可以画板 ≈ 页面),画板里有width、height标识这个画板的宽高,imagePath是这个画板(页面)的预览效果图片。layers就是这个画板(页面)里包含的所有的层(html 标签)。关于layer这里需要强调一点,每一个layer都是矩形。层里面的结构如下,其中我们比较关心的是rectcss这俩字段。 rect标明的是这个层的绝对位置和自身的宽高,css是层自身的一些 css 属性。到这里,数据有了,数据的结构我们也了解了,接下来就是把这些层展示出来了:

一个简单的循环搞定,我们可以先给每一个层加一个 1px 的 border 来看一下效果(是不是有点骨架屏的感觉了):

这里我们看到了页面基本的骨架,有点类似骨架屏的效果。在前面介绍数据结构的时候提到了imagePath这个字段,我们把imagePath对应的预览效果图作为背景贴上去,感觉就有那么些味道了。

果真好看多,有那么些样子了。接着我们继续优化,这些层的 border 我们不想让它一直展示着(毕竟不好看),只有当我鼠标放上去的时候才展示,这时就需要用到了 hover 伪类:

这里的效果直接脑补就可以,就不上图了,基本的样子是有了。接着,我们还要精益求精,别人有的我们也得有。

鼠标放上去的时候,我们还常见下图的这种效果—— 参考线

如何实现呢?这里我们可以转换一下思路,没必要真的去画线,你看到这四条线可以是两个长矩形的相交的效果。

图中你看到的参考线,其实是这俩矩形的 border (border-style: dashed),把矩形的背景设置成透明就达到了我们预想的效果了。

鼠标悬浮的我们上面处理完过了,接下来需要考虑鼠标点击/选中某一层后出来的效果了(如下图 ⬇️)

这里我的做法是监听外层 div 的 onClick 事件,在点击事件里拿到点击的对象层,进行动态增删样式。

层上面&右边显示的数据(红色背景和35px/20px),是通过 before&after 这俩伪元素来实现的(面试题来了,伪元素、伪类什么区别)。

展示的内容(35px/20px)依赖 content 属性从当前的点击 div 层属性中取 data-width、data-height 数据。ps.这的这俩数据,已经在前文循环铺层的时候一并带上了(如下图)。

文章到这里,一个简单的 sketch 标注功能就到了能凑合用的地步了,不过,我们还需要再做一些锦上添花的事情:当选中某一个层时,移动鼠标到其他的层,能够帮我测量这两层之间的距离数据,像这样的⬇️:

这里的线条要显示的红色线条,可是真的线条了(非矩形 border 的方式)。有两种思路,① 我们知道了线条的两端位置,就能画出来这根线了,② 我们只需要知道线条一端的位置以及这个线条的长度,也能划出来。思路 ① 的场景比较灵活可以画各种直接(水平、竖直、斜的),用 css 实现需要算出两点的距离及两者的倾斜角度,设置一条线高度为 1px,宽度为两者距离,然后围绕着某一点旋转到倾斜角度即可。

思路 ② 有一定的局限性,只能是水平或竖直方向的。水平方向的需要把高度设置为 1px,竖直方向需要把宽度设置成 1px。

结合实际使用场景中,这里我们采用方案 ②;原因不外乎,我们只需求水平或竖直的线条,能少写一些代码。方案确定了,接下来就需要确定每个线的起始点,在从每个基准点(起始点)开始算一下线条长度(距离各个边的距离)。

在确定基准点之前,我们需要先明确一点,如果想要展示距离数据的话,需要至少有两个层,一个层是我们选中的 selected-层(我们用橘红色实线 border 来标注),另一个是我们鼠标移动到的 hover-层(蓝色实线 border 来标注)。由于 hover-层是千变万化的,以它为基础确立起始点,计算上稍微复杂一下,我们选择以 selected-层来计算基准点。关于基准点的位置,从效果图上可以看出是 selected-层的每个边的中点位置。在遍历生成每个层的时候,我们已经有了每个层的左上角位置(x1,y1)及宽高(w,h),我们很容易计算层的边的中心点位置,总共会有 4 个点。

计算过程就省略了,我们得到每个起始点位置后,下一步就需要算一下每线条的长度了。以左边距离为例,selected-层与 hover-层的距离,就是两个层左边的 x 轴的距离,便可得到距离为:x1-x2,其他边长度类似:

这些数据都有了,再接着就是开始画线了,水平方向的线条,我们让 height=1,线条 width 为计算的长度,竖直方向正好相反,width=1,高度为计算的长度。思路有了就可以开始编码了,看一下效果(线条上的数字的实现在上文中提到过data-* + content:attr):

我们发现,left、top 的这俩线条展示的不是我们想要的,思考了一下,发现问题所在,由于我们的基准点是 selected-层,计算的两层的对应边的距离都是正值,所以在“画线条”的时候它们分别会向右、下延伸。如何修正呢,我们采用的是 translateX/translateY。在计算长度时,我们会把 left、top 的这俩边的值计算的结果取负数(即:x1-x2 变成-(x1-x2),y-y2 变成-(y1-y2) )。在线条样式上加上一个逻辑判断,如果是负数的话就进行平移,其他边的线条也同样进行处理即可。

在后续自测中还发现,存在下面一种情况:

这种情况,属于两个层完全无交叉、无包含的情况,这里我们对这种情况进行特殊处理下即可

由于IF条件取得是并集,同时也兼容了在左上,右上,左下,右下的情况。到这里,基本的功能就差不多都实现了。后面的更多的扩展功能的实现,包括查看标注css样式,N倍图的尺寸,鼠标缩放,双指拖动等等功能,这里就不再一一去表述了。大家如果对这感兴趣或有更好的建议的话,可以在评论区留言,一起讨论交流。

Copyright© 2013-2020

All Rights Reserved 京ICP备2023019179号-8