Hutool Hutool
首页
指南
  • 核心(Hutool-core)
  • 配置文件(Hutool-setting)
  • 日志(Hutool-log)
  • 缓存(Hutool-cache)
  • JSON(Hutool-json)
  • 加密解密(Hutool-crypto)
  • DFA查找(Hutool-dfa)
  • 数据库(Hutool-db)
  • HTTP客户端(Hutool-http)
  • 定时任务(Hutool-cron)
  • 扩展(Hutool-extra)
  • 布隆过滤(Hutool-bloomFilter)
  • 切面(Hutool-aop)
  • 脚本(Hutool-script)
  • Office文档操作(Hutool-poi)
  • 系统调用(Hutool-system)
  • 图形验证码(Hutool-captcha)
  • 网络Socket(Hutool-socket)
  • JWT(Hutool-jwt)
支持
更新记录 (opens new window)
GitHub (opens new window)
首页
指南
  • 核心(Hutool-core)
  • 配置文件(Hutool-setting)
  • 日志(Hutool-log)
  • 缓存(Hutool-cache)
  • JSON(Hutool-json)
  • 加密解密(Hutool-crypto)
  • DFA查找(Hutool-dfa)
  • 数据库(Hutool-db)
  • HTTP客户端(Hutool-http)
  • 定时任务(Hutool-cron)
  • 扩展(Hutool-extra)
  • 布隆过滤(Hutool-bloomFilter)
  • 切面(Hutool-aop)
  • 脚本(Hutool-script)
  • Office文档操作(Hutool-poi)
  • 系统调用(Hutool-system)
  • 图形验证码(Hutool-captcha)
  • 网络Socket(Hutool-socket)
  • JWT(Hutool-jwt)
