收藏
评论

Painter 一款轻量级的小程序海报生成组件

生成海报相信大家有的人都做过,但是canvas绘图的坑太多。大家可以试试这个组件。

Painter

由于我们无法将小程序直接分享到朋友圈,但分享到朋友圈的需求又很多,业界目前的做法是利用小程序的 Canvas 功能生成一张带有二维码的图片,然后引导用户下载图片到本地后再分享到朋友圈。而小程序 Canvas 功能是很难用的,往往为了绘制一张简单图片,就得写上一堆 boilerplate code ,而且一不小心还会踩到 Canvas 的各种彩蛋(坑)。我想此时你的心情肯定是这样的。

这边说上几个小程序 Canvas 的坑

  1. Canvas 绘图是用的 px,而在小程序中我们一般使用 rpx 进行相对布局。
  2. 小程序 Canvas 中的 drawImage 方法,在 IDE 中可以直接设置网络图片进行绘制,但在真机上设置网络图片无用。
  3. canvasContext.clip 方法在 iOS 设备上的微信 6.6.6 版本及以下有 bug,会导致该 clip 下面使用的的 restore 方法失效。

画家计划

想到小程序中有如此大量的生成图片需求,而 Canvas 生成方法又是如此难用和坑爹。那我们就想到可不可以做一款可以很方便生成图片,并且还能屏蔽掉直接使用 Canvas 的一些坑的库呢?所以我们发起了 “画家计划— 通过 json 数据形式,来进行动态渲染并绘制出图片”。 Painter 库的整体架构如下:

整体架构

首先,我们定义了一套绘图 JSON 规范,开发者可以根据需求构建生成图片的 Palette(调色板),然后在程序运行过程中把调色板传入给 Painter(画家)。Painter 会调用 Pen(画笔),根据 Palette 内容绘制出对应的图片后返回。

How To Use

运行例子

git clone https://github.com/Kujiale-Mobile/Painter.git

代码下载后,用小程序 IDE 打开后即可使用。

注:请选择小程序项目,非小游戏,例子中无 appid,所以无法在手机上运行,如果需要真机调试,请在打开例子时,填上自己的小程序 id

使用 Painter

  1. 引入代码

    Painter 的核心代码在另一个 repo 中,https://github.com/Kujiale-Mobile/PainterCore.git 。你可以通过以下三种方式进行库的引入:

    一,直接下载代码,拷贝代码到你需要的库中。(不推荐)

    二,submodule 的方式。可以在主项目下执行以下命令。如后续需更新代码,则到对应目录下 pull 最新的代码即可。(推荐)

    git submodule add https://github.com/Kujiale-Mobile/PainterCore.git components/painter
    

    三,subtree 的方式。也一样是在主项目中执行命令。代码更新要复杂点,submodule 和 subtree 的区别请自行 Google。

    git subtree add --prefix=components/painter https://github.com/Kujiale-Mobile/PainterCore.git master
    
  2. 作为自定义组件引入,注意目录为第一步引入的代码所在目录

    "usingComponents":{
      "painter":"/components/painter/painter"
    }
    
  3. 组件接收 palette 字段作为画图数据的数据源, 图案数据以json形式存在,推荐使用“皮肤模板”的方法进行传递,示例代码如下:

    <painter palette="{{data}}" bind:imgOK="onImgOK" />
    
  4. 数据传入后,则会自动进行绘图。绘图完成后,你可以通过绑定 imgOK 或 onImgErr 事件来获得成功后的图片 或失败的原因。

    bind:imgOK="onImgOK"
    bind:imgErr="onImgErr"
    

Palette 规范

如你使用 wxss + wxml 规范进行绘制一样,Painter 需要根据一定的规范来进行图片绘制。当然 Painter 的绘制规范要比 wxml 简单很多。

调色板属性

一个调色板首先需要给予一些整体属性

background: 可以是颜色值,也可以为网络图片的链接,默认为白色
width: 宽度
height: 高度
borderRadius: 边框的圆角(该属性也同样适用于子 view)
views: 里面承载子 view

子 View 属性

当我们把整体的调色板属性构建起来后,里面就可以添加子 View 来进行绘制了。

type content description 自有css
image url 表示图片资源的地址,本地或网络
text text 文本的内容 fontSize: 文字大小,color: 字体颜色(默认为黑色)
rect 矩形 color: 颜色
qrcode content 画二维码 background: 背景颜色(默认为透明色),

布局属性

以上 View ,除去自己拥有的特别属性外,还有以下的通用布局属性

属性 意义
rotate 旋转,按照顺时针旋转的度数,默认不旋转
borderRadius 边界圆角程度,如果是正方形布局,该属性为一半宽或高时,则为圆形
top、right、bottom、left 如 css 中为 absolute 布局时的作用,默认 top 和 left 为 0
align center:中间对齐方式;right:右对齐方式;left:左对齐方式(默认,可不写)

尺寸即其他

1,目前 Painter 中支持两种尺寸单位,px 和 rpx,代表的意思和小程序中一致,此处就不多说。

2,目前子 view 的 css 属性支持 object 或 array。所以意味着,你可以把几个子 view 共用的 css 属性提取出来。做到让 Palette 更加简洁。

3,因为我们的 palette 是以 js 承载的 json,所以意味着你可以在每一个属性中很方便的加上自己的逻辑。也可以把某些属性单独提取出来,让多个 palette 共用,做到模块化。

举个栗子

