Wicket Kaptcha統合の例

Wicket + Kaptcha統合の例

Kaptchaはシンプルで使いやすいJavaライブラリで、キャプチャ画像の検証を生成します。 このチュートリアルでは、integrate Kaptcha with Wicket framework, via Springを実行する方法を示します。

使用されるライブラリ:

  1. Kaptcha v2.3.2

  2. Wicket v1.4.17

  3. wicket-spring v1.4.17

  4. Spring v3.0.5.RELEASE

Note
この記事では、主にKaptchaをWicketフレームワークと統合する方法について説明します。Wicket+ Springの場合は、この「Wicket + Spring integration example」を参照してください。

1. カプチャを入手

このthreadによると、所有者はMavenが気に入らないため、ライブラリをローカルのMavenリポジトリに手動でインストールする必要があります。

1. ここでKaptchaライブラリを取得しますhttp://code.google.com/p/kaptcha/
2。 以下のMavenコマンドを発行して、手動でインストールします。

mvn install:install-file -Dfile=c:\kaptcha-2.3.2.jar -DgroupId=com.google.code
    -DartifactId=kaptcha -Dversion=2.3.2 -Dpackaging=jar

3. 後で、pom.xmlファイルにkaptchaを含めることができます。

ファイル:pom.xml

    
        com.google.code
        kaptcha
        2.3.2
    

2. Spring経由のDefaultKaptcha

captchaProducerという名前の「DefaultKaptcha」のSpringBeanを作成します。

ファイル:applicationContext.xml



    
        
            
                
                
            
        
    

3. CaptchaImage

WicketのNonCachingImageを拡張するCaptchaImageクラスを作成し、DynamicImageResourceクラスを使用してキャプチャ画像を動的に生成します。

ファイル:CaptchaImage.java

package com.example.user;

import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.Request;
import org.apache.wicket.RequestCycle;
import org.apache.wicket.markup.html.image.NonCachingImage;
import org.apache.wicket.markup.html.image.resource.DynamicImageResource;
import org.apache.wicket.protocol.http.WebRequest;
import org.apache.wicket.spring.injection.annot.SpringBean;
import com.google.code.kaptcha.Constants;
import com.google.code.kaptcha.impl.DefaultKaptcha;
import com.sun.image.codec.jpeg.JPEGCodec;
import com.sun.image.codec.jpeg.JPEGImageEncoder;

public class CaptchaImage extends NonCachingImage {

    private static final String CAPTCHA_PRODUCER = "captchaProducer";

    // inject via Spring
    @SpringBean
    private DefaultKaptcha captchaProducer;

    // private DefaultKaptcha captchaProducer;
    public CaptchaImage(String id) {
        super(id);

        setImageResource(new DynamicImageResource() {

            public byte[] getImageData() {
                ByteArrayOutputStream os = new ByteArrayOutputStream();

                JPEGImageEncoder encoder = JPEGCodec.createJPEGEncoder(os);

                try {
                    BufferedImage bi = getImageCaptchaService();
                    encoder.encode(bi);
                    return os.toByteArray();
                } catch (Exception e) {
                    throw new RuntimeException(e);
                }

            };

            private BufferedImage getImageCaptchaService() {

                Request request = RequestCycle.get().getRequest();
                HttpServletRequest httpRequest = ((WebRequest) request)
                        .getHttpServletRequest();

                String capText = captchaProducer.createText();

                // store the text in the session
                httpRequest.getSession().setAttribute(
                        Constants.KAPTCHA_SESSION_KEY, capText);

                // create the image with the text
                BufferedImage bi = captchaProducer.createImage(capText);

                return bi;

            }
        });

    }
}

4. CaptchaValidator

CaptchaValidator」という名前のカスタムバリデーターを作成し、ユーザー入力を検証して、Kaptchaで生成されたコードと比較するために使用します。

ファイル:CaptchaValidator.java

package com.example.user;

import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.Request;
import org.apache.wicket.RequestCycle;
import org.apache.wicket.protocol.http.WebRequest;
import org.apache.wicket.validation.IValidatable;
import org.apache.wicket.validation.validator.AbstractValidator;

public class CaptchaValidator extends AbstractValidator {

    private static final long serialVersionUID = 1L;
    private String INVALID_CODE = "captcha.invalid";

    public void onValidate(IValidatable validatable) {
        String kaptchaReceived = (String) validatable.getValue();

        Request request = RequestCycle.get().getRequest();
        HttpServletRequest httpRequest = ((WebRequest) request)
                .getHttpServletRequest();

        String kaptchaExpected = (String) httpRequest.getSession()
            .getAttribute(com.google.code.kaptcha.Constants.KAPTCHA_SESSION_KEY);

        if (kaptchaReceived == null
                || !kaptchaReceived.equalsIgnoreCase(kaptchaExpected)) {
            error(validatable);
        }

    }

    // validate on numm value as well
    @Override
    public boolean validateOnNullValue() {

        return true;

    }

    @Override
    protected String resourceKey() {
        return INVALID_CODE;
    }
}

ファイル:package.properties

captcha.invalid = Incorrect answer, type words in image again!

5. 改札コンポーネント

KaptchaをWicketコンポーネントと統合します。

package com.example.user;

import org.apache.wicket.PageParameters;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.markup.html.AjaxFallbackLink;
import org.apache.wicket.markup.html.form.Form;
import org.apache.wicket.markup.html.form.TextField;
import org.apache.wicket.markup.html.panel.FeedbackPanel;
import org.apache.wicket.markup.html.WebPage;
import org.apache.wicket.model.PropertyModel;

public class KaptchaPage extends WebPage {

    private String captchaInput;

    public KaptchaPage(final PageParameters parameters) {

        final CaptchaImage captchaImage = new CaptchaImage("kaptchaImage");
        captchaImage.setOutputMarkupId(true);

        TextField captchaTF = new TextField("captcha",
                new PropertyModel(this, "captchaInput"));
        captchaTF.add(new CaptchaValidator());

        Form form = new Form("form") {
            @Override
            protected void onSubmit() {

                info("Image words are correct!!!");
            };
        };

        form.add(new AjaxFallbackLink("link") {
            @Override
            public void onClick(final AjaxRequestTarget target) {

                captchaImage.detach();

                if (target != null) {
                    target.addComponent(captchaImage);
                } else {
                    // javascript is disable
                }
            }
        }.add(captchaImage));

        form.add(captchaTF);
        add(form);
        add(new FeedbackPanel("feedback"));
    }

}

Note
captchaImage.detach();を使用すると、ユーザーがキャプチャ画像をクリックしているときに、新しいキャプチャ画像を動的に生成できます。







    

Wicket + Kaptcha integration example


6. Demo

入力が正しくない場合:

wicket kaptcha

入力が正しい場合:

wicket kaptcha

ダウンロード–Wicket-Kaptcha-Integration-Example.zip(10 KB)