• Stars
    star
    309
  • Rank 135,306 (Top 3 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created over 4 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

https://github.com/whvcse/EasyCaptcha增强JAVA11

1.简介

 Java图形验证码,支持gif、中文、算术等类型,可用于Java Web、JavaSE等项目。


2.效果展示

验证码    验证码    验证码
验证码    验证码    验证码

算术类型:

验证码    验证码    验证码

中文类型:

验证码    验证码    验证码

内置字体:

验证码    验证码    验证码


3.导入项目

3.1.gradle方式的引入

dependencies {
    implementation 'com.pig4cloud.plugin:easy-captcha:2.2.3'
}

3.2.maven方式引入

<dependencies>
   <dependency>
      <groupId>com.pig4cloud.plugin</groupId>
      <artifactId>captcha-spring-boot-starter</artifactId>
      <version>2.2.3</version>
   </dependency>
</dependencies>

3.3.jar包下载

easy-captcha

4.使用方法

注意:
 1. 使用 Jakarta 时用 CaptchaJakartaUtil;使用 Javax 时使用 CaptchaUtil
 2. 使用 CaptchaUtil 时需要根据使用情况引入对应的 servlet 依赖。

4.1.在SpringMVC中使用

@Controller
public class CaptchaController {
    
    @RequestMapping("/captcha")
    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
        // 使用 Jakarta 时用 CaptchaJakartaUtil
        CaptchaUtil.out(request, response);
    }
}

前端html代码:

<img src="/captcha" width="130px" height="48px"/>

不要忘了把/captcha路径排除登录拦截,比如shiro的拦截。

4.2.在servlet中使用

web.xml 中配置 Javax servlet:

<web-app>
    <!-- 图形验证码servlet -->
    <servlet>
        <servlet-name>CaptchaServlet</servlet-name>
        <servlet-class>com.pig4cloud.captcha.servlet.CaptchaServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>CaptchaServlet</servlet-name>
        <url-pattern>/captcha</url-pattern>
    </servlet-mapping>
</web-app>

web.xml 中配置 Jakarta servlet:

<web-app>
    <!-- 图形验证码servlet -->
    <servlet>
        <servlet-name>CaptchaServlet</servlet-name>
        <servlet-class>com.pig4cloud.captcha.servlet.CaptchaJakartaServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>CaptchaServlet</servlet-name>
        <url-pattern>/captcha</url-pattern>
    </servlet-mapping>
</web-app>

前端html代码:

<img src="/captcha" width="130px" height="48px" />

4.3.判断验证码是否正确

@Controller
public class LoginController {
    
    @PostMapping("/login")
    public JsonResult login(String username, String password, String verCode) {
        // 使用 Jakarta 时用 CaptchaJakartaUtil
        if (!CaptchaUtil.ver(verCode, request)) {
            CaptchaUtil.clear(request);  // 清除session中的验证码
            return JsonResult.error("验证码不正确");
        }
    }   
}

4.4.设置宽高和位数

@Controller
public class CaptchaController {
    
    @RequestMapping("/captcha")
    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
        // 设置位数
        CaptchaUtil.out(5, request, response);
        // 设置宽、高、位数
        CaptchaUtil.out(130, 48, 5, request, response);
        
        // 使用gif验证码
        GifCaptcha gifCaptcha = new GifCaptcha(130,48,4);
        CaptchaUtil.out(gifCaptcha, request, response);
    }
}

4.5.不使用工具类

 CaptchaUtil封装了输出验证码、存session、判断验证码等功能,也可以不使用此工具类:

@Controller
public class CaptchaController {
    
    @RequestMapping("/captcha")
    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
        // 设置请求头为输出图片类型
        response.setContentType("image/gif");
        response.setHeader("Pragma", "No-cache");
        response.setHeader("Cache-Control", "no-cache");
        response.setDateHeader("Expires", 0);
        
        // 三个参数分别为宽、高、位数
        SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
        // 设置字体
        specCaptcha.setFont(new Font("Verdana", Font.PLAIN, 32));  // 有默认字体,可以不用设置
        // 设置类型,纯数字、纯字母、字母数字混合
        specCaptcha.setCharType(Captcha.TYPE_ONLY_NUMBER);
        
        // 验证码存入session
        request.getSession().setAttribute("captcha", specCaptcha.text().toLowerCase());
        
        // 输出图片流
        specCaptcha.out(response.getOutputStream());
    }
    
    @PostMapping("/login")
    public JsonResult login(String username,String password,String verCode){
        // 获取session中的验证码
        String sessionCode = request.getSession().getAttribute("captcha");
        // 判断验证码
        if (verCode==null || !sessionCode.equals(verCode.trim().toLowerCase())) {
            return JsonResult.error("验证码不正确");
        }
    }  
}

