QrCodes (polaris-toolkit 3.2.53 API)

java.lang.Object
- io.polaris.image.qrcode.QrCodes

```
public class QrCodes
extends Object
```
基于Zxing的二维码工具类，支持：
- 二维码生成和识别，见BarcodeFormat.QR_CODE
- 条形码生成和识别，见BarcodeFormat.CODE_39等很多标准格式
从以下版本开始:

1.8

作者:

Qt

字段概要

字段
限定符和类型字段和说明

static String QR_TYPE_SVG

static String QR_TYPE_TXT

字段
限定符和类型	字段和说明
`static String`	`QR_TYPE_SVG`
`static String`	`QR_TYPE_TXT`

构造器概要

构造器
构造器和说明

QrCodes()

构造器
构造器和说明
`QrCodes()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`decode(File qrCodeFile)` 解码二维码或条形码图片为文本
`static String`	`decode(Image image)` 将二维码或条形码图片解码为文本
`static String`	`decode(Image image, boolean isTryHarder, boolean isPureBarcode)` 将二维码或条形码图片解码为文本此方法会尝试使用`HybridBinarizer`和`GlobalHistogramBinarizer`两种模式解析需要注意部分二维码如果不带logo，使用PureBarcode模式会解析失败，此时须设置此选项为false。
`static String`	`decode(Image image, Map<com.google.zxing.DecodeHintType,Object> hints)` 将二维码或条形码图片解码为文本此方法会尝试使用`HybridBinarizer`和`GlobalHistogramBinarizer`两种模式解析需要注意部分二维码如果不带logo，使用PureBarcode模式会解析失败，此时须设置此选项为false。
`static String`	`decode(InputStream qrCodeInputStream)` 解码二维码或条形码图片为文本
`static com.google.zxing.common.BitMatrix`	`encode(String content, com.google.zxing.BarcodeFormat format, int width, int height)` 将文本内容编码为条形码或二维码
`static com.google.zxing.common.BitMatrix`	`encode(String content, com.google.zxing.BarcodeFormat format, QrConfig config)` 将文本内容编码为条形码或二维码
`static com.google.zxing.common.BitMatrix`	`encode(String content, int width, int height)` 将文本内容编码为二维码
`static com.google.zxing.common.BitMatrix`	`encode(String content, QrConfig config)` 将文本内容编码为二维码
`static BufferedImage`	`generate(String content, com.google.zxing.BarcodeFormat format, int width, int height)` 生成二维码或条形码图片
`static BufferedImage`	`generate(String content, com.google.zxing.BarcodeFormat format, QrConfig config)` 生成二维码或条形码图片只有二维码时QrConfig中的图片才有效
`static BufferedImage`	`generate(String content, int width, int height)` 生成二维码图片
`static File`	`generate(String content, int width, int height, File targetFile)` 生成二维码到文件，二维码图片格式取决于文件的扩展名
`static void`	`generate(String content, int width, int height, String targetType, OutputStream out)` 生成二维码到输出流
`static BufferedImage`	`generate(String content, QrConfig config)` 生成二维码图片
`static File`	`generate(String content, QrConfig config, File targetFile)` 生成二维码到文件，二维码图片格式取决于文件的扩展名
`static void`	`generate(String content, QrConfig config, String targetType, OutputStream out)` 生成二维码到输出流
`static String`	`generateAsAsciiArt(String content)` 生成ASCII Art字符画形式的二维码
`static String`	`generateAsAsciiArt(String content, int width, int height, int margin)`
`static String`	`generateAsAsciiArt(String content, QrConfig qrConfig)` 生成ASCII Art字符画形式的二维码
`static String`	`generateAsBase64(String content, QrConfig qrConfig, String targetType)` 生成 Base64 编码格式的二维码，以 String 形式表示输出格式为: data:image/[type];base64,[data]
`static String`	`generateAsBase64(String content, QrConfig qrConfig, String targetType, byte[] logo)` 生成代 logo 图片的 Base64 编码格式的二维码，以 String 形式表示
`static String`	`generateAsBase64(String content, QrConfig qrConfig, String targetType, Image logo)` 生成代 logo 图片的 Base64 编码格式的二维码，以 String 形式表示
`static String`	`generateAsBase64(String content, QrConfig qrConfig, String targetType, String logoBase64)` 生成代 logo 图片的 Base64 编码格式的二维码，以 String 形式表示
`static String`	`generateAsSvg(String content, QrConfig qrConfig)`
`static byte[]`	`generatePng(String content, int width, int height)` 生成PNG格式的二维码图片，以byte[]形式表示
`static byte[]`	`generatePng(String content, QrConfig config)` 生成PNG格式的二维码图片，以byte[]形式表示
`static String`	`toAsciiArt(com.google.zxing.common.BitMatrix bitMatrix, QrConfig qrConfig)` BitMatrix转ASCII Art字符画形式的二维码
`static BufferedImage`	`toImage(com.google.zxing.common.BitMatrix matrix, int foreColor, Integer backColor)` BitMatrix转BufferedImage
`static String`	`toSVG(com.google.zxing.common.BitMatrix matrix, Integer foreColor, Integer backColor, Image logoImg, int ratio)` BitMatrix转SVG(字符串)
`static String`	`toSVG(com.google.zxing.common.BitMatrix matrix, QrConfig qrConfig)` BitMatrix转SVG(字符串)

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - QR_TYPE_SVG
```
public static final String QR_TYPE_SVG
```
    另请参阅:
    
    常量字段值
  - QR_TYPE_TXT
```
public static final String QR_TYPE_TXT
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - QrCodes
```
public QrCodes()
```
- 方法详细资料
  - generateAsBase64
```
public static String generateAsBase64(String content,
                                      QrConfig qrConfig,
                                      String targetType,
                                      String logoBase64)
                               throws IOException
```
    生成代 logo 图片的 Base64 编码格式的二维码，以 String 形式表示
    
    参数:
    
    content - 内容
    
    qrConfig - 二维码配置，包括宽度、高度、边距、颜色等
    
    targetType - 类型（图片扩展名），见QR_TYPE_SVG、 QR_TYPE_TXT、Images
    
    logoBase64 - logo 图片的 base64 编码
    
    返回:
    
    图片 Base64 编码字符串
    
    抛出:
    
    IOException
  - generateAsBase64
```
public static String generateAsBase64(String content,
                                      QrConfig qrConfig,
                                      String targetType,
                                      byte[] logo)
                               throws IOException
```
    生成代 logo 图片的 Base64 编码格式的二维码，以 String 形式表示
    
    参数:
    
    content - 内容
    
    qrConfig - 二维码配置，包括宽度、高度、边距、颜色等
    
    targetType - 类型（图片扩展名），见QR_TYPE_SVG、 QR_TYPE_TXT、Images
    
    logo - logo 图片的byte[]
    
    返回:
    
    图片 Base64 编码字符串
    
    抛出:
    
    IOException
  - generateAsBase64
```
public static String generateAsBase64(String content,
                                      QrConfig qrConfig,
                                      String targetType,
                                      Image logo)
                               throws IOException
```
    生成代 logo 图片的 Base64 编码格式的二维码，以 String 形式表示
    
    参数:
    
    content - 内容
    
    qrConfig - 二维码配置，包括宽度、高度、边距、颜色等
    
    targetType - 类型（图片扩展名），见QR_TYPE_SVG、 QR_TYPE_TXT、Images
    
    logo - logo 图片的byte[]
    
    返回:
    
    图片 Base64 编码字符串
    
    抛出:
    
    IOException
  - generateAsBase64
```
public static String generateAsBase64(String content,
                                      QrConfig qrConfig,
                                      String targetType)
                               throws IOException
```
    生成 Base64 编码格式的二维码，以 String 形式表示
    输出格式为: data:image/[type];base64,[data]
    
    参数:
    
    content - 内容
    
    qrConfig - 二维码配置，包括宽度、高度、边距、颜色等
    
    targetType - 类型（图片扩展名），见QR_TYPE_SVG、 QR_TYPE_TXT、Images
    
    返回:
    
    图片 Base64 编码字符串
    
    抛出:
    
    IOException
  - generateAsSvg
```
public static String generateAsSvg(String content,
                                   QrConfig qrConfig)
                            throws IOException
```
    参数:
    
    content - 内容
    
    qrConfig - 二维码配置，包括宽度、高度、边距、颜色等
    
    返回:
    
    SVG矢量图（字符串）
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    5.8.6
  - generateAsAsciiArt
```
public static String generateAsAsciiArt(String content)
                                 throws IOException
```
    生成ASCII Art字符画形式的二维码
    
    参数:
    
    content - 内容
    
    返回:
    
    ASCII Art字符画形式的二维码字符串
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    5.8.6
  - generateAsAsciiArt
```
public static String generateAsAsciiArt(String content,
                                        QrConfig qrConfig)
                                 throws IOException
```
    生成ASCII Art字符画形式的二维码
    
    参数:
    
    content - 内容
    
    qrConfig - 二维码配置，仅宽度、高度、边距配置有效
    
    返回:
    
    ASCII Art字符画形式的二维码
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    5.8.6
  - generateAsAsciiArt
```
public static String generateAsAsciiArt(String content,
                                        int width,
                                        int height,
                                        int margin)
                                 throws IOException
```
    参数:
    
    content - 内容
    
    width - 宽度（单位：字符▄的大小）
    
    height - 高度（单位：字符▄的大小）
    
    margin - 边距大小（1~4）
    
    返回:
    
    ASCII Art字符画形式的二维码
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    5.8.6
  - generatePng
```
public static byte[] generatePng(String content,
                                 int width,
                                 int height)
                          throws IOException
```
    生成PNG格式的二维码图片，以byte[]形式表示
    
    参数:
    
    content - 内容
    
    width - 宽度（单位：像素）
    
    height - 高度（单位：像素）
    
    返回:
    
    图片的byte[]
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.0.10
  - generatePng
```
public static byte[] generatePng(String content,
                                 QrConfig config)
                          throws IOException
```
    生成PNG格式的二维码图片，以byte[]形式表示
    
    参数:
    
    content - 内容
    
    config - 二维码配置，包括宽度、高度、边距、颜色等
    
    返回:
    
    图片的byte[]
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.1.2
  - generate
```
public static File generate(String content,
                            int width,
                            int height,
                            File targetFile)
                     throws IOException
```
    生成二维码到文件，二维码图片格式取决于文件的扩展名
    
    参数:
    
    content - 文本内容
    
    width - 宽度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    height - 高度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    targetFile - 目标文件，扩展名决定输出格式
    
    返回:
    
    目标文件
    
    抛出:
    
    IOException
  - generate
```
public static File generate(String content,
                            QrConfig config,
                            File targetFile)
                     throws IOException
```
    生成二维码到文件，二维码图片格式取决于文件的扩展名
    
    参数:
    
    content - 文本内容
    
    config - 二维码配置，包括宽度、高度、边距、颜色等
    
    targetFile - 目标文件，扩展名决定输出格式
    
    返回:
    
    目标文件
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.1.2
  - generate
```
public static void generate(String content,
                            int width,
                            int height,
                            String targetType,
                            OutputStream out)
                     throws IOException
```
    生成二维码到输出流
    
    参数:
    
    content - 文本内容
    
    width - 宽度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    height - 高度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    targetType - 类型（图片扩展名），见QR_TYPE_SVG、 QR_TYPE_TXT、Images
    
    out - 目标流
    
    抛出:
    
    IOException
  - generate
```
public static void generate(String content,
                            QrConfig config,
                            String targetType,
                            OutputStream out)
                     throws IOException
```
    生成二维码到输出流
    
    参数:
    
    content - 文本内容
    
    config - 二维码配置，包括宽度、高度、边距、颜色等
    
    targetType - 类型（图片扩展名），见QR_TYPE_SVG、 QR_TYPE_TXT、Images
    
    out - 目标流
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.1.2
  - generate
```
public static BufferedImage generate(String content,
                                     int width,
                                     int height)
                              throws IOException
```
    生成二维码图片
    
    参数:
    
    content - 文本内容
    
    width - 宽度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    height - 高度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    返回:
    
    二维码图片（黑白）
    
    抛出:
    
    IOException
  - generate
```
public static BufferedImage generate(String content,
                                     com.google.zxing.BarcodeFormat format,
                                     int width,
                                     int height)
                              throws IOException
```
    生成二维码或条形码图片
    
    参数:
    
    content - 文本内容
    
    format - 格式，可选二维码或者条形码
    
    width - 宽度（单位：像素）
    
    height - 高度（单位：像素）
    
    返回:
    
    二维码图片（黑白）
    
    抛出:
    
    IOException
  - generate
```
public static BufferedImage generate(String content,
                                     QrConfig config)
                              throws IOException
```
    生成二维码图片
    
    参数:
    
    content - 文本内容
    
    config - 二维码配置，包括宽度、高度、边距、颜色等
    
    返回:
    
    二维码图片（黑白）
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.1.2
  - generate
```
public static BufferedImage generate(String content,
                                     com.google.zxing.BarcodeFormat format,
                                     QrConfig config)
                              throws IOException
```
    生成二维码或条形码图片
    只有二维码时QrConfig中的图片才有效
    
    参数:
    
    content - 文本内容
    
    format - 格式，可选二维码、条形码等
    
    config - 二维码配置，包括宽度、高度、边距、颜色等
    
    返回:
    
    二维码图片（黑白）
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.1.14
  - encode
```
public static com.google.zxing.common.BitMatrix encode(String content,
                                                       int width,
                                                       int height)
                                                throws IOException
```
    将文本内容编码为二维码
    
    参数:
    
    content - 文本内容
    
    width - 宽度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    height - 高度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    返回:
    
    BitMatrix
    
    抛出:
    
    IOException
  - encode
```
public static com.google.zxing.common.BitMatrix encode(String content,
                                                       QrConfig config)
                                                throws IOException
```
    将文本内容编码为二维码
    
    参数:
    
    content - 文本内容
    
    config - 二维码配置，包括宽度、高度、边距、颜色等
    
    返回:
    
    BitMatrix
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.1.2
  - encode
```
public static com.google.zxing.common.BitMatrix encode(String content,
                                                       com.google.zxing.BarcodeFormat format,
                                                       int width,
                                                       int height)
                                                throws IOException
```
    将文本内容编码为条形码或二维码
    
    参数:
    
    content - 文本内容
    
    format - 格式枚举
    
    width - 宽度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    height - 高度（单位：类型为一般图片或SVG时，单位是像素，类型为 Ascii Art 字符画时，单位是字符▄或▀的大小）
    
    返回:
    
    BitMatrix
    
    抛出:
    
    IOException
  - encode
```
public static com.google.zxing.common.BitMatrix encode(String content,
                                                       com.google.zxing.BarcodeFormat format,
                                                       QrConfig config)
                                                throws IOException
```
    将文本内容编码为条形码或二维码
    
    参数:
    
    content - 文本内容
    
    format - 格式枚举
    
    config - 二维码配置，包括宽度、高度、边距、颜色等
    
    返回:
    
    BitMatrix
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    4.1.2
  - decode
```
public static String decode(InputStream qrCodeInputStream)
                     throws IOException
```
    解码二维码或条形码图片为文本
    
    参数:
    
    qrCodeInputStream - 二维码输入流
    
    返回:
    
    解码文本
    
    抛出:
    
    IOException
  - decode
```
public static String decode(File qrCodeFile)
                     throws IOException
```
    解码二维码或条形码图片为文本
    
    参数:
    
    qrCodeFile - 二维码文件
    
    返回:
    
    解码文本
    
    抛出:
    
    IOException
  - decode
```
public static String decode(Image image)
```
    将二维码或条形码图片解码为文本
    
    参数:
    
    image - Image 二维码图片
    
    返回:
    
    解码后的文本
  - decode
```
public static String decode(Image image,
                            boolean isTryHarder,
                            boolean isPureBarcode)
```
    将二维码或条形码图片解码为文本
    此方法会尝试使用HybridBinarizer和GlobalHistogramBinarizer两种模式解析
    需要注意部分二维码如果不带logo，使用PureBarcode模式会解析失败，此时须设置此选项为false。
    
    参数:
    
    image - Image 二维码图片
    
    isTryHarder - 是否优化精度
    
    isPureBarcode - 是否使用复杂模式，扫描带logo的二维码设为true
    
    返回:
    
    解码后的文本
    
    从以下版本开始:
    
    4.3.1
  - decode
```
public static String decode(Image image,
                            Map<com.google.zxing.DecodeHintType,Object> hints)
```
    将二维码或条形码图片解码为文本
    此方法会尝试使用HybridBinarizer和GlobalHistogramBinarizer两种模式解析
    需要注意部分二维码如果不带logo，使用PureBarcode模式会解析失败，此时须设置此选项为false。
    
    参数:
    
    image - Image 二维码图片
    
    hints - 自定义扫码配置，包括算法、编码、复杂模式等
    
    返回:
    
    解码后的文本
    
    从以下版本开始:
    
    5.7.12
  - toImage
```
public static BufferedImage toImage(com.google.zxing.common.BitMatrix matrix,
                                    int foreColor,
                                    Integer backColor)
```
    BitMatrix转BufferedImage
    
    参数:
    
    matrix - BitMatrix
    
    foreColor - 前景色
    
    backColor - 背景色(null表示透明背景)
    
    返回:
    
    BufferedImage
    
    从以下版本开始:
    
    4.1.2
  - toSVG
```
public static String toSVG(com.google.zxing.common.BitMatrix matrix,
                           QrConfig qrConfig)
                    throws IOException
```
    BitMatrix转SVG(字符串)
    
    参数:
    
    matrix - BitMatrix
    
    qrConfig - 二维码配置，包括宽度、高度、边距、颜色等
    
    返回:
    
    SVG矢量图（字符串）
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    5.8.6
  - toSVG
```
public static String toSVG(com.google.zxing.common.BitMatrix matrix,
                           Integer foreColor,
                           Integer backColor,
                           Image logoImg,
                           int ratio)
                    throws IOException
```
    BitMatrix转SVG(字符串)
    
    参数:
    
    matrix - BitMatrix
    
    foreColor - 前景色
    
    backColor - 背景色(null表示透明背景)
    
    logoImg - LOGO图片
    
    ratio - 二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
    
    返回:
    
    SVG矢量图（字符串）
    
    抛出:
    
    IOException
    
    从以下版本开始:
    
    5.8.6
  - toAsciiArt
```
public static String toAsciiArt(com.google.zxing.common.BitMatrix bitMatrix,
                                QrConfig qrConfig)
```
    BitMatrix转ASCII Art字符画形式的二维码
    
    参数:
    
    bitMatrix - BitMatrix
    
    qrConfig - QR设置
    
    返回:
    
    ASCII Art字符画形式的二维码
    
    从以下版本开始:
    
    5.8.6

类 QrCodes

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

QR_TYPE_SVG

QR_TYPE_TXT

构造器详细资料

QrCodes

方法详细资料

generateAsBase64

generateAsBase64

generateAsBase64

generateAsBase64

generateAsSvg

generateAsAsciiArt

generateAsAsciiArt

generateAsAsciiArt

generatePng

generatePng

generate

generate

generate

generate

generate

generate

generate

generate

encode

encode

encode

encode

decode

decode

decode

decode

decode

toImage

toSVG

toSVG

toAsciiArt