支持
更新记录 (opens new window)
GitHub (opens new window)
  • 快速入门

    • 简介
  • 核心(Hutool-core)

    • 克隆

      • 支持泛型的克隆接口和克隆类
    • 类型转换

      • 类型转换工具类-Convert
      • 自定义类型转换-ConverterRegistry
    • 日期时间

      • 概述
      • 日期时间工具-DateUtil
      • 日期时间对象-DateTime
      • 农历日期-ChineseDate
      • LocalDateTime工具-LocalDateTimeUtil
      • 计时器工具-TimeInterval
    • IO流相关

      • 概述
      • IO工具类-IoUtil
      • 文件工具类-FileUtil
      • 文件监听-WatchMonitor
      • 文件类型判断-FileTypeUtil
      • 文件

        • 文件读取-FileReader
        • 文件写入-FileWriter
        • 文件追加-FileAppender
        • 文件跟随-Tailer
        • 文件名工具-FileNameUtil
      • 资源

        • 概述
        • 资源工具-ResourceUtil
        • ClassPath资源访问-ClassPathResource
    • 工具类

      • 概述
      • 字符串工具-StrUtil
      • 16进制工具-HexUtil
      • Escape工具-EscapeUtil
      • Hash算法-HashUtil
      • URL工具-URLUtil
      • XML工具-XmlUtil
      • 对象工具-ObjectUtil
      • 反射工具-ReflectUtil
      • 泛型类型工具-TypeUtil
      • 分页工具-PageUtil
      • 剪贴板工具-ClipboardUtil
      • 类工具-ClassUtil
      • 枚举工具-EnumUtil
      • 命令行工具-RuntimeUtil
      • 数字工具-NumberUtil
      • 数组工具-ArrayUtil
      • 随机工具-RandomUtil
      • 唯一ID工具-IdUtil
      • 压缩工具-ZipUtil
      • 引用工具-ReferenceUtil
      • 正则工具-ReUtil
      • 身份证工具-IdcardUtil
      • 信息脱敏工具-DesensitizedUtil
      • 社会信用代码工具-CreditCodeUtil
      • SPI加载工具-ServiceLoaderUtil
      • 字符编码工具-CharsetUtil
      • 类加载工具-ClassLoaderUtil
    • 语言特性

      • 概述
      • HashMap扩展-Dict
      • 单例工具-Singleton
      • 断言-Assert
      • 二进码十进数-BCD
      • 控制台打印封装-Console
      • 字段验证器-Validator
      • 字符串格式化-StrFormatter
      • 树结构

        • 树结构工具-TreeUtil
    • JavaBean

      • 概述
      • Bean工具-BeanUtil
      • DynaBean
      • 表达式解析-BeanPath
      • Bean描述-BeanDesc
      • 空检查属性获取-Opt
    • 集合类

      • 概述
      • 集合工具-CollUtil
      • 列表工具-ListUtil
      • Iterator工具-IterUtil
      • 有界优先队列-BoundedPriorityQueue
      • 线程安全的HashSet-ConcurrentHashSet
      • 集合串行流工具-CollStreamUtil
      • 行遍历器-LineIter
    • Map

      • 概述
      • Map工具-MapUtil
      • 双向查找Map-BiMap
      • 可重复键值Map-TableMap
      • Map流式构建器-MapBuilder copy
    • Codec编码

      • Base62编码解码-Base62
      • Base64编码解码-Base64
      • Base32编码解码-Base32
      • 莫尔斯电码-Morse
      • BCD码-BCD
      • 回转N位密码-Rot
      • Punycode实现-PunyCode
    • 文本操作

      • CSV文件处理工具-CsvUtil
      • Unicode编码转换工具-UnicodeUtil
      • 可复用字符串生成器-StrBuilder
      • 字符串切割-StrSplitter
    • 注解

      • 注解工具-AnnotationUtil
    • 比较器

      • 概述
      • 比较工具-CompareUtil
      • 版本比较器-VersionComparator
    • 异常

      • 异常工具-ExceptionUtil
      • 其它异常封装
    • 数学

      • 数学相关-MathUtil
    • 线程和并发

      • 线程工具-ThreadUtil
      • 异步工具类-AsyncUtil
      • 自定义线程池-ExecutorBuilder
      • 高并发测试-ConcurrencyTester
    • 图片

      • 图片工具-ImgUtil
      • 图片编辑器-Img
    • 网络

      • 网络工具-NetUtil
      • URL生成器-UrlBuilder
    • 源码编译

      • 源码编译工具-CompilerUtil
  • 配置文件(Hutool-setting)

    • 概述
    • Properties扩展-Props
    • 设置文件-Setting
  • 日志(Hutool-log)

    • 概述
    • 日志工厂-LogFactory
    • 疑惑解答
    • 静态调用日志-StaticLog
  • 缓存(Hutool-cache)

    • 概述
    • 缓存工具-CacheUtil
    • 先入先出-FIFOCache
    • 文件缓存-FileCache
    • 最少使用-LFUCache
    • 最近最久未使用-LRUCache
    • 超时-TimedCache
    • 弱引用-WeakCache
  • JSON(Hutool-json)

    • 概述
    • JSON工具-JSONUtil
    • JSON对象-JSONObject
    • JSON数组-JSONArray
  • 加密解密(Hutool-crypto)

    • 概述
    • 加密解密工具-SecureUtil
    • 国密算法工具-SmUtil
    • 对称加密-SymmetricCrypto
    • 摘要加密-Digester
    • 消息认证码算法-HMac
    • 签名和验证-Sign
    • 非对称加密-AsymmetricCrypto
  • DFA查找(Hutool-dfa)

    • 概述
    • DFA查找
  • 数据库(Hutool-db)

    • 概述
    • SQL执行器-SqlExecutor
    • 支持事务的CRUD-Session
    • 数据库简单操作-Db
    • 数据源工厂-DsFactory
    • 数据源配置db.setting样例
    • 案例1-导出Blob字段图像
    • 常见问题
    • NoSQL

      • Redis客户端封装-RedisDS
      • MongoDB客户端封装-MongoDS
  • HTTP客户端(Hutool-http)

    • 概述
    • Http客户端工具类-HttpUtil
      • 概述
      • 使用
        • 请求普通页面
        • 文件上传
        • 下载文件
        • 更多有用的工具方法
        • 更多请求参数
    • HTML工具类-HtmlUtil
    • Http响应-HttpResponse
    • Http请求-HttpRequest
    • UA工具类-UserAgentUtil
    • 常用Http状态码-HttpStatus
    • 案例1-爬取开源中国的开源资讯
    • 常见问题
    • Server

      • 简易Http服务器-SimpleServer
    • WebService

      • Soap客户端-SoapClient
  • 定时任务(Hutool-cron)

    • 概述
    • 全局定时任务-CronUtil
  • 扩展(Hutool-extra)

    • 概述
    • Servlet工具-ServletUtil
    • 二维码工具-QrCodeUtil
    • 邮件工具-MailUtil
    • cglib

      • Cglib工具-CglibUtil
    • emoji

      • Emoji工具-EmojiUtil
    • FTP

      • FTP客户端封装-Ftp
      • 简易FTP服务器-SimpleFtpServer
    • Jsch封装

      • SFTP封装-Sftp
      • Jsch工具-JschUtil
    • Spring

      • Spring工具-SpringUtil
    • 中文分词

      • 中文分词封装-TokenizerUtil
    • 压缩

      • 压缩封装-CompressUtil
    • 拼音

      • 拼音工具-PinyinUtil
    • 表达式引擎

      • 表达式引擎封装-ExpressionUtil
    • 模板引擎

      • 模板引擎封装-TemplateUtil
  • 布隆过滤(Hutool-bloomFilter)

    • 概述
  • 切面(Hutool-aop)

    • 概述
    • 切面代理工具-ProxyUtil
  • 脚本(Hutool-script)

    • 概述
    • Script工具-ScriptUtil
  • Office文档操作(Hutool-poi)

    • 概述
    • Excel工具-ExcelUtil
    • Excel生成-ExcelWriter
    • Excel大数据生成-BigExcelWriter
    • Excel读取-ExcelReader
    • Word生成-Word07Writer
    • 流方式读取Excel2003-Excel03SaxReader
    • 流方式读取Excel2007-Excel07SaxReader
  • 系统调用(Hutool-system)

    • 系统属性调用-SystemUtil
    • Oshi封装-OshiUtil
  • 图形验证码(Hutool-captcha)

    • 概述
  • 网络Socket(Hutool-socket)

    • 概述
    • AIO封装-AioServer和AioClient
    • NIO封装-NioServer和NioClient
  • JWT(Hutool-jwt)

    • 概述
    • JWT工具-JWTUtil
    • JWT签名工具-JWTSignerUtil
    • JWT验证-JWTValidator
  • 指南
  • HTTP客户端(Hutool-http)