5.更多设置

5.1.验证码类型

public class Test {
    
    public static void main(String[] args) {
        // png类型
        SpecCaptcha captcha = new SpecCaptcha(130, 48);
        captcha.text();  // 获取验证码的字符
        captcha.textChar();  // 获取验证码的字符数组
        
        // gif类型
        GifCaptcha captcha = new GifCaptcha(130, 48);
        
        // 中文类型
        ChineseCaptcha captcha = new ChineseCaptcha(130, 48);
        
        // 中文gif类型
        ChineseGifCaptcha captcha = new ChineseGifCaptcha(130, 48);
        
        // 算术类型
        ArithmeticCaptcha captcha = new ArithmeticCaptcha(130, 48);
        captcha.setLen(3);  // 几位数运算,默认是两位
        captcha.getArithmeticString();  // 获取运算的公式:3+2=?
        captcha.text();  // 获取运算的结果:5
        captcha.supportAlgorithmSign(2); // 可设置支持的算法:2 表示只生成带加减法的公式
        captcha.setDifficulty(50); // 设置计算难度,参与计算的每一个整数的最大值
        captcha.out(outputStream);  // 输出验证码
        //简单算术类型 SimpleArithmeticCaptcha,用法同ArithmeticCaptcha,只支持加减,计算结果为正整数
    }
}

注意:
 1. 算术验证码的len表示是几位数运算,而其他验证码的len表示验证码的位数,算术验证码的text()表示的是公式的结果, 对于算术验证码,你应该把公式的结果存储session,而不是公式。
 2. 由于部分字体库的问题,除号可能无法显示

5.2.验证码字符类型

算数验证码

描述
2 加法
3 加减
4 加减乘
5 加减乘除

使用方法:

    ArithmeticCaptcha arithmeticCaptcha=new ArithmeticCaptcha();
    arithmeticCaptcha.supportAlgorithmSign(5);

验证码

类型 描述
TYPE_DEFAULT 数字和字母混合
TYPE_ONLY_NUMBER 纯数字
TYPE_ONLY_CHAR 纯字母
TYPE_ONLY_UPPER 纯大写字母
TYPE_ONLY_LOWER 纯小写字母
TYPE_NUM_AND_UPPER 数字和大写字母

使用方法:

    SpecCaptcha captcha=new SpecCaptcha(130,48,5);
    captcha.setCharType(Captcha.TYPE_ONLY_NUMBER);

只有SpecCaptchaGifCaptcha设置才有效果。

5.3.字体设置

内置字体:

字体 效果
Captcha.FONT_1
Captcha.FONT_2
Captcha.FONT_3
Captcha.FONT_4
Captcha.FONT_5
Captcha.FONT_6
Captcha.FONT_7
Captcha.FONT_8
Captcha.FONT_9
Captcha.FONT_10

使用方法:

SpecCaptcha captcha = new SpecCaptcha(130, 48, 5);

// 设置内置字体
captcha.setFont(Captcha.FONT_1); 

// 设置系统字体
captcha.setFont(new Font("楷体", Font.PLAIN, 28)); 

5.4.输出base64编码

SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
specCaptcha.toBase64();

// 如果不想要base64的头部data:image/png;base64,
specCaptcha.toBase64("");  // 加一个空的参数即可

5.5.输出到文件

FileOutputStream outputStream = new FileOutputStream(new File("C:/captcha.png"))
SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
specCaptcha.out(outputStream);

6.前后端分离项目的使用

 前后端分离项目建议不要存储在session中,存储在redis中,redis存储需要一个key,key一同返回给前端用于验证输入:

@Controller
public class CaptchaController {
    @Autowired
    private RedisUtil redisUtil;
    
    @ResponseBody
    @RequestMapping("/captcha")
    public JsonResult captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
        SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
        String verCode = specCaptcha.text().toLowerCase();
        String key = UUID.randomUUID().toString();
        // 存入redis并设置过期时间为30分钟
        redisUtil.setEx(key, verCode, 30, TimeUnit.MINUTES);
        // 将key和base64返回给前端
        return JsonResult.ok().put("key", key).put("image", specCaptcha.toBase64());
    }
    
    @ResponseBody
    @PostMapping("/login")
    public JsonResult login(String username,String password,String verCode,String verKey){
        // 获取redis中的验证码
        String redisCode = redisUtil.get(verKey);
        // 判断验证码
        if (verCode==null || !redisCode.equals(verCode.trim().toLowerCase())) {
            return JsonResult.error("验证码不正确");
        }
    }  
}

前端使用ajax获取验证码:

<img id="verImg" width="130px" height="48px"/>

