java.net
类 URLConnection

java.lang.Object
  java.net.URLConnection

直接已知子类：

HttpURLConnection, JarURLConnection

public abstract class URLConnection
     

      extends 
      Object
     

抽象类 URLConnection 是所有类的超类，它代表应用程序和 URL 之间的通信链接。此类的实例可用于读取和写入此 URL 引用的资源。通常，创建一个到 URL 的连接需要几个步骤：

1. 通过在 URL 上调用 openConnection 方法创建连接对象。
2. 处理设置参数和一般请求属性。
3. 使用 connect 方法建立到远程对象的实际连接。
4. 远程对象变为可用。远程对象的头字段和内容变为可访问。

使用以下方法修改设置参数：

• setAllowUserInteraction
• setDoInput
• setDoOutput
• setIfModifiedSince
• setUseCaches

使用以下方法修改一般请求属性：

• setRequestProperty

使用 setDefaultAllowUserInteraction 和 setDefaultUseCaches 可设置 AllowUserInteraction 和 UseCaches 参数的默认值。

上面每个 set 方法都有一个用于获取参数值或一般请求属性值的对应 get 方法。适用的具体参数和一般请求属性取决于协议。

在建立到远程对象的连接后，以下方法用于访问头字段和内容：

• getContent
• getHeaderField
• getInputStream
• getOutputStream

某些头字段需要经常访问。以下方法：

• getContentEncoding
• getContentLength
• getContentType
• getDate
• getExpiration
• getLastModifed

提供对这些字段的便捷访问。getContent 方法使用 getContentType 方法以确定远程对象类型；子类重写 getContentType 方法很容易。

一般情况下，所有的预连接参数和一般请求属性都可忽略：预连接参数和一般请求属性默认为敏感值。对于此接口的大多数客户端而言，只有两个需要的方法：getInputStream 和 getContent，它们通过便捷方法镜像到 URL 类中。

有关 http 连接的请求属性和头字段的更多信息，可从以下位置找到：

 http://www.ietf.org/rfc/rfc2068.txt
 

从以下版本开始：

JDK1.0

另请参见：

URL.openConnection(), connect(), getContent(), getContentEncoding(), getContentLength(), getContentType(), getDate(), getExpiration(), getHeaderField(int), getHeaderField(java.lang.String), getInputStream(), getLastModified(), getOutputStream(), setAllowUserInteraction(boolean), setDefaultUseCaches(boolean), setDoInput(boolean), setDoOutput(boolean), setIfModifiedSince(long), setRequestProperty(java.lang.String, java.lang.String), setUseCaches(boolean)

url

protected URL url

URL 表示此连接要在互联网上打开的远程对象。

使用 getURL 方法可访问此字段的值。

此变量的默认值为 URLConnection 构造方法中的 URL 参数的值。

另请参见：

getURL(), url

doInput

protected boolean doInput

此变量由 setDoInput 方法设置。其值由 getDoInput 方法返回。

URL 连接可用于输入和/或输出。将 doInput 标志设置为 true，指示应用程序要从 URL 连接读取数据。

此字段的默认值为 true。

另请参见：

getDoInput(), setDoInput(boolean)

doOutput

protected boolean doOutput

此变量由 setDoOutput 方法设置。其值由 getDoOutput 方法返回。

URL 连接可用于输入和/或输出。将 doOutput 标志设置为 true，指示应用程序要将数据写入 URL 连接。

此字段的默认值为 false。

另请参见：

getDoOutput(), setDoOutput(boolean)

allowUserInteraction

protected boolean allowUserInteraction

如果为 true，则在允许用户交互（例如弹出一个验证对话框）的上下文中对此 URL 进行检查。如果为 false，则不允许有任何用户交互。

使用 setAllowUserInteraction 方法可对此字段的值进行设置。其值由 getAllowUserInteraction 方法返回。其默认值为上一次调用 setDefaultAllowUserInteraction 方法所用的参数的值。

另请参见：

getAllowUserInteraction(), setAllowUserInteraction(boolean), setDefaultAllowUserInteraction(boolean)

useCaches

protected boolean useCaches

如果为 true，则只要有条件就允许协议使用缓存。如果为 false，则该协议始终必须获得此对象的新副本。

此字段由 setUseCaches 方法设置。其值由 getUseCaches 方法返回。

其默认值为上一次调用 setDefaultUseCaches 方法时给定的值。

另请参见：

setUseCaches(boolean), getUseCaches(), setDefaultUseCaches(boolean)

ifModifiedSince

protected long ifModifiedSince

有些协议支持跳过对象获取，除非该对象在某个特定时间点之后又进行了修改。

