更新记录
1.0.1(2025-07-22)
修改文档说明
1.0.0(2025-07-22)
1.0.0
平台兼容性
云函数类插件通用教程
使用云函数类插件的前提是:使用HBuilderX 2.9+
条形码生成工具前端使用说明文档
🚨 重要提示
请您先试用再购买!
在正式购买前,请务必在测试环境中充分测试本工具的功能。
本工具由开发者利用业余时间开发维护,可能存在以下情况:
- 功能兼容性:请确认工具完全满足您的项目需求
- 问题响应:Bug修复可能无法做到即时响应
- 支持限制:优先处理已确认购买的正式用户问题
强烈建议:在试用环境中全面测试后,确认功能满足需求再进行购买!
感谢您的理解与支持 🙏
兼容性说明
本工具全面兼容以下平台和框架:
平台/框架 | 支持情况 | 特别说明 |
---|---|---|
UniApp | ✅ 完全兼容 | 支持所有UniApp版本 |
UniApp-X | ✅ 完全兼容 | 支持新一代跨平台框架 |
微信小程序 | ✅ 完全兼容 | 支持最新版本API |
QQ小程序 | ✅ 完全兼容 | 已通过官方测试 |
支付宝小程序 | ✅ 完全兼容 | 支持最新版本 |
百度小程序 | ✅ 完全兼容 | 已适配百度环境 |
字节跳动小程序 | ✅ 完全兼容 | 支持抖音/头条小程序 |
快应用 | ✅ 完全兼容 | 支持华为/小米等快应用 |
H5 | ✅ 完全兼容 | 支持所有现代浏览器 |
App | ✅ 完全兼容 | 同时支持Android和iOS |
Vue | ✅ 完全兼容 | 支持Vue 2.x和3.x |
NVue | ✅ 完全兼容 | 高性能原生渲染支持 |
Web | ✅ 完全兼容 | 支持PC和移动端浏览器 |
方法列表
1. 生成自定义条形码
方法名
generateBarcode(params)
请求参数
参数名 | 类型 | 必填 | 默认值 | 说明与限制 |
---|---|---|---|---|
content |
string | 是 | - | 条形码内容(最大3KB,约3000字符) |
bcid |
string | 否 | 'code128' | 条形码类型,支持多种标准类型 |
width |
number | 否 | 200 | 条形码宽度(像素,1-2000) |
barHeight |
number | 否 | 自动计算 | 条形码高度(像素,1-1000) |
barColor |
string | 否 | '#000000' | 条颜色(HEX格式#RRGGBB或RGB/RGBA格式) |
bgColor |
string | 否 | '#FFFFFF' | 背景色(格式同上) |
textColor |
string | 否 | '#000000' | 文本颜色(格式同上) |
textSize |
number | 否 | 12 | 文本大小(8/10/12/14/16/18/20等像素) |
textPosition |
string | 否 | '下' | 文本位置('上'/'下',不区分大小写) |
textCenter |
boolean | 否 | false | 文本是否居中 |
textBold |
boolean | 否 | false | 文本是否加粗 |
textMargin |
number | 否 | 0 | 文本与条形码间距(0-50像素) |
showDisplayText |
boolean | 否 | true | 是否显示展示文本 |
marginTop |
number | 否 | 0 | 上边距(0-100像素) |
marginRight |
number | 否 | 0 | 右边距(0-100像素) |
marginBottom |
number | 否 | 0 | 下边距(0-100像素) |
marginLeft |
number | 否 | 0 | 左边距(0-100像素) |
uploadToCloud |
boolean | 否 | false | 是否上传到云存储(false返回Base64) |
返回结果
{
code: Number, // 200=成功,400=参数错误,500=生成失败
message: String, // 结果描述
data: {
url: String, // 云存储访问URL uploadToCloud=true 时返回
fileID: String, // 云存储文件ID uploadToCloud=true 时返回
size: Number // 图片大小(字节)uploadToCloud=true 时返回
image: String, // Base64图片数据 uploadToCloud=false 时返回
params: Object, // 实际使用的参数
},
details: Object // 错误详情(仅错误时返回)
}
2. 参数预校验
方法名
validateBarcodeParams(params)
返回结果
{
code: number, // 200=验证通过,其他=失败
message: string, // 错误详情(多个错误用逗号分隔)
data?: Object, // 校验后的参数(成功时返回)
details?: string[] // 错误详情(失败时返回)
}
关键特性说明
1. 颜色格式关键说明
-
支持的颜色格式:
- HEX格式:
#RRGGBB
(如#FF0000
) - RGB格式:
rgb(r,g,b)
(如rgb(255,0,0)
) - RGBA格式:
rgba(r,g,b,a)
(如rgba(255,0,0,0.5)
)
- HEX格式:
-
颜色对比度建议:
- 确保barColor与bgColor有足够对比度
- 推荐组合:
- 黑色条码+白色背景(默认)
- 深蓝色条码+浅黄色背景
- 深绿色条码+白色背景
-
透明度注意事项:
- 当使用
rgba
格式设置透明度时,背景色将与页面背景混合 - 对于要求不透明背景的场景,建议使用
rgb
或hex
格式
- 当使用
2. 文本显示控制
-
文本位置与可见性:
showDisplayText
控制是否显示自定义文本(通过text
参数设置)
-
文本大小限制:
- 仅支持预设尺寸:8/10/12/14/16/18/20/22/24/26/28/30/32/64像素
-
云存储路径:
- 当设置
uploadToCloud=true
时,条形码将上传到UniCloud云存储 - 系统会自动创建名为
barcode-gsz
的文件夹 - 所有生成的条形码都将存储在此文件夹下
- 当设置
3. 条形码类型兼容性
-
常用类型推荐:
- code128:默认类型,支持全ASCII字符集,推荐大多数场景使用
- ean13:用于零售商品的13位条形码,仅支持数字
- code39:可表示数字和字母,支持自检,适合工业应用
- upca:北美商品条形码标准,12位数字
-
字符限制:
- 数字型条形码(ean13, upca等):仅支持数字0-9
- 字母数字型条形码(code39等):支持数字、大写字母和部分特殊字符
- 全ASCII型条形码(code128等):支持所有ASCII字符
支持的条形码类型与规范
1. 常用条形码类型详解
商品条码类
类型名称 | 简称 | 特点 | 应用场景 | 字符限制 |
---|---|---|---|---|
EAN-13 | ean13 |
13位数字,含校验位 | 国际商品标识 | 13位数字 |
EAN-8 | ean8 |
8位数字,含校验位 | 小型商品标识 | 8位数字 |
UPC-A | upca |
12位数字,北美标准 | 北美商品标识 | 12位数字 |
UPC-E | upce |
6位数字,压缩版UPC-A | 小型包装商品 | 6位数字 |
GS1-128 | gs1-128 |
支持GS1应用标识符 | 物流、医疗、零售 | ASCII字符 |
工业条码类
类型名称 | 简称 | 特点 | 应用场景 | 字符限制 |
---|---|---|---|---|
Code 39 | code39 |
自检能力,可变长度 | 工业、物流、资产管理 | 字母、数字、特殊字符 |
Code 93 | code93 |
高密度,比Code39更紧凑 | 仓储、运输 | 全ASCII字符 |
Code 128 | code128 |
高密度,全ASCII支持 | 物流、零售、医疗 | 全ASCII字符 |
Interleaved 2 of 5 | interleaved2of5 |
偶数位数字,高密度 | 仓储、物流 | 偶数位数字 |
Code 2 of 5 | code2of5 |
可变长度,简单结构 | 仓储、工业 | 数字 |
2. 完整条形码类型列表
以下是本工具支持的所有条形码类型(共80+种):
类型分组 | 支持的类型列表 |
---|---|
通用商品条码 | ean13, ean8, upca, upce, gs1-128, issn, isbn, ismn |
工业与物流条码 | code128, code39, code39ext, code93, code93ext, code2of5, interleaved2of5, codabar, databarlimited, databartruncated |
邮政与特殊条码 | auspost, japanpost, kix, planet, postnet, royalmail, identcode, leitcode |
GS1系统条码 | gs1datamatrix, gs1qrcode, gs1dotcode, databarexpanded, databarcstacked |
其他专用条码 | codablockf, code16k, code49, channelcode, daft, dotcode, flattermarken, hanxin |
完整类型参考:auspost, azteccode, azteccodecompact, aztecrune, bc412, channelcode, codablockf, code11, code128, code16k, code2of5, code32, code39, code39ext, code49, code93, code93ext, codeone, coop2of5, daft, databarexpanded, databarexpandedcomposite, databarexpandedstacked, databarexpandedstackedcomposite, databarlimited, databarlimitedcomposite, databaroomni, databaroomnicomposite, databarcstacked, databarcstackedcomposite, databarcstackedomni, databarcstackedomnicomposite, databartruncated, databartruncatedcomposite, datalogic2of5, datamatrix, datamatrixrectangular, datamatrixrectangularextension, dotcode, ean13, ean13composite, ean14, ean2, ean5, ean8, ean8composite, flattermarken, gs1-128, gs1-128composite, gs1-cc, gs1datamatrix, gs1datamatrixrectangular, gs1dldatamatrix, gs1dlqrcode, gs1dotcode, gs1northamericancoupon, gs1qrcode, hanxin, hibcazteccode, hibccodablockf, hibccode128, hibccode39, hibcdatamatrix, hibcdatamatrixrectangular, hibcmicropdf417, hibcpdf417, hibcqrcode, iata2of5, identcode, industrial2of5, interleaved2of5, isbn, ismn, issn, itf14, japanpost, kix, leitcode, mailmark, mands, matrix2of5, maxicode, micropdf417, microqrcode, msi, onecode, pdf417, pdf417compact, pharmacode, pharmacode2, planet, plessey, postnet, qrcode, rationalizedCodabar, raw, royalmail, royalmailcbc, rss14, rss14composite, rsslimited, rsslimitedcomposite, rssexpanded, rssexpandedcomposite, sscc18, telepen, telepennumeric, upca, upcacomposite, upce, upcecomposite
错误码说明
错误码 | 说明 | 解决方法 |
---|---|---|
400 | 参数格式错误 | 检查参数类型和格式是否符合要求 |
401 | 参数值超限 | 调整参数值至有效范围内 |
601 | 颜色格式错误 | 使用正确的hex/rgb/rgba格式 |
602 | 内容超限 | 减少条形码内容长度(<3KB) |
603 | 条形码生成失败 | 检查网络连接或尝试更换浏览器 |
604 | 不支持的条形码类型 | 使用SUPPORTED_BCIDS常量中的类型 |
605 | 文本大小错误 | 使用支持的文本尺寸(8/10/12/14/16/18/20) |
606 | 文本位置错误 | 使用'上'/'下'有效值之一 |
607 | 尺寸参数错误 | 确保宽高为正数且在有效范围内 |
608 | 缩放比例错误 | 缩放比例需在1-50范围内 |
609 | 字符集不支持 | 移除不支持的特殊字符 |
610 | 文本字体错误 | 使用支持的字体类型 |