【Java基础】- HttpURLConnection详解

ゝ一世哀愁。 2023-10-12 11:56 75阅读 0赞

【Java基础】- HttpURLConnection详解

文章目录

  • 【Java基础】- HttpURLConnection详解
      • 一、HttpURLConnection简述
      • 二、HttpURLConnection使用步骤
      • 三、HttpURLConnection使用的方法
        • 设置连接参数方法
        • 设置请求头或响应体
        • 发送URL请求
        • 获取响应
        • 相应的信息头用以下方法获取
      • 四、HttpURLConnection使用演示
        • Get方式
        • POST方式
      • 五、HttpURLConnection使用总结

一、HttpURLConnection简述

HttpURLConnection一个抽象类是标准的JAVA接口，该类位于java.net包中，它提供了基本的URL请求，响应等功能。

HttpURLConnection是基于http协议的，支持GET、POST、PUT、DELETE等各种请求方式。如果使用HTTPS协议请求，可以使用它的子类HttpsURLConnection完成更安全的请求操作。

二、HttpURLConnection使用步骤

  1. 创建一个URL对象：URL url=new URL(“接口地址”)

  2. 调用URL对象的openConnection()来获取HttpURLConnection对象实例；

    HttpURLConnection connection= (HttpURLConnection) url.openConnection();

  3. 设置HTTP请求使用的方法：GET、POST或其他请求；

    connection.setRequestMethod(“GET”);

  4. 设置连接超时，读取超时的毫秒数，以及服务器希望得到的一些消息头；

    connection.setConnectTimeout(6*1000);

    connection.setReadTimeout(6 * 1000);

  5. 调用getInputStream()方法获得服务器返回的输入流，然后输入流进行读取了；

    InputStream in = connection.getInputStream();

  6. 最后调用disconnect()方法将HTTP连接关掉；

    connection.disconnect();

