cn.hutool.captcha

Class AbstractCaptcha

java.lang.Object

cn.hutool.captcha.AbstractCaptcha

All Implemented Interfaces:

ICaptcha, Serializable

Direct Known Subclasses:

CircleCaptcha, GifCaptcha, LineCaptcha, ShearCaptcha

public abstract class AbstractCaptcha
extends Object
implements ICaptcha

抽象验证码
抽象验证码实现了验证码字符串的生成、验证，验证码图片的写出
实现类通过实现createImage(String) 方法生成图片对象

Author:

looly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	background 背景色
protected String	code 验证码
protected Font	font 字体
protected CodeGenerator	generator 验证码生成器
protected int	height 图片的高度
protected byte[]	imageBytes 验证码图片
protected int	interfereCount 验证码干扰元素个数
protected AlphaComposite	textAlpha 文字透明度
protected int	width 图片的宽度

Constructor Summary

Constructors

Constructor and Description
AbstractCaptcha(int width, int height, CodeGenerator generator, int interfereCount) 构造
AbstractCaptcha(int width, int height, CodeGenerator generator, int interfereCount, float size) 构造
AbstractCaptcha(int width, int height, int codeCount, int interfereCount) 构造，使用随机验证码生成器生成验证码

Method Summary

Modifier and Type	Method and Description
void	createCode() 创建验证码，实现类需同时生成随机验证码字符串和验证码图片
protected abstract Image	createImage(String code) 根据生成的code创建验证码图片
protected void	generateCode() 生成验证码字符串
String	getCode() 获取验证码的文字内容
CodeGenerator	getGenerator() 获取验证码生成器
BufferedImage	getImage() 获取验证码图
String	getImageBase64() 获得图片的Base64形式
String	getImageBase64Data() 获取图片带文件格式的 Base64
byte[]	getImageBytes() 获取图形验证码图片bytes
void	setBackground(Color background) 设置背景色
void	setFont(Font font) 自定义字体
void	setGenerator(CodeGenerator generator) 设置验证码生成器
void	setTextAlpha(float textAlpha) 设置文字透明度
boolean	verify(String userInputCode) 验证验证码是否正确，建议忽略大小写
void	write(File file) 验证码写出到文件
void	write(OutputStream out) 将验证码写出到目标流中
void	write(String path) 验证码写出到文件

Methods inherited from class java.lang.Object

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

Field Detail

width

protected int width

图片的宽度

height

protected int height

图片的高度

interfereCount

protected int interfereCount

验证码干扰元素个数

font

protected Font font

字体

code

protected String code

验证码

imageBytes

protected byte[] imageBytes

验证码图片

generator

protected CodeGenerator generator

验证码生成器

background

protected Color background

背景色

textAlpha

protected AlphaComposite textAlpha

文字透明度

Constructor Detail

AbstractCaptcha

public AbstractCaptcha(int width,
                       int height,
                       int codeCount,
                       int interfereCount)

构造，使用随机验证码生成器生成验证码

Parameters:

width - 图片宽

height - 图片高

codeCount - 字符个数

interfereCount - 验证码干扰元素个数

AbstractCaptcha

public AbstractCaptcha(int width,
                       int height,
                       CodeGenerator generator,
                       int interfereCount)

构造

Parameters:

width - 图片宽

height - 图片高

generator - 验证码生成器

interfereCount - 验证码干扰元素个数

AbstractCaptcha

public AbstractCaptcha(int width,
                       int height,
                       CodeGenerator generator,
                       int interfereCount,
                       float size)

构造

Parameters:

width - 图片宽

height - 图片高

generator - 验证码生成器

interfereCount - 验证码干扰元素个数

size - 字体的大小 高度的倍数

Method Detail

createCode

public void createCode()

Description copied from interface: ICaptcha

创建验证码，实现类需同时生成随机验证码字符串和验证码图片

Specified by:

createCode in interface ICaptcha

generateCode

protected void generateCode()

生成验证码字符串

Since:

3.3.0

createImage

protected abstract Image createImage(String code)

根据生成的code创建验证码图片

Parameters:

code - 验证码

Returns:

Image

getCode

public String getCode()

Description copied from interface: ICaptcha

获取验证码的文字内容

Specified by:

getCode in interface ICaptcha

Returns:

验证码文字内容

verify

public boolean verify(String userInputCode)

Description copied from interface: ICaptcha

验证验证码是否正确，建议忽略大小写

Specified by:

verify in interface ICaptcha

Parameters:

userInputCode - 用户输入的验证码

Returns:

是否与生成的一直

write

public void write(String path)
           throws IORuntimeException

验证码写出到文件

Parameters:

path - 文件路径

Throws:

IORuntimeException - IO异常

write

public void write(File file)
           throws IORuntimeException

验证码写出到文件

Parameters:

file - 文件

Throws:

IORuntimeException - IO异常

write

public void write(OutputStream out)

Description copied from interface: ICaptcha

将验证码写出到目标流中

Specified by:

write in interface ICaptcha

Parameters:

out - 目标流

getImageBytes

public byte[] getImageBytes()

获取图形验证码图片bytes

Returns:

图形验证码图片bytes

Since:

4.5.17

getImage

public BufferedImage getImage()

获取验证码图

Returns:

验证码图

getImageBase64

public String getImageBase64()

获得图片的Base64形式

Returns:

图片的Base64

Since:

3.3.0

getImageBase64Data

public String getImageBase64Data()

获取图片带文件格式的 Base64

Returns:

图片带文件格式的 Base64

Since:

5.3.11

setFont

public void setFont(Font font)

自定义字体

Parameters:

font - 字体

getGenerator

public CodeGenerator getGenerator()

获取验证码生成器

Returns:

验证码生成器

setGenerator

public void setGenerator(CodeGenerator generator)

设置验证码生成器

Parameters:

generator - 验证码生成器

setBackground

public void setBackground(Color background)

设置背景色

Parameters:

background - 背景色

Since:

4.1.22

setTextAlpha

public void setTextAlpha(float textAlpha)

设置文字透明度

Parameters:

textAlpha - 文字透明度，取值0~1，1表示不透明

Since:

4.5.17