com.yishuifengxiao.common.code.generator

Interface CodeGenerator

All Known Implementing Classes:

BaseCodeGenerator, EmailCodeGenerator, ImageCodeGenerator, SmsCodeGenerator

public interface CodeGenerator

验证码生成器

Since:

1.0.0

Version:

1.0.0

Author:

yishui

Method Summary

Modifier and Type	Method and Description
ValidateCode	generate(org.springframework.web.context.request.ServletWebRequest servletWebRequest, CodeProperties codeProperties) 生成验证码
String	generateKey(org.springframework.web.context.request.ServletWebRequest request, CodeProperties codeProperties) 生成验证码的唯一标识符
String	getCodeInRequest(org.springframework.web.context.request.ServletWebRequest request, CodeProperties codeProperties) 获取请求中携带的验证码的内容

Method Detail

generate

ValidateCode generate(org.springframework.web.context.request.ServletWebRequest servletWebRequest,
                      CodeProperties codeProperties)

生成验证码

Parameters:

servletWebRequest - 用户请求

codeProperties - 验证码属性配置

Returns:

验证码

generateKey

String generateKey(org.springframework.web.context.request.ServletWebRequest request,
                   CodeProperties codeProperties)
            throws com.yishuifengxiao.common.tool.exception.ValidateException

生成验证码的唯一标识符

Parameters:

request - 用户请求

codeProperties - 验证码属性配置

Returns:

验证码的唯一标识符

Throws:

com.yishuifengxiao.common.tool.exception.ValidateException - 提取时出现问题

getCodeInRequest

String getCodeInRequest(org.springframework.web.context.request.ServletWebRequest request,
                        CodeProperties codeProperties)
                 throws com.yishuifengxiao.common.tool.exception.ValidateException

获取请求中携带的验证码的内容

Parameters:

request - 用户请求

codeProperties - 验证码属性配置

Returns:

验证码的内容

Throws:

com.yishuifengxiao.common.tool.exception.ValidateException - 提取时出现问题