收藏
评论

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

生成海报相信大家有的人都做过,但是canvas绘图的坑太多。大家可以试试这个组件。然后附上楼下大哥做的可视化拖拽生成painter代码的工具:链接地址https://developers.weixin.qq.com/community/develop/article/doc/000e222d9bcc305c5739c718d56813

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.
最后一次编辑于  2019-09-27
收藏

112 个评论

  • 、尓蕞紾貴
    、尓蕞紾貴
    2020-03-17

    参数怎么传递呢 还有怎么生成自己的小程序码 这个扫码是别人的小程序啊

    2020-03-17
    赞同
    回复 1
  • phoenixor
    phoenixor
    2020-03-07

    能不能帮我看看canvas 2d的问题:

    https://developers.weixin.qq.com/community/develop/doc/000686d617848851390ae892b5b000?highLine=drawImage%25E4%25BD%25BF%25E7%2594%25A8tempFilePath

    2020-03-07
    赞同
    回复
  • 沧似海
    沧似海
    2020-03-05

    text元素想加边框不知道text的宽,如何留出边框与text文字之间的距离,padding不生效。

    2020-03-05
    赞同
    回复 1
    • TNT
      TNT
      2020-03-06
      这个需要手动写
      2020-03-06
      回复
  • 沧似海
    沧似海
    2020-03-05

    可以动态根据数据判断某个json元素的饮食或者隐藏吗

    2020-03-05
    赞同
    回复 1
    • TNT
      TNT
      2020-03-06
      可以。
      2020-03-06
      回复
  • 沧似海
    沧似海
    2020-03-05

    如何让多个text居中显示

    2020-03-05
    赞同
    回复 7
    • TNT
      TNT
      2020-03-05
      看了下的代码片段么。。我有写居中的文字样式。
      2020-03-05
      回复
    • 沧似海
      沧似海
      2020-03-05回复TNT
      仔细看了不行诶,我这边是好几个text,个数不确定。要显示在一行中的中间,试了下align:center不可以。您有好办法吗
      2020-03-05
      回复
    • TNT
      TNT
      2020-03-05回复沧似海
      设置 align:center 还需要设置 left 为整个内容部分宽度的一半。
      2020-03-05
      回复
    • TNT
      TNT
      2020-03-05
      真机请开启调试模式,开发者工具需开启不校验域名:https://developers.weixin.qq.com/s/jiEZu4m17z9b
      2020-03-05
      回复
    • TNT
      TNT
      2020-03-05回复沧似海
      这是示例
      2020-03-05
      回复
    查看更多(2)
  • 2020-02-20

    用了一年多,今天突然就报错了,开发者工具调试正常。真机报错:canvasToTempFilePath: fail canvas is empty。有没有朋友遇到一样的问题?

    2020-02-20
    赞同
    回复 10
    • viva la vida 🐨
      viva la vida 🐨
      2020-02-20
      也是今天一样的问题,解决了吗?
      2020-02-20
      回复
    • TNT
      TNT
      2020-02-20回复viva la vida 🐨
      安卓还是ios
      2020-02-20
      回复
    • 2020-02-21回复TNT
      iOS 13.2 iPhone 11 微信7.0.10
      2020-02-21
      回复
    • TNT
      TNT
      2020-02-21回复
      目前IOS没复现该问题。我看安卓有个新版本灰度了。
      2020-02-21
      回复
    • 2020-02-24回复TNT
      iOS没有吗?啊啊啊,线上的尴尬。
      2020-02-24
      回复
    查看更多(5)
  • 倾紫
    倾紫
    2020-02-18

    views里添加的子元素,在ios上有的绘制不出来呀,是因为尺寸设置的太大了吗

    2020-02-18
    赞同
    回复 2
    • TNT
      TNT
      2020-02-18
      看手机内存问题了。不建议设置大的。
      2020-02-18
      回复
    • 倾紫
      倾紫
      2020-02-18回复TNT
      哦哦,那就应该是了,刚开始是可以的,后边忽然就丢失元素了
      2020-02-18
      回复
  • searchFan
    searchFan
    2020-02-09

    可以做到直接截图当前页面,再加上个人信息,加上小程序码并生成海报码?

    2020-02-09
    赞同
    回复 1
    • TNT
      TNT
      2020-03-05
      这个建议使用wxml-to-canvas 官方的扩展组件。
      2020-03-05
      回复
  • h
    h
    2020-02-08

    作者在吗 我是在uni-app小程序上使用的,有时候会出现图片没出来可能是什么原因 高度出来了,图没出来(大概5~10次会出现一次),下面是代码片段

    this.template = {
      background:this.detail.choose_article_img,
      width: '750rpx',
      height: '150rpx',
      views: [
        {
          type: 'text',
          text:'123333',
          css: {
            width:'550rpx',
            height:'284rpx',
            top: '20rpx',
            maxLines:5,
            fontSize: '28rpx',
            lineHeight:'40rpx',
            left: '375rpx',
            align: 'center',
            background: '#F9851E',
            textAlign:'center'
          }
        },
        {
          type: 'text',
          text:this.detail.msg,
          css: {
            width:'550rpx',
            height:'284rpx',
            top: '211rpx',
            maxLines:5,
            fontSize: '28rpx',
            lineHeight:'40rpx',
            left: '375rpx',
            align: 'center',
            color: '#F9851E',
            textAlign:'center'
          }
        },
        {
          type: 'image',
          url: this.detail.WxQr,
          css: {
            bottom: '40rpx',
            left: '280rpx',
            width: '170rpx',
            height: '170rpx',
          },
        }
      ],
    }
    
    2020-02-08
    赞同
    回复 5
    • TNT
      TNT
      2020-02-10
      写个代码片段出来? 图片是否添加到了downloadfile合法域名
      2020-02-10
      回复
    • h
      h
      2020-02-10回复TNT
      已经加了,只有在频繁操作的情况下会出现 比如页面打开关闭重复几次,还有图片在小程序上层级很高,自己打个弹窗和想做个按钮悬浮在图片上无法实现,不知道这2问题是否在uni-app上使用才会出现
      2020-02-10
      回复
    • TNT
      TNT
      2020-02-10
      图片在小程序上跟普通的一样。没有什么层级高的问题。除非你没有转换为image 而是用的canvas
      2020-02-10
      回复
    • h
      h
      2020-02-10回复TNT
      早上改了这个了,不知道空白是否也也是因为用的canvas的问题,后面观察下,谢谢
      2020-02-10
      回复
    • TNT
      TNT
      2020-02-10回复h
      👌
      2020-02-10
      回复
  • 神经蛙
    神经蛙
    2020-01-19

    可以支持一下链接生成二维码不,这样就更好了,或者有没有这样的好用的插件?

    2020-01-19
    赞同
    回复 2

正在加载...

登录 后发表内容