1. 程式人生 > 實用技巧 >Spring Boot之kaptcha圖形驗證碼

Spring Boot之kaptcha圖形驗證碼

上效果圖:

具體實現:

1:引入pom的maven依賴:

<!--圖形驗證碼生成依賴-->
<dependency>
<groupId>com.github.penggle</groupId>
<artifactId>kaptcha</artifactId>
<version>2.3.2</version>
</dependency>

2:java配置:

建立java類:KaptchaConfig

import com.google.code.kaptcha.impl.DefaultKaptcha;
import com.google.code.kaptcha.util.Config;
import java.util.Properties;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

@Component
public class KaptchaConfig {

//第一種配置:此種配置圖形混有干擾線 // @Bean // public DefaultKaptcha getDefaultKaptcha() { // com.google.code.kaptcha.impl.DefaultKaptcha defaultKaptcha = new com.google.code.kaptcha.impl.DefaultKaptcha(); // Properties properties = new Properties(); // properties.setProperty("kaptcha.border", "yes"); // properties.setProperty("kaptcha.border.color", "105,179,90"); // properties.setProperty("kaptcha.textproducer.font.color", "blue"); // properties.setProperty("kaptcha.image.width", "110"); // properties.setProperty("kaptcha.image.height", "40"); // properties.setProperty("kaptcha.textproducer.font.size", "30"); // properties.setProperty("kaptcha.session.key", "code"); // properties.setProperty("kaptcha.textproducer.char.length", "4"); // properties.setProperty("kaptcha.textproducer.font.names", "宋體"); // Config config = new Config(properties); // defaultKaptcha.setConfig(config); // return defaultKaptcha; // }
//第二種配置:沒有干擾線,就是上面的圖片效果 @Bean public DefaultKaptcha getDefaultKaptcha() { DefaultKaptcha defaultKaptcha = new DefaultKaptcha(); Properties properties = new Properties(); properties.setProperty("kaptcha.border", "no"); properties.setProperty("kaptcha.border.color", "105,179,90"); properties.setProperty("kaptcha.textproducer.font.color", "black"); properties.setProperty("kaptcha.image.width", "110"); properties.setProperty("kaptcha.image.height", "40"); properties.setProperty("kaptcha.textproducer.char.string","23456789abcdefghkmnpqrstuvwxyzABCDEFGHKMNPRSTUVWXYZ"); properties.setProperty("kaptcha.textproducer.font.size", "30"); properties.setProperty("kaptcha.textproducer.char.space","3"); properties.setProperty("kaptcha.session.key", "code"); properties.setProperty("kaptcha.textproducer.char.length", "4"); properties.setProperty("kaptcha.textproducer.font.names", "宋體,楷體,微軟雅黑"); // 這裡 是去掉 噪點顏色 //properties.setProperty("kaptcha.noise.color", "255,96,0"); // 這是 是圖片樣式配置 原生的有三種 水紋 、 魚眼 、 陰影 // 這裡是 我們自己實現的一個 也就是 樣式自定義 properties.setProperty("kaptcha.obscurificator.impl","com.huawei.ccop.boot.config.NoWaterRipple"); // 配置使用原生的 無噪 實現類 NoNoise properties.setProperty("kaptcha.noise.impl","com.google.code.kaptcha.impl.NoNoise"); Config config = new Config(properties); defaultKaptcha.setConfig(config); return defaultKaptcha; } }
  

注意:上面配置:com.huawei.ccop.boot.config.NoWaterRipple 這個是我自己自定義的類,主要是去掉干擾線,此類配置如下:

NoWaterRipple.java
import com.google.code.kaptcha.GimpyEngine;
import com.google.code.kaptcha.util.Configurable;

import java.awt.*;
import java.awt.image.BufferedImage;
import java.awt.image.ImageObserver;

public class NoWaterRipple extends Configurable implements GimpyEngine {
    public NoWaterRipple(){}

    @Override
    public BufferedImage getDistortedImage(BufferedImage baseImage) {
        //NoiseProducer noiseProducer = this.getConfig().getNoiseImpl();
        BufferedImage distortedImage = new BufferedImage(baseImage.getWidth(), baseImage.getHeight(), 2);
        Graphics2D graphics = (Graphics2D)distortedImage.getGraphics();
        //RippleFilter rippleFilter = new RippleFilter();
        //rippleFilter.setWaveType(0);
        //rippleFilter.setXAmplitude(2.6F);
        //rippleFilter.setYAmplitude(1.7F);
        //rippleFilter.setXWavelength(15.0F);
        //rippleFilter.setYWavelength(5.0F);
        //rippleFilter.setEdgeAction(0);
        //WaterFilter waterFilter = new WaterFilter();
        //waterFilter.setAmplitude(1.5F);
        //waterFilter.setPhase(10.0F);
        //waterFilter.setWavelength(2.0F);
        //BufferedImage effectImage = waterFilter.filter(baseImage, (BufferedImage)null);
        //effectImage = rippleFilter.filter(effectImage, (BufferedImage)null);
        graphics.drawImage(baseImage, 0, 0, (Color)null, (ImageObserver)null);
        graphics.dispose();
        //noiseProducer.makeNoise(distortedImage, 0.1F, 0.1F, 0.25F, 0.25F);
        //noiseProducer.makeNoise(distortedImage, 0.1F, 0.25F, 0.5F, 0.9F);
        return distortedImage;
    }
}

  

3:配置類寫好了,就寫controller的實現程式碼,如下:

3.1:首先必須自動注入該類:

3.2:controller介面:(注意:此處我這邊把生成的圖形字元驗證碼是放入redis快取,並且生成的圖片是base64,那你們也可以不生成base64

@GetMapping("/imageCode")
    public ApiResult defaultKaptcha() throws Exception {
        String base64String = "";
        String createText = defaultKaptcha.createText();
        log.info("生成的圖形驗證碼==" + createText);

        BufferedImage challenge = defaultKaptcha.createImage(createText);
        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        ImageIO.write(challenge, "PNG", bos);
        byte[] bytes = bos.toByteArray();
        Base64.Encoder encoder = Base64.getEncoder();
        base64String = encoder.encodeToString(bytes);

        String imageKey = UUID.randomUUID().toString().replace("-", ""); //這個uuid是生成返回給前端,並且通過key-value放入redis快取,前端提交登入的時候,
//會把這個uuid一併提交過來,我們後端通過這個uuid從redis取出來比較圖形驗證碼是否正確

//這裡是使用loombok的形式set值,如果你們不喜歡,可以使用new物件,比如:ImageCode code=new ImageCode();code.setImageKey(imageKey);
ImageCode code = ImageCode.builder().imageKey(imageKey).imageCode("data:image/png;base64," + base64String).build(); log.info("生成的圖形驗證碼==" + createText); log.info("生成的圖形驗設定的key==" + imageKey); //儲存到redis:30秒 redisTemplate.opsForValue().set(imageKey, createText, Duration.ofSeconds(60)); //預設設定60秒過時 return ApiResult.ok(code); }

  

如有不明白,可以直接新增作者微信:Y1141100952