AbstractCaptcha (hutool-captcha 5.8.27 API)

java.lang.Object
- cn.hutool.captcha.AbstractCaptcha

所有已实现的接口:

ICaptcha, Serializable

直接已知子类:

CircleCaptcha, GifCaptcha, LineCaptcha, ShearCaptcha
```
public abstract class AbstractCaptcha
extends Object
implements ICaptcha
```
抽象验证码
抽象验证码实现了验证码字符串的生成、验证，验证码图片的写出
实现类通过实现createImage(String) 方法生成图片对象

作者:

looly

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`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` 图片的宽度

构造器概要

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

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`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)` 验证码写出到文件

从类继承的方法 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 Font font
```
    字体
  - code
```
protected String code
```
    验证码
  - imageBytes
```
protected byte[] imageBytes
```
    验证码图片
  - generator
```
protected CodeGenerator generator
```
    验证码生成器
  - background
```
protected Color background
```
    背景色
  - textAlpha
```
protected AlphaComposite textAlpha
```
    文字透明度
- 构造器详细资料
  - 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 Image createImage(String code)
```
    根据生成的code创建验证码图片
    
    参数:
    
    code - 验证码
    
    返回:
    
    Image
  - getCode
```
public String getCode()
```
    从接口复制的说明: ICaptcha
    
    获取验证码的文字内容
    
    指定者:
    
    getCode 在接口中 ICaptcha
    
    返回:
    
    验证码文字内容
  - verify
```
public boolean verify(String userInputCode)
```
    从接口复制的说明: ICaptcha
    
    验证验证码是否正确，建议忽略大小写
    
    指定者:
    
    verify 在接口中 ICaptcha
    
    参数:
    
    userInputCode - 用户输入的验证码
    
    返回:
    
    是否与生成的一直
  - write
```
public void write(String path)
           throws IORuntimeException
```
    验证码写出到文件
    
    参数:
    
    path - 文件路径
    
    抛出:
    
    IORuntimeException - IO异常
  - write
```
public void write(File file)
           throws IORuntimeException
```
    验证码写出到文件
    
    参数:
    
    file - 文件
    
    抛出:
    
    IORuntimeException - IO异常
  - write
```
public void write(OutputStream out)
```
    从接口复制的说明: ICaptcha
    
    将验证码写出到目标流中
    
    指定者:
    
    write 在接口中 ICaptcha
    
    参数:
    
    out - 目标流
  - getImageBytes
```
public byte[] getImageBytes()
```
    获取图形验证码图片bytes
    
    返回:
    
    图形验证码图片bytes
    
    从以下版本开始:
    
    4.5.17
  - getImage
```
public BufferedImage getImage()
```
    获取验证码图
    
    返回:
    
    验证码图
  - getImageBase64
```
public String getImageBase64()
```
    获得图片的Base64形式
    
    返回:
    
    图片的Base64
    
    从以下版本开始:
    
    3.3.0
  - getImageBase64Data
```
public String getImageBase64Data()
```
    获取图片带文件格式的 Base64
    
    返回:
    
    图片带文件格式的 Base64
    
    从以下版本开始:
    
    5.3.11
  - setFont
```
public void setFont(Font font)
```
    自定义字体
    
    参数:
    
    font - 字体
  - getGenerator
```
public CodeGenerator getGenerator()
```
    获取验证码生成器
    
    返回:
    
    验证码生成器
  - setGenerator
```
public void setGenerator(CodeGenerator generator)
```
    设置验证码生成器
    
    参数:
    
    generator - 验证码生成器
  - setBackground
```
public void setBackground(Color background)
```
    设置背景色
    
    参数:
    
    background - 背景色
    
    从以下版本开始:
    
    4.1.22
  - setTextAlpha
```
public void setTextAlpha(float textAlpha)
```
    设置文字透明度
    
    参数:
    
    textAlpha - 文字透明度，取值0~1，1表示不透明
    
    从以下版本开始:
    
    4.5.17

类 AbstractCaptcha

字段概要

构造器概要

方法概要

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

字段详细资料

width

height

interfereCount

font

code

imageBytes

generator

background

textAlpha

构造器详细资料

AbstractCaptcha

AbstractCaptcha

方法详细资料

createCode

generateCode

createImage

getCode

verify

write

write

write

getImageBytes

getImage

getImageBase64

getImageBase64Data

setFont

getGenerator

setGenerator

setBackground

setTextAlpha