加入CODE CHINA

· 不限速    · 不限空间    · 不限人数    · 私仓免费

免费加入
    README.md

    EasyCaptcha

    MavenCentral Hex.pm

    1.简介

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


    2.效果展示

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

    算术类型:

    验证码    验证码    验证码

    中文类型:

    验证码    验证码    验证码

    内置字体:

    验证码    验证码    验证码


    3.导入项目

    3.1.gradle方式的引入

    dependencies {
        compile 'com.github.whvcse:easy-captcha:1.6.2'
    }

    3.2.maven方式引入

    <dependencies>
       <dependency>
          <groupId>com.github.whvcse</groupId>
          <artifactId>easy-captcha</artifactId>
          <version>1.6.2</version>
       </dependency>
    </dependencies>

    3.3.jar包下载

    easy-captcha-1.6.2.jar

    maven导入jar包,在项目根目录创建libs文件夹,然后pom.xml添加如下:

    <dependency>
      <groupId>com.github.whvcse</groupId>
      <artifactId>easy-captcha</artifactId>
      <version>1.6.1</version>
      <systemPath>${basedir}/libs/easy-captcha-1.6.2.jar</systemPath>
    </dependency>

    4.使用方法

    4.1.在SpringMVC中使用

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

    前端html代码:

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

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

    4.2.在servlet中使用

    web.xml中配置servlet:

    <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>
        </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){
            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.out(outputStream);  // 输出验证码
        }
    }

    注意:
     算术验证码的len表示是几位数运算,而其他验证码的len表示验证码的位数,算术验证码的text()表示的是公式的结果, 对于算术验证码,你应该把公式的结果存储session,而不是公式。

    5.2.验证码字符类型

    类型 描述
    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.更新日志

    • 2019-08-23 (v1.6.2)

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

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

      • 增加输出base64编码的功能

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

    • 2018-08-09 (v1.5.0)

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

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

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

      • 增加CaptchaUtil便于Web项目使用

    项目简介

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/whvcse/easycaptcha

    发行版本 2

    1.6.2 增加算术验证码

    全部发行版

    贡献者 4

    D dependabot[bot] @dependabot[bot]
    S synchronized @synchronized
    W whvcse@foxmail.com @whvcse@foxmail.com

    开发语言

    • Java 100.0 %