Hutool
2023-03-28
目录

Http客户端工具类-HttpUtil

特别赞助 by:

# 概述

HttpUtil是应对简单场景下Http请求的工具类封装,此工具封装了HttpRequest对象常用操作,可以保证在一个方法之内完成Http请求。

此模块基于JDK的HttpUrlConnection封装完成,完整支持https、代理和文件上传。

# 使用

# 请求普通页面

针对最为常用的GET和POST请求,HttpUtil封装了两个方法,

  • HttpUtil.get
  • HttpUtil.post

这两个方法用于请求普通页面,然后返回页面内容的字符串,同时提供一些重载方法用于指定请求参数(指定参数支持File对象,可实现文件上传,当然仅仅针对POST请求)。

GET请求栗子:

// 最简单的HTTP请求,可以自动通过header等信息判断编码,不区分HTTP和HTTPS
String result1= HttpUtil.get("https://www.baidu.com");

// 当无法识别页面编码的时候,可以自定义请求页面的编码
String result2= HttpUtil.get("https://www.baidu.com", CharsetUtil.CHARSET_UTF_8);

//可以单独传入http参数,这样参数会自动做URL编码,拼接在URL中
HashMap<String, Object> paramMap = new HashMap<>();
paramMap.put("city", "北京");

String result3= HttpUtil.get("https://www.baidu.com", paramMap);

POST请求例子:

HashMap<String, Object> paramMap = new HashMap<>();
paramMap.put("city", "北京");

String result= HttpUtil.post("https://www.baidu.com", paramMap);

# 文件上传

HashMap<String, Object> paramMap = new HashMap<>();
//文件上传只需将参数中的键指定(默认file),值设为文件对象即可,对于使用者来说,文件上传与普通表单提交并无区别
paramMap.put("file", FileUtil.file("D:\\face.jpg"));

String result= HttpUtil.post("https://www.baidu.com", paramMap);

# 下载文件

因为Hutool-http机制问题,请求页面返回结果是一次性解析为byte[]的,如果请求URL返回结果太大(比如文件下载),那内存会爆掉,因此针对文件下载HttpUtil单独做了封装。文件下载在面对大文件时采用流的方式读写,内存中只是保留一定量的缓存,然后分块写入硬盘,因此大文件情况下不会对内存有压力。

String fileUrl = "http://mirrors.sohu.com/centos/8.4.2105/isos/x86_64/CentOS-8.4.2105-x86_64-dvd1.iso";

//将文件下载后保存在E盘,返回结果为下载文件大小
long size = HttpUtil.downloadFile(fileUrl, FileUtil.file("e:/"));
System.out.println("Download size: " + size);

当然,如果我们想感知下载进度,还可以使用另一个重载方法回调感知下载进度:

//带进度显示的文件下载
HttpUtil.downloadFile(fileUrl, FileUtil.file("e:/"), new StreamProgress(){
	
	@Override
	public void start() {
		Console.log("开始下载。。。。");
	}
	
	@Override
	public void progress(long progressSize) {
		Console.log("已下载:{}", FileUtil.readableFileSize(progressSize));
	}
	
	@Override
	public void finish() {
		Console.log("下载完成!");
	}
});

StreamProgress接口实现后可以感知下载过程中的各个阶段。

当然,工具类提供了一个更加抽象的方法:HttpUtil.download,此方法会请求URL,将返回内容写入到指定的OutputStream中。使用这个方法,可以更加灵活的将HTTP内容转换写出,以适应更多场景。

# 更多有用的工具方法

  • HttpUtil.encodeParams 对URL参数做编码,只编码键和值,提供的值可以是url附带参数,但是不能只是url
  • HttpUtil.toParams和HttpUtil.decodeParams 两个方法是将Map参数转为URL参数字符串和将URL参数字符串转为Map对象
  • HttpUtil.urlWithForm是将URL字符串和Map参数拼接为GET请求所用的完整字符串使用
  • HttpUtil.getMimeType 根据文件扩展名快速获取其MimeType(参数也可以是完整文件路径)

# 更多请求参数

如果想设置头信息、超时、代理等信息,请见下一章节《Http客户端-HttpRequest》。

上次更新: 2023/05/08, 01:55:50
概述
HTML工具类-HtmlUtil

← 概述 HTML工具类-HtmlUtil→

Theme by Vdoing | Copyright © 2023-2023 Hutool | MulanPSL-2.0
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式