<script>
    var verKey;
    // 获取验证码
    $.get('/captcha', function(res) {
        verKey = res.key;
        $('#verImg').attr('src', res.image);
    },'json');
    
    // 登录
    $.post('/login', {
        verKey: verKey,
        verCode: '8u6h',
        username: 'admin',
        password: 'admin'
    }, function(res) {
        console.log(res);
    }, 'json');
</script>

RedisUtil到这里获取https://gitee.com/whvse/RedisUtil


7.自定义效果

 继承Captcha实现out方法,中文验证码可继承ChineseCaptchaAbstract,算术验证码可继承ArithmeticCaptchaAbstract


8.日志

 使用 slf4j 进行日志输出,需要根据自身使用情况搭配日志框架


9.更新日志

  • 2023-01-28 (v2.2.3)

    • 增加除法运算
    • 使用 slf4j 代替控制台打印
    • 增加 CaptchaUtil (适用于 javax.servlet)
    • 增加 CaptchaJakartaUtil (适用于 jakarta.servlet)
    • 增加 CaptchaServlet (适用于 javax.servlet)
    • 增加 CaptchaJakartaServlet (适用于 jakarta.servlet)
  • 2019-08-23 (v1.6.2)

    • 增加10种漂亮的内置字体,不依赖系统字体

    • 增加算术验证码,运算位数可自由配置

    • 增加输出base64编码的功能

    • 增加贝塞尔曲线作为干扰线

  • 2018-08-09 (v1.5.0)

    • 增加纯大写字母、纯小写字母、数字和大写字母配置

    • 增加中文验证码、中文gif验证码

    • 增加抗锯齿效果,优化文字颜色

    • 增加CaptchaUtil便于Web项目使用

More Repositories

1

pig

↥ ↥ ↥ 点击关注更新,基于 Spring Cloud 2023 、Spring Boot 3.3、 OAuth2 的 RBAC 权限管理系统
Java
5,775
star
2

excel-spring-boot-starter

本项目旨在为用户提供一个便捷的 Excel 导出解决方案。基于阿里巴巴的 EasyExcel 库,结合 Spring Boot 框架,封装并优化了 Excel 文件的导出流程,帮助开发者更高效地实现数据导出功能。
Java
429
star
3

oss-spring-boot-starter

兼容S3协议的通用文件存储工具类
Java
244
star
4

multilevel-cache-spring-boot-starter

spring cache 多级缓存扩展
238
star
5

pig-ui

🚀 The best rbac web framework. base on Spring Boot 3.2、 Spring Cloud 2023、 OAuth2 . Give a star
Vue
238
star
6

idempotent-spring-boot-starter

spring boot idempotent starter
Java
138
star
7

ureport-spring-boot-starter

UReport2 是一款基于架构在 Spring 之上纯 Java 的高性能报表引擎
Java
57
star
8

nacos-datasource-plugin-dm8

nacos 达梦数据库插件
Java
27
star
9

nacos-datasource-plugin-oracle

nacos oracle 持久化数据库插件
PLSQL
16
star
10

docker-mirror

自动化搞定 Docker 镜像操作
15
star
11

nacos-datasource-plugin-pg

nacos postgresql 数据库插件
Java
13
star
12

pig-ui-electron

pig-ui的 electron 移植版(或者叫增强,因为他们并不冲突)
Vue
12
star
13

nacos-datasource-plugin-kingbase

nacos 人大金仓数据库存储插件
Java
11
star
14

fastdfs-spring-boot-starter

fastdfs spring boot start
Java
10
star
15

RuoYi-Vue

若依v3.8 前后端分离 适配PIGX v4.6 单点登录示例
Java
8
star
16

anti-reptile-spring-boot-starter

反爬组件
Java
7
star
17

pigx-mini-login

pigx 整合小程序登录示例源码
JavaScript
6
star
18

Ruoyi-vue-pig

pig 3.6 整合 ruoyi 3.8 前后端分离示意项目
Java
5
star
19

spring-cloud-pig-mesh

自己实现一套 spring cloud
Java
5
star
20

aliyun-sms-spring-boot-starter

阿里云短信发送工具
Java
4
star
21

CGTM

Code Generation Template Marketplace
Vue
3
star
22

beanstalkd-spring-boot-starter

Beanstalkd分布式内存队列系统 的 spring boot starter 封装
Java
2
star
23

rocketmq-spring-boot3-starter

RocketMQ SpringBoot 3.0 Starter
2
star
24

nacos-datasource-plugin-highgo

nacos 瀚高数据库存储插件
Java
2
star
25

jeesite5

pig 3.6 整合 jeesite 5.x 前后端分离示意项目
JavaScript
1
star
26

start-spring-io-default-val-extension

Chrome 插件 start.spring.io 创建项目时指定一些默认值
JavaScript
1
star
27

aj-captcha

Java
1
star
28

docker-ocr-image

Dockerfile
1
star