hutool工具类常用API整理

• 2022 年 4 月 12 日
• 笔记
• JavaSE

0、官网学习地址

• //www.hutool.cn/

1、依赖

	<dependency>
		 <groupId>cn.hutool</groupId>
		 <artifactId>hutool-all</artifactId>
		 <version>${hutool.version}</version>
	</dependency>

2、工具集

2.1、convert

• 此工具用于于各种类型数据的转换

	// 转换为字符串
	int a = 1;
	String aStr = Convert.toStr(a);

	// 转换为指定类型数组
	String[] b = {"1", "2", "3", "4"};
	Integer[] bArr = Convert.toIntArray(b);

	// 转换为日期对象
	String dateStr = "2017-05-06";
	Date date = Convert.toDate(dateStr);

	// 转换为列表
	String[] strArr = {"a", "b", "c", "d"};
	List<String> strList = Convert.toList(String.class, strArr);

2.2、DataUtil

• 此工具定义了一些操作日期的方法: Date、long、Calendar之间的相互转换

	// 当前时间
	Date date = DateUtil.date();

	// Calendar转Date
	date = DateUtil.date(Calendar.getInstance());

	// 时间戳转Date
	date = DateUtil.date(System.currentTimeMillis());
	// 自动识别格式转换
	String dateStr = "2017-03-01";
	date = DateUtil.parse(dateStr);

	// 自定义格式化转换
	date = DateUtil.parse(dateStr, "yyyy-MM-dd");

	// 格式化输出日期
	String format = DateUtil.format(date, "yyyy-MM-dd");

	// 获得年的部分
	int year = DateUtil.year(date);

	// 获得月份，从0开始计数
	int month = DateUtil.month(date);

	// 获取某天的开始、结束时间
	Date beginOfDay = DateUtil.beginOfDay(date);
	Date endOfDay = DateUtil.endOfDay(date);

	// 计算偏移后的日期时间
	Date newDate = DateUtil.offset(date, DateField.DAY_OF_MONTH, 2);

	// 计算日期时间之间的偏移量
	long betweenDay = DateUtil.between(date, newDate, DateUnit.DAY);

2.3、StrUtil

• 此工具定义了一些操作字符串的方法

	// 判断是否为空字符串
	String str = "test";
	StrUtil.isEmpty(str);
	StrUtil.isNotEmpty(str);

	// 去除字符串的前后缀
	StrUtil.removeSuffix("a.jpg", ".jpg");
	StrUtil.removePrefix("a.jpg", "a.");

	// 格式化字符串
	String template = "这只是个占位符:{}";
	String str2 = StrUtil.format(template, "我是占位符");
	LOGGER.info("/strUtil format:{}", str2);

2.4、ClassPathResource

• 此工具是获取ClassPath下的文件，在Tomcat等容器中，ClassPath一般为：WEB-INFO/classes

	// 获取定义在src/main/resources文件夹中的配置文件
	ClassPathResource resource = new ClassPathResource("generator.properties");
	Properties properties = new Properties();
	properties.load(resource.getStream());
	LOGGER.info("/classPath:{}", properties);

2.5、ReflectUtil

• 此工具是为了反射获取类的方法及创建对象

	// 获取某个类的所有方法
	Method[] methods = ReflectUtil.getMethods(PmsBrand.class);

	// 获取某个类的指定方法
	Method method = ReflectUtil.getMethod(PmsBrand.class, "getId");

	// 使用反射来创建对象
	PmsBrand pmsBrand = ReflectUtil.newInstance(PmsBrand.class);

	// 反射执行对象的方法
	ReflectUtil.invoke(pmsBrand, "setId", 1);

2.6、NumberUtil