{
  background: '#eee',
  width: '654rpx',
  height: '400rpx',
  borderRadius: '20rpx',
  views: [
  {
    type: 'image',
    url: 'https://qhyxpicoss.kujiale.com/r/2017/12/04/L3D123I45VHNYULVSAEYCV3P3X6888_3200x2400.jpg@!70q',
    css: {
      top: '48rpx',
      right: '48rpx',
      width: '192rpx',
      height: '192rpx',
    },
  }
  ...
  ],
}

绘制效果如下

License

Copyright (c) 2018 Kujiale

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
最后一次编辑于  2018-07-10  (未经腾讯允许,不得转载)
复制链接收藏

92 个评论

  • 来一间
    来一间
    05-30

    非常不错!

    05-30
    赞同 3
    回复
  • 仙森ღ₅₂₀¹³¹⁴
    仙森ღ₅₂₀¹³¹⁴
    05-30

    这是使用painter生成的分享图


    05-30
    赞同 1
    回复 13
    • 高雷
      高雷
      06-01

      生成这种图有示例吗?

      06-01
      回复
    • 仙森ღ₅₂₀¹³¹⁴
      仙森ღ₅₂₀¹³¹⁴
      06-03回复高雷

      可以写个代码片段。

      06-03
      2
      回复
    • 飞天
      飞天
      06-12回复仙森ღ₅₂₀¹³¹⁴

      代码片断有么

      06-12
      回复
    • 仙森ღ₅₂₀¹³¹⁴
      仙森ღ₅₂₀¹³¹⁴
      06-12回复高雷

      真机请开启调试模式,开发者工具需开启不校验域名:https://developers.weixin.qq.com/s/jiEZu4m17z9b

      06-12
      3
      回复
    • 飞天
      飞天
      06-13回复仙森ღ₅₂₀¹³¹⁴

      学习了。谢了。再问个问题,这个支不支持静默生成,就是我不用显示海报。用户点击一键保存的,自动生成。我现在看我把它设置成不可见的时候是没用的

      06-13
      回复
    查看更多(8)
  • 仙森ღ₅₂₀¹³¹⁴
    仙森ღ₅₂₀¹³¹⁴
    06-12

    写了个代码片段,真机请开启调试模式,开发者工具需开启不校验域名:https://developers.weixin.qq.com/s/jiEZu4m17z9b  因为图片涉及donwloadFile域名等。

    06-12
    赞同 1
    回复
  • 昨日青空
    昨日青空
    2018-10-25

    我如果想用这个应该怎么用呢,看的不是很懂

    2018-10-25
    赞同
    回复 1
  • 海玄科技
    海玄科技
    2018-12-06

    12.6 测试一下,真机反应的有些慢。

    2018-12-06
    赞同
    回复 1
    • 仙森ღ₅₂₀¹³¹⁴
      仙森ღ₅₂₀¹³¹⁴
      2018-12-07

      所以需要一进入页面接口请求成功返回图片 或者文案那些 就开始画图

      2018-12-07
      回复
  • 君君
    君君
    01-19

    还是有http域名的问题,我们的图片都是http的域名的,会报错

    01-19
    赞同
    回复
  • 五行不缺木和土
    五行不缺木和土
    03-05

    我在使用这个的时候一次生成5张图片,但是有时候生成出来的图片不完整,其中有几张会出现少了一些底部配图,或者插图的情况

    03-05
    赞同
    回复 2
    • 五行不缺木和土
      五行不缺木和土
      03-06

       项目要求 一次生成5张海报,让用户滑动切换

      03-06
      回复
    • 侯衍超
      侯衍超
      08-17回复五行不缺木和土
      这个问题怎么解决的呢
      08-17
      回复
  • aholy
    aholy
    05-28

    真棒

    05-28
    赞同
    回复 3
  • "
    06-05

    自己弄的海报在安卓机中只要生成的长度超过3 4千px就闪退,用这个插件能支持多大的尺寸呢?

    06-05
    赞同
    回复 6
    • 仙森ღ₅₂₀¹³¹⁴
      仙森ღ₅₂₀¹³¹⁴
      06-05

      看你手机运存了。具体多少 我没操作过。你可以试试

      06-05
      回复
    • "
      06-05回复仙森ღ₅₂₀¹³¹⁴

      好的,我刚下载demo,有BUG:在真机上,生成的图片尺寸跟设置的尺寸不一致(安卓手机,苹果未测试,而开发工具上是正常的)

      06-05
      回复
    • "
      06-13回复仙森ღ₅₂₀¹³¹⁴

      谢谢  不是这个问题 是图片输出的尺寸的问题 已经解决了

      06-13
      回复
    • 仙森ღ₅₂₀¹³¹⁴
      仙森ღ₅₂₀¹³¹⁴
      06-13回复

      好的

      06-13
      回复
    • 执念
      执念
      07-12
      请问大佬我不知道要生成的图片高度是多少应该,也就是说图片高度根据内容多少变化的要怎么弄呢
      07-12
      回复
    查看更多(1)
  • Destiny
    Destiny
    06-18

    请问 在 uni-app 中如何使用

    06-18
    赞同
    回复 3
    • 仙森ღ₅₂₀¹³¹⁴
      仙森ღ₅₂₀¹³¹⁴
      06-18

      uni-app么操作过。需要自行试下

      06-18
      回复
    • Destiny
      Destiny
      06-19回复仙森ღ₅₂₀¹³¹⁴

      还望大佬指点迷津

      06-19
      回复
    • 仙森ღ₅₂₀¹³¹⁴
      仙森ღ₅₂₀¹³¹⁴
      06-19回复Destiny

      额。我没用过。不过用法应该都差不多吧。你理清楚 我发你的代码片段的逻辑 就可以了。

      06-19
      回复