HttpCookie Класс

Определение

Предоставляет типобезопасный способ создания и обработки отдельных НТТР-файлов Cookie.

public ref class HttpCookie sealed
public sealed class HttpCookie
type HttpCookie = class
Public NotInheritable Class HttpCookie
Наследование
HttpCookie

Примеры

В следующем примере кода показано, как проверить наличие файла cookie с именем DateCookieExample в объекте HttpRequest . Если файл cookie не найден, он создается и добавляется в HttpResponse объект. Срок действия файла cookie истекает через 10 минут.

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    protected void Page_Load(object sender, EventArgs e)
    {
        StringBuilder sb = new StringBuilder();
        // Get cookie from the current request.
        HttpCookie cookie = Request.Cookies.Get("DateCookieExample");
        
        // Check if cookie exists in the current request.
        if (cookie == null)
        {
            sb.Append("Cookie was not received from the client. ");
            sb.Append("Creating cookie to add to the response. <br/>");
            // Create cookie.
            cookie = new HttpCookie("DateCookieExample");
            // Set value of cookie to current date time.
            cookie.Value = DateTime.Now.ToString();
            // Set cookie to expire in 10 minutes.
            cookie.Expires = DateTime.Now.AddMinutes(10d);
            // Insert the cookie in the current HttpResponse.
            Response.Cookies.Add(cookie);
        }
        else
        {
            sb.Append("Cookie retrieved from client. <br/>");
            sb.Append("Cookie Name: " + cookie.Name + "<br/>");
            sb.Append("Cookie Value: " + cookie.Value + "<br/>");
            sb.Append("Cookie Expiration Date: " + 
                cookie.Expires.ToString() + "<br/>");
        }
        Label1.Text = sb.ToString();
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>HttpCookie Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:Label id="Label1" runat="server"></asp:Label>
    </div>
    </form>
</body>
</html>
<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        Dim sb As New StringBuilder()
        ' Get cookie from current request.
        Dim cookie As HttpCookie
        cookie = Request.Cookies.Get("DateCookieExample")
        
        ' Check if cookie exists in the current request
        If (cookie Is Nothing) Then
            sb.Append("Cookie was not received from the client. ")
            sb.Append("Creating cookie to add to the response. <br/>")
            ' Create cookie.
            cookie = New HttpCookie("DateCookieExample")
            ' Set value of cookie to current date time.
            cookie.Value = DateTime.Now.ToString()
            ' Set cookie to expire in 10 minutes.
            cookie.Expires = DateTime.Now.AddMinutes(10D)
            ' Insert the cookie in the current HttpResponse.
            Response.Cookies.Add(cookie)
        Else
            sb.Append("Cookie retrieved from client. <br/>")
            sb.Append("Cookie Name: " + cookie.Name + "<br/>")
            sb.Append("Cookie Value: " + cookie.Value + "<br/>")
            sb.Append("Cookie Expiration Date: " & _
                cookie.Expires.ToString() & "<br/>")
        End If
        Label1.Text = sb.ToString()

    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>HttpCookie Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:Label id="Label1" runat="server"></asp:Label>    
    </div>
    </form>
</body>
</html>

Комментарии

Класс HttpCookie получает и задает свойства отдельных файлов cookie. Класс HttpCookieCollection предоставляет методы для хранения, извлечения и управления несколькими файлами cookie.

ASP.NET включает две встроенные коллекции файлов cookie. Коллекция, доступная через Cookies коллекцию HttpRequest объекта, содержит файлы cookie, передаваемые клиентом серверу в заголовке Cookie . Коллекция, доступная через Cookies коллекцию HttpResponse объекта, содержит новые файлы cookie, созданные на сервере и передаваемые клиенту в заголовке Set-Cookie ОТВЕТА HTTP.

Конструкторы

HttpCookie(String)

Создает новый файл Cookie и присваивает ему имя.

HttpCookie(String, String)

Создает новый файл Cookie и присваивает ему имя и значение.

Свойства

Domain

Получает или задает домен, связанный с файлом Cookie.

Expires

Получает или задает срок действия и время для текущего файла Cookie.

HasKeys

Получает значение, определяющее наличие подразделов в файле Cookie.

HttpOnly

Получает или задает значение, указывающее имеет ли клиентский скрипт доступ к файлу Cookie.

Item[String]

Получает ярлык свойства Values. Это свойство обеспечивает совместимость с предыдущими версиями ASP.

Name

Получает или задает имя файла Cookie.

Path

Получает или задает виртуальный путь для передачи вместе с текущим файлом Cookie.

SameSite

Получает или устанавливает значение атрибута SameSite файла cookie.

Secure

Получает или задает значение, определяющее, выполнять ли передачу файлов Cookie по протоколу SSL (т.е. только по протоколу HTTPS).

Shareable

Определяет, разрешен ли файл cookie для участия в кэшировании выходных данных.

Value

Получает или задает индивидуальное значение файла Cookie.

Values

Получает коллекцию значений в паре "ключ-значение", содержащуюся в одном файле Cookie.

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)
TryParse(String, HttpCookie)

Преобразовывает указанное строковое представление файла cookie в его эквивалент HttpCookie и возвращает значение, позволяющее определить успешность преобразования.

Применяется к

См. также раздел