Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pig-mesh/easy-captcha
https://github.com/whvcse/EasyCaptcha增强JAVA11
https://github.com/pig-mesh/easy-captcha
captcha java spring-boot
Last synced: 2 days ago
JSON representation
https://github.com/whvcse/EasyCaptcha增强JAVA11
- Host: GitHub
- URL: https://github.com/pig-mesh/easy-captcha
- Owner: pig-mesh
- License: apache-2.0
- Created: 2020-07-31T07:31:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T03:41:44.000Z (3 months ago)
- Last Synced: 2024-12-29T16:02:44.066Z (9 days ago)
- Topics: captcha, java, spring-boot
- Language: Java
- Homepage:
- Size: 434 KB
- Stars: 336
- Watchers: 4
- Forks: 87
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 1.简介
Java图形验证码,支持gif、中文、算术等类型,可用于Java Web、JavaSE等项目。---
## 2.效果展示
![验证码](https://s2.ax1x.com/2019/08/23/msFrE8.png)
![验证码](https://s2.ax1x.com/2019/08/23/msF0DP.png)
![验证码](https://s2.ax1x.com/2019/08/23/msFwut.png)
![验证码](https://s2.ax1x.com/2019/08/23/msFzVK.gif)
![验证码](https://s2.ax1x.com/2019/08/23/msFvb6.gif)
![验证码](https://s2.ax1x.com/2019/08/23/msFXK1.gif)**算术类型:**
![验证码](https://s2.ax1x.com/2019/08/23/mskKPg.png)
![验证码](https://s2.ax1x.com/2019/08/23/msknIS.png)
![验证码](https://s2.ax1x.com/2019/08/23/mskma8.png)**中文类型:**
![验证码](https://s2.ax1x.com/2019/08/23/mskcdK.png)
![验证码](https://s2.ax1x.com/2019/08/23/msk6Z6.png)
![验证码](https://s2.ax1x.com/2019/08/23/msksqx.png)**内置字体:**
![验证码](https://s2.ax1x.com/2019/08/23/msAVSJ.png)
![验证码](https://s2.ax1x.com/2019/08/23/msAAW4.png)
![验证码](https://s2.ax1x.com/2019/08/23/msAkYF.png)---
## 3.导入项目
### 3.1.gradle方式的引入
```groovy
dependencies {
implementation 'com.pig4cloud.plugin:easy-captcha:2.2.4'
}
```### 3.2.maven方式引入
```xml
com.pig4cloud.plugin
captcha-spring-boot-starter
2.2.4
```
### 3.3.jar包下载
[easy-captcha](https://repo1.maven.org/maven2/com/pig4cloud/plugin/easy-captcha)## 4.使用方法
> 注意:
> 1. 使用 Jakarta 时用 `CaptchaJakartaUtil`;使用 Javax 时使用 `CaptchaUtil`;
> 2. 使用 `CaptchaUtil` 时需要根据使用情况引入对应的 `servlet` 依赖。### 4.1.在SpringMVC中使用
```java
@Controller
public class CaptchaController {
@RequestMapping("/captcha")
public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
// 使用 Jakarta 时用 CaptchaJakartaUtil
CaptchaUtil.out(request, response);
}
}
```前端html代码:
```html
```> 不要忘了把`/captcha`路径排除登录拦截,比如shiro的拦截。
### 4.2.在servlet中使用
web.xml 中配置 Javax servlet:
```xml
CaptchaServlet
com.pig4cloud.captcha.servlet.CaptchaServlet
CaptchaServlet
/captcha
```
web.xml 中配置 Jakarta servlet:
```xml
CaptchaServlet
com.pig4cloud.captcha.servlet.CaptchaJakartaServlet
CaptchaServlet
/captcha
```
前端html代码:
```html
```### 4.3.判断验证码是否正确
```java
@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.设置宽高和位数
```java
@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、判断验证码等功能,也可以不使用此工具类:```java
@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.验证码类型
```java
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 | 加减乘除 |使用方法:
```java
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 | 数字和大写字母 |使用方法:
```java
SpecCaptcha captcha=new SpecCaptcha(130,48,5);
captcha.setCharType(Captcha.TYPE_ONLY_NUMBER);
```> 只有`SpecCaptcha`和`GifCaptcha`设置才有效果。
### 5.3.字体设置
内置字体:| 字体 | 效果 |
|-----------------|------------------------------------------------|
| Captcha.FONT_1 | ![](https://s2.ax1x.com/2019/08/23/msMe6U.png) |
| Captcha.FONT_2 | ![](https://s2.ax1x.com/2019/08/23/msMAf0.png) |
| Captcha.FONT_3 | ![](https://s2.ax1x.com/2019/08/23/msMCwj.png) |
| Captcha.FONT_4 | ![](https://s2.ax1x.com/2019/08/23/msM9mQ.png) |
| Captcha.FONT_5 | ![](https://s2.ax1x.com/2019/08/23/msKz6S.png) |
| Captcha.FONT_6 | ![](https://s2.ax1x.com/2019/08/23/msKxl8.png) |
| Captcha.FONT_7 | ![](https://s2.ax1x.com/2019/08/23/msMPTs.png) |
| Captcha.FONT_8 | ![](https://s2.ax1x.com/2019/08/23/msMmXF.png) |
| Captcha.FONT_9 | ![](https://s2.ax1x.com/2019/08/23/msMVpV.png) |
| Captcha.FONT_10 | ![](https://s2.ax1x.com/2019/08/23/msMZlT.png) |使用方法:
```
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一同返回给前端用于验证输入:
```java
@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获取验证码:
```htmlvar 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');```
> RedisUtil到这里获取[https://gitee.com/whvse/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项目使用