1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/ramostear-Happy-Captcha

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
Внести вклад в разработку кода
Синхронизировать код
Отмена
Подсказка: Поскольку Git не поддерживает пустые директории, создание директории приведёт к созданию пустого файла .keep.
Loading...
README.md

Хэппи-Капча: использование, проверка и очистка

  • Использование:
    • Для получения Хэппи-Капчи пользователи Gradle могут использовать следующую конфигурацию:
      • 
        

implementation 'com.ramostear:Happy-Captcha:1.0.1'

    * В случае использования по умолчанию, для генерации красивой картинки с капчей достаточно написать одну строку кода. Пример использования:
        * ```java
@Controller
public class HappyCaptchaController{
    @GetMapping("/captcha")
    public void happyCaptcha(HttpServletRequest request,HttpServletResponse response){
        HappyCaptcha.require(request,response).build().finish();
    }
}
  • Проверка:
    • Проверка введённого пользователем кода является обязательным этапом. Хэппи-Капча имеет встроенную функцию проверки введённого кода. Пример проверки:
      • 
        

@Controller public class CaptchaController{

@PostMapping("/verify")
public String verify(String code,HttpServletRequest request){
    //Verification Captcha
    boolean flag = HappyCaptcha.verification(request,code,true);
    if(flag){
        //Other operations...
    }
}

}

    * Если необходимо игнорировать регистр букв при проверке, третий параметр должен быть установлен в true. Если требуется строгая проверка, установите значение false.
* **Очистка:**
    * После использования можно удалить сессию с помощью метода remove() класса HappyCaptcha. Пример очистки:
        * ```java
@Controller
public class HappyCaptchaController{
    
    @GetMapping("/remove/captcha")
    public void removeCaptcha(HttpServletRequest request){
        HappyCaptcha.remove(request);   
    }
}
* Помимо предоставленного метода, можно также вручную очистить сессию в нужном месте. Ключ капчи — «happy-captcha».
  • Дополнительные функции:
    • 6.1 style():
      • Хэппи-Капча предоставляет два вида представления капчи: картинка и анимация. По умолчанию используется картинка, которую можно изменить с помощью метода style(). Значения предоставляются классом CaptchaStyle и включают IMG и ANIM. Пример использования style():
        • 
          

HappyCaptcha.require(request,response) .style(CaptchaStyle.ANIM) .build().finish();

        * Если используется картинка, style(CaptchaStyle.IMG) можно опустить.
    * **6.2 type():**
        * Всего доступно 12 типов капчи, и вы можете выбрать любой из них. По умолчанию капча использует смешанные цифры и буквы. Значения предоставляются классом CaptchaType.
        | Значение | Описание |
        | --- | --- |
        | DEFAULT | Смешанные цифры и буквы |
        | ARITHMETIC | Выражение арифметической операции |
        | ARITHMETIC_ZH | Описание арифметической операции на китайском языке |
        | CHINESE | Случайный набор распространённых китайских иероглифов (3500) |
        | NUMBER | Случайное сочетание цифр от 0 до 9 |
        | NUMBER_ZH_CN | Случайное сочетание китайских цифр (от 零 до 九) |
        | NUMBER_ZH_HK | Случайное сочетание гонконгских цифр (от 零 до 玖) |
        | WORD | Случайная комбинация больших и маленьких букв |
        | WORD_LOWER | Случайная комбинация маленьких букв |
        | WORD_UPPER | Случайная комбинация заглавных букв |
        | WORD_NUMBER_LOWER | Сочетание цифр и маленьких букв |
        | WORD_NUMBER_UPPER | Сочетание цифр и заглавных букв |
    * Пример использования type():
        * ```java
HappyCaptcha.require(request,response)
            .type(CaptchaType.CHINESE)
            .build().finish();
* **6.3 length():**
    * Метод length() используется для установки длины символов в капчах. По умолчанию длина равна 5. Пример использования length():
        * ```java

HappyCaptcha.require(request,response) .length(6) .build().finish();

    * **6.4 width():**
        * Ширина капчи может быть настроена с помощью width(). По умолчанию ширина равна 160. Пример использования width():
            * ```java
HappyCaptcha.require(request,response)
            .width(180)
            .build().finish();
* **6.5 height():**
    * Высота капчи настраивается с помощью height(). По умолчанию высота равна 50. Пример использования height():
        * ```java

HappyCaptcha.require(request,response) .height(60) .build().finish();

    *  **6.6 font():**
        * Чтобы изменить шрифт капчи, используйте метод font(). По умолчанию используется шрифт Microsoft YaHei. В Хэппи-Каптче есть четыре встроенных шрифта, которые можно вызвать через класс Fonts. Пример использования font():
            * ```java
HappyCaptcha.require(request,response)
            .font(Fonts.getInstance().zhFont())
            .build().finish();
* **6.7 Цепочка вызовов:**
    * Можно одновременно настроить несколько свойств капчи. Например:
        * ```java

@GetMapping("/captcha") public void captcha(HttpServletRequest req,HttpServletResponse res){ HappyCaptcha.require(req,res) .style(CaptchaStyle.ANIM) //Установить стиль отображения как анимацию .type(CaptchaType.CHINESE) //Установить содержимое капчи как китайские иероглифы .length(6) //Установить длину символов равной 6 .width(220)

Комментарии ( 0 )

Вы можете оставить комментарий после Вход в систему

Введение

Описание недоступно Развернуть Свернуть
Apache-2.0
Отмена

Обновления (1)

все

Участники

все

Недавние действия

Загрузить больше
Больше нет результатов для загрузки
1
https://api.gitlife.ru/oschina-mirror/ramostear-Happy-Captcha.git
git@api.gitlife.ru:oschina-mirror/ramostear-Happy-Captcha.git
oschina-mirror
ramostear-Happy-Captcha
ramostear-Happy-Captcha
master