推荐:一个小而美的Java工具类库
前言
是的,你没看错,没看错,它就是 hutool !相信很多做java开发的朋友应该都已经认识并使用过它了,今天带大家再重温一下它都有哪些功能,并以示例来看看 hutool 是如何简便实现 JWT 认证的。关于JWT大家可以参考之前的文章。干货:JWT实现token认证详解
简介
Hutool是一个小而全的Java工具类库,通过静态方法封装,降低相关API的学习成本,提高工作效率,使Java拥有函数式语言般的优雅,让Java语言也可以“甜甜的”。它涵盖了Java开发底层代码中的方方面面,它既是大型项目开发中解决小问题的利器,也是小型项目中的效率担当。
Hutool是项目中“util”包友好的替代,它节省了开发人员对项目中公用类和公用工具方法的封装时间,使开发专注于业务,同时可以最大限度的避免封装不完善带来的bug。
名称的由来
Hutool = Hu + tool,是原公司项目底层代码剥离后的开源库,“Hu”是公司名称的表示,tool表示工具。Hutool谐音“糊涂”,一方面简洁易懂,一方面寓意“难得糊涂”。寓意追求“万事都作糊涂观,无所谓失,无所谓得”。
包含组件
一个Java基础工具类,对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装,组成各种Util工具类,同时提供以下组件:
模块 | 介绍 |
hutool-aop | JDK动态代理封装,提供非IOC下的切面支持 |
hutool-bloomFilter | 布隆过滤,提供一些Hash算法的布隆过滤 |
hutool-cache | 简单缓存实现 |
hutool-core | 核心,包括Bean操作、日期、各种Util等 |
hutool-cron | 定时任务模块,提供类Crontab表达式的定时任务 |
hutool-crypto | 加密解密模块,提供对称、非对称和摘要算法封装 |
hutool-db | JDBC封装后的数据操作,基于ActiveRecord思想 |
hutool-dfa | 基于DFA模型的多关键字查找 |
hutool-extra | 扩展模块,对第三方封装(模板引擎、邮件、Servlet、二维码、Emoji、FTP、分词等) |
hutool-http | 基于HttpUrlConnection的Http客户端封装 |
hutool-log | 自动识别日志实现的日志门面 |
hutool-script | 脚本执行封装,例如Javascript |
hutool-setting | 功能更强大的Setting配置文件和Properties封装 |
hutool-system | 系统参数调用封装(JVM信息等) |
hutool-json | JSON实现 |
hutool-captcha | 图片验证码实现 |
hutool-poi | 针对POI中Excel和Word的封装 |
hutool-socket | 基于Java的NIO和AIO的Socket封装 |
hutool-jwt | JSON Web Token (JWT)封装实现 |
JWT工具包
关于JWT的介绍,可以参考 干货:JWT实现token认证详解 ,整体结构是 header.payload.signature 三部分组成。
- pom.xml中加入hutool包
cn.hutool
hutool-all
5.7.4
- JWT创建、验证、解析
主要使用的方法JWTUtil.createToken、JWTUtil.verify、JWTValidator、JWTUtil.parseToken。详见API文档:
https://apidoc.gitee.com/dromara/hutool/
import cn.hutool.core.date.DateField;
import cn.hutool.core.date.DateTime;
import cn.hutool.core.util.IdUtil;
import cn.hutool.jwt.*;
import cn.hutool.jwt.signers.JWTSigner;
import cn.hutool.jwt.signers.JWTSignerUtil;
import com.google.common.collect.Maps;
import java.util.Map;
/**
* @description: hutool jwt验证
* @author:八零后锁话
* @date: 2022-04-09 3:15 下午
*/
public class JwtTest {
/**
* 设置 token 过期时间
*/
private static final int EXPIRES_TIME = 1;
/**
* Signature 签名
*/
private static final String JWT_SIGNATURE_KEY = "jwt_signature_key";
/**
* 测试方法
* @param args
*/
public static void main(String[] args) throws InterruptedException {
DateTime now = DateTime.now();
// 当前时间加10分钟,作为token的失效时间
DateTime expiresTime = now.offset(DateField.MILLISECOND, EXPIRES_TIME);
// header.payload.signature 中的payload部分
Map payload = Maps.newHashMap();
// 签发人
payload.put(JWTPayload.ISSUER, "签发人-八零后锁话");
// 主题
payload.put(JWTPayload.SUBJECT, "主题:Hutool的JWT工具");
// 受众
payload.put(JWTPayload.AUDIENCE, "受众");
// 签发时间,不能晚于当前时间
payload.put(JWTPayload.ISSUED_AT, now);
// 生效时间,不能晚于当前时间
payload.put(JWTPayload.NOT_BEFORE, now);
// 过期时间,必须要大于签发时间
payload.put(JWTPayload.EXPIRES_AT, expiresTime);
// 编号
payload.put(JWTPayload.JWT_ID, IdUtil.simpleUUID());
// 其他信息
payload.put("channelCode", "S2204");
// header.payload.signature 中的signature部分
JWTSigner signer = JWTSignerUtil.hs256(JWT_SIGNATURE_KEY.getBytes());
// JWT 创建
String jwtToken = JWTUtil.createToken(payload, signer);
System.out.println("jwt token is: " + jwtToken);
// JWT 验证token签名有效性
System.out.println(new JWTUtil().verify(jwtToken, signer));
// JWT 验证 算法签名是否正确、时间过期
try {
JWTValidator.of(jwtToken).validateAlgorithm(JWTSignerUtil.hs256(JWT_SIGNATURE_KEY.getBytes()));
JWTValidator.of(jwtToken).validateDate(DateTime.now());
} catch (Exception e) {
System.out.println("JWT token 验证失败");
return;
}
// JWT 解析
JWT jwt = new JWTUtil().parseToken(jwtToken);
JWTHeader jwtHeader = jwt.getHeader();
System.out.println(jwtHeader.getClaim(JWTHeader.ALGORITHM));
JWTPayload jwtPayload = jwt.getPayload();
System.out.println(jwtPayload.getClaim(JWTPayload.ISSUER));
}
}
hutool官方网站:http://www.hutool.cn/
hutool参考文档:
http://www.hutool.cn/docs/#/