語言
取得 DbProviderFactory 的程序包含傳遞資料提供者的相關資訊給 DbProviderFactories 類別。 根據這些資訊,該 GetFactory 方法會回傳一個強型別的供應商工廠。 例如,註冊 SqlClientFactory後,傳遞 GetFactory 提供者名稱 Microsoft.Data.SqlClient。 另一個 GetFactory 的多載接受一個 DataRow。 取得提供者工廠後,你可以利用其方法來製作更多物件。
SqlClientFactory 的某些方法包括 CreateConnection、CreateCommand 和 CreateDataAdapter。
注意
OracleClientFactory, OdbcFactory 和 OleDbFactory 類別也會提供類似的功能。
註冊 DbProviderFactories
請先安裝 Microsoft.Data.SqlClient NuGet 套件,再註冊其 factory。
在 .NET Framework 中,請在應用程式的 configuration 或 system.data 檔案的 web.config 元素內加入以下 app.config 章節。 此 remove 元素可避免從其他設定檔繼承的重複註冊。
<system.data>
<DbProviderFactories>
<remove invariant="Microsoft.Data.SqlClient" />
<add name="Microsoft SqlClient Data Provider"
invariant="Microsoft.Data.SqlClient"
description="Microsoft SqlClient Data Provider for SQL Server"
type="Microsoft.Data.SqlClient.SqlClientFactory, Microsoft.Data.SqlClient"
/>
</DbProviderFactories>
</system.data>
在現代 .NET 中,設定檔不會登錄提供者工廠。 在呼叫GetFactory之前,先呼叫Instance,並將RegisterFactory(String, DbProviderFactory)作為提供者名稱、Microsoft.Data.SqlClient作為工廠執行個體。
RegisterFactory 無法在 .NET Framework 上使用。
以下範例示範如何在現代 .NET 中以程式碼註冊工廠。 對於 .NET 框架,請使用先前的設定條目,並省略任何RegisterFactory呼叫。
不變的提供者名稱用來識別底層的資料提供者。 工廠查詢和 連接字串 的 providerName 屬性請使用相同的名稱。
取得提供者資訊
您可以使用此 GetFactoryClasses 方法取得註冊資料提供者的資訊。 它回傳一個名為 DataTable 的 DbProviderFactories ,其中包含下表所述的欄位。 範例值對應於先前所示的 .NET Framework 設定項目;組件版本的詳細資訊則依所安裝的套件而定。
| 欄序數 | 欄位名稱 | 範例輸出 | 描述 |
|---|---|---|---|
| 0 | Name |
Microsoft SqlClient Data Provider | 資料提供者的可讀取名稱 |
| 1 | Description |
Microsoft SqlClient Data Provider for SQL Server | 資料提供者的可讀取描述 |
| 2 | InvariantName |
Microsoft.Data.SqlClient | 可用程式設計方式用來參考資料提供者的名稱 |
| 3 | AssemblyQualifiedName |
Microsoft.Data.SqlClient.SqlClientFactory, Microsoft.Data.SqlClient | 工廠類別的組件限定名稱 |
這DataTable可以用來讓使用者在運行時選擇DataRow。 然後,選取的 DataRow 可傳遞給 GetFactory 方法,以便建立強型別 DbProviderFactory。 選取的 DataRow 可傳遞給 GetFactory 方法,以便建立所需的 DbProviderFactory 物件。
列出已安裝的提供者工廠類別
這個範例將說明如何使用 GetFactoryClasses 方法來傳回 DataTable,其中包含已安裝提供者的相關資訊。 此程式碼會逐一查看 DataTable 中的每個資料列,並在主控台視窗中顯示每個已安裝提供者的資訊。
// This example assumes a reference to System.Data.Common.
static DataTable GetProviderFactoryClasses()
{
#if !NETFRAMEWORK
DbProviderFactories.RegisterFactory("Microsoft.Data.SqlClient", SqlClientFactory.Instance);
#endif
// Retrieve the installed providers and factories.
DataTable table = DbProviderFactories.GetFactoryClasses();
// Display each row and column value.
foreach (DataRow row in table.Rows)
{
foreach (DataColumn column in table.Columns)
{
Console.WriteLine(row[column]);
}
}
return table;
}
' This example assumes a reference to System.Data.Common.
Private Shared Function GetProviderFactoryClasses() As DataTable
#If Not NETFRAMEWORK Then
DbProviderFactories.RegisterFactory("Microsoft.Data.SqlClient", SqlClientFactory.Instance)
#End If
' Retrieve the installed providers and factories.
Dim table As DataTable = DbProviderFactories.GetFactoryClasses()
' Display each row and column value.
Dim row As DataRow
Dim column As DataColumn
For Each row In table.Rows
For Each column In table.Columns
Console.WriteLine(row(column))
Next
Next
Return table
End Function
使用應用程式組態檔來儲存 Factory 資訊
用於處理 Factory 的設計模式需要將提供者和連接字串資訊儲存在應用程式組態檔中,例如 Windows 應用程式的 app.config 和 ASP.NET 應用程式的 web.config。
下列組態檔片段將說明如何儲存兩個具名連接字串:"NorthwindSQL" 代表 SQL Server 中 Northwind 資料庫的連接,而 "NorthwindAccess" 代表 Access/Jet 中 Northwind 資料庫的連接。
invariant這個名稱就是用來指代屬性providerName的。
<configuration>
<connectionStrings>
<clear/>
<add name="NorthwindSQL"
providerName="Microsoft.Data.SqlClient"
connectionString=
"Data Source=<server>;Initial Catalog=Northwind;Integrated Security=true;Encrypt=true"
/>
<add name="NorthwindAccess"
providerName="System.Data.OleDb"
connectionString=
"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Data\Northwind.mdb;"
/>
</connectionStrings>
</configuration>
重要
Microsoft建議您使用可用的最安全驗證流程。 如果您正在連接 Azure SQL,建議使用的驗證方法為 Azure 資源受控識別。
依提供者名稱擷取連接字串
要透過供應商工廠建立連線,請提供一個 連接字串 以及提供者名稱。 此範例示範如何透過傳遞不變的提供者名稱(例如 Microsoft.Data.SqlClient)從應用程式設定檔中取得 連接字串 。 此程式碼會逐一查看 ConnectionStringSettingsCollection。 成功時會回傳相符的 連接字串;否則null(Nothing在 Visual Basic 中)。 如果某個提供者有多個項目,就會傳回第一個找到的項目。 如需從組態檔擷取連接字串的詳細資訊和範例,請參閱連接字串與組態檔。
注意
您必須使用 System.Configuration.dll 的參考,才能讓此程式碼執行。
// Retrieve a connection string by specifying the providerName.
// Assumes one connection string per provider in the config file.
static string? GetConnectionStringByProvider(string providerName)
{
// Get the collection of connection strings.
ConnectionStringSettingsCollection? settings =
ConfigurationManager.ConnectionStrings;
// Walk through the collection and return the first
// connection string matching the providerName.
if (settings != null)
{
foreach (ConnectionStringSettings cs in settings)
{
if (cs.ProviderName == providerName)
{
return cs.ConnectionString;
}
}
}
return null;
}
' Retrieve a connection string by specifying the providerName.
' Assumes one connection string per provider in the config file.
Private Shared Function GetConnectionStringByProvider( _
ByVal providerName As String) As String
'Return Nothing on failure.
Dim returnValue As String = Nothing
' Get the collection of connection strings.
Dim settings As ConnectionStringSettingsCollection = _
ConfigurationManager.ConnectionStrings
' Walk through the collection and return the first
' connection string matching the providerName.
If Not settings Is Nothing Then
For Each cs As ConnectionStringSettings In settings
If cs.ProviderName = providerName Then
returnValue = cs.ConnectionString
Exit For
End If
Next
End If
Return returnValue
End Function
建立 DbProviderFactory 和 DbConnection
此範例示範如何透過傳遞不變的提供者名稱(如 DbConnection)及一個 連接字串 來建立 Microsoft.Data.SqlClient 和 DbProviderFactory 物件。 如果成功,它就會傳回 DbConnection 物件。如果發生任何錯誤,則會傳回 null (在 Visual Basic 中為 Nothing)。
此程式碼會透過呼叫 DbProviderFactory,取得 GetFactory。 然後,CreateConnection 方法會建立 DbConnection 物件而且 ConnectionString 屬性會設定為連接字串。
// Given a provider name and connection string,
// create the DbProviderFactory and DbConnection.
// Returns a DbConnection on success; null on failure.
static DbConnection CreateDbConnection(
string providerName, string connectionString)
{
// Assume failure.
DbConnection connection = null;
// Create the DbProviderFactory and DbConnection.
if (connectionString != null)
{
try
{
#if !NETFRAMEWORK
if (providerName == "Microsoft.Data.SqlClient")
{
DbProviderFactories.RegisterFactory(providerName, SqlClientFactory.Instance);
}
#endif
DbProviderFactory factory =
DbProviderFactories.GetFactory(providerName);
connection = factory.CreateConnection();
connection.ConnectionString = connectionString;
}
catch (Exception ex)
{
// Set the connection to null if it was created.
if (connection != null)
{
connection = null;
}
Console.WriteLine(ex.Message);
}
}
// Return the connection.
return connection;
}
' Given a provider, create a DbProviderFactory and DbConnection.
' Returns a DbConnection on success; Nothing on failure.
Private Shared Function CreateDbConnection( _
ByVal providerName As String, ByVal connectionString As String) _
As DbConnection
' Assume failure.
Dim connection As DbConnection = Nothing
' Create the DbProviderFactory and DbConnection.
If Not connectionString Is Nothing Then
Try
#If Not NETFRAMEWORK Then
DbProviderFactories.RegisterFactory("Microsoft.Data.SqlClient", SqlClientFactory.Instance)
#End If
Dim factory As DbProviderFactory = _
DbProviderFactories.GetFactory(providerName)
connection = factory.CreateConnection()
connection.ConnectionString = connectionString
Catch ex As Exception
' Set the connection to Nothing if it was created.
If Not connection Is Nothing Then
connection = Nothing
End If
Console.WriteLine(ex.Message)
End Try
End If
' Return the connection.
Return connection
End Function