SpringSceurity实现短信验证码功能的示例代码

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ValidateCode {

 private String code;

 private LocalDateTime expireTime;

 public boolean isExpired() {
 return LocalDateTime.now().isAfter(expireTime);
 }

}

@Data
public class ImageCode extends ValidateCode {

 private BufferedImage image;

 public ImageCode(BufferedImage image, String code, LocalDateTime expireTime) {
 super(code, expireTime);
 this.image = image;
 }

 public ImageCode(BufferedImage image, String code, int expireIn) {
 super(code, LocalDateTime.now().plusSeconds(expireIn));
 this.image = image;
 }
}

public class SmsCode extends ValidateCode {

 public SmsCode(String code, LocalDateTime expireTime) {
 super(code, expireTime);
 }

 public SmsCode(String code, int expireIn) {
 super(code, LocalDateTime.now().plusSeconds(expireIn));
 }
}

public interface ValidateCodeProcessorService {

 /**
 * 因为现在有两种验证码，所以存放到seesion的key不能一样，所以前缀+具体type
 */
 String SESSION_KEY_PREFIX = "SESSION_KEY_FOR_CODE_";
 /**
 * 通过也是 type+CODE_PROCESSOR获取对于的bean
 */
 String CODE_PROCESSOR = "CodeProcessorService";

 /**
 * 这个接口要做三件事
 * 1、获取验证码。
 * 2、将验证码存入session
 * 3、将验证码信息通过短信或者图形验证码发送出去。
 * （将spring-boot-security-study-03接口里的那三步进行里封装）
 *
 */
 void processor(ServletWebRequest request) throws Exception;

@Component
public abstract class AbstractValidateCodeProcessorService<C> implements ValidateCodeProcessorService {

 private static final String SEPARATOR = "/code/";

 /**
 * 操作session的工具集
 */
 private SessionStrategy sessionStrategy = new HttpSessionSessionStrategy();

 /**
 * 这是Spring的一个特性，就是在项目启动的时候会自动收集系统中 {@link ValidateCodeGeneratorService} 接口的实现类对象
 *
 * key为bean name
 */
 @Autowired
 private Map<String, ValidateCodeGeneratorService> validateCodeGeneratorMap;

 @Override
 public void processor(ServletWebRequest request) throws Exception {
 //第一件事
 C validateCode = generate(request);
 //第二件事
 save(request, validateCode);
 //第三件事
 send(request, validateCode);
 }

 /**
 * 生成验证码
 *
 */
 private C generate(ServletWebRequest request) {
 String type = getProcessorType(request);
 //这里 image+CodeGenerator = imgCodeGenerator 对应的就是ImageCodeGeneratorServiceService
 ValidateCodeGeneratorService validateCodeGenerator = validateCodeGeneratorMap.get(type.concat(ValidateCodeGeneratorService.CODE_GENERATOR));
 return (C) validateCodeGenerator.generate(request);
 }

 /**
 * 保存验证码到session中
 */
 private void save(ServletWebRequest request, C validateCode) {
 //这里也是封装了一下
 sessionStrategy.setAttribute(request, SESSION_KEY_PREFIX.concat(getProcessorType(request).toUpperCase()), validateCode);
 }

 /**
 * 发送验证码 （只有发送验证码是需要自己去实现的。）
 */
 protected abstract void send(ServletWebRequest request, C validateCode) throws Exception;

 /**
 * 获取请求URL中具体请求的验证码类型
 *
 */
 private String getProcessorType(ServletWebRequest request) {
 // 获取URI分割后的第二个片段 (/code/image 通过/code/ 切割后就只剩下 image
 return StringUtils.substringAfter(request.getRequest().getRequestURI(), SEPARATOR);
 }
}

public interface ValidateCodeGeneratorService {

 /**
 * 这个常量也是用来 type+CodeGeneratorService获取对于bean对象
 */
 String CODE_GENERATOR = "CodeGeneratorService";

 /**
 * 生成验证码
 * 具体是图片验证码 还是短信验证码就需要对应的实现类
 */
 ValidateCode generate(ServletWebRequest request);
}

@Data
@Component("imageCodeGeneratorService")
public class ImageCodeGeneratorServiceImpl implements ValidateCodeGeneratorService {

 private static final String IMAGE_WIDTH_NAME = "width";
 private static final String IMAGE_HEIGHT_NAME = "height";
 private static final Integer MAX_COLOR_VALUE = 255;

 @Autowired
 private ValidateCodeProperties validateCodeProperties;