一个非零值给定一个时间，它表示距离格林威治标准时间 1970 年 1 月 1 日的毫秒数。只有在该时间之后又进行了修改时，才获取该对象。

此变量由 setIfModifiedSince 方法设置。其值由 getIfModifiedSince 方法返回。

此字段的默认值为 0，表示必须一直进行获取。

另请参见：

getIfModifiedSince(), setIfModifiedSince(long)

connected

protected boolean connected

如果为 false，则此连接对象尚未创建到指定 URL 的通信链接。如果为 true，则已经建立了通信链接。

URLConnection

protected URLConnection(URL url)

构造一个到指定 URL 的 URL 连接。不会创建到 URL 所引用的对象的连接。

参数：

url - 指定的 URL。

getFileNameMap

public static FileNameMap getFileNameMap()

从数据文件加载文件名映射（一个 mimetable）。它首先尝试加载由 "content.types.user.table" 属性定义的特定于用户的表。如果加载失败，它会尝试加载位于 java 主目录下的 lib/content-types.properties 中的默认内置表。

返回：

FileNameMap

从以下版本开始：

1.2

另请参见：

setFileNameMap(java.net.FileNameMap)

setFileNameMap

public static void setFileNameMap(FileNameMap map)

设置 FileNameMap。

如果有安全管理器，此方法首先调用安全管理器的 checkSetFactory 方法以确保允许该操作。这可能会导致抛出 SecurityException 异常。

参数：

map - 要设置的 FileNameMap

抛出：

SecurityException - 如果安全管理器存在并且其 checkSetFactory 方法不允许进行此操作。

从以下版本开始：

1.2

另请参见：

SecurityManager.checkSetFactory(), getFileNameMap()

connect

public abstract void connect()
                      throws IOException

打开到此 URL 引用的资源的通信链接（如果尚未建立这样的连接）。

如果在已打开连接（此时 connected 字段的值为 true）的情况下调用 connect 方法，则忽略该调用。

URLConnection 对象经历两个阶段：首先创建对象，然后建立连接。在创建对象之后，建立连接之前，可指定各种选项（例如，doInput 和 UseCaches）。连接后再进行设置就会发生错误。连接后才能进行的操作（例如 getContentLength），如有必要，将隐式执行连接。

抛出：

SocketTimeoutException - 如果在建立连接之前超时期满

IOException - 如果打开连接时发生 I/O 错误。

另请参见：

connected, getConnectTimeout(), setConnectTimeout(int)

setConnectTimeout

public void setConnectTimeout(int timeout)

设置一个指定的超时值（以毫秒为单位），该值将在打开到此 URLConnection 引用的资源的通信链接时使用。如果在建立连接之前超时期满，则会引发一个 java.net.SocketTimeoutException。超时时间为零表示无穷大超时。

此方法的一些非标准实现可能忽略指定的超时。要查看连接超时设置，请调用 getConnectTimeout()。

参数：

timeout - 一个指定连接超时值的 int，以毫秒为单位

抛出：

IllegalArgumentException - 如果超时参数为负

从以下版本开始：

1.5

另请参见：

getConnectTimeout(), connect()

getConnectTimeout

public int getConnectTimeout()

返回连接超时设置。

返回 0 表明该选项被禁用（即超时为无穷大）。

返回：

一个指示连接超时值的 int，以毫秒为单位

从以下版本开始：

1.5

另请参见：

setConnectTimeout(int), connect()

setReadTimeout

public void setReadTimeout(int timeout)

将读超时设置为指定的超时值，以毫秒为单位。用一个非零值指定在建立到资源的连接后从 Input 流读入时的超时时间。如果在数据可读取之前超时期满，则会引发一个 java.net.SocketTimeoutException。超时时间为零表示无穷大超时。

此方法的一些非标准实现会忽略指定的超时。要查看读入超时设置，请调用 getReadTimeout()。

参数：

timeout - 一个指定要使用的超时值的 int，以毫秒为单位

抛出：

IllegalArgumentException - 如果超时参数为负

从以下版本开始：

1.5

另请参见：

getReadTimeout(), InputStream.read()

getReadTimeout

public int getReadTimeout()

返回读入超时设置。返回 0 表明该选项被禁用（即超时为无穷大）。

返回：

一个指示读入超时值的 int，以毫秒为单位

从以下版本开始：

1.5

另请参见：

setReadTimeout(int), InputStream.read()

getURL

public URL getURL()

返回此 URLConnection 的 URL 字段的值。

返回：

此 URLConnection 的 URL 字段的值。

另请参见：

url

getContentLength

