update [重大更新]全业务 增加 接口文档注解 格式化代码

疯狂的狮子li

2021-10-15 a6fb88d74c20cc28043d75e8a5097fce49cf9a78

 ruoyi-admin/src/main/java/com/ruoyi/web/controller/common/CaptchaController.java

@@ -1,25 +1,25 @@
package com.ruoyi.web.controller.common;

import cn.hutool.captcha.AbstractCaptcha;
import cn.hutool.captcha.CircleCaptcha;
import cn.hutool.captcha.LineCaptcha;
import cn.hutool.captcha.ShearCaptcha;
import cn.hutool.captcha.generator.CodeGenerator;
import cn.hutool.captcha.generator.RandomGenerator;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.util.IdUtil;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.constant.Constants;
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.core.redis.RedisCache;
import com.ruoyi.framework.captcha.UnsignedMathGenerator;
import com.ruoyi.common.enums.CaptchaType;
import com.ruoyi.common.utils.RedisUtils;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.reflect.ReflectUtils;
import com.ruoyi.common.utils.spring.SpringUtils;
import com.ruoyi.framework.config.properties.CaptchaProperties;
import com.ruoyi.system.service.ISysConfigService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
@@ -27,99 +27,61 @@
/**
 * 验证码操作处理
 *
 * @author ruoyi
 * @author Lion Li
 */
@Api(value = "验证码操作处理", tags = {"验证码管理"})
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@RestController
public class CaptchaController {

   // 圆圈干扰验证码
   @Resource(name = "CircleCaptcha")
   private CircleCaptcha circleCaptcha;
   // 线段干扰的验证码
   @Resource(name = "LineCaptcha")
   private LineCaptcha lineCaptcha;
   // 扭曲干扰验证码
   @Resource(name = "ShearCaptcha")
   private ShearCaptcha shearCaptcha;
    private final CaptchaProperties captchaProperties;
    private final ISysConfigService configService;

   @Autowired
   private RedisCache redisCache;
    /**
     * 生成验证码
     */
    @ApiOperation("生成验证码")
    @GetMapping("/captchaImage")
    public AjaxResult<Map<String, Object>> getCode() {
        Map<String, Object> ajax = new HashMap<>();
        boolean captchaOnOff = configService.selectCaptchaOnOff();
        ajax.put("captchaOnOff", captchaOnOff);
        if (!captchaOnOff) {
            return AjaxResult.success(ajax);
        }
        // 保存验证码信息
        String uuid = IdUtil.simpleUUID();
        String verifyKey = Constants.CAPTCHA_CODE_KEY + uuid;
        // 生成验证码
        CaptchaType captchaType = captchaProperties.getType();
        boolean isMath = CaptchaType.MATH == captchaType;
        Integer length = isMath ? captchaProperties.getNumberLength() : captchaProperties.getCharLength();
        CodeGenerator codeGenerator = ReflectUtils.newInstance(captchaType.getClazz(), length);
        AbstractCaptcha captcha = SpringUtils.getBean(captchaProperties.getCategory().getClazz());
        captcha.setGenerator(codeGenerator);
        captcha.createCode();
        String code = isMath ? getCodeResult(captcha.getCode()) : captcha.getCode();
        RedisUtils.setCacheObject(verifyKey, code, Constants.CAPTCHA_EXPIRATION, TimeUnit.MINUTES);
        ajax.put("uuid", uuid);
        ajax.put("img", captcha.getImageBase64());
        return AjaxResult.success(ajax);
    }

   @Autowired
   private CaptchaProperties captchaProperties;

   @Autowired
   private ISysConfigService configService;

   /**
    * 生成验证码
    */
   @GetMapping("/captchaImage")
   public AjaxResult getCode() {
      Map<String, Object> ajax = new HashMap<>();
      boolean captchaOnOff = configService.selectCaptchaOnOff();
      ajax.put("captchaOnOff", captchaOnOff);
      if (!captchaOnOff) {
         return AjaxResult.success(ajax);
      }
      // 保存验证码信息
      String uuid = IdUtil.simpleUUID();
      String verifyKey = Constants.CAPTCHA_CODE_KEY + uuid;
      String code = null;
      // 生成验证码
      CodeGenerator codeGenerator;
      AbstractCaptcha captcha;
      switch (captchaProperties.getType()) {
         case "math":
            codeGenerator = new UnsignedMathGenerator(captchaProperties.getNumberLength());
            break;
         case "char":
            codeGenerator = new RandomGenerator(captchaProperties.getCharLength());
            break;
         default:
            throw new IllegalArgumentException("验证码类型异常");
      }
      switch (captchaProperties.getCategory()) {
         case "line":
            captcha = lineCaptcha;
            break;
         case "circle":
            captcha = circleCaptcha;
            break;
         case "shear":
            captcha = shearCaptcha;
            break;
         default:
            throw new IllegalArgumentException("验证码类别异常");
      }
      captcha.setGenerator(codeGenerator);
      captcha.createCode();
      if ("math".equals(captchaProperties.getType())) {
         code = getCodeResult(captcha.getCode());
      } else if ("char".equals(captchaProperties.getType())) {
         code = captcha.getCode();
      }
      redisCache.setCacheObject(verifyKey, code, Constants.CAPTCHA_EXPIRATION, TimeUnit.MINUTES);
      ajax.put("uuid", uuid);
      ajax.put("img", captcha.getImageBase64());
      return AjaxResult.success(ajax);
   }

   private String getCodeResult(String capStr) {
      int numberLength = captchaProperties.getNumberLength();
      int a = Convert.toInt(StringUtils.sub(capStr, 0, numberLength).trim());
      char operator = capStr.charAt(numberLength);
      int b = Convert.toInt(StringUtils.sub(capStr, numberLength + 1, numberLength + 1 + numberLength).trim());
      switch (operator) {
         case '*':
            return a * b + "";
         case '+':
            return a + b + "";
         case '-':
            return a - b + "";
         default:
            return "";
      }
   }
    private String getCodeResult(String capStr) {
        int numberLength = captchaProperties.getNumberLength();
        int a = Convert.toInt(StringUtils.substring(capStr, 0, numberLength).trim());
        char operator = capStr.charAt(numberLength);
        int b = Convert.toInt(StringUtils.substring(capStr, numberLength + 1, numberLength + 1 + numberLength).trim());
        switch (operator) {
            case '*':
                return Convert.toStr(a * b);
            case '+':
                return Convert.toStr(a + b);
            case '-':
                return Convert.toStr(a - b);
            default:
                return StringUtils.EMPTY;
        }
    }

}