{"id":20269122,"url":"https://github.com/pig-mesh/easy-captcha","last_synced_at":"2025-04-08T12:09:22.243Z","repository":{"id":50441441,"uuid":"283972300","full_name":"pig-mesh/easy-captcha","owner":"pig-mesh","description":"A powerful and easy-to-use CAPTCHA library for Java applications, supporting various types of captchas including GIF, Chinese characters, arithmetic operations, and more.","archived":false,"fork":false,"pushed_at":"2025-03-07T05:34:46.000Z","size":455,"stargazers_count":350,"open_issues_count":5,"forks_count":92,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-01T11:03:46.356Z","etag":null,"topics":["captcha","java","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pig-mesh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-31T07:31:04.000Z","updated_at":"2025-03-25T08:15:17.000Z","dependencies_parsed_at":"2023-02-15T14:31:55.157Z","dependency_job_id":"30880075-22fd-410f-93ed-3b0c99e966a9","html_url":"https://github.com/pig-mesh/easy-captcha","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pig-mesh%2Feasy-captcha","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pig-mesh%2Feasy-captcha/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pig-mesh%2Feasy-captcha/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pig-mesh%2Feasy-captcha/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pig-mesh","download_url":"https://codeload.github.com/pig-mesh/easy-captcha/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247838444,"owners_count":21004580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["captcha","java","spring-boot"],"created_at":"2024-11-14T12:23:27.097Z","updated_at":"2025-04-08T12:09:22.214Z","avatar_url":"https://github.com/pig-mesh.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## 1.简介\n\u0026emsp;Java图形验证码，支持gif、中文、算术等类型，可用于Java Web、JavaSE等项目。\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.pig4cloud.plugin/easy-captcha.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/com.pig4cloud.plugin/easy-captcha)\n\n---\n\n## 2.效果展示\n\n![验证码](https://s2.ax1x.com/2019/08/23/msFrE8.png) \n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msF0DP.png)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msFwut.png)\n\u003cbr/\u003e\n![验证码](https://s2.ax1x.com/2019/08/23/msFzVK.gif) \n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msFvb6.gif)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msFXK1.gif)\n\n**算术类型：**\n\n![验证码](https://s2.ax1x.com/2019/08/23/mskKPg.png)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msknIS.png)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/mskma8.png)\n\n**中文类型：**\n\n![验证码](https://s2.ax1x.com/2019/08/23/mskcdK.png)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msk6Z6.png)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msksqx.png)\n\n**内置字体：**\n\n![验证码](https://s2.ax1x.com/2019/08/23/msAVSJ.png)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msAAW4.png)\n\u0026emsp;\u0026emsp;\n![验证码](https://s2.ax1x.com/2019/08/23/msAkYF.png)\n\n\n---\n\n## 3.导入项目\n\n### 3.1.gradle方式的引入\n```groovy\ndependencies {\n    implementation 'com.pig4cloud.plugin:easy-captcha:2.2.5'\n}\n```\n\n### 3.2.maven方式引入 \n\n```xml\n\u003cdependencies\u003e\n   \u003cdependency\u003e\n      \u003cgroupId\u003ecom.pig4cloud.plugin\u003c/groupId\u003e\n      \u003cartifactId\u003ecaptcha-spring-boot-starter\u003c/artifactId\u003e\n      \u003cversion\u003e2.2.5\u003c/version\u003e\n   \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n### 3.3.jar包下载\n[easy-captcha](https://repo1.maven.org/maven2/com/pig4cloud/plugin/easy-captcha)\n\n## 4.使用方法\n\u003e 注意：\u003cbr/\u003e\n\u003e \u0026emsp;1. 使用 Jakarta 时用 `CaptchaJakartaUtil`；使用 Javax 时使用 `CaptchaUtil`；  \n\u003e \u0026emsp;2. 使用 `CaptchaUtil` 时需要根据使用情况引入对应的 `servlet` 依赖。\n\n### 4.1.在SpringMVC中使用\n```java\n@Controller\npublic class CaptchaController {\n    \n    @RequestMapping(\"/captcha\")\n    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {\n        // 使用 Jakarta 时用 CaptchaJakartaUtil\n        CaptchaUtil.out(request, response);\n    }\n}\n```\n\n前端html代码：\n\n```html\n\u003cimg src=\"/captcha\" width=\"130px\" height=\"48px\"/\u003e\n```\n\n\u003e 不要忘了把`/captcha`路径排除登录拦截，比如shiro的拦截。\n\n### 4.2.在servlet中使用\n\nweb.xml 中配置 Javax servlet：\n\n```xml\n\n\u003cweb-app\u003e\n    \u003c!-- 图形验证码servlet --\u003e\n    \u003cservlet\u003e\n        \u003cservlet-name\u003eCaptchaServlet\u003c/servlet-name\u003e\n        \u003cservlet-class\u003ecom.pig4cloud.captcha.servlet.CaptchaServlet\u003c/servlet-class\u003e\n    \u003c/servlet\u003e\n    \u003cservlet-mapping\u003e\n        \u003cservlet-name\u003eCaptchaServlet\u003c/servlet-name\u003e\n        \u003curl-pattern\u003e/captcha\u003c/url-pattern\u003e\n    \u003c/servlet-mapping\u003e\n\u003c/web-app\u003e\n```\n\nweb.xml 中配置 Jakarta servlet：\n\n```xml\n\n\u003cweb-app\u003e\n    \u003c!-- 图形验证码servlet --\u003e\n    \u003cservlet\u003e\n        \u003cservlet-name\u003eCaptchaServlet\u003c/servlet-name\u003e\n        \u003cservlet-class\u003ecom.pig4cloud.captcha.servlet.CaptchaJakartaServlet\u003c/servlet-class\u003e\n    \u003c/servlet\u003e\n    \u003cservlet-mapping\u003e\n        \u003cservlet-name\u003eCaptchaServlet\u003c/servlet-name\u003e\n        \u003curl-pattern\u003e/captcha\u003c/url-pattern\u003e\n    \u003c/servlet-mapping\u003e\n\u003c/web-app\u003e\n```\n\n前端html代码：\n```html\n\u003cimg src=\"/captcha\" width=\"130px\" height=\"48px\" /\u003e\n```\n\n### 4.3.判断验证码是否正确\n\n```java\n@Controller\npublic class LoginController {\n    \n    @PostMapping(\"/login\")\n    public JsonResult login(String username, String password, String verCode) {\n        // 使用 Jakarta 时用 CaptchaJakartaUtil\n        if (!CaptchaUtil.ver(verCode, request)) {\n            CaptchaUtil.clear(request);  // 清除session中的验证码\n            return JsonResult.error(\"验证码不正确\");\n        }\n    }   \n}\n```\n\n### 4.4.设置宽高和位数\n```java\n@Controller\npublic class CaptchaController {\n    \n    @RequestMapping(\"/captcha\")\n    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {\n        // 设置位数\n        CaptchaUtil.out(5, request, response);\n        // 设置宽、高、位数\n        CaptchaUtil.out(130, 48, 5, request, response);\n        \n        // 使用gif验证码\n        GifCaptcha gifCaptcha = new GifCaptcha(130,48,4);\n        CaptchaUtil.out(gifCaptcha, request, response);\n    }\n}\n```\n\n### 4.5.不使用工具类\n\u0026emsp;CaptchaUtil封装了输出验证码、存session、判断验证码等功能，也可以不使用此工具类：\n\n```java\n@Controller\npublic class CaptchaController {\n    \n    @RequestMapping(\"/captcha\")\n    public void captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {\n        // 设置请求头为输出图片类型\n        response.setContentType(\"image/gif\");\n        response.setHeader(\"Pragma\", \"No-cache\");\n        response.setHeader(\"Cache-Control\", \"no-cache\");\n        response.setDateHeader(\"Expires\", 0);\n        \n        // 三个参数分别为宽、高、位数\n        SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);\n        // 设置字体\n        specCaptcha.setFont(new Font(\"Verdana\", Font.PLAIN, 32));  // 有默认字体，可以不用设置\n        // 设置类型，纯数字、纯字母、字母数字混合\n        specCaptcha.setCharType(Captcha.TYPE_ONLY_NUMBER);\n        \n        // 验证码存入session\n        request.getSession().setAttribute(\"captcha\", specCaptcha.text().toLowerCase());\n        \n        // 输出图片流\n        specCaptcha.out(response.getOutputStream());\n    }\n    \n    @PostMapping(\"/login\")\n    public JsonResult login(String username,String password,String verCode){\n        // 获取session中的验证码\n        String sessionCode = request.getSession().getAttribute(\"captcha\");\n        // 判断验证码\n        if (verCode==null || !sessionCode.equals(verCode.trim().toLowerCase())) {\n            return JsonResult.error(\"验证码不正确\");\n        }\n    }  \n}\n```\n\n## 5.更多设置\n\n### 5.1.验证码类型\n\n```java\npublic class Test {\n    \n    public static void main(String[] args) {\n        // png类型\n        SpecCaptcha captcha = new SpecCaptcha(130, 48);\n        captcha.text();  // 获取验证码的字符\n        captcha.textChar();  // 获取验证码的字符数组\n        \n        // gif类型\n        GifCaptcha captcha = new GifCaptcha(130, 48);\n        \n        // 中文类型\n        ChineseCaptcha captcha = new ChineseCaptcha(130, 48);\n        \n        // 中文gif类型\n        ChineseGifCaptcha captcha = new ChineseGifCaptcha(130, 48);\n        \n        // 算术类型\n        ArithmeticCaptcha captcha = new ArithmeticCaptcha(130, 48);\n        captcha.setLen(3);  // 几位数运算，默认是两位\n        captcha.getArithmeticString();  // 获取运算的公式：3+2=?\n        captcha.text();  // 获取运算的结果：5\n        captcha.supportAlgorithmSign(2); // 可设置支持的算法：2 表示只生成带加减法的公式\n        captcha.setDifficulty(50); // 设置计算难度，参与计算的每一个整数的最大值\n        captcha.out(outputStream);  // 输出验证码\n        //简单算术类型 SimpleArithmeticCaptcha,用法同ArithmeticCaptcha,只支持加减，计算结果为正整数\n    }\n}\n```\n\n\u003e 注意：\u003cbr/\u003e\n\u003e \u0026emsp;1. 算术验证码的len表示是几位数运算，而其他验证码的len表示验证码的位数，算术验证码的text()表示的是公式的结果，\n\u003e 对于算术验证码，你应该把公式的结果存储session，而不是公式。  \n\u003e \u0026emsp;2. 由于部分字体库的问题，除号可能无法显示\n\n### 5.2.验证码字符类型\n\n#### 算数验证码\n\n| 值   | 描述   |\n|-----|------|\n| 2   | 加法   |\n| 3   | 加减   |\n| 4   | 加减乘  |\n| 5   | 加减乘除 |\n\n使用方法：\n\n```java\n    ArithmeticCaptcha arithmeticCaptcha=new ArithmeticCaptcha();\n    arithmeticCaptcha.supportAlgorithmSign(5);\n```\n\n#### 验证码\n\n| 类型                 | 描述      |\n|--------------------|---------|\n| TYPE_DEFAULT       | 数字和字母混合 |\n| TYPE_ONLY_NUMBER   | 纯数字     |\n| TYPE_ONLY_CHAR     | 纯字母     |\n| TYPE_ONLY_UPPER    | 纯大写字母   |\n| TYPE_ONLY_LOWER    | 纯小写字母   |\n| TYPE_NUM_AND_UPPER | 数字和大写字母 |\n\n使用方法：\n\n```java\n    SpecCaptcha captcha=new SpecCaptcha(130,48,5);\n    captcha.setCharType(Captcha.TYPE_ONLY_NUMBER);\n```\n\n\u003e 只有`SpecCaptcha`和`GifCaptcha`设置才有效果。\n\n### 5.3.字体设置\n内置字体：\n\n| 字体              | 效果                                             |\n|-----------------|------------------------------------------------|\n| Captcha.FONT_1  | ![](https://s2.ax1x.com/2019/08/23/msMe6U.png) |\n| Captcha.FONT_2  | ![](https://s2.ax1x.com/2019/08/23/msMAf0.png) |\n| Captcha.FONT_3  | ![](https://s2.ax1x.com/2019/08/23/msMCwj.png) |\n| Captcha.FONT_4  | ![](https://s2.ax1x.com/2019/08/23/msM9mQ.png) |\n| Captcha.FONT_5  | ![](https://s2.ax1x.com/2019/08/23/msKz6S.png) |\n| Captcha.FONT_6  | ![](https://s2.ax1x.com/2019/08/23/msKxl8.png) |\n| Captcha.FONT_7  | ![](https://s2.ax1x.com/2019/08/23/msMPTs.png) |\n| Captcha.FONT_8  | ![](https://s2.ax1x.com/2019/08/23/msMmXF.png) |\n| Captcha.FONT_9  | ![](https://s2.ax1x.com/2019/08/23/msMVpV.png) |\n| Captcha.FONT_10 | ![](https://s2.ax1x.com/2019/08/23/msMZlT.png) |\n\n使用方法：\n```\nSpecCaptcha captcha = new SpecCaptcha(130, 48, 5);\n\n// 设置内置字体\ncaptcha.setFont(Captcha.FONT_1); \n\n// 设置系统字体\ncaptcha.setFont(new Font(\"楷体\", Font.PLAIN, 28)); \n```\n\n### 5.4.输出base64编码\n```\nSpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);\nspecCaptcha.toBase64();\n\n// 如果不想要base64的头部data:image/png;base64,\nspecCaptcha.toBase64(\"\");  // 加一个空的参数即可\n```\n\n### 5.5.输出到文件\n```\nFileOutputStream outputStream = new FileOutputStream(new File(\"C:/captcha.png\"))\nSpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);\nspecCaptcha.out(outputStream);\n```\n\n---\n\n## 6.前后端分离项目的使用\n\n\u0026emsp;前后端分离项目建议不要存储在session中，存储在redis中，redis存储需要一个key，key一同返回给前端用于验证输入：\n```java\n@Controller\npublic class CaptchaController {\n    @Autowired\n    private RedisUtil redisUtil;\n    \n    @ResponseBody\n    @RequestMapping(\"/captcha\")\n    public JsonResult captcha(HttpServletRequest request, HttpServletResponse response) throws Exception {\n        SpecCaptcha specCaptcha = new SpecCaptcha(130, 48, 5);\n        String verCode = specCaptcha.text().toLowerCase();\n        String key = UUID.randomUUID().toString();\n        // 存入redis并设置过期时间为30分钟\n        redisUtil.setEx(key, verCode, 30, TimeUnit.MINUTES);\n        // 将key和base64返回给前端\n        return JsonResult.ok().put(\"key\", key).put(\"image\", specCaptcha.toBase64());\n    }\n    \n    @ResponseBody\n    @PostMapping(\"/login\")\n    public JsonResult login(String username,String password,String verCode,String verKey){\n        // 获取redis中的验证码\n        String redisCode = redisUtil.get(verKey);\n        // 判断验证码\n        if (verCode==null || !redisCode.equals(verCode.trim().toLowerCase())) {\n            return JsonResult.error(\"验证码不正确\");\n        }\n    }  \n}\n```\n前端使用ajax获取验证码：\n```html\n\u003cimg id=\"verImg\" width=\"130px\" height=\"48px\"/\u003e\n\n\u003cscript\u003e\n    var verKey;\n    // 获取验证码\n    $.get('/captcha', function(res) {\n        verKey = res.key;\n        $('#verImg').attr('src', res.image);\n    },'json');\n    \n    // 登录\n    $.post('/login', {\n        verKey: verKey,\n        verCode: '8u6h',\n        username: 'admin',\n        password: 'admin'\n    }, function(res) {\n        console.log(res);\n    }, 'json');\n\u003c/script\u003e\n```\n\n\u003e RedisUtil到这里获取[https://gitee.com/whvse/RedisUtil](https://gitee.com/whvse/RedisUtil)\n\n---\n\n## 7.自定义效果\n\n\u0026emsp;继承`Captcha`实现`out`方法，中文验证码可继承`ChineseCaptchaAbstract`，算术验证码可继承`ArithmeticCaptchaAbstract`。\n\n---\n\n## 8.致谢\n\n本项目 fork 源至EasyCaptcha ，  [ele-admin/EasyCaptcha](https://github.com/ele-admin/EasyCaptcha)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpig-mesh%2Feasy-captcha","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpig-mesh%2Feasy-captcha","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpig-mesh%2Feasy-captcha/lists"}