cn.hutool.captcha

类 AbstractCaptcha

java.lang.Object

cn.hutool.captcha.AbstractCaptcha

所有已实现的接口:

ICaptcha, java.io.Serializable

直接已知子类:

CircleCaptcha, LineCaptcha, ShearCaptcha

public abstract class AbstractCaptcha
extends java.lang.Object
implements ICaptcha

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

作者:

looly

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected java.awt.Color	background 背景色
protected java.lang.String	code 验证码
protected java.awt.Font	font 字体
protected CodeGenerator	generator 验证码生成器
protected int	height 图片的高度
protected byte[]	imageBytes 验证码图片
protected int	interfereCount 验证码干扰元素个数
protected int	width 图片的宽度

构造器概要

构造器

构造器和说明
AbstractCaptcha(int width, int height, CodeGenerator generator, int interfereCount) 构造
AbstractCaptcha(int width, int height, int codeCount, int interfereCount) 构造，使用随机验证码生成器生成验证码

方法概要

方法

限定符和类型	方法和说明
void	createCode() 创建验证码，实现类需同时生成随机验证码字符串和验证码图片
protected abstract java.awt.Image	createImage(java.lang.String code) 根据生成的code创建验证码图片
protected void	generateCode() 生成验证码字符串
java.lang.String	getCode() 获取验证码的文字内容
CodeGenerator	getGenerator() 获取验证码生成器
java.awt.image.BufferedImage	getImage() 获取验证码图
java.lang.String	getImageBase64() 获得图片的Base64形式
void	setBackground(java.awt.Color background) 设置背景色
void	setFont(java.awt.Font font) 自定义字体
void	setGenerator(CodeGenerator generator) 设置验证码生成器
boolean	verify(java.lang.String userInputCode) 验证验证码是否正确，建议忽略大小写
void	write(java.io.File file) 验证码写出到文件
void	write(java.io.OutputStream out) 将验证码写出到目标流中
void	write(java.lang.String path) 验证码写出到文件

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

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

字段详细资料

width

protected int width

图片的宽度

height

protected int height

图片的高度

interfereCount

protected int interfereCount

验证码干扰元素个数

font

protected java.awt.Font font

字体

code

protected java.lang.String code

验证码

imageBytes

protected byte[] imageBytes

验证码图片

generator

protected CodeGenerator generator

验证码生成器

background

protected java.awt.Color background

背景色

构造器详细资料

AbstractCaptcha

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

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

参数:

width - 图片宽

height - 图片高

codeCount - 字符个数

interfereCount - 验证码干扰元素个数

AbstractCaptcha

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

构造

参数:

width - 图片宽

height - 图片高

generator - 验证码生成器

interfereCount - 验证码干扰元素个数

方法详细资料

createCode

public void createCode()

从接口复制的说明: ICaptcha

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

指定者:

createCode 在接口中 ICaptcha

generateCode

protected void generateCode()

生成验证码字符串

从以下版本开始:

3.3.0

createImage

protected abstract java.awt.Image createImage(java.lang.String code)

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

参数:

code - 验证码

getCode

public java.lang.String getCode()

从接口复制的说明: ICaptcha

获取验证码的文字内容

指定者:

getCode 在接口中 ICaptcha

返回:

验证码文字内容

verify

public boolean verify(java.lang.String userInputCode)

从接口复制的说明: ICaptcha

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

指定者:

verify 在接口中 ICaptcha

参数:

userInputCode - 用户输入的验证码

返回:

是否与生成的一直

write

public void write(java.lang.String path)
           throws IORuntimeException

验证码写出到文件

参数:

path - 文件路径

抛出:

IORuntimeException - IO异常

write

public void write(java.io.File file)
           throws IORuntimeException

验证码写出到文件

参数:

file - 文件

抛出:

IORuntimeException - IO异常

write

public void write(java.io.OutputStream out)

从接口复制的说明: ICaptcha

将验证码写出到目标流中

指定者:

write 在接口中 ICaptcha

参数:

out - 目标流

getImage

public java.awt.image.BufferedImage getImage()

获取验证码图

返回:

验证码图

getImageBase64

public java.lang.String getImageBase64()

获得图片的Base64形式

返回:

图片的Base64

从以下版本开始:

3.3.0

setFont

public void setFont(java.awt.Font font)

自定义字体

参数:

font - 字体

getGenerator

public CodeGenerator getGenerator()

获取验证码生成器

返回:

验证码生成器

setGenerator

public void setGenerator(CodeGenerator generator)

设置验证码生成器

参数:

generator - 验证码生成器

setBackground

public void setBackground(java.awt.Color background)

设置背景色

参数:

background - 背景色

从以下版本开始:

4.1.22