SpringBoot接入腾讯滑块验证

2022-07-05

SpringBoot接入腾讯滑块验证

依赖

1 2	// https://mvnrepository.com/artifact/com.tencentcloudapi/tencentcloud-sdk-java implementation group: 'com.tencentcloudapi', name: 'tencentcloud-sdk-java', version: '3.1.501'

配置

## 滑块验证码配置信息
tencent.captcha.secretId=xxxx
tencent.captcha.secretKey=xxxx
tencent.captcha.captchaType=9
tencent.captcha.captchaAppId=2066929924
tencent.captcha.appSecretKey=xxxxx

配置类

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

/**
 * @author 曳戈泰尔
 * @description 腾讯云图形验证码常量配置类
 * @since 2022-05-01
 */
@Configuration
@Data
@ConfigurationProperties(prefix = "tencent.captcha")
public class CaptchaConfig {

    // 云API秘钥ID
    @Value("secretId")
    private String secretId;

    // 云API秘钥Key
    @Value("secretKey")
    private String secretKey;

    // 验证码类型，使用时转为Long
    @Value("captchaType")
    private String captchaType;

    // 验证码应用 ID，使用时转为Long
    @Value("captchaAppId")
    private String captchaAppId;

    // 验证码应用密钥
    @Value("appSecretKey")
    private String appSecretKey;

}

获取请求IP工具类

import java.net.InetAddress;
import java.net.UnknownHostException;
import javax.servlet.http.HttpServletRequest;

/**
 * 获取IP方法
 * 
 * @author ruoyi
 */
public class IpUtils
{
    public static String getIpAddr(HttpServletRequest request)
    {
        if (request == null)
        {
            return "unknown";
        }
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("X-Forwarded-For");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("X-Real-IP");
        }

        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getRemoteAddr();
        }

        return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : ip;
    }

    public static boolean internalIp(String ip)
    {
        byte[] addr = textToNumericFormatV4(ip);
        return internalIp(addr) || "127.0.0.1".equals(ip);
    }

    private static boolean internalIp(byte[] addr)
    {
        if (StringUtils.isNull(addr) || addr.length < 2)
        {
            return true;
        }
        final byte b0 = addr[0];
        final byte b1 = addr[1];
        // 10.x.x.x/8
        final byte SECTION_1 = 0x0A;
        // 172.16.x.x/12
        final byte SECTION_2 = (byte) 0xAC;
        final byte SECTION_3 = (byte) 0x10;
        final byte SECTION_4 = (byte) 0x1F;
        // 192.168.x.x/16
        final byte SECTION_5 = (byte) 0xC0;
        final byte SECTION_6 = (byte) 0xA8;
        switch (b0)
        {
            case SECTION_1:
                return true;
            case SECTION_2:
                if (b1 >= SECTION_3 && b1 <= SECTION_4)
                {
                    return true;
                }
            case SECTION_5:
                switch (b1)
                {
                    case SECTION_6:
                        return true;
                }
            default:
                return false;
        }
    }

    /**
     * 将IPv4地址转换成字节
     * 
     * @param text IPv4地址
     * @return byte 字节
     */
    public static byte[] textToNumericFormatV4(String text)
    {
        if (text.length() == 0)
        {
            return null;
        }

        byte[] bytes = new byte[4];
        String[] elements = text.split("\\.", -1);
        try
        {
            long l;
            int i;
            switch (elements.length)
            {
                case 1:
                    l = Long.parseLong(elements[0]);
                    if ((l < 0L) || (l > 4294967295L)) {
                        return null;
                    }
                    bytes[0] = (byte) (int) (l >> 24 & 0xFF);
                    bytes[1] = (byte) (int) ((l & 0xFFFFFF) >> 16 & 0xFF);
                    bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 2:
                    l = Integer.parseInt(elements[0]);
                    if ((l < 0L) || (l > 255L)) {
                        return null;
                    }
                    bytes[0] = (byte) (int) (l & 0xFF);
                    l = Integer.parseInt(elements[1]);
                    if ((l < 0L) || (l > 16777215L)) {
                        return null;
                    }
                    bytes[1] = (byte) (int) (l >> 16 & 0xFF);
                    bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 3:
                    for (i = 0; i < 2; ++i)
                    {
                        l = Integer.parseInt(elements[i]);
                        if ((l < 0L) || (l > 255L)) {
                            return null;
                        }
                        bytes[i] = (byte) (int) (l & 0xFF);
                    }
                    l = Integer.parseInt(elements[2]);
                    if ((l < 0L) || (l > 65535L)) {
                        return null;
                    }
                    bytes[2] = (byte) (int) (l >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 4:
                    for (i = 0; i < 4; ++i)
                    {
                        l = Integer.parseInt(elements[i]);
                        if ((l < 0L) || (l > 255L)) {
                            return null;
                        }
                        bytes[i] = (byte) (int) (l & 0xFF);
                    }
                    break;
                default:
                    return null;
            }
        }
        catch (NumberFormatException e)
        {
            return null;
        }
        return bytes;
    }

    public static String getHostIp()
    {
        try
        {
            return InetAddress.getLocalHost().getHostAddress();
        }
        catch (UnknownHostException e)
        {
        }
        return "127.0.0.1";
    }

    public static String getHostName()
    {
        try
        {
            return InetAddress.getLocalHost().getHostName();
        }
        catch (UnknownHostException e)
        {
        }
        return "未知";
    }
}

输入类

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author 曳戈泰尔
 * @description 腾讯云图形验证码cmd实体
 * @since 2022-05-01
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class CaptchaCmd {

    // 前端验证成功的票据
    private String ticket;

    // 前端当次验证的随机串
    private String randStr;
}

