更新记录
1.1.1(2024-12-11) 下载此版本
应用场景
由于中文文体库文件较大,微信小程序在使用中文字体库时有以下限制 1、微信小程序包大小有严格的限制,不宜随包一起发布 2、通过网络加载时,有较长时间的延时 在大部分业务场景下,美字可完美地解决问题,令微信小程序美起来,可轻松使用各种中文字体。
插件使用
appid
wxff740dd084659765
添加插件
在使用插件前,首先要在小程序管理后台的“设置-第三方服务-插件管理”中添加插件。开发者可登录小程序管理后台,通过 wxff740dd084659765 查找插件并添加。
基础库
目前插件支持的基础库版本为 >=2.21.1, 使用前,请在公众平台小程序后台"设置-基本设置-基础库最低版本设置",将最低版本要求设置为2.21.1
引入插件
对于插件的使用者,使用插件前要在 app.json 中声明
{
"plugins": {
"frmstock-plugin": {
"version": "1.0.1",
"provider": "wxff740dd084659765"
}
}
}
调用插件
在 .json 文件中定义需要引入的自定义组件
{
"usingComponents": {
"beautifont": "plugin://frmstock-plugin/beautifont"
}
}
在 .wxml 文件使用组件
<view class="weui-media-box__bd">
<beautifont wx:if="{{obj.bf_unid}}" bfuid="41f28881-e724-4521-8128-4ec81af8124b" unid="{{obj.bf_unid}}"/>
<h4 wx:else class="weui-media-box__title" style="font-size:1.2rem;">{{obj.name}}</h4>
</view>
bfuid 为beautifont插件的用户id,其获取方法参见 开通账号 unid 为文本唯一标识,文本制作方法参见 文本制作
开通账号
注册
打开网站 https://www.frmstock.org.cn ,注册后登录
开通
依次打开页面“首页 》 测试项目 》 美字插件服务”,点击按钮“开通账户”,获取 bfuid ,请妥善保存,不要泄漏。
文本制作
文本制作后,平台会返回文本的唯一标识 unid,此在页面调用插件时被使用。 此唯一标识应保存在本地数据库中,且在不使用时及时销毁。
后台接口
制作接口
URL: https://mp.frmstock.org.cn/index.php/services/beauti_font/make 功能说明:用于制作文本数据 参数说明: 1、bfuid:beautifont插件的用户id,网站上开通服务时返回 2、text:必填 文件内容 3、max_words:可选 行内最大字数,默认为12 4、max_lines:可选 最大行数,默认为2 5、font:可选 使用的字体,默认为"lishu" 6、align:可选 对齐方式,默认为"left" 返回数据: 1、status:0表示操作成功,非0表示操作失败 2、message:原因描述 3、unid:文本的唯一标识 常见失败原因: 1、无授权信息:比如 bfuid 错误 2、冷却时间未结束:冷却时长参见 费用》冷却时间 3、参数text为空
状态查询接口
URL: https://mp.frmstock.org.cn/index.php/services/beauti_font/monitor 功能说明:用于查询文本制作是否已完成,只有制作完成的文本才可正常使用 参数说明: 1、bfuid:必填 beautifont插件的用户id,网站上开通服务时返回 2、unid :文本的唯一标识,此值由制作接口返回 返回数据: 1、status:0表示制作成功,非0表示制作失败 2、message:
销毁接口
URL: https://mp.frmstock.org.cn/index.php/services/beauti_font/discard 功能说明:用于销毁文本数据,回收可用量 参数说明: 1、bfuid:beautifont插件的用户id,网站上开通服务时返回 2、unid :文本的唯一标识,此值由制作接口返回 返回数据: 1、status:0表示操作成功,非0表示操作失败 2、message:
参数说明
文件内容
必填 不能为空 有效范围:1-50 最大支持的中文字符数为50个
可用字体
默认值:lishu(隶书) 可用字体有三种:lishu(隶书)、xingkai(行楷)、zhengkai(正楷) 除此之外,可额外定制一种字体,参见定制化》定制字体
行内最大字数
默认值:12 有效范围:1-20
最大行数
默认值:2 有效范围:1-50
对齐方式
默认值:left 有效范围:left center right
文本管理
文本使用量
页面中可看到“当前文本的使用量”及“剩余可用量”等数据。 使用历史记录如下图
demo案例
功能说明
数据库中有一表,人员信息表,小程序中有一人员列表页面,在未使用美字插件前,页面显示如图1. 使用美字插件后,页面显示如图2.
改造过程
1、数据库改造
人员信息表中,添加字段 bf_unid
ALTER TABLE person_info add `bf_unid` char(36) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '美字唯一标识';
2、后台改造
增加人员时
当增加人员信息时,调用制作接口,获取到文本唯一标识,并把该标识填写到该人员信息的 bf_unid 字段中
更新人员时
当更新人员信息时,先调用销毁接口,销毁旧的文本数据,再调用制作接口,制作新的文本数据
删除人员时
当删除人员信息时,调用销毁接口,销毁旧的文本数据
3、源码改造
app.json文件
引入插件,在文件中添加声明
{
"plugins": {
"frmstock-plugin": {
"version": "1.0.1",
"provider": "wxff740dd084659765"
}
}
}
person_list.json文件
在文件中定义组件
{
"usingComponents": {
"beautifont": "plugin://frmstock-plugin/beautifont"
}
}
person_list.wxml文件
在文件中使用组件
<view class="weui-cell__bd">
<beautifont wx:if="{{persion.bf_unid}}" bfuid="ad601ab8-8d5a-11ef-9c13-00163e30f374" unid="{{persion.bf_unid}}"/>
<text wx:else>{{persion.name}}</text>
</view>
定制化
定制字体
除了平台内字体外,每个账号可额外定制一种字体。 联系管理员,上传中文字体文件后,即可使用。
应用案例
案例一:汉字拼读微信小程序
案例一:西电联盟微信小程序
平台兼容性
Vue2 | Vue3 |
---|---|
× | × |
App | 快应用 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节小程序 | QQ小程序 |
---|---|---|---|---|---|---|
× | × | 2.21.1 | × | × | × | × |
钉钉小程序 | 快手小程序 | 飞书小程序 | 京东小程序 |
---|---|---|---|
× | × | × | × |
H5-Safari | Android Browser | 微信浏览器(Android) | QQ浏览器(Android) | Chrome | IE | Edge | Firefox | PC-Safari |
---|---|---|---|---|---|---|---|---|
× | × | × | × | × | × | × | × | × |
小程序自定义组件的通用使用方式详见:uni-app中使用小程序自定义组件教程
应用场景
由于中文文体库文件较大,微信小程序在使用中文字体库时有以下限制 1、微信小程序包大小有严格的限制,不宜随包一起发布 2、通过网络加载时,有较长时间的延时 在大部分业务场景下,美字可完美地解决问题,令微信小程序美起来,可轻松使用各种中文字体。
插件使用
appid
wxff740dd084659765
添加插件
在使用插件前,首先要在小程序管理后台的“设置-第三方服务-插件管理”中添加插件。开发者可登录小程序管理后台,通过 wxff740dd084659765 查找插件并添加。
基础库
目前插件支持的基础库版本为 >=2.21.1, 使用前,请在公众平台小程序后台"设置-基本设置-基础库最低版本设置",将最低版本要求设置为2.21.1
引入插件
对于插件的使用者,使用插件前要在 app.json 中声明
{
"plugins": {
"frmstock-plugin": {
"version": "1.0.1",
"provider": "wxff740dd084659765"
}
}
}
调用插件
在 .json 文件中定义需要引入的自定义组件
{
"usingComponents": {
"beautifont": "plugin://frmstock-plugin/beautifont"
}
}
在 .wxml 文件使用组件
<view class="weui-media-box__bd">
<beautifont wx:if="{{obj.bf_unid}}" bfuid="41f28881-e724-4521-8128-4ec81af8124b" unid="{{obj.bf_unid}}"/>
<h4 wx:else class="weui-media-box__title" style="font-size:1.2rem;">{{obj.name}}</h4>
</view>
bfuid 为beautifont插件的用户id,其获取方法参见 开通账号 unid 为文本唯一标识,文本制作方法参见 文本制作
开通账号
注册
打开网站 https://www.frmstock.org.cn ,注册后登录
开通
依次打开页面“首页 》 测试项目 》 美字插件服务”,点击按钮“开通账户”,获取 bfuid ,请妥善保存,不要泄漏。
文本制作
文本制作后,平台会返回文本的唯一标识 unid,此在页面调用插件时被使用。 此唯一标识应保存在本地数据库中,且在不使用时及时销毁。
后台接口
制作接口
URL: https://mp.frmstock.org.cn/index.php/services/beauti_font/make 功能说明:用于制作文本数据 参数说明: 1、bfuid:beautifont插件的用户id,网站上开通服务时返回 2、text:必填 文件内容 3、max_words:可选 行内最大字数,默认为12 4、max_lines:可选 最大行数,默认为2 5、font:可选 使用的字体,默认为"lishu" 6、align:可选 对齐方式,默认为"left" 返回数据: 1、status:0表示操作成功,非0表示操作失败 2、message:原因描述 3、unid:文本的唯一标识 常见失败原因: 1、无授权信息:比如 bfuid 错误 2、冷却时间未结束:冷却时长参见 费用》冷却时间 3、参数text为空
状态查询接口
URL: https://mp.frmstock.org.cn/index.php/services/beauti_font/monitor 功能说明:用于查询文本制作是否已完成,只有制作完成的文本才可正常使用 参数说明: 1、bfuid:必填 beautifont插件的用户id,网站上开通服务时返回 2、unid :文本的唯一标识,此值由制作接口返回 返回数据: 1、status:0表示制作成功,非0表示制作失败 2、message:
销毁接口
URL: https://mp.frmstock.org.cn/index.php/services/beauti_font/discard 功能说明:用于销毁文本数据,回收可用量 参数说明: 1、bfuid:beautifont插件的用户id,网站上开通服务时返回 2、unid :文本的唯一标识,此值由制作接口返回 返回数据: 1、status:0表示操作成功,非0表示操作失败 2、message:
参数说明
文件内容
必填 不能为空 有效范围:1-50 最大支持的中文字符数为50个
可用字体
默认值:lishu(隶书) 可用字体有三种:lishu(隶书)、xingkai(行楷)、zhengkai(正楷) 除此之外,可额外定制一种字体,参见定制化》定制字体
行内最大字数
默认值:12 有效范围:1-20
最大行数
默认值:2 有效范围:1-50
对齐方式
默认值:left 有效范围:left center right
文本管理
文本使用量
页面中可看到“当前文本的使用量”及“剩余可用量”等数据。 使用历史记录如下图
demo案例
功能说明
数据库中有一表,人员信息表,小程序中有一人员列表页面,在未使用美字插件前,页面显示如图1. 使用美字插件后,页面显示如图2.
改造过程
1、数据库改造
人员信息表中,添加字段 bf_unid
ALTER TABLE person_info add `bf_unid` char(36) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '美字唯一标识';
2、后台改造
增加人员时
当增加人员信息时,调用制作接口,获取到文本唯一标识,并把该标识填写到该人员信息的 bf_unid 字段中
更新人员时
当更新人员信息时,先调用销毁接口,销毁旧的文本数据,再调用制作接口,制作新的文本数据
删除人员时
当删除人员信息时,调用销毁接口,销毁旧的文本数据
3、源码改造
app.json文件
引入插件,在文件中添加声明
{
"plugins": {
"frmstock-plugin": {
"version": "1.0.1",
"provider": "wxff740dd084659765"
}
}
}
person_list.json文件
在文件中定义组件
{
"usingComponents": {
"beautifont": "plugin://frmstock-plugin/beautifont"
}
}
person_list.wxml文件
在文件中使用组件
<view class="weui-cell__bd">
<beautifont wx:if="{{persion.bf_unid}}" bfuid="ad601ab8-8d5a-11ef-9c13-00163e30f374" unid="{{persion.bf_unid}}"/>
<text wx:else>{{persion.name}}</text>
</view>
定制化
定制字体
除了平台内字体外,每个账号可额外定制一种字体。 联系管理员,上传中文字体文件后,即可使用。