在 .NET 源代碼中,設計模式是常見的編程范式,用于解決經典的問題,如對象創建、接口解耦、算法透明等。本文將介紹.NET 源代碼中常見的設計模式及其示例。
創建型模式
創建型模式用于處理對象的創建過程,包括對象的實例化時機、構造方法參數、實例化過程等。常見的創建型模式有:
- 工廠方法模式 (Factory Method Pattern)
- 抽象工廠模式 (Abstract Factory Pattern)
- 單例模式 (Singleton Pattern)
- 建造者模式 (Builder Pattern)
- 原型模式 (Prototype Pattern)
這些設計模式是.NET 源代碼中的精華所在,在實際開發中也有廣泛應用。
設計模式和示例
以下是一些 .NET 源代碼中常見的設計模式及其示例:
1.工廠模式
工廠模式 - Factory Pattern 在 .NET 中使用工廠模式來創建對象。例如,以下是 .NET 中使用的一些工廠模式示例:
- 在 System.Data 中,使用 DbProviderFactory 工廠類來創建數據庫提供程序;
- 在 System.Net.Sockets 中,使用 SocketFactory 工廠類來創建套接字;
- 在 System.Threading.Tasks.Dataflow 中,使用 DataflowBlockOptions 靜態工廠方法來創建數據流塊。
DbProviderFactory說明和示例
DbProviderFactory 是一個抽象工廠類,提供了一種方式來創建與 ADO.NET 數據庫提供程序所支持的特定數據源的命令對象、連接對象、數據適配器對象和數據讀取器對象。 它使得應用程序可以在不直接調用特定數據庫提供程序的情況下與多個數據庫提供程序進行交互,從而提高了代碼的可移植性和靈活性。
在 .NET Framework 中,常用的數據庫提供程序如 System.Data.SqlClient、System.Data.OracleClient、System.Data.OleDb、System.Data.Odbc 等都繼承自 DbProviderFactory 類,并實現了它的抽象成員,如 CreateCommand(), CreateConnection(), CreateDataAdapter(), CreateParameter() 等,這些成員通過使用特定數據庫的 ADO.NET 提供程序,來創建與該數據庫所兼容的命令對象、連接對象、數據適配器對象和數據讀取器對象。
使用 DbProviderFactory 可以避免將應用程序綁定到特定的數據庫提供程序,并且它還可以通過簡單地更改配置文件中的設置來切換到另一個數據庫提供程序,從而增加了代碼的靈活性。例如,可以在 Web.config 文件中指定與 Oracle 數據庫兼容的數據庫提供程序,在另一個 config 文件中指定與 SQL Server 數據庫兼容的數據庫提供程序,然后通過更改配置文件來切換到不同的數據庫提供程序。
下面是一個使用 DbProviderFactory 創建 SQL Server 數據庫連接對象的示例:
using System;
using System.Configuration;
using System.Data;
using System.Data.Common;
using System.Data.SqlClient;
public class Program
{
static void MAIn(string[] args)
{
// 獲取數據庫提供程序工廠
DbProviderFactory factory = DbProviderFactories.GetFactory("System.Data.SqlClient");
// 創建連接對象
using (DbConnection connection = factory.CreateConnection())
{
// 從配置文件中獲取連接字符串
string connectionString = ConfigurationManager.ConnectionStrings["MyConnectionString"].ConnectionString;
// 設置連接對象的連接字符串
connection.ConnectionString = connectionString;
// 打開連接
connection.Open();
Console.WriteLine("連接成功!");
// 關閉連接
connection.Close();
}
}
}
在這個示例中,我們首先通過
DbProviderFactories.GetFactory() 方法獲取了一個特定的數據庫提供程序工廠。然后,我們使用 CreateConnection() 方法創建了一個連接對象,并從配置文件中獲取了一個連接字符串。最后,我們通過調用 Open() 方法打開連接,并在控制臺輸出了一條連接成功的消息。當使用完連接對象之后,我們應該調用 Close() 方法關閉連接,以釋放與之關聯的任何資源。
SocketFactory說明和示例
在 System.Net.Sockets 命名空間中,可以使用 SocketFactory 工廠類來創建套接字。SocketFactory 提供了一些靜態方法來創建不同類型的套接字,例如 CreateSocket() 方法可以用于創建一個基于 TCP/IP 協議的套接字實例。
下面是一個使用 SocketFactory 創建套接字的示例:
using System.Net.Sockets;
// 創建一個基于TCP/IP協議的套接字
Socket tcpSocket = SocketFactory.CreateSocket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
// 設置套接字選項
tcpSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true);
在上面的示例中,我們使用了 SocketFactory 工廠類的 CreateSocket 靜態方法來創建一個基于 TCP/IP 協議的套接字實例。然后,我們使用 SetSocketOption 方法為套接字設置一些選項,例如重用地址選項等。
需要注意的是,SocketFactory 工廠類雖然提供了方便的套接字創建方法,但在某些情況下可能不夠靈活,無法滿足一些特定需求。這時,可以通過手動創建一個 Socket 實例并設置其屬性和選項來獲得更精細的控制。
DataflowBlockOptions說明和示例
在
System.Threading.Tasks.Dataflow 命名空間中,為了方便使用和創建數據流塊,提供了一些靜態工廠方法來創建常用的數據流塊類型,這些工廠方法會返回已經設置好一些默認選項的數據流塊實例。
這些靜態工廠方法通常會使用 DataflowBlockOptions 作為參數,以便為創建的數據流塊設置選項。下面是幾個常用的靜態工廠方法示例:
- TransformBlock<TInput,TOutput>(Func<TInput,TOutput>, DataflowBlockOptions):創建一個轉換塊,用于從輸入元素中轉換出新的輸出元素。
- BroadcastBlock<T>(DataflowBlockOptions):創建一個廣播塊,它將每個輸入元素廣播到多個目標塊中。
- BufferBlock<T>(DataflowBlockOptions):創建一個緩沖塊,用于在不同塊之間存儲元素的緩沖區。
- ActionBlock<T>(Action<T>, DataflowBlockOptions):創建一個動作塊,用于執行某些操作而不生成任何輸出元素。
下面是一個使用靜態工廠方法創建數據流塊的示例:
using System.Threading.Tasks.Dataflow;
// 創建一個轉換塊,將int類型的輸入轉換為double類型的輸出
var transformBlock = new TransformBlock<int, double>(
input => input * 2.0, // 轉換函數
new DataflowBlockOptions() // 使用DataflowBlockOptions設置選項
{
BoundedCapacity = 10, // 設置緩沖區大小
CancellationToken = cancellationToken, // 設置取消標記
MaxDegreeOfParallelism = 2 // 設置最大并行度為2
}
);
在上面的示例中,我們使用了 TransformBlock 靜態工廠方法來創建一個轉換塊,并將其配置為可以處理 int 類型的輸入,并且將其轉換為 double 類型的輸出。同時,我們使用了 DataflowBlockOptions 參數來設置了一些常用選項,包括了緩沖區大小、取消標記以及最大并行度等。
2.單例模式
單例模式 - Singleton Pattern 在 .NET 中使用單例模式來創建全局唯一的對象和服務。例如,以下是 .NET 中使用的一些單例模式示例:
- 在 System.Diagnostics 中,使用 TraceSource 類來創建全局唯一的跟蹤源;
- 在 System.Net 中,使用 ServicePointManager 類來創建全局唯一的服務點管理器;
- 在 ASP.NET 中,使用 HttpRuntime 類來創建全局唯一的運行時對象。
TraceSource說明和示例
在 System.Diagnostics 命名空間中,可以使用 TraceSource 類來創建全局唯一的跟蹤源,以便進行跟蹤和調試工作。
TraceSource 跟蹤源提供了一種跟蹤和記錄應用程序的方式,它具有比 Trace 和 Debug 類更高的靈活性和可配置性。使用 TraceSource 類創建的跟蹤源可以定義多個監聽器,每個監聽器可以將跟蹤信息記錄到不同的目標,例如控制臺、文本文件、事件日志等。
下面是一個示例,展示如何使用 TraceSource 類創建全局唯一的跟蹤源:
using System.Diagnostics;
// 創建一個名為 "MyApp" 的跟蹤源
TraceSource traceSource = new TraceSource("MyApp");
// 添加一個名稱為 "console" 的 TextWriterTraceListener 監聽器
traceSource.Listeners.Add(new TextWriterTraceListener(Console.Out, "console"));
// 啟用跟蹤級別為 Verbose 的跟蹤信息
traceSource.Switch.Level = SourceLevels.Verbose;
// 在跟蹤源上記錄一條信息
traceSource.TraceInformation("Hello, world!");
在上面的示例中,我們首先創建了一個名為 "MyApp" 的跟蹤源,并向其添加了一個名稱為 "console" 的監聽器,該監聽器將跟蹤信息輸出到控制臺。然后,我們使用 Switch 屬性來啟用跟蹤級別為 Verbose 的跟蹤信息,最后通過 TraceInformation 方法在跟蹤源上記錄了一條信息。
需要注意的是,TraceSource 的使用與 Trace 和 Debug 類相比更加復雜,這是因為它提供了更高的靈活性和可配置性。在實際應用中,應根據需要選擇適當的跟蹤方式和工具,并進行合理的跟蹤級別設置,以避免對應用程序性能和安全造成不必要的影響。
ServicePointManager說明和示例
在 System.Net 命名空間中,可以使用 ServicePointManager 類來創建全局唯一的服務點管理器,以便對 HTTP 連接進行管理和配置。
ServicePointManager 類提供了一種集中式管理服務點的方式,它允許設置一些常見的 HTTP 協議參數,例如超時、緩存、安全等級等。使用 ServicePointManager 創建的服務點可以在應用程序范圍內共享和重用,從而提高應用程序的性能和可維護性。
下面是一個示例,展示如何使用 ServicePointManager 類創建全局唯一的服務點管理器:
using System.Net;
// 設置默認的最大連接數和默認連接超時時間
ServicePointManager.DefaultConnectionLimit = 10;
ServicePointManager.DefaultConnectTimeout = 10000;
// 創建一個新的服務點并設置特定的 HTTP 選項
ServicePoint sp = ServicePointManager.FindServicePoint(new Uri("http://www.example.com"));
sp.ConnectionLeaseTimeout = 60000;
// 使用服務點發送 HTTP 請求
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(new Uri("http://www.example.com"));
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
在上面的示例中,我們首先使用 ServicePointManager 類設置了默認的最大連接數和連接超時時間。然后,我們創建了一個新的服務點,并設置了該服務點的連接租約超時時間。最后,我們使用該服務點發送了一個 HTTP 請求。
需要注意的是,ServicePointManager 類提供了一些常見的 HTTP 協議參數設置,但是并不適用于所有場景。在實際應用中,應根據具體的業務需求和系統環境來選擇合適的 HTTP 參數設置方式,并進行適當地調整和優化。
HttpRuntime說明和示例
在 ASP.NET 中,可以使用 HttpRuntime 類來創建全局唯一的運行時對象,以便對 ASP.NET 應用程序進行管理和配置。
HttpRuntime 類是 ASP.NET 運行時環境的核心類之一,它提供了一種集中式管理 ASP.NET 應用程序的方式。使用 HttpRuntime 創建的運行時對象可以訪問和設置一些重要的應用程序參數,例如應用程序域、路徑映射、編譯器選項等。
下面是一個示例,展示如何使用 HttpRuntime 類創建全局唯一的運行時對象:
using System.Web;
// 獲取全局唯一的 HttpRuntime 對象
HttpRuntime runtime = HttpRuntime.AppDomainAppId == null ? null : HttpRuntime.Instance;
// 輸出當前應用程序域的 ID
string appDomainId = runtime?.AppDomainId;
Console.WriteLine("Current app domain ID: " + appDomainId);
// 輸出當前應用程序的虛擬路徑
string appVirtualPath = runtime?.AppVirtualPath;
Console.WriteLine("Current app virtual path: " + appVirtualPath);
在上面的示例中,我們首先使用 HttpRuntime 類獲取了全局唯一的運行時對象,并輸出了當前應用程序域的 ID 和當前應用程序的虛擬路徑。
需要注意的是,HttpRuntime 類并不適用于所有場景,它主要用于管理和配置 ASP.NET 應用程序本身。在實際應用中,應根據具體的業務需求和系統環境來選擇合適的 ASP.NET 參數設置方式,并進行適當地調整和優化。
3.建造者模式
建造者模式 - Builder Pattern 在 .NET 中,使用建造者模式來創建和組裝復雜對象。例如,以下是 .NET 中使用的一些建造者模式示例:
- 在 ASP.NET Core 中,使用 Startup 類中的 ConfigureServices 和 Configure 方法來組裝 Web 應用程序的服務和中間件;
- 在 Entity Framework 中,使用 DbContextOptionsBuilder 和 DbContext 構造函數來配置和創建數據上下文;
- 在 Prism 中,使用 IUnityContainer 接口和 RegisterType 方法來實現依賴項注入和對象構建。
Startup說明和示例
在ASP.NET Core中,使用 Startup 類中的 ConfigureServices 和 Configure 方法來組裝 Web 應用程序的服務和中間件。
ConfigureServices 方法在應用程序啟動時被調用,用于注冊應用程序所需的服務。在這個方法中,可以通過依賴注入容器向應用程序添加服務,并配置服務的生命周期、作用域等屬性。
Configure 方法則用于配置應用程序的 HTTP 請求管道。在這個方法中,可以添加各種中間件(Middleware)來處理請求和響應,例如路由、靜態文件、認證授權、日志記錄等。
下面是一個示例,展示了如何在 Startup 類中使用 ConfigureServices 和 Configure 方法來組裝 Web 應用程序的服務和中間件:
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
public class Startup
{
// 注冊應用程序所需的服務
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
services.AddDbContext<MyDbContext>();
services.AddTransient<IMyService, MyServiceImpl>();
services.AddAuthentication();
}
// 配置應用程序的 HTTP 請求管道
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Error");
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller}/{action}/{id?}");
});
}
}
在上面的示例中,我們定義了一個 Startup 類,并在 ConfigureServices 方法中注冊了一些服務,例如 MVC 控制器、數據庫上下文、自定義服務和身份認證等。在 Configure 方法中,我們添加了一些中間件(Middleware),例如開發者異常頁、HTTPS 重定向、靜態文件、路由、身份驗證和授權等。
需要注意的是,ASP.NET Core 中的依賴注入容器通常使用泛型主機建立,而不是使用全局唯一的靜態類。因此,在實際應用中,我們需要使用依賴注入容器的 API 來注冊和解析服務,而不是直接使用靜態類。
DbContextOptionsBuilder說明和示例
在 Entity Framework 中,使用 DbContextOptionsBuilder 和 DbContext 構造函數來配置和創建數據上下文(DbContext)。
DbContextOptionsBuilder 提供了一種鏈式調用的方式來配置數據上下文的選項,例如數據庫連接字符串、日志記錄、緩存策略等。通過 DbContextOptionsBuilder,我們可以靈活地配置數據上下文的行為和屬性。
下面是一個示例,展示了如何使用 DbContextOptionsBuilder 來配置數據上下文的選項:
using Microsoft.EntityFrameworkCore;
public class MyDbContext : DbContext
{
public MyDbContext(DbContextOptions<MyDbContext> options) : base(options)
{
}
public DbSet<MyEntity> MyEntities { get; set; }
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
if (!optionsBuilder.IsConfigured)
{
optionsBuilder.UseSqlServer("Data Source=(localdb)\MSSQLLocalDB;Initial Catalog=MyDb;Integrated Security=True;MultipleActiveResultSets=True");
}
}
}
在上面的示例中,我們定義了一個繼承自 DbContext 的數據上下文類 MyDbContext,并重載了它的構造函數和 OnConfiguring 方法。在構造函數中,我們接受了一個 DbContextOptions<MyDbContext> 類型的參數,并將其傳遞給基類的構造函數。在 OnConfiguring 方法中,我們檢查當前是否已經配置了數據庫選項,如果沒有,則使用 SQL Server 數據庫連接字符串配置選項。
需要注意的是,在實際應用中,我們通常不會在數據上下文中硬編碼數據庫連接字符串或其他配置選項,而是通過依賴注入容器和配置文件來進行動態配置。可以使用 IConfiguration 類來讀取應用程序的配置文件,然后將配置選項傳遞給 DbContextOptionsBuilder 的方法中。
在使用數據上下文時,我們通常需要使用依賴注入容器來創建和解析數據上下文的實例。例如,在 ASP.NET Core 中,我們可以使用內置的依賴注入容器(IServiceProvider)來注冊數據上下文,并在需要時從容器中解析出實例。
IUnityContainer說明和示例
在 Prism 中,可以使用 IUnityContainer 接口和 RegisterType 方法來實現依賴項注入和對象構建。
IUnityContainer 是 Unity 容器的接口,用于管理對象的生命周期和依賴關系。通過向容器注冊類型并指定其依賴項,我們可以讓容器自動解析對象和依賴項,并在需要時創建和銷毀對象實例。
RegisterType 方法是 IUnityContainer 接口中的一個方法,用于向容器注冊類型并指定其依賴項。通過 RegisterType 方法,我們可以指定對象的生命周期、作用域和其他屬性,并配置容器如何處理對象和依賴項之間的關系。
下面是一個示例,展示了如何使用 IUnityContainer 和 RegisterType 方法來實現依賴項注入和對象構建:
using Microsoft.Practices.Unity;
public class MyService : IMyService
{
private readonly IDbContext dbContext;
private readonly ILogger logger;
public MyService(IDbContext dbContext, ILogger logger)
{
this.dbContext = dbContext;
this.logger = logger;
}
public void DoSomething()
{
// 使用 dbContext 和 logger 執行操作
}
}
// 在應用程序啟動時注冊服務
var container = new UnityContainer();
container.RegisterType<IDbContext, MyDbContext>(new ContainerControlledLifetimeManager());
container.RegisterType<ILogger, MyLogger>(new TransientLifetimeManager());
container.RegisterType<IMyService, MyService>(new TransientLifetimeManager());
// 在需要使用服務的地方解析服務
var myService = container.Resolve<IMyService>();
myService.DoSomething();
在上面的示例中,我們定義了一個類 MyService,它需要依賴于 IDbContext 和 ILogger 接口。我們使用 RegisterType 方法來向容器注冊這些類型,并指定它們的生命周期為 Singleton 和 Transient。最后,在需要使用服務的地方,我們從容器中解析出實現了 IMyService 接口的對象,并調用其方法。
需要注意的是,在 Prism 中,通常建議我們使用基于接口的編程和依賴項注入,以便實現松耦合和可測試性。可以使用 RegisterInstance 方法來向容器注冊單例對象或配置選項,也可以使用 RegisterFactory 方法來自定義對象創建邏輯。在實際應用中,我們通常會將容器的配置封裝到模塊或組件中,并通過 Prism 模塊化架構來實現靈活的應用程序架構和組織。
4.原型模式
原型模式用于創建與現有對象相似的新對象,而不是通過類的構造函數或工廠方法創造對象。它適用于創建復雜對象的場景,其中構造函數的參數較多或創建對象的過程較為復雜,或者在創建對象的代價較高的情況下,通過復制已有的對象來創建新對象可以提高性能。
在 .NET 源代碼中,有一個和原型模式相關的接口和一個實現。
這個接口就是 System.ICloneable 接口。它定義了一個名為 Clone() 的方法,用于創建當前對象的淺表副本。在使用原型模式時,通常我們會讓對象實現 ICloneable 接口,并在 Clone() 方法中返回對象的淺表副本。
下面是一個示例:
public class MyObject : ICloneable
{
public int Id { get; set; }
public string Name { get; set; }
public object Clone()
{
return this.MemberwiseClone();
}
}
在上面的示例中,我們定義了一個類 MyObject,它實現了 ICloneable 接口,并在 Clone() 方法中返回 MemberwiseClone() 的結果。這個方法會創建并返回一個對象的淺表副本,也就是僅復制對象中的值類型成員和引用類型成員的引用,而不會復制整個對象圖。
需要注意的是,在使用原型模式時,我們通常需要謹慎處理對象中的引用類型成員,以確保副本對象與原始對象的引用類型成員指向正確的對象。另外,由于 Clone() 方法只能創建淺表副本,如果需要深復制對象圖,則需要使用其他的技術或模式來實現,例如序列化和反序列化、手動復制等。
總結
在使用這些創建型設計模式時,我們需要權衡其優缺點,并根據具體場景進行選擇。同時,我們需要注意代碼的可維護性和擴展性,并盡可能地遵循SOLID原則,以便更好地管理對象的創建過程。