Compartilhar via


WebMethodAttribute.EnableSession Propriedade

Definição

Indica se o estado de sessão é habilitado para um método de serviço Web XML.

public:
 property bool EnableSession { bool get(); void set(bool value); };
public bool EnableSession { get; set; }
member this.EnableSession : bool with get, set
Public Property EnableSession As Boolean

Valor da propriedade

Boolean

true se o estado de sessão é habilitado para um método de serviço Web XML. O padrão é false.

Exemplos

O exemplo a seguir usa o estado da sessão para determinar quantas vezes uma sessão específica acessa o método SessionHitCounterde serviço Web XML.

<%@ WebService Language="C#" Class="Util" %>
 
 using System.Web.Services;
 
 public class Util: WebService {
   [ WebMethod(Description="Per session Hit Counter",EnableSession=true)]
    public int SessionHitCounter() {
       if (Session["HitCounter"] == null) {
          Session["HitCounter"] = 1;
       }
       else {
          Session["HitCounter"] = ((int) Session["HitCounter"]) + 1;
          }
       return ((int) Session["HitCounter"]);
    }   
 }
<%@ WebService Language="VB" Class="Util" %>
 
Imports System.Web.Services

Public Class Util
    Inherits WebService
    
    <WebMethod(Description := "Per session Hit Counter", _
        EnableSession := True)> _
    Public Function SessionHitCounter() As Integer
        
        If Session("HitCounter") Is Nothing Then
            Session("HitCounter") = 1
        Else
            Session("HitCounter") = CInt(Session("HitCounter")) + 1
        End If
        Return CInt(Session("HitCounter"))
    End Function
End Class

O exemplo de código a seguir é um cliente Web Forms de um serviço Web XML que usa o estado da sessão. O cliente persiste o cookie HTTP que identifica exclusivamente a sessão armazenando-a no estado de sessão do cliente.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.IO" %>
<%@ Import Namespace="System.Net" %>

<html>

    <script runat="server">

        void EnterBtn_Click(Object Src, EventArgs E) 
    {
      // Create a new instance of a proxy class for your XML Web service.
      ServerUsage su = new ServerUsage();
          CookieContainer cookieJar;

      // Check to see if the cookies have already been saved for this session.
      if (Session["CookieJar"] == null) 
        cookieJar= new CookieContainer();
          else
       cookieJar = (CookieContainer) Session["CookieJar"];

        // Assign the CookieContainer to the proxy class.
        su.CookieContainer = cookieJar;

      // Invoke an XML Web service method that uses session state and thus cookies.
      int count = su.PerSessionServiceUsage();         

      // Store the cookies received in the session state for future retrieval by this session.
      Session["CookieJar"] = cookieJar;

          // Populate the text box with the results from the call to the XML Web service method.
          SessionCount.Text = count.ToString();  
        }
         
    </script>
    <body>
       <form runat=server ID="Form1">
           
             Click to bump up the Session Counter.
             <p>
             <asp:button text="Bump Up Counter" Onclick="EnterBtn_Click" runat=server ID="Button1" NAME="Button1"/>
             <p>
             <asp:label id="SessionCount"  runat=server/>
          
       </form>
    </body>
</html>
<%@ Page Language="VB" %>
<%@ Import Namespace="System.IO" %>
<%@ Import Namespace="System.Net" %>

<html>

    <script runat=server>

        Public Sub EnterBtn_Click(src As Object, E As EventArgs) 

      ' Create a new instance of a proxy class for your XML Web service.
      Dim su As ServerUsage = new ServerUsage()
          Dim cookieJar As CookieContainer

      ' Check to see if the cookies have already been saved for this session.
      If (Session("CookieJar") Is Nothing) 
        cookieJar= new CookieContainer()
          Else
       cookieJar = Session("CookieJar")
      End If
   

        ' Assign the CookieContainer to the proxy class.
        su.CookieContainer = cookieJar

      ' Invoke an XML Web service method that uses session state and thus cookies.
      Dim count As Integer = su.PerSessionServiceUsage()         

      ' Store the cookies received in the session state for future retrieval by this session.
      Session("CookieJar") = cookieJar

          ' Populate the text box with the results from the call to the XML Web service method.
          SessionCount.Text = count.ToString()  
    End Sub
         
    </script>
    <body>
       <form runat=server ID="Form1">
           
             Click to bump up the Session Counter.
             <p>
             <asp:button text="Bump Up Counter" Onclick="EnterBtn_Click" runat=server ID="Button1" NAME="Button1"/>
             <p>
             <asp:label id="SessionCount"  runat=server/>
          
       </form>
    </body>
</html>

Comentários

Para armazenar o estado da sessão no objeto ASP.NETHttpSessionState, o serviço Web XML deve herdar WebService e um WebMethodAttribute aplicado ao método de serviço Web XML, definindo a EnableSession propriedade como true. Se o estado da sessão não for necessário para um método de serviço Web XML, desabilitá-lo poderá melhorar o desempenho.

Um cliente de serviço Web XML é identificado exclusivamente por um cookie HTTP retornado por um serviço Web XML. Para que um serviço Web XML mantenha o estado da sessão para um cliente, o cliente deve persistir o cookie. Os clientes podem receber o cookie HTTP criando uma nova instância CookieContainer e atribuindo-a CookieContainer à propriedade da classe proxy antes de chamar o método de serviço Web XML. Se você precisar manter o estado da sessão além de quando a instância da classe proxy ficar fora do escopo, o cliente deverá persistir o cookie HTTP entre chamadas para o serviço Web XML. Por exemplo, um cliente Web Forms pode persistir o cookie HTTP salvando-o CookieContainer em seu próprio estado de sessão. Como nem todos os serviços Web XML usam o estado da sessão e, portanto, os clientes nem sempre são necessários para usar a CookieContainer propriedade de um proxy de cliente, a documentação do serviço Web XML deve declarar se o estado da sessão é usado.

Aplica-se a

Confira também