Skip to content

工具概览

Vben Admin 提供了丰富的工具类,分为前端工具和后端工具。

前端工具类(20 个)

数据处理

工具类说明链接
ExportUtilsExcel/CSV/JSON 导出查看
FormatUtils文件大小/数字/日期格式化查看
TreeUtils树形数据处理查看
ArrayUtils数组操作查看
ObjectUtils对象操作查看

安全加密

工具类说明链接
EncryptUtilsMD5/AES/SHA256/Base64查看
DesensitizeUtils数据脱敏查看
ValidationUtils数据验证查看

用户交互

工具类说明链接
ClipboardUtils剪贴板操作查看
FullscreenUtils全屏控制查看
PrintUtils打印功能查看
DownloadUtils文件下载查看

页面增强

工具类说明链接
WatermarkUtils水印功能查看
QRCodeUtils二维码生成查看
DomUtilsDOM 操作查看

存储和工具

工具类说明链接
StorageUtilslocalStorage/sessionStorage查看
UrlUtilsURL 参数处理查看
DeviceUtils设备检测查看
ColorUtils颜色处理查看
FunctionUtils防抖/节流查看

后端工具类(12 个)

文件处理

工具类说明链接
ExcelUtilsExcel 导入导出查看
FileDownloadUtils文件下载查看

数据安全

工具类说明链接
DesensitizeUtils数据脱敏查看
ValidationUtils数据验证查看

缓存和锁

工具类说明链接
CacheUtilsRedis 缓存查看
LockUtils分布式锁查看

通用工具

工具类说明链接
IpUtilsIP 处理查看
JsonUtilsJSON 处理查看
DateUtils日期处理查看
StringUtils字符串处理查看
CollectionUtils集合处理查看
BeanUtilsBean 处理查看

快速使用

前端工具

typescript
import { 
  ExportUtils, 
  ClipboardUtils, 
  EncryptUtils 
} from '@vben/utils'

// 导出 Excel
ExportUtils.exportExcel(data, '用户列表')

// 复制到剪贴板
await ClipboardUtils.copy('文本内容')

// MD5 加密
const hash = EncryptUtils.md5('password')

后端工具

java
import com.vben.common.utils.*;

// 导出 Excel
ExcelUtils.exportExcel(users, User.class, "用户列表", response);

// 数据脱敏
String phone = DesensitizeUtils.desensitize("13812341234", DesensitizeType.PHONE);

// 分布式锁
LockUtils.executeWithLock("order:" + userId, () -> {
    orderService.createOrder(order);
});

工具分类

按功能分类

数据处理

  • ExportUtils(前端/后端)
  • FormatUtils(前端)
  • TreeUtils(前端)
  • ArrayUtils(前端)
  • ObjectUtils(前端)
  • JsonUtils(后端)
  • DateUtils(后端)
  • StringUtils(后端)
  • CollectionUtils(后端)
  • BeanUtils(后端)

安全加密

  • EncryptUtils(前端)
  • DesensitizeUtils(前端/后端)
  • ValidationUtils(前端/后端)

文件操作

  • ExcelUtils(后端)
  • FileDownloadUtils(后端)
  • DownloadUtils(前端)
  • PrintUtils(前端)

用户交互

  • ClipboardUtils(前端)
  • FullscreenUtils(前端)
  • WatermarkUtils(前端)
  • QRCodeUtils(前端)

系统工具

  • CacheUtils(后端)
  • LockUtils(后端)
  • StorageUtils(前端)
  • IpUtils(后端)
  • UrlUtils(前端)
  • DeviceUtils(前端)
  • DomUtils(前端)
  • ColorUtils(前端)
  • FunctionUtils(前端)

使用建议

最佳实践

  1. 优先使用框架提供的工具类
  2. 避免重复造轮子
  3. 注意工具类的适用场景
  4. 合理处理异常情况
  5. 关注性能影响

注意事项

  1. 部分工具类需要特定环境支持
  2. 注意浏览器兼容性
  3. 大数据量操作要注意性能
  4. 敏感数据要做好安全防护

相关链接

MIT License