EasyCaptcha/README.md

414 lines
12 KiB
Markdown
Raw Normal View History

2018-02-11 14:46:59 +08:00
# EasyCaptcha
2018-07-27 15:52:40 +08:00
2018-07-27 16:18:18 +08:00
![JitPack](https://img.shields.io/jitpack/v/whvcse/EasyCaptcha.svg?style=flat-square)
![Hex.pm](https://img.shields.io/hexpm/l/plug.svg?style=flat-square)
2018-07-27 15:52:40 +08:00
## 1.简介
 Java图形验证码支持gif、中文、算术等类型可用于Java Web、JavaSE等项目。
2018-07-27 15:52:40 +08:00
---
2018-07-27 15:52:40 +08:00
## 2.效果展示
![验证码](https://s2.ax1x.com/2019/08/23/msFrE8.png)
  
![验证码](https://s2.ax1x.com/2019/08/23/msF0DP.png)
2018-07-27 15:52:40 +08:00
  
![验证码](https://s2.ax1x.com/2019/08/23/msFwut.png)
<br/>
![验证码](https://s2.ax1x.com/2019/08/23/msFzVK.gif)
2018-07-27 15:52:40 +08:00
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/msFvb6.gif)
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/msFXK1.gif)
2018-07-27 15:52:40 +08:00
**算术类型:**
2018-07-27 15:52:40 +08:00
![验证码](https://s2.ax1x.com/2019/08/23/mskKPg.png)
2018-07-27 15:52:40 +08:00
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/msknIS.png)
2018-07-27 15:52:40 +08:00
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/mskma8.png)
2018-07-27 15:52:40 +08:00
**中文类型:**
2018-07-28 00:22:49 +08:00
![验证码](https://s2.ax1x.com/2019/08/23/mskcdK.png)
2018-07-28 00:22:49 +08:00
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/msk6Z6.png)
2018-07-28 00:22:49 +08:00
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/msksqx.png)
2018-07-28 00:22:49 +08:00
**内置字体:**
![验证码](https://s2.ax1x.com/2019/08/23/msAVSJ.png)
2018-07-28 00:22:49 +08:00
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/msAAW4.png)
2018-07-28 00:22:49 +08:00
&emsp;&emsp;
![验证码](https://s2.ax1x.com/2019/08/23/msAkYF.png)
2018-07-28 00:22:49 +08:00
---
2018-07-27 15:52:40 +08:00
## 3.导入项目
### 3.1.gradle方式的引入
2018-05-14 11:39:09 +08:00
需要先在project的build.gradle中添加
2018-07-27 15:52:40 +08:00
```text
2018-05-14 11:39:09 +08:00
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
在项目的build.gradle中添加
2018-07-27 15:52:40 +08:00
```text
2018-05-14 11:39:09 +08:00
dependencies {
compile 'com.github.whvcse:EasyCaptcha:1.6.2'
2018-05-14 11:39:09 +08:00
}
```
### 3.2.maven方式引入
2018-07-27 15:52:40 +08:00
在你的pom.xml中添加如下代码
2018-05-14 11:39:09 +08:00
```xml
2018-07-27 15:52:40 +08:00
<project>
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>com.github.whvcse</groupId>
<artifactId>EasyCaptcha</artifactId>
<version>1.6.2</version>
2018-07-27 15:52:40 +08:00
</dependency>
</dependencies>
</project>
2018-05-14 11:39:09 +08:00
```
### 3.3.jar包下载
[EasyCaptcha-1.6.2.jar](https://gitee.com/whvse/EasyCaptcha/releases)
2018-07-27 15:52:40 +08:00
2019-06-25 21:56:56 +08:00
maven导入jar包在项目根目录创建`libs`文件夹然后pom.xml添加如下
```
<dependency>
<groupId>com.github.whvcse</groupId>
<artifactId>EasyCaptcha</artifactId>
<version>1.6.1</version>
<systemPath>${basedir}/libs/EasyCaptcha-1.6.2.jar</systemPath>
2019-06-25 21:56:56 +08:00
</dependency>
```
2018-07-27 15:52:40 +08:00
---
2018-05-14 11:39:09 +08:00
## 4.使用方法
2018-07-27 15:52:40 +08:00
### 4.1.在SpringMVC中使用
```java
@Controller
public class CaptchaController {
@RequestMapping("/captcha")
public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {
CaptchaUtil.out(request, response);
}
}
```
前端html代码
```html
<img src="/captcha" width="130px" height="48px" />
```
> 不要忘了把`/captcha`路径排除登录拦截比如shiro的拦截。
2018-07-27 15:52:40 +08:00
### 4.2.在servlet中使用
web.xml中配置servlet
2018-05-14 11:39:09 +08:00
```xml
2018-07-27 15:52:40 +08:00
<web-app>
<!-- 图形验证码servlet -->
<servlet>
<servlet-name>CaptchaServlet</servlet-name>
<servlet-class>com.wf.captcha.servlet.CaptchaServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>CaptchaServlet</servlet-name>
   <url-pattern>/captcha</url-pattern>
2018-07-27 15:52:40 +08:00
</servlet-mapping>
</web-app>
2018-05-14 11:39:09 +08:00
```
前端html代码
2018-05-14 11:39:09 +08:00
```html
<img src="/captcha" width="130px" height="48px" />
2018-05-14 11:39:09 +08:00
```
### 4.3.判断验证码是否正确
2018-05-14 11:39:09 +08:00
```java
2018-07-27 15:52:40 +08:00
@Controller
public class LoginController {
@PostMapping("/login")
public JsonResult login(String username,String password,String verCode){
if (!CaptchaUtil.ver(verCode, request)) {
CaptchaUtil.clear(request); // 清除session中的验证码
2018-07-27 15:52:40 +08:00
return JsonResult.error("验证码不正确");
}
}
2018-05-14 11:39:09 +08:00
}
```
2018-07-27 15:52:40 +08:00
### 4.4.设置宽高和位数
2018-05-14 11:39:09 +08:00
```java
2018-07-27 15:52:40 +08:00
@Controller
public class CaptchaController {
2018-07-27 15:52:40 +08:00
@RequestMapping("/captcha")
2018-07-27 15:52:40 +08:00
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);
2018-07-27 15:52:40 +08:00
}
2018-05-14 11:39:09 +08:00
}
```
### 4.5.不使用工具类
&emsp;CaptchaUtil封装了输出验证码、存session、判断验证码等功能也可以不使用此工具类
2018-07-28 00:22:49 +08:00
```java
@Controller
public class CaptchaController {
2018-07-28 00:22:49 +08:00
@RequestMapping("/captcha")
2018-07-28 00:22:49 +08:00
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);
2018-07-28 00:22:49 +08:00
// 三个参数分别为宽、高、位数
SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
2018-07-28 00:22:49 +08:00
// 设置字体
specCaptcha.setFont(new Font("Verdana", Font.PLAIN, 32)); // 有默认字体,可以不用设置
2018-07-28 00:22:49 +08:00
// 设置类型,纯数字、纯字母、字母数字混合
specCaptcha.setCharType(Captcha.TYPE_ONLY_NUMBER);
2018-07-28 00:22:49 +08:00
// 验证码存入session
request.getSession().setAttribute("captcha", specCaptcha.text().toLowerCase());
2018-07-28 00:22:49 +08:00
// 输出图片流
specCaptcha.out(response.getOutputStream());
2018-07-28 00:22:49 +08:00
}
@PostMapping("/login")
public JsonResult login(String username,String password,String verCode){
2018-07-28 00:22:49 +08:00
// 获取session中的验证码
String sessionCode = request.getSession().getAttribute("captcha");
// 判断验证码
if (verCode==null || !sessionCode.equals(verCode.trim().toLowerCase())) {
2018-07-28 00:22:49 +08:00
return JsonResult.error("验证码不正确");
}
}
}
```
## 5.更多设置
2018-05-14 11:39:09 +08:00
### 5.1.验证码类型
2018-07-27 16:18:18 +08:00
```java
public class Test {
public static void main(String[] args) {
// png类型
SpecCaptcha captcha = new SpecCaptcha(130, 48);
captcha.text(); // 获取验证码的字符
captcha.textChar(); // 获取验证码的字符数组
2018-07-27 16:18:18 +08:00
// gif类型
GifCaptcha captcha = new GifCaptcha(130, 48);
2018-07-27 16:18:18 +08:00
// 中文类型
ChineseCaptcha captcha = new ChineseCaptcha(130, 48);
2018-07-27 16:18:18 +08:00
// 中文gif类型
ChineseGifCaptcha captcha = new ChineseGifCaptcha(130, 48);
// 算术类型
ArithmeticCaptcha captcha = new ArithmeticCaptcha(130, 48);
captcha.setLen(3); // 几位数运算,默认是两位
captcha.getArithmeticString(); // 获取运算的公式3+2=?
captcha.text(); // 获取运算的结果5
2018-07-27 16:18:18 +08:00
captcha.out(outputStream); // 输出验证码
2018-07-27 16:18:18 +08:00
}
}
```
> 注意:<br/>
> &emsp;算术验证码的len表示是几位数运算而其他验证码的len表示验证码的位数算术验证码的text()表示的是公式的结果,
> 对于算术验证码你应该把公式的结果存储session而不是公式。
2018-07-27 16:18:18 +08:00
### 5.2.验证码字符类型
类型 | 描述
:--- | :---
TYPE_DEFAULT | 数字和字母混合
TYPE_ONLY_NUMBER | 纯数字
TYPE_ONLY_CHAR | 纯字母
2018-08-09 15:54:30 +08:00
TYPE_ONLY_UPPER | 纯大写字母
TYPE_ONLY_LOWER | 纯小写字母
TYPE_NUM_AND_UPPER | 数字和大写字母
使用方法:
```
SpecCaptcha captcha = new SpecCaptcha(130, 48, 5);
captcha.setCharType(Captcha.TYPE_ONLY_NUMBER);
```
> 只有`SpecCaptcha`和`GifCaptcha`设置才有效果。
2018-07-28 00:22:49 +08:00
### 5.3.字体设置
内置字体:
2018-07-28 00:22:49 +08:00
字体 | 效果
:--- | :---
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);
2018-07-28 00:22:49 +08:00
// 设置内置字体
captcha.setFont(Captcha.FONT_1);
// 设置系统字体
captcha.setFont(new Font("楷体", Font.PLAIN, 28));
```
### 5.4.输出base64编码
2018-07-28 00:22:49 +08:00
```
SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
specCaptcha.toBase64();
2018-07-28 00:22:49 +08:00
// 如果不想要base64的头部data:image/png;base64,
specCaptcha.toBase64(""); // 加一个空的参数即可
```
2018-07-28 00:22:49 +08:00
### 5.5.输出到文件
```
FileOutputStream outputStream = new FileOutputStream(new File("C:/captcha.png"))
SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);
specCaptcha.out(outputStream);
```
---
## 6.前后端分离项目的使用
&emsp;前后端分离项目建议不要存储在session中存储在redis中redis存储需要一个keykey一同返回给前端用于验证输入
2018-07-28 00:22:49 +08:00
```java
@Controller
public class CaptchaController {
@Autowired
private RedisUtil redisUtil;
2018-07-28 00:22:49 +08:00
@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());
2018-07-28 00:22:49 +08:00
}
@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("验证码不正确");
}
}
2018-07-28 00:22:49 +08:00
}
```
前端使用ajax获取验证码
```html
<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>
```
2018-07-28 00:22:49 +08:00
> RedisUtil到这里获取[https://gitee.com/whvse/RedisUtil](https://gitee.com/whvse/RedisUtil)
2018-07-28 00:22:49 +08:00
---
## 7.自定义效果
2018-07-28 00:22:49 +08:00
&emsp;继承`Captcha`实现`out`方法,中文验证码可继承`ChineseCaptchaAbstract`,算术验证码可继承`ArithmeticCaptchaAbstract`。
---
## 8.更新日志
- **2019-08-23 (v1.6.2)**
- 增加10种漂亮的内置字体不依赖系统字体
- 增加算术验证码,运算位数可自由配置
- 增加输出base64编码的功能
- 增加贝塞尔曲线作为干扰线
- **2018-08-09 (v1.5.0)**
- 增加纯大写字母、纯小写字母、数字和大写字母配置
- 增加中文验证码、中文gif验证码
- 增加抗锯齿效果,优化文字颜色
- 增加CaptchaUtil便于Web项目使用
---
2018-07-28 10:26:10 +08:00
## 9.推荐
&emsp;**EasyWeb管系统模板**一个开箱即用的后台模板使用简单功能丰富包含ifram版和spa单页面版[前往查看](https://easyweb.vip)。
2018-07-28 10:26:10 +08:00
![](https://s2.ax1x.com/2019/08/23/msiO78.png)