设计模式之模板方法模式(3):抽取通用代码逻辑到父类

场景

将设计模式运用在项目中是学习设计模式最有效的方式
场景:系统多方式登录时候验证码生成
(1)系统提供多种登录方式:图形验证码登录、短信验证码登录。
(2)验证码登录的逻辑里面大部分是相同的:
主干逻辑3步骤:1.生成验证码 2.保存验证码到session 3.发送(发送方式不一样,图片验证码是发送到前端展示,手机验证码是发送到客户手机,是抽象方法,让子类自己去实现)
(3)我们把1.生成验证码 2.保存验证码到session是通用的逻辑 3.是 提供给子类的模板,让子类自己去实现。
(4) 1.生成验证码 2.保存验证码到session 大范围内看是相同的,但是具体细节上也是不同的,我们如何保证其对于父类是相同的代码,需要面向接口编程,我们调用生成验证码和保存session的接口对应的方法,具体实现的话,我们传递不同的接口实现类去做区分。这也是面向接口编程的优点:符合设计模式的:a.Dependence Inversion Principle(依赖倒转原则)-面向接口编程 b.Interface Segregation Principle(接口隔离原则)-使用多个隔离的接口,降低类之间的耦合度

内容

1.验证码生成业务梳理

image.png

  1. 在发起登录表单提交之前,会先获取验证码,然后对应的验证码会保存到session里面,登录时候会将得到的验证码一并表单提交到后端与session里面的验证码作比较,以及是否过期。
  2. 验证码生成需要提供一个接口:ValidateCodeController(调用实现验证码的3步操作的ValidateCodeProcessor)
  3. ValidateCodeProcessor里面封装了处理整个验证码的生成流程的:包括:a.生成验证码 b.存放session c.发送出去
  4. 声明一个ValidateCodeProcessor接口,这个接口有一个抽象的实现: AbstractValidateCodeProcessor(短信/图片验证码生成逻辑会写到这里面);具体的发送是不一样的:一种是请求返回,一种是调用短信运营商返回。这些不同的地方,会让其子类去实现。
  5. 1.生成验证码 2.保存验证码到session对于AbstractValidateCodeProcessor而言是相同的逻辑:AbstractValidateCodeProcessor只需要根据请求参数调用另外接口封装的:ValidateCodeGenerator

2.验证码关键代码

2.1 ValidateCodeController

@RestController
public class ValidateCodeController {
    @Autowired
    private Map<String, ValidateCodeProcessor> validateCodeProcessors;

    //将以上2个服务变成一个服务
    @GetMapping("/code/{type}")
    public void createCode(@PathVariable String type,HttpServletRequest request, HttpServletResponse response) throws Exception {
        ValidateCodeProcessor validateCodeProcessor;
        validateCodeProcessor = validateCodeProcessors.get(type + "ValidateCodeProcessor");
        validateCodeProcessor.create(new ServletWebRequest(request,response));
    }
}

2.2 ValidateCodeProcessor

public interface ValidateCodeProcessor {
    /**
     * 创建校验码
     * 
     * @param request
     * @throws Exception
     */
    void create(ServletWebRequest request) throws Exception;
}

2.3 ValidateCodeProcessor

public abstract class AbstractValidateCodeProcessor<C extends ValidateCode> implements ValidateCodeProcessor {
    /**
     * 操作session的工具类
     */
    private SessionStrategy sessionStrategy = new HttpSessionSessionStrategy();

    @Autowired
    private ValidateCodeRepository validateCodeRepository;

    /**
     * 收集系统中所有的 {@link ValidateCodeGenerator} 接口的实现。
     */
    @Autowired
    private Map<String, ValidateCodeGenerator> validateCodeGenerators;
    @Override
    public void create(ServletWebRequest request) throws Exception {
        //主干逻辑3步骤:1.生成验证码  2.保存验证码到session 3.发送(发送是抽象方法,让子类自己去实现)
        C validateCode = generate(request);
        save(request, validateCode);
        send(request, validateCode);
    }