三、HttpURLConnection使用的方法

  • 设置连接参数方法













































    编号 方法名 说明
    1 setAllowUserInteraction 如果为 true，则在允许用户交互（例如弹出一个身份验证对话框）的上下文中对此 URL 进行检查。
    2 setDoInput URL 连接可用于输入和/或输出。如果打算使用 URL 连接进行输入，则将 DoInput 标志设置为 true；如果不打算使用，则设置为 false。默认值为 true。
    3 setDoOutput URL 连接可用于输入和/或输出。如果打算使用 URL 连接进行输出，则将 DoOutput 标志设置为 true；如果不打算使用，则设置为 false。默认值为 false
    4 setIfModifiedSince 有些协议支持跳过对象获取，除非该对象在某个特定时间点之后又进行了修改
    5 setUseCaches 如果为 true，则只要有条件就允许协议使用缓存。
    6 setDefaultAllowUserInteraction 默认值为 “sticky”，它是所有 URLConnection 的其中一种静态状态。此标志适用于下一个及后续创建的所有 URLConnection。
    7 setDefaultUseCaches 将此 URLConnection 的 useCaches 字段的值设置为指定的值。
  • 设置请求头或响应体




















    编号 方法 说明
    1 setRequestProperty(key,value) 设置一般请求属性。如果已存在具有该关键字的属性，则用新值改写其值。注：HTTP 要求所有能够合法拥有多个具有相同键的实例的请求属性，使用以逗号分隔的列表语法，这样可实现将多个属性添加到一个属性中。
    2 addRequestProperty(key,value) 添加由键值对指定的一般请求属性。此方法不会改写与相同键关联的现有值
  • 发送URL请求















    编号 方法 说明
    1 getOutputStream 建立实际连接之后，就是发送请求，把请求参数传到服务器，这就需要使用outputStream把请求参数传给服务器
  • 获取响应








































    编号 方法 说明
    1 getContent 检索此 URL 连接的内容；此方法首先通过调用 getContentType 方法确定对象的内容类型；如果这是该应用程序第一次遇到的特定内容类型，则会创建适用于该类型的内容处理程序：
    如果该应用程序已使用 setContentHandlerFactory 方法建立了内容处理程序工厂实例，则调用此实例的 createContentHandler 方法，内容类型为其中的一个参数；结果为该内容类型的内容处理程序。
    如果尚未建立任何内容处理程序工厂，或者如果工厂的createContentHandler方法返回null`，则应用程序会加载以下名称的类
    2 getHeaderField 返回第 n 个头字段的值。如果少于 n+1 个字段，则返回 null。此方法可与 getHeaderFieldKey 方法配合使用，以迭代消息中的所有头
    3 getInputStream 返回从此打开的连接读取的输入流。 在读取返回的输入流时，如果在数据可供读取之前达到读入超时时间，则会抛出 SocketTimeoutException。
    4 getResponseCode 获取服务器的响应代码
    5 getResponseMessage 获取服务器的响应消息
    6 getResponseMethod 获取发送请求的方法
  • 相应的信息头用以下方法获取



































    编码 方法 说明
    1 getContentEncoding 返回 content-encoding 头字段的值
    2 getContentLength 返回 content-length 头字段的值。
    3 getContentType 返回 content-type 头字段的值。
    4 getDate 返回 date 头字段的值。
    5 getExpiration 返回 expires 头字段的值。

四、HttpURLConnection使用演示

  • Get方式
    1. public void testDoGet(){
    3.         String api="";
    4.         HttpURLConnection connection = null;
    5.         InputStream in=null;
    6.         BufferedReader reader=null;
    7.         try{
    9.             //构造一个URL对象
    10.             URL url = new URL(api);
    11.             //获取URLConnection对象
    12.             connection= (HttpURLConnection) url.openConnection();
    13.             //getOutputStream会隐含的进行connect(即：如同调用上面的connect()方法，所以在开发中不调用connect()也可以)
    14.             in = connection.getInputStream();
    15.             //通过InputStreamReader将字节流转换成字符串，在通过BufferedReader将字符流转换成自带缓冲流
    16.             reader = new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8));
    17.             StringBuilder sb = new StringBuilder();
    18.             String line = null;
    19.             //按行读取
    20.             while ((line = reader.readLine()) != null) {
    22.                 sb.append(line);
    23.             }
    24.             String response= sb.toString();
    25.             System.out.println(response);
    26.         }catch (Exception exception){
    28.             exception.printStackTrace();
    29.         }finally {
    31.             if (connection != null) {
    33.                 connection.disconnect();
    34.             }
    35.             if (in != null) {
    37.                 try {
    39.                     in.close();
    40.                 } catch (IOException e) {
    42.                     e.printStackTrace();
    43.                 }
    44.             }
    45.             if (reader != null) {
    47.                 try {
    49.                     reader.close();
    50.                 } catch (IOException e) {
    52.                     e.printStackTrace();
    53.                 }
    54.             }
    55.         }
    56.     }
  • POST方式
    1. public void testDoPost(){
    3.         String apiUrl = "https://www.goyeer.com/api";
    4.         String username  = "Goyeer";
    5.         String password  = "123456";
    6.         String tenantUrl = "";
    7.         HttpURLConnection conn = null;
    8.         OutputStream out = null;
    9.         InputStream in = null;
    10.         String idToken = null;
    11.         try
    12.         {
    14.            // 构造一个URL对象
    15.             URL url = new URL(apiUrl);
    16.             // 获取URLConnection对象
    17.             conn = (HttpURLConnection) url.openConnection();
    18.             // 限制socket等待建立连接的时间，超时将会抛出java.net.SocketTimeoutException
    19.             conn.setConnectTimeout(3000);
    20.             // 限制输入流等待数据到达的时间，超时将会抛出java.net.SocketTimeoutException
    21.             conn.setReadTimeout(3000);
    22.             // 设定请求的方法为"POST"，默认是GET
    23.             conn.setRequestMethod("POST");
    24.             // 设置传送的内容类型是json格式
    25.             conn.setRequestProperty("Content-Type", "application/json;charset=utf-8");
    26.             // 接收的内容类型也是json格式
    27.             conn.setRequestProperty("Accept", "application/json;charset=utf-8");
    28.             // 设置是否从httpUrlConnection读入，默认情况下是true
    29.             conn.setDoInput(true);
    30.             // 由于URLConnection在默认的情况下不允许输出，所以在请求输出流之前必须调用setDoOutput(true)。为一个HTTP URL将doOutput设置为true时，请求方法将由GET变为POST
    31.             conn.setDoOutput(true);
    32.             // 是否使用缓存，Post方式不能使用缓存
    33.             conn.setUseCaches(false);
    34.             // 准备数据
    35.             JSONObject json = new JSONObject();
    36.             json.put("username", username);
    37.             json.put("password", DigestUtils.md5Hex(password));
    38.             json.put("tenantUrl", tenantUrl);
    39.             // 返回一个OutputStream，可以用来写入数据传送给服务器
    40.             out = conn.getOutputStream();
    41.             // 将数据写入到输出流中
    42.             out.write(json.toString().getBytes(StandardCharsets.UTF_8));
    43.             // 刷新管道
    44.             out.flush();
    45.             // 建立连接
    46.             conn.connect();
    47.             // 判断数字响应码是否是200
    48.             int responseCode = conn.getResponseCode();
    49.             String result="";
    50.             if (responseCode == 200) {
    52.                 // 获取输入流
    53.                 in = conn.getInputStream();
    54.                 // 获取返回的内容
    55.                 StringWriter sw = new StringWriter();
    56.                 InputStreamReader reader = new InputStreamReader(in, StandardCharsets.UTF_8);
    57.                 char[] buffer = new char[4096];
    58.                 for (int n = 0; -1 != (n = reader.read(buffer)); ) {
    60.                     sw.write(buffer, 0, n);
    61.                 }
    62.                 result = sw.toString();
    63.                 System.out.println(result);
    64.             }
    65.         }catch (Exception exception){
    67.             exception.printStackTrace();
    68.         }finally {
    70.             if (conn != null) {
    72.                 conn.disconnect();
    73.             }
    74.             if (out != null) {
    76.                 out.close();
    77.             }
    78.             if (in != null) {
    80.                 in.close();
    81.             }
    82.         }
    83.     }

五、HttpURLConnection使用总结

  • HttpURLConnection对象不能直接构造，需使用URL类中的openConnection()方法来创建实例
  • HttpURLConnection对象属性设置，需在connect()方法执行之前完成HttpURLConnection的connect()函数,其本质是建立一个与服务器的TCP连接，但并未实际发送HTTP请求 HTTP请求靠调用getInputStream()、getResponseCode()等方法触发，HttpURLConnection是基于HTTP协议的,其底层通过socket通信实现
    不设置超时(timeout),当网络异常的情况下,可能会导致程序僵死而不继续往下执行
  • HTTP正文的内容是通过OutputStream流写入,向流中写入的数据不会立即发送到网络,而是存在于内存缓冲区中,待流关闭时，根据写入的内容生成HTTP正文。
  • 调用getInputStream()方法时,会返回一个输入流,用于从中读取服务器对于HTTP请求的返回信息
  • 当获取HTTP响应的时候，请求就会自动的发起
  • 如使用HttpURLConnection.getInputStream()方法的时系统会自动调用connect()方法
  • JDK8自带的HttpURLConnection 默认启用keepAlive,支持HTTP / 1.1和HTTP / 1.0持久连接，使用后的HttpURLConnection会放入缓存中供以后的同host:port的请求重用底层socket在keepAlive超时之前不会关闭。
  • 当在HttpURLConnection的header中加入Connection: close，则此连接不会启用keepAlive如果想启用keepAlive，程序请求完毕后必须调用HttpURLConnection.getInputStream().close()(此操作用于归还长连接给缓存,下次同host:port的请求重用底层socket连接),而不调用HttpURLConnection.disconnect()(表示关闭底层socket连接，不会启用keepAlive)。

发表评论

表情：
评论列表 （有 0 条评论，75人围观）

还没有评论，来说两句吧...

相关阅读