com.yishuifengxiao.common.code

Class CodeAutoConfiguration

java.lang.Object

com.yishuifengxiao.common.code.CodeAutoConfiguration

@Configuration
 @EnableConfigurationProperties(value=CodeProperties.class)
 @Import(value={MailExtendAutoConfiguration.class,RedisExtendAutoConfiguration.class})
 @AutoConfigureAfter(value=RedisExtendAutoConfiguration.class)
 @ConditionalOnProperty(prefix="yishuifengxiao.code",
                       name="enable",
                       havingValue="true",
                       matchIfMissing=true)
public class CodeAutoConfiguration
extends Object

验证码组件自动配置

Since:

1.0.0

Version:

1.0.0

Author:

yishui

Constructor Summary

Constructors

Constructor and Description
CodeAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfig() 配置检查
CodeProcessor	codeProcessor(CodeProperties codeProperties, Map<String,CodeGenerator> codeGenerators, Map<String,CodeSender> codeSenders, CodeRepository repository) 注入一个验证码处理器
CodeRepository	codeRepository() 注入一个名为codeRepository的验证码存储器
CodeGenerator	emailCodeGenerator() 注入一个缺省的邮件验证码生成器
CodeGenerator	imageCodeGenerator() 注入一个缺省的图形验证码生成器
CodeSender	imageCodeSender() 注入一个缺省的图像验证码发送器
CodeGenerator	smsCodeGenerator() 注入一个缺省的短信验证码生成器
CodeSender	smsCodeSender() 注入体格缺省的短信验证码发送器

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeAutoConfiguration

public CodeAutoConfiguration()

Method Detail

codeRepository

@ConditionalOnMissingBean(name="redisTemplate",
                          value=CodeRepository.class)
 @Bean
public CodeRepository codeRepository()

注入一个名为codeRepository的验证码存储器

Returns:

名为codeRepository的验证码存储器

imageCodeGenerator

@ConditionalOnMissingBean(name="imageCodeGenerator")
 @Bean(value="imageCodeGenerator")
public CodeGenerator imageCodeGenerator()

注入一个缺省的图形验证码生成器

Returns:

图形验证码生成器

imageCodeSender

@ConditionalOnMissingBean(name="imageCodeSender")
 @Bean(value="imageCodeSender")
public CodeSender imageCodeSender()

注入一个缺省的图像验证码发送器

Returns:

图像验证码发送器

smsCodeSender

@ConditionalOnMissingBean(name="smsCodeSender")
 @Bean(value="smsCodeSender")
public CodeSender smsCodeSender()

注入体格缺省的短信验证码发送器

Returns:

短信验证码发送器

smsCodeGenerator

@ConditionalOnMissingBean(name="smsCodeGenerator")
 @Bean(value="smsCodeGenerator")
public CodeGenerator smsCodeGenerator()

注入一个缺省的短信验证码生成器

Returns:

短信验证码生成器

emailCodeGenerator

@ConditionalOnMissingBean(name="emailCodeGenerator")
 @Bean(value="emailCodeGenerator")
 @ConditionalOnBean(name="emailCodeSender")
public CodeGenerator emailCodeGenerator()

注入一个缺省的邮件验证码生成器

Returns:

邮件验证码生成器

codeProcessor

@Bean
 @ConditionalOnMissingBean(value=CodeProcessor.class)
public CodeProcessor codeProcessor(CodeProperties codeProperties,
                                                                                               Map<String,CodeGenerator> codeGenerators,
                                                                                               Map<String,CodeSender> codeSenders,
                                                                                               CodeRepository repository)

注入一个验证码处理器

Parameters:

codeProperties - 验证码属性配置

codeGenerators - 系统中所有的 CodeGenerator 验证码生成器接口的实现。key为bean的名字

codeSenders - 系统中所有的 CodeSender 验证码发送器接口的实现，。key为bean的名字

repository - 验证码存储器

Returns:

验证码处理器

checkConfig

@PostConstruct
public void checkConfig()

配置检查