    /**
     * 生成校验码:这里涉及到Spring里面的开发技巧;依赖查找
     * 
     * @param request
     * @return
     */
    @SuppressWarnings("unchecked")
    private C generate(ServletWebRequest request) {
        /*String type = getProcessorType(request);*/
        String type = getValidateCodeType(request).toString().toLowerCase();
        String generatorName = type + ValidateCodeGenerator.class.getSimpleName();
        ValidateCodeGenerator validateCodeGenerator = validateCodeGenerators.get(generatorName);
        if(validateCodeGenerator == null){
           throw new ValidateCodeException("验证码生成器" + generatorName + "不存在");
        }
        return (C) validateCodeGenerator.generate(request);
    }
    /**
     * 保存校验码
     * @param request
     * @param validateCode
     */
    private void save(ServletWebRequest request, C validateCode) {
        ValidateCode code = new ValidateCode(validateCode.getCode(),validateCode.getExpireTime());
        validateCodeRepository.save(request,code,getValidateCodeType(request));
    }
    /**
     * 构建验证码放入session时的key
     * @param request
     * @return
     */
    private String getSessionKey(ServletWebRequest request) {
        return SESSION_KEY_PREFIX + getValidateCodeType(request).toString().toUpperCase();
    }
    /**
     * 发送校验码,由子类实现
     * @param request
     * @param validateCode
     * @throws Exception
     */
    protected abstract void send(ServletWebRequest request, C validateCode) throws Exception;
    /**
     * 根据请求的url获取校验码类型:根据请求后半段不同对应的校验器也不同
     * @param request
     * @return
     */
    private ValidateCodeType getValidateCodeType(ServletWebRequest request){
        String type = StringUtils.substringBefore(getClass().getSimpleName(), "CodeProcessor");
        return ValidateCodeType.valueOf(type.toUpperCase());
    }

    @SuppressWarnings("unchecked")
    @Override
    public void validate(ServletWebRequest request) {
        ValidateCodeType processorType = getValidateCodeType(request);
        String sessionKey = getSessionKey(request);
        //C codeInSession = (C) sessionStrategy.getAttribute(request, sessionKey);
        ValidateCode validateCode = validateCodeRepository.get(request, getValidateCodeType(request));

        String codeInRequest;
        try {
            codeInRequest = ServletRequestUtils.getStringParameter(request.getRequest(),
                    processorType.getParamNameOnValidate());
        } catch (ServletRequestBindingException e) {
            throw new ValidateCodeException("获取验证码的值失败");
        }

        if (StringUtils.isBlank(codeInRequest)) {
            throw new ValidateCodeException(processorType + "验证码的值不能为空");
        }

        if (validateCode == null) {
            throw new ValidateCodeException(processorType + "验证码不存在");
        }

        if (validateCode.isExpried()) {
            sessionStrategy.removeAttribute(request, sessionKey);
            throw new ValidateCodeException(processorType + "验证码已过期");
        }

        if (!StringUtils.equals(validateCode.getCode(), codeInRequest)) {
            throw new ValidateCodeException(processorType + "验证码不匹配");
        }
        sessionStrategy.removeAttribute(request, sessionKey);
    }
}

2.4 ValidateCodeGenerator

public interface ValidateCodeGenerator {
    /**
     * 生成验证码
     * @param request
     * @return
     */
    ValidateCode generate(ServletWebRequest request);
}

2.5 ImageCodeProcessor

public class ImageCodeProcessor extends AbstractValidateCodeProcessor<ImageCode> {
    @Override
    protected void send(ServletWebRequest request, ImageCode imageCode) throws Exception {
        ImageIO.write(imageCode.getImage(),"JPEG",request.getResponse().getOutputStream());
    }
}

2.6 SmsCodeProcessor

@Component("smsValidateCodeProcessor")
public class SmsCodeProcessor extends AbstractValidateCodeProcessor<ValidateCode> {
    @Autowired
    private SmsCodeSender smsCodeSender;
    @Override
    protected void send(ServletWebRequest request, ValidateCode validateCode) throws Exception {
        //使用短信发送平台发送出去
        String mobile = ServletRequestUtils.getRequiredStringParameter(request.getRequest(), "mobile");
        smsCodeSender.send(mobile,validateCode.getCode());
    }
}

2.7 SmsCodeSender

public interface SmsCodeSender {
    /**
     * 给某个手机发送短信验证码
     * @param mobile
     * @param code
     */
    void send(String mobile,String code);
}

3.总结

3.1 不使用模板方法模式

  1. 验证码生成都有一段通用的生成验证码,保存到esssion通用逻辑,是相同的代码;但是相同的一段代码,通过复制粘贴的方式,放到了不同的类里去;一旦那段通用逻辑,要修改,就涉及到多个类都要去修改那个代码;如果你一旦忘了修改某个类中的那段代码,后果不堪设想
  2. 项目后期,原始开发人员离职,没人记得清楚那段通用逻辑代码放在了多少个类中,如果要排查,需要将很多类重新读一遍代码;这就是垃圾代码,扩展性,维护性,很烂。

3.2 使用模板方法模式

  1. 一旦我们修改通用逻辑时候,只需要修改通用类即可。
  2. 我们这里的模板方法就是:protected abstract void send(ServletWebRequest request, C validateCode) throws Exception;他只是定义模块,具体实现是去子类完成
  3. 模板方法模式是最高频使用的设计模式;因为在任何一个系统中,一定会出现多个类中都有相同的代码,此时就可以使用模板方法设计模式,将多个类中通用的逻辑抽取到一个父类中去

3.3 模式自带特征

模板方法模式:封装通用逻辑到父类,限制子类随意个性化通用逻辑,限定了通用的统一的执行步骤,避免不同的人写出多种多样个性化的可通用的逻辑。

评论

暂无评论