qrCodeKit

Documentation

Index

• func Decode(path string) (content string, err error)
• func EncodeToFile(content, outputImgPath string, options ...standard.ImageOption) error
• func Generate(content string, level qrcode.RecoveryLevel, size int) ([]byte, error)
• func GenerateFile(content string, level qrcode.RecoveryLevel, size int, outputImgPath string) error
• func GenerateFileWithBackgroundImage(content string, level qrcode.RecoveryLevel, size int, ...) error
• func GenerateFileWithColor(content string, level qrcode.RecoveryLevel, size int, ...) error
• func GenerateWithColor(content string, level qrcode.RecoveryLevel, size int, ...) ([]byte, error)

Functions

func Decode

func Decode(path string) (content string, err error)

Decode 解析二维码（仅支持部分图片）.

PS: (1) 能解析 yeqown/go-qrcode 生成的二维码. (2) 不能解析 skip2/go-qrcode 生成的二维码.

func EncodeToFile

func EncodeToFile(content, outputImgPath string, options ...standard.ImageOption) error

EncodeToFile 生成二维码图片.

@param content 二维码的内容 @param options 可以指定: (1) logo（放在二维码的中心）

(2) halftone（比较酷炫），可参考 https://github.com/yeqown/go-qrcode 中: example/with-halftone/README.md
(3) 尺寸（但单位并非像素）
(4) 透明
(5) 前景色、背景色

func Generate

func Generate(content string, level qrcode.RecoveryLevel, size int) ([]byte, error)

Generate 生成二维码([]byte类型).

Deprecated: 推荐使用 EncodeToFile.

@param content 二维码的内容 @param level 一般使用 qrcode.Medium @param size 二维码的宽高，单位: px @return png图片的字节流

func GenerateFile

func GenerateFile(content string, level qrcode.RecoveryLevel, size int, outputImgPath string) error

GenerateFile 生成二维码文件.

Deprecated: 推荐使用 EncodeToFile.

PS: 背景色默认为白色（非透明），前景色默认为黑色.

@param size 生成图片的尺寸

e.g.256 => 256*256

@param outputImagePath 输出图片的路径

(1) 如果存在且是个文件的话，会覆盖
(2) 建议是 .png 格式的
(3) 生成图片的背景色是白色而非透明，即使保存为 .png 格式

func GenerateFileWithBackgroundImage

func GenerateFileWithBackgroundImage(content string, level qrcode.RecoveryLevel, size int, backgroundImagePath string, foreground color.Color, outputImgPath string) error

GenerateFileWithBackgroundImage

Deprecated: 推荐使用 EncodeToFile.

@param size 二维码的尺寸（宽高）

(1) 如果<=0，则自适应（取背景图片宽高的最小值）
(2) 建议传参-1

func GenerateFileWithColor

func GenerateFileWithColor(content string, level qrcode.RecoveryLevel, size int, background, foreground color.Color, outputImgPath string) error

GenerateFileWithColor

Deprecated: 推荐使用 EncodeToFile.

@param background 背景色（推荐使用透明色 color.Transparent，然后保存为.png格式的图片） @param foreground 前景色（一般为 color.Black） @param outputImagePath 输出的图片路径，仅支持3种格式: .jpg、.jpeg、.png（推荐）

func GenerateWithColor

func GenerateWithColor(content string, level qrcode.RecoveryLevel, size int, background, foreground color.Color) ([]byte, error)

GenerateWithColor 参考了 qrcode.WriteColorFile.

Deprecated: 推荐使用 EncodeToFile.