• 此工具是用于各种类型数字的加减乘除操作及判断类型

	double n1 = 1.234;
	double n2 = 1.234;
	double result;

	// 对float、double、BigDecimal做加减乘除操作
	result = NumberUtil.add(n1, n2);
	result = NumberUtil.sub(n1, n2);
	result = NumberUtil.mul(n1, n2);
	result = NumberUtil.div(n1, n2);

	// 保留两位小数
	BigDecimal roundNum = NumberUtil.round(n1, 2);
	String n3 = "1.234";

	// 判断是否为数字、整数、浮点数
	NumberUtil.isNumber(n3);
	NumberUtil.isInteger(n3);
	NumberUtil.isDouble(n3);

2.7、BeanUtil

• 此工具是用于Map与JavaBean对象的互相转换以及对象属性的拷贝

	PmsBrand brand = new PmsBrand();
	brand.setId(1L);
	brand.setName("小米");
	brand.setShowStatus(0);

	// Bean转Map
	Map<String, Object> map = BeanUtil.beanToMap(brand);
	LOGGER.info("beanUtil bean to map:{}", map);

	// Map转Bean
	PmsBrand mapBrand = BeanUtil.mapToBean(map, PmsBrand.class, false);
	LOGGER.info("beanUtil map to bean:{}", mapBrand);

	// Bean属性拷贝
	PmsBrand copyBrand = new PmsBrand();
	BeanUtil.copyProperties(brand, copyBrand);
	LOGGER.info("beanUtil copy properties:{}", copyBrand);

2.8、CollUtil

• 此工具是集合的一些操作

	// 数组转换为列表
	String[] array = new String[]{"a", "b", "c", "d", "e"};
	List<String> list = CollUtil.newArrayList(array);

	// 数组转字符串时添加连接符号
	String joinStr = CollUtil.join(list, ",");
	LOGGER.info("collUtil join:{}", joinStr);

	// 将以连接符号分隔的字符串再转换为列表
	List<String> splitList = StrUtil.split(joinStr, ',');
	LOGGER.info("collUtil split:{}", splitList);

	// 创建新的Map、Set、List
	HashMap<Object, Object> newMap = CollUtil.newHashMap();
	HashSet<Object> newHashSet = CollUtil.newHashSet();
	ArrayList<Object> newList = CollUtil.newArrayList();

	// 判断列表是否为空
	CollUtil.isEmpty(list);

2.9、MapUtil

• 此工具可用于创建Map和判断Map是否为null

	// 将多个键值对加入到Map中
	Map<Object, Object> map = MapUtil.of(new String[][]{
		{"key1", "value1"},
		{"key2", "value2"},
		{"key3", "value3"}
	});

	// 判断Map是否为空
	MapUtil.isEmpty(map);
	MapUtil.isNotEmpty(map);

2.10、AnnotationUtil

• 此工具可用于获取注解和注解中指定的值

	// 获取指定类、方法、字段、构造器上的注解列表
	Annotation[] annotationList = AnnotationUtil.getAnnotations(HutoolController.class, false);
	LOGGER.info("annotationUtil annotations:{}", annotationList);

	// 获取指定类型注解
	Api api = AnnotationUtil.getAnnotation(HutoolController.class, Api.class);
	LOGGER.info("annotationUtil api value:{}", api.description());

	// 获取指定类型注解的值
	Object annotationValue = AnnotationUtil.getAnnotationValue(HutoolController.class, RequestMapping.class);

2.11、SecureUtil

• 此工具用于MD5加密

	// MD5加密
	String str = "123456";
	String md5Str = SecureUtil.md5(str);
	LOGGER.info("secureUtil md5:{}", md5Str);

2.12、CaptchaUtil

• 此工具用于生成图形验证码

	// 生成验证码图片
	LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(200, 100);
	try {
		request.getSession().setAttribute("CAPTCHA_KEY", lineCaptcha.getCode());
		response.setContentType("image/png");//告诉浏览器输出内容为图片
		response.setHeader("Pragma", "No-cache");//禁止浏览器缓存
		response.setHeader("Cache-Control", "no-cache");
		response.setDateHeader("Expire", 0);
		lineCaptcha.write(response.getOutputStream());
	} catch (IOException e) {
		e.printStackTrace();
	}