测试类

import com.tencentcloudapi.captcha.v20190722.CaptchaClient;
import com.tencentcloudapi.captcha.v20190722.models.DescribeCaptchaResultRequest;
import com.tencentcloudapi.captcha.v20190722.models.DescribeCaptchaResultResponse;
import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
// 导入可选配置类
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

/**
 * @author 曳戈泰尔
 * @description 腾讯云图形验证码测试类
 * @since 2022-05-01
 */
@RestController
@RequestMapping("/test")
public class CaptchaTest {

    @Autowired
    private CaptchaConfig captchaConfig;

    // 验证码测试
    @PostMapping("/captcha")
    @CrossOrigin
    public DescribeCaptchaResultResponse test(CaptchaCmd captchaCmd, HttpServletRequest request) {
        try {
            // 实例化一个认证对象，入参需要传入腾讯云账户secretId，secretKey,此处还需注意密钥对的保密
            // 密钥可前往https://console.cloud.tencent.com/cam/capi网站进行获取
            Credential cred = new Credential(captchaConfig.getSecretId(), captchaConfig.getSecretKey());

            // 实例化一个http选项，可选的，没有特殊需求可以跳过
            HttpProfile httpProfile = new HttpProfile();
            httpProfile.setEndpoint("captcha.tencentcloudapi.com");

            // 实例化一个client选项，可选的，没有特殊需求可以跳过
            ClientProfile clientProfile = new ClientProfile();
            clientProfile.setHttpProfile(httpProfile);

            // 实例化要请求产品的client对象,clientProfile是可选的
            CaptchaClient client = new CaptchaClient(cred, "", clientProfile);

            // 实例化一个请求对象,每个接口都会对应一个request对象
            DescribeCaptchaResultRequest req = new DescribeCaptchaResultRequest();
            req.setCaptchaType(Long.valueOf(captchaConfig.getCaptchaType()));
            req.setTicket(captchaCmd.getTicket());
            req.setUserIp(IpUtils.getIpAddr(request));
            req.setRandstr(captchaCmd.getRandStr());
            req.setCaptchaAppId(Long.valueOf(captchaConfig.getCaptchaAppId()));
            req.setAppSecretKey(captchaConfig.getAppSecretKey());

            // 返回的resp是一个DescribeCaptchaResultResponse的实例，与请求对象对应
            DescribeCaptchaResultResponse resp = client.DescribeCaptchaResult(req);

            // 输出json格式的字符串回包
            System.out.println(DescribeCaptchaResultResponse.toJsonString(resp));

            return resp;
        } catch (TencentCloudSDKException e) {
            System.out.println("捕获到异常： " + e.toString());

            return null;
        }
    }
}

前端页面

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Web 前端接入示例</title>
    <!-- 验证码程序依赖(必须)。请勿修改以下程序依赖，如使用本地缓存，或通过其他手段规避加载，会影响程序的正常使用。 -->
    <script src="https://ssl.captcha.qq.com/TCaptcha.js"></script>
    <script src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
</head>

<body>
    <!--点击此元素会自动激活验证码, 此例使用的button元素, 也可以使用div、span等-->
    <!--id :            (不可变) 元素的 ID, 值必须是 "TencentCaptcha"-->
    <!--data-appid :    (必须) 验证码CaptchaAppId, 从腾讯云的验证码控制台中获取, 验证码控制台页面内【图形验证】>【验证列表】进行查看 。如果未新建验证，请根据业务需求选择适合的验证渠道、验证场景进行新建-->
    <!--data-cbfn :     (必须) 回调函数名, 函数名要与 data-cbfn 相同-->
    <!--data-biz-state :(可选) 业务自定义透传参数, 会在回调函数内获取到 （res.bizState）-->
    <button id="TencentCaptcha" data-appid="2066929924" data-cbfn="callbackName" data-biz-state="data-biz-state"
        type="button">验证</button>
</body>
<script>
    // 回调函数需要放在全局对象window下
    window.callbackName = function (res) {
        // 返回结果
        // ret         Int       验证结果，0：验证成功。2：用户主动关闭验证码。
        // ticket      String    验证成功的票据，当且仅当 ret = 0 时 ticket 有值。
        // CaptchaAppId       String    验证码应用ID。
        // bizState    Any       自定义透传参数。
        // randstr     String    本次验证的随机串，请求后台接口时需带上。
        console.log("callback:", res);
        // res（用户主动关闭验证码）= {ret: 2, ticket: null}
        // res（验证成功） = {ret: 0, ticket: "String", randstr: "String"}
        if (res.ret === 0) {
            // 复制结果至剪切板
            // let str = `【randstr】->【${res.randstr}】      【ticket】->【${res.ticket}】`

            console.log("开始请求后端验证");

            $.ajax({
                url: "http://127.0.0.1:8080/test/captcha",
                type: "post",
                data: {
                    ticket: res.ticket,
                    randStr: res.randstr
                },
                async: false,
                contentType: "application/x-www-form-urlencoded",
                success: function (res) {
                    console.log("请求成功");
                    console.log(res);
                    alert("验证" + res.captchaMsg);
                },
                fail: function (res) {
                    console.log("请求失败");
                    console.log(res);
                },
                error: function (res) {
                    console.log("请求错误");
                },
            });

            console.log("请求后端验证结束");

            // let ipt = document.createElement("input");
            // ipt.value = str;
            // document.body.appendChild(ipt);
            // ipt.select();
            // document.execCommand("Copy");
            // document.body.removeChild(ipt);
            // alert("1. 返回结果（randstr、ticket）已复制到剪切板，ctrl+v 查看。2. 打开浏览器控制台，查看完整返回结果。");
        }
    }
</script>

</html>