使用kaptcha框架来实现验证码

你的名字 2022-05-21 11:28 173阅读 0赞

kaptcha是一个开源项目，通过它可以很容易实现验证码功能。

只需要在项目Lib中导入：activation-1.1.jar、javaee-api-7.0.jar、javax.mail-1.5.0.jar和kaptcha-2.3.2.jar四个jar包，并且在项目web.xml文件中进行简单的配置即可。

详细内容见配置文件。

### 其中，比较重要的一点是：把验证码字符串传入session的属性中。需要在init-param中配置kaptcha.session.key参数，其值就是session中的存放验证码字符串的属性名。即：session.setAttribute("param-value的值",验证码). ###

需要注意：验证码的校验只能在Servlet中进行，在JSP页面进行会出现验证码慢一步对应不上的情况。

配置相关文件为：

Kaptcha是一个基于SimpleCaptcha的验证码开源项目。
    官网地址：http://code.google.com/p/kaptcha/
    
    kaptcha的使用比较方便，只需添加jar包依赖之后简单地配置就可以使用了。kaptcha所有配置都可以通过web.xml来完成，如果你的项目中使用了Spring MVC，那么则有另外的一种方式来实现。
    一、简单的jsp-servlet项目
    1.添加jar包依赖
    如果你使用maven来统一管理jar包，则在工程的pom.xml中添加dependency
    Xml代码  收藏代码
    
    <dependency>
        <groupId>com.google.code.kaptcha</groupId>
        <artifactId>kaptcha</artifactId>
        <version>2.3.2</version>
    </dependency>
    如果是非maven管理的项目，则直接在官网下载kaptcha的jar包，然后添加到项目lib库中，下载地址：http://code.google.com/p/kaptcha/downloads/list
    
    
    2.配置web.xml
    上面说了，kaptcha都是在web.xml中配置，我们必须在web.xml中配置kaptcha的servlet，具体如下：
    Xml代码  收藏代码
    <servlet>
        <servlet-name>Kaptcha</servlet-name>
        <servlet-class>com.google.code.kaptcha.servlet.KaptchaServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>Kaptcha</servlet-name>
        <url-pattern>/kaptcha.jpg</url-pattern>
    </servlet-mapping>
    其中servlet的url-pattern可以自定义。
    
    kaptcha所有的参数都有默认的配置，如果我们不显示配置的话，会采取默认的配置。
    如果要显示配置kaptcha，在配置kaptcha对应的Servlet时，在init-param增加响应的参数配置即可。示例如下：
    Xml代码  收藏代码
    <servlet>
        <servlet-name>Kaptcha</servlet-name>
        <servlet-class>com.google.code.kaptcha.servlet.KaptchaServlet</servlet-class>
        <init-param>
            <param-name>kaptcha.image.width</param-name>
            <param-value>200</param-value>
            <description>Width in pixels of the kaptcha image.</description>
        </init-param>
        <init-param>
            <param-name>kaptcha.image.height</param-name>
            <param-value>50</param-value>
            <description>Height in pixels of the kaptcha image.</description>
        </init-param>
        <init-param>
            <param-name>kaptcha.textproducer.char.length</param-name>
            <param-value>4</param-value>
            <description>The number of characters to display.</description>
        </init-param>
        <init-param>
            <param-name>kaptcha.noise.impl</param-name>
            <param-value>com.google.code.kaptcha.impl.NoNoise</param-value>
            <description>The noise producer.</description>
        </init-param>
    </servlet>
    具体的配置参数参见：http://code.google.com/p/kaptcha/wiki/ConfigParameters
    
    Constant	描述	默认值
    kaptcha.border	图片边框，合法值：yes , no	yes
    kaptcha.border.color	边框颜色，合法值： r,g,b (and optional alpha) 或者 white,black,blue.	black
    kaptcha.border.thickness	边框厚度，合法值：>0	1
    kaptcha.image.width	图片宽	200
    kaptcha.image.height	图片高	50
    kaptcha.producer.impl	图片实现类	com.google.code.kaptcha.impl.DefaultKaptcha
    kaptcha.textproducer.impl	文本实现类	com.google.code.kaptcha.text.impl.DefaultTextCreator
    kaptcha.textproducer.char.string	文本集合，验证码值从此集合中获取	abcde2345678gfynmnpwx
    kaptcha.textproducer.char.length	验证码长度	5
    kaptcha.textproducer.font.names	字体	Arial, Courier
    kaptcha.textproducer.font.size	字体大小	40
    kaptcha.textproducer.font.color	字体颜色，合法值： r,g,b  或者 white,black,blue.	black
    kaptcha.textproducer.char.space	文字间隔	2
    kaptcha.noise.impl	干扰实现类	com.google.code.kaptcha.impl.DefaultNoise
    kaptcha.noise.color	干扰颜色，合法值： r,g,b 或者 white,black,blue.	black
    kaptcha.obscurificator.impl	图片样式：
    水纹com.google.code.kaptcha.impl.WaterRipple
    鱼眼com.google.code.kaptcha.impl.FishEyeGimpy
    阴影com.google.code.kaptcha.impl.ShadowGimpy
    com.google.code.kaptcha.impl.WaterRipple
    kaptcha.background.impl	背景实现类	com.google.code.kaptcha.impl.DefaultBackground
    kaptcha.background.clear.from	背景颜色渐变，开始颜色	light grey
    kaptcha.background.clear.to	背景颜色渐变，结束颜色	white
    kaptcha.word.impl	文字渲染器
    com.google.code.kaptcha.text.impl.DefaultWordRenderer
    kaptcha.session.key	session key	KAPTCHA_SESSION_KEY
    kaptcha.session.date	session date	KAPTCHA_SESSION_DATE
    
    3.页面调用
    Html代码  收藏代码
    <form action="submit.action">
        <input type="text" name="kaptcha" value="" /><img src="kaptcha.jpg" />
    </form>
    
    
    
    
    
    4.在submit的action方法中进行验证码校验
    Java代码  收藏代码
    //从session中取出servlet生成的验证码text值
    String kaptchaExpected = (String)request.getSession().getAttribute(com.google.code.kaptcha.Constants.KAPTCHA_SESSION_KEY);
    //获取用户页面输入的验证码
    String kaptchaReceived = request.getParameter("kaptcha");
    //校验验证码是否正确
    if (kaptchaReceived == null || !kaptchaReceived.equalsIgnoreCase(kaptchaExpected)){
        setError("kaptcha", "Invalid validation code.");
    }
    注：确保JDK设置了 -Djava.awt.headless=true
    
    
    
    5.实现页面验证码刷新
    Html代码  收藏代码
    <img src="kaptcha.jpg" width="200" id="kaptchaImage" title="看不清，点击换一张" />
    <script type="text/javascript">
        $(function() {
            $('#kaptchaImage').click(function() {$(this).attr('src','kaptcha.jpg?' + Math.floor(Math.random() * 100));});
        });
    </script>
    <br /><small>看不清，点击换一张</small>