public int getContentLength()

返回 content-length 头字段的值。

返回：

此连接的 URL 引用的资源的内容长度，或者如果内容长度未知，则返回 -1。

getContentType

public String getContentType()

返回 content-type 头字段的值。

返回：

该 URL 引用的资源的内容类型，或者如果类型为未知，则返回 null。

另请参见：

getHeaderField(java.lang.String)

getContentEncoding

public String getContentEncoding()

返回 content-encoding 头字段的值。

返回：

该 URL 引用的资源的内容编码，或者如果编码为未知，则返回 null。

另请参见：

getHeaderField(java.lang.String)

getExpiration

public long getExpiration()

返回 expires 头字段的值。

返回：

此 URL 引用的资源的期满日期，或者如果为未知，则返回 0。该值为距离格林威治标准时间 1970 年 1 月 1 日的毫秒数。

另请参见：

getHeaderField(java.lang.String)

getDate

public long getDate()

返回 date 头字段的值。

返回：

该 URL 引用的资源的发送日期，或者如果为未知，则返回 0。返回的值为距离格林威治标准时间 1970 年 1 月 1 日的毫秒数。

另请参见：

getHeaderField(java.lang.String)

getLastModified

public long getLastModified()

返回 last-modified 头字段的值。结果为距离格林威治标准时间 1970 年 1 月 1 日的毫秒数。

返回：

此 URLConnection 引用的资源的上次修改日期，或者如果为未知，则返回 0。

另请参见：

getHeaderField(java.lang.String)

getHeaderField

public String getHeaderField(String name)

返回指定的头字段的值。

如果调用的连接多次使用不同的值设置了头字段，则只返回最后一次设置的值。

参数：

name - 头字段的名称。

返回：

指定的头字段的值，或者如果头中没有这样一个字段，则返回 null。

getHeaderFields

public Map<String,List<String>> getHeaderFields()

返回头字段的不可修改的 Map。Map 键是表示 response-header 字段名称的 String。每个 Map 值为一个不可修改的 String 的列表，它们代表相应的字段值。

返回：

头字段的 Map

从以下版本开始：

1.4

getHeaderFieldInt

public int getHeaderFieldInt(String name,
                             int Default)

返回解析为数字的指定字段的值。

有些连接类型（例如 http-ng）具有预解析头，所以存在这种形式的 getHeaderField。用于这种连接类型的类可重写此方法从而缩短解析过程。

参数：

name - 头字段的名称。

Default - 默认值。

返回：

指定字段的值，解析为整数。如果该字段缺少或有错误，则返回 Default 值。

getHeaderFieldDate

public long getHeaderFieldDate(String name,
                               long Default)

返回解析为日期的指定字段的值。结果为指定字段表示的距离格林威治标准时间 1970 年 1 月 1 日的毫秒数。

有些连接类型（例如 http-ng）具有预解析头，所以存在这种形式的 getHeaderField。用于该类型的连接可重写此方法和缩短解析过程。

参数：

name - 头字段的名称。

Default - 默认值。

返回：

字段的值，解析为日期。如果该字段缺少或有错误，则返回 Default 参数的值。

getHeaderFieldKey

public String getHeaderFieldKey(int n)

返回第 n 个头字段的键。如果少于 n+1 个字段，则返回 null。

参数：

n - 一个索引，n>=0

返回：

对应第 n 个头字段的键，或者如果少于 n+1 个字段，则返回 null。

getHeaderField

public String getHeaderField(int n)

返回第 n 个头字段的值。如果少于 n+1 个字段，则返回 null。

此方法可与 getHeaderFieldKey 方法配合使用，以迭代消息中的所有头。

参数：

n - 一个索引，n>=0

返回：

第 n 个头字段的值，或者如果少于 n+1 个字段，则返回 null

另请参见：

getHeaderFieldKey(int)

getContent

public Object getContent()
                  throws IOException

获取此 URL 连接的内容。

此方法首先通过调用 getContentType 方法确定对象的内容类型。如果这是该应用程序第一次遇到的特定内容类型，则会创建适用于该类型的内容处理程序：

1. 如果该应用程序已使用 setContentHandlerFactory 方法建立了内容处理程序工厂实例，则调用此实例的 createContentHandler 方法，内容类型为其中的一个参数；结果为该内容类型的内容处理程序。
2. 如果尚未建立任何内容处理程序工厂，或者如果工厂的 createContentHandler 方法返回 null，则应用程序会加载以下名称的类：

            sun.net.www.content.<contentType>
        

   其中，<contentType> 取自 content-type 字符串，将所有的斜杠字符用句点 ('