ASP.NET 2.0中使用自訂provider

作者：Eve Cole 更新時間：2009-06-30 15:50:48

在ASP.NET 2.0中，新增加的membership provider功能，以及結合功能強大的一系列註冊，登陸控件，可以很方便地對用戶的登陸和權限等進行管理（參見<<ASP.NET 2.0登陸控件簡介>>)。

但是，可能大家會發現，ASP.NET 2.0自帶的這些登陸控制項和membership的管理功能，預設的是和sql server 2005 express搭配使用的，那麼，如何改成使用SQL Server 2000或是其他的資料來源，如access,oracle等呢？如果自己想在應用程式中，另外重新寫一個對登陸使用者或使用者權限等管理的應用，又該如何修改呢？在本文中，將給出在ASP.NET 2.0中使用自訂provider,以配合登陸控制來實現一個簡單的登陸過程。

為了明白ASP.NET 2.0中的provider是如何運作的，首先看下面的結構圖：

由上圖可以清楚看到，在最上面的一層，是各類的登陸控件，下面一層是與member有關的membership api。在Membership Api中，membership 類別執行有關對用戶的操作，例如增加，刪除用戶，而MembershipUser類別則儲存有關用戶的個人信息，如用戶名，密碼，EMAIL等資訊。

在Visual Studio 2005 beta 2中，預設使用的是Sql express membership provider。 Provider的作用，是起到溝通Membership Api以及資料庫，使得用戶並不需要關心要使用的是何種資料庫，全部的操作都可以用各類對應的資料provider來實現。

但很多時候，ASP.NET 2.0預設支援的provider是不能滿足其需要的，我們可以自己根據需要編寫provider.在本文中，將介紹如何使用access資料庫，建立一個資料表，存放使用者的資訊。本文介紹的方法，也可以適用在其他資料庫上。

首先，我們開啟Visual Studio 2005 beta 2,選用VB.NET，新建一個WEB SITE網站。在這個例子中，為簡單起見，我們設定一個使用者註冊表單，一個登陸的表單，新使用者可以先註冊，之後進行登陸。

接著，往預設的窗體中，拖放一個CreateUserWizard的控件，這是一個系統提供的新建用戶的自動控件，可以很方便地新建一個用戶。為了頁面美觀，我們點控制右上方的"智慧感知"，選擇"auto format"，在彈出的窗體中，再選擇"Elegant"樣式，如下圖所示：

當然，我們可以任意修改該控制項的文字提示。這裡我們為了讓能使用戶在註冊後能轉到登陸頁面，因此，設定該控制項的ContinueDestinationPageUrl屬性的值為：Login.aspx,這個頁面等下會寫。

接著，再拖曳一個LoginView控制項到default.aspx頁面。在這個控制項中，可以設定兩種模版：Anonymous模版，表示在使用者未登陸前，訪客看到的狀態；LoggedIn 模版，表示等使用者成功登陸後，看到的狀態（這裡可以設定一些文字顯示，例如歡迎進入等，同時一般會顯示使用者的名字）。

在這裡，我們在LoginView控制項中的LoggedIn 模版中，我們輸入"You are logged in",並且增加一個LoginName和一個LoginStatus控制項。其中，LoginName控制項顯示登陸後使用者的ID，而LoginStatus控件，則當使用者登陸後，會顯示logout(註銷)的連結。如下兩圖：

接著，再往項目中新增加一窗體，命名為login.aspx，再往該窗體中增加一個login控件，如下圖：

接下來，我們要做的工作就是建立資料庫了。我們在工作目錄下，用access建立一個名為Members.mdb的資料庫，資料結構表如下圖所示：

Field Name Data Type Field Size
Username (key) Text 8
Password Text 8
Email Text 50
passwordQuestion Text 50
passwordAnswer Text 50

在創建自己的provider之前，我們先了解下在ASP.NET 2.0中的provider的構造。在ASP.NET 2.0 beta 2中，預設的SqlMembershipProvider是繼承MembershipProvider類別的，MembershipProvider類別又是繼承自ProviderBase這個基底類別的，如下圖所示：

如果想要修改已有的sql membership provider，則只需要建立一個類，繼承ＳqlMembershipProvider類，並覆寫其方法就可以了，例如下面的例子：

Public Class ModifiedSqlMembershipProvider
Inherits SqlMembershipProvider

Public Overrides Function CreateUser (...)
…
End Function
…
End Class

如果不想使用在Visual Studio 2005 beta 2中提供的SqlMembershipProvider,則只需要聲明自己的類，並且繼承MembershipProvider類就可以了。 MembershipProvider類別包含了與membership相關的方法和屬性。

在Solution Explorer中，使用"Add New item.."，增加一個類，命名為AccessMembershipProvider.vb,並按系統提示，將其放到App_Code目錄中去。

接下來，引用相關的命名空間，並且寫出程式的框架如下：

Imports Microsoft.VisualBasic
Imports System.Data

Public Class AccessMembershipProvider
Inherits MembershipProvider
End Class

為了要使用自訂的provider,必須在web.config中進行相關的設定。可以新增加一個web.config文件，寫入如下的程式碼：

<system.web>
<authentication mode="Forms"/>
<membership
defaultProvider="AccessMembershipProvider" >
<providers>
<add name="AccessMembershipProvider"
type="AccessMembershipProvider"
requiresQuestionAndAnswer="true"
connectionString="Provider=Microsoft.Jet.
OLEDB.4.0;Data Source=C:NewMembershipProvider
App_DataMembers.mdb;Persist Security
Info=False" />
</providers>
</membership>
</system.web>

其中，要留意以下幾點：

必須選擇驗證方式為"Forms"(authentication mode="forms").

透過使用<add>標籤，增加一個自訂的provider,名稱叫AccessMembershipProvider。

其中的requiresQuestionAndAnswer屬性，當其值為true時，指出在新註冊時，必須填寫提示問題和要回答的答案。

ConnectionString，指出要進行資料庫連線的連線字串。

DefaultProvider屬性，指出系統預設使用哪一個provider,因為一個系統中可以設定多個provider.

在AccessMembershipProvider.vb中，增加以下的私有成員

Private connStr As String
Private comm As New OleDb.OleDbCommand
Private _requiresQuestionAndAnswer As Boolean
Private _minRequiredPasswordLength As Integer

並且增加Initialize()方法，程式碼如下

Public Overrides Sub Initialize(ByVal name As String, ByVal config As System.Collections.Specialized.NameValueCollection)

'===retrives the attribute values set inbute values set in
'web.config and assign to local variables===
If config("requiresQuestionAndAnswer") = "true" Then _
_requiresQuestionAndAnswer = True
connStr = config("connectionString")
MyBase.Initialize(name, config)
End Sub

當provider被裝載時，會呼叫Initialize()方法。剛才在web.config檔中，使用<add>標籤設定的各類屬性值，都能在這個方法中讀取。例如，可以透過使用config參數來讀取，上面的程式碼中，就使用config("connectionString")來讀取資料庫連接字串，並放到變數connStr變數中去。之後，再設定RequiresQuestionAndAnswer屬性，如下：

Public Overrides ReadOnly Property _
RequiresQuestionAndAnswer() _
As Boolean
Get
If _requiresQuestionAndAnswer = 真 Then
Return True
Else
Return False
End If
End Get
End Property

要注意，必須設定該屬性的值，否則，在CreateUserWizard控制項中，則不會顯示密碼提示問題和密碼提示答案兩個文字方塊。

接下來，我們可以開始寫新建使用者的程式碼了，CreateUser（）方法的程式碼如下：

Public Overrides Function CreateUser(ByVal username As String, ByVal password As String, ByVal email As String, ByVal passwordQuestion As String, ByVal passwordAnswer As String , ByVal isApproved As Boolean, ByVal providerUserKey As Object, ByRef status As System.Web.Security.MembershipCreateStatus) As System.Web.Security.MembershipUser
Dim conn As New OleDb.OleDbConnection(connStr)
Try
conn.Open()
Dim sql As String = "INSERT INTO Membership VALUES (" & _
"@username, @password, @email, " & _
" @passwordQuestion, @passwordAnswer )"
Dim comm As New OleDb.OleDbCommand(sql, conn)
comm.Parameters.AddWithValue("@username", username)
comm.Parameters.AddWithValue("@password", password)
comm.Parameters.AddWithValue("@email", email)
comm.Parameters.AddWithValue("@passwordQuestion", passwordQuestion)
comm.Parameters.AddWithValue("@passwordAnswer", passwordAnswer)
Dim result As Integer = comm.ExecuteNonQuery()
conn.Close()

status = MembershipCreateStatus.Success
Dim user As New MembershipUser("AccessMembershipProvider", username, Nothing, email, passwordQuestion, Nothing, True, False, Now, Nothing, Nothing, Nothing, Nothing)
Return user
Catch ex As Exception
status = MembershipCreateStatus.UserRejected
Return Nothing
End Try
End Function

我們解讀上面的程式碼，首先，我們往資料庫插入了一筆記錄，在新增使用者成功後，我們必須傳回一個狀態資訊status(該status時在傳入時以ByRef status As System.Web.Security .MembershipCreateStatus方式傳入),並且我們要傳回一個MembershipUser的類別的實例，因此，我們以這樣的方式傳回其實例：

Dim user As New MembershipUser("AccessMembershipProvider", username, Nothing, email, passwordQuestion, Nothing, True , False, Now, Nothing, Nothing, Nothing, Nothing)

其中，使用到MembershipUser類別的方法的建構函數有很多，具體的可以查看MSDN，在這裡我們只用到了username,email,passwordQuestion,createdate(帳號創建日期，這裡使用NOW)。

而在登陸頁面裡，為了判斷是否為合法使用者登陸，則需要寫如下程式碼：

Public Overrides Function ValidateUser( _
ByVal username As String, _
ByVal password As String) As Boolean

Dim conn As New OleDb.OleDbConnection(connStr)
Try
conn.Open()
Dim sql As String = _
"Select * From Membership WHERE " & _
" username=@username AND password=@password "
Dim comm As New OleDb.OleDbCommand(sql, conn)
comm.Parameters.AddWithValue("@username", _
username)
comm.Parameters.AddWithValue("@password", _
password)
Dim reader As OleDb.OleDbDataReader = _
comm.ExecuteReader
If reader.HasRows Then
Return True
Else
Return False
End If
conn.Close()

Catch ex As Exception
Console.Write(ex.ToString)
Return False
End Try
End Function

就這樣，一個簡單的自訂provider就完成了，可以搭配登陸，註冊等控制進行使用了。運行程序，首先是出現用戶註冊的頁面，當用戶成功註冊後，則會將用戶引導到登陸頁面，如下圖所示：

當使用者成功登陸後，如下圖所示：