net.ymate.platform.commons

Class QRCodeHelper

java.lang.Object

net.ymate.platform.commons.QRCodeHelper

public class QRCodeHelper
extends Object

二维码生成工具类

Author:

刘镇 (suninformation@163.com) on 15/1/2 下午4:21

Method Summary

Modifier and Type	Method and Description
static QRCodeHelper	create(String content, int width, int height)
static QRCodeHelper	create(String content, int width, int height, com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level)
static QRCodeHelper	create(String content, int width, int height, int margin, com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level)
static QRCodeHelper	create(String content, String characterSet, int width, int height, int margin, com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level)
String	getFormat()
QRCodeHelper	setFormat(String format)
QRCodeHelper	setLogo(BufferedImage logoImage, int logoImageSize, int borderWidth, Color borderColor, Color backgroundColor)
QRCodeHelper	setLogo(File logoFile, int logoImageSize, int borderWidth, Color borderColor, Color backgroundColor)
QRCodeHelper	setLogo(ImageInputStream logoImageInputStream, int logoImageSize, int borderWidth, Color borderColor, Color backgroundColor)
QRCodeHelper	setLogo(InputStream logoInputStream, int logoImageSize, int borderWidth, Color borderColor, Color backgroundColor)
QRCodeHelper	setLogo(URL logoUrl, int logoImageSize, int borderWidth, Color borderColor, Color backgroundColor)
BufferedImage	toBufferedImage()
void	writeToFile(File file) 输出二维码图片到文件
void	writeToStream(OutputStream stream) 输出二维码图片到输出流

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static QRCodeHelper create(String content,
                                  String characterSet,
                                  int width,
                                  int height,
                                  int margin,
                                  com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level)
                           throws com.google.zxing.WriterException

Parameters:

content - 二维码内容字符串

characterSet - 使用的字符编码集，默认UTF-8

width - 二维码图片宽度

height - 二维码图片高度

margin - 二维码图片边距，默认3

level - 二维码容错级别

Returns:

创建二维码工具类实例对象

Throws:

com.google.zxing.WriterException - 可能产生异常

create

public static QRCodeHelper create(String content,
                                  int width,
                                  int height,
                                  int margin,
                                  com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level)
                           throws com.google.zxing.WriterException

Throws:

com.google.zxing.WriterException

create

public static QRCodeHelper create(String content,
                                  int width,
                                  int height,
                                  com.google.zxing.qrcode.decoder.ErrorCorrectionLevel level)
                           throws com.google.zxing.WriterException

Parameters:

content - 二维码内容字符串

width - 二维码图片宽度

height - 二维码图片高度

level - 二维码容错级别

Returns:

创建二维码工具类实例对象

Throws:

com.google.zxing.WriterException - 可能产生的异常

create

public static QRCodeHelper create(String content,
                                  int width,
                                  int height)
                           throws com.google.zxing.WriterException

Parameters:

content - 二维码内容字符串

width - 二维码图片宽度

height - 二维码图片高度

Returns:

创建二维码工具类实例对象

Throws:

com.google.zxing.WriterException - 可能产生的异常

setFormat

public QRCodeHelper setFormat(String format)

Parameters:

format - 图片格式

Returns:

设置二维码图片格式，默认PNG

setLogo

public QRCodeHelper setLogo(InputStream logoInputStream,
                            int logoImageSize,
                            int borderWidth,
                            Color borderColor,
                            Color backgroundColor)
                     throws IOException

Throws:

IOException

setLogo

public QRCodeHelper setLogo(File logoFile,
                            int logoImageSize,
                            int borderWidth,
                            Color borderColor,
                            Color backgroundColor)
                     throws IOException

Throws:

IOException

setLogo

public QRCodeHelper setLogo(URL logoUrl,
                            int logoImageSize,
                            int borderWidth,
                            Color borderColor,
                            Color backgroundColor)
                     throws IOException

Throws:

IOException

setLogo

public QRCodeHelper setLogo(ImageInputStream logoImageInputStream,
                            int logoImageSize,
                            int borderWidth,
                            Color borderColor,
                            Color backgroundColor)
                     throws IOException

Throws:

IOException

setLogo

public QRCodeHelper setLogo(BufferedImage logoImage,
                            int logoImageSize,
                            int borderWidth,
                            Color borderColor,
                            Color backgroundColor)

toBufferedImage

public BufferedImage toBufferedImage()

getFormat

public String getFormat()

writeToFile

public void writeToFile(File file)
                 throws IOException

输出二维码图片到文件

Parameters:

file - 目标文件对象

Throws:

IOException - 可能产生的异常

writeToStream

public void writeToStream(OutputStream stream)
                   throws IOException

输出二维码图片到输出流

Parameters:

stream - 目标输出流对象

Throws:

IOException - 可能产生的异常