 @Override
 public ImageCode generate(ServletWebRequest request) {
 int width = ServletRequestUtils.getIntParameter(request.getRequest(), IMAGE_WIDTH_NAME, validateCodeProperties.getImage().getWidth());
 int height = ServletRequestUtils.getIntParameter(request.getRequest(), IMAGE_HEIGHT_NAME,validateCodeProperties.getImage().getHeight());
 BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
 Graphics g = image.getGraphics();

 Random random = new Random();

 // 生成画布
 g.setColor(getRandColor(200, 250));
 g.fillRect(0, 0, width, height);
 g.setFont(new Font("Times New Roman", Font.ITALIC, 20));
 g.setColor(getRandColor(160, 200));
 for (int i = 0; i < 155; i++) {
 int x = random.nextInt(width);
 int y = random.nextInt(height);
 int xl = random.nextInt(12);
 int yl = random.nextInt(12);
 g.drawLine(x, y, x + xl, y + yl);
 }

 // 生成数字验证码
 StringBuilder sRand = new StringBuilder();
 for (int i = 0; i < validateCodeProperties.getImage().getLength(); i++) {
 String rand = String.valueOf(random.nextInt(10));
 sRand.append(rand);
 g.setColor(new Color(20 + random.nextInt(110), 20 + random.nextInt(110), 20 + random.nextInt(110)));
 g.drawString(rand, 13 * i + 6, 16);
 }

 g.dispose();

 return new ImageCode(image, sRand.toString(), validateCodeProperties.getImage().getExpireIn());
 }

 /**
 * 生成随机背景条纹
 *
 * @param fc 前景色
 * @param bc 背景色
 * @return RGB颜色
 */
 private Color getRandColor(int fc, int bc) {
 Random random = new Random();
 if (fc > MAX_COLOR_VALUE) {
 fc = MAX_COLOR_VALUE;
 }
 if (bc > MAX_COLOR_VALUE) {
 bc = MAX_COLOR_VALUE;
 }
 int r = fc + random.nextInt(bc - fc);
 int g = fc + random.nextInt(bc - fc);
 int b = fc + random.nextInt(bc - fc);
 return new Color(r, g, b);
 }
}

@Data
@Component("smsCodeGeneratorService")
public class SmsCodeGeneratorServiceImpl implements ValidateCodeGeneratorService {

 @Autowired
 private ValidateCodeProperties validateCodeProperties;


 @Override
 public SmsCode generate(ServletWebRequest request) {
 //生成随机数
 String code = RandomStringUtils.randomNumeric(validateCodeProperties.getSms().getLength());
 return new SmsCode(code, validateCodeProperties.getSms().getExpireIn());
 }
}

@Component("imageCodeProcessorService")
public class ImageCodeProcessorServiceImpl extends AbstractValidateCodeProcessorService<ImageCode> {

 private static final String FORMAT_NAME = "JPEG";

 /**
 * 发送图形验证码，将其写到相应中
 *
 * @param request ServletWebRequest实例对象
 * @param imageCode 验证码
 */
 @Override
 protected void send(ServletWebRequest request, ImageCode imageCode) throws Exception {
 ImageIO.write(imageCode.getImage(), FORMAT_NAME, request.getResponse().getOutputStream());
 }
}

@Component("smsCodeProcessorService")
public class SmsCodeProcessorServiceImpl extends AbstractValidateCodeProcessorService<SmsCode> {
 private static final String SMS_CODE_PARAM_NAME = "mobile";

 @Override
 protected void send(ServletWebRequest request, SmsCode smsCode) throws Exception {
 //这里有一个参数也是前端需要传来的 就是用户的手机号
 String mobile = ServletRequestUtils.getRequiredStringParameter(request.getRequest(), SMS_CODE_PARAM_NAME);
 // 这里仅仅写个打印，具体逻辑一般都是调用第三方接口发送短信
 System.out.println("向手机号为：" + mobile + "的用户发送验证码：" + smsCode.getCode());
 }

@RestController
@Slf4j
public class ValidateCodeController {


 @Autowired
 private Map<String, ValidateCodeProcessorService> validateCodeProcessorMap;


 @RequestMapping("/code/{type}")
 public void createCode(HttpServletRequest request, HttpServletResponse response, @PathVariable String type) throws Exception {
 if(!StringUtils.equalsAny(type, "image", "sms")){
 log.info("type类型错误 type={}",type);
 return;
 };

 //根据type获取具体的实现类
 ValidateCodeProcessorService validateCodeProcessorService = validateCodeProcessorMap.get(type.concat(ValidateCodeProcessorService.CODE_PROCESSOR));
 validateCodeProcessorService.processor(new ServletWebRequest(request, response));

 }

}