[[388029]]

本文轉(zhuǎn)載自微信公眾號(hào)「老王Plus」，作者老王Plus的老王 。轉(zhuǎn)載本文請(qǐng)聯(lián)系老王Plus公眾號(hào)。

一、洋蔥架構(gòu)簡(jiǎn)介

洋蔥架構(gòu)出來(lái)的其實(shí)有一點(diǎn)年頭了。大約在2017年下半年，就有相關(guān)的說(shuō)法了。不過，大量的文章在于理論性的討論，而我們今天會(huì)用一個(gè)項(xiàng)目來(lái)完成這個(gè)架構(gòu)。

洋蔥架構(gòu)，有時(shí)候也被叫做整潔架構(gòu)，它本身是為高質(zhì)量的軟件而存在的。

相對(duì)其它架構(gòu)而言，洋蔥架構(gòu)具有更好的可測(cè)試性、實(shí)用性和穩(wěn)定性，并且足夠靈活，完全適應(yīng)項(xiàng)目未來(lái)可能的成長(zhǎng)和進(jìn)化?？梢赃@么說(shuō)，洋蔥架構(gòu)完美解決了三層或N層架構(gòu)所面臨的困難和問題。

牛吹完了，下面來(lái)看張圖：

這張圖，充分解釋了它為什么叫洋蔥架構(gòu)。

不過，這不是重點(diǎn)。這個(gè)架構(gòu)最重要的是里面的代碼依賴原則：從外向內(nèi)，并且只有這一個(gè)方向。處于內(nèi)環(huán)的代碼，不應(yīng)該知道外環(huán)的任何東西。

從上面圖也可以看到，洋蔥架構(gòu)，也使用層的概念。不過，它不同于我們習(xí)慣的三層或N層。我們來(lái)看看每個(gè)層的情況：

• 數(shù)據(jù)層(Domain Layer)

存在于架構(gòu)的中心部分，由所有業(yè)務(wù)數(shù)據(jù)的實(shí)體組成。大多數(shù)情況下，就是我們的數(shù)據(jù)模型。后面的實(shí)踐代碼中，我是用EF(Entity Framework)來(lái)操作的數(shù)據(jù)庫(kù)。

• 存儲(chǔ)層(Repository Layer)

存儲(chǔ)層在架構(gòu)中充當(dāng)服務(wù)層和數(shù)據(jù)模型之間的紐帶，并且在這一層將保持所有數(shù)據(jù)庫(kù)操作和應(yīng)用數(shù)據(jù)的上下文。通常的做法是接口，用接口來(lái)描述數(shù)據(jù)訪問所涉及的讀寫操作。

• 服務(wù)層(Services Layer)

服務(wù)層用于實(shí)現(xiàn)存儲(chǔ)層和項(xiàng)目之間的通信，同時(shí)，還可以保存實(shí)體的業(yè)務(wù)邏輯。在這一層，服務(wù)接口與實(shí)現(xiàn)分離，以實(shí)現(xiàn)解耦和焦點(diǎn)分離。

• 用戶界面層(UI Layer)

這個(gè)不解釋了。項(xiàng)目最終對(duì)外的一層。注意，這兒可能是網(wǎng)站，也可能是API。不需要糾結(jié)有沒有實(shí)際的界面。咱們的實(shí)踐代碼中，我用的是API。

二、實(shí)踐

好，現(xiàn)在直接進(jìn)入代碼。

1. 創(chuàng)建工程

這個(gè)不解釋了，都是套路：

% dotnet new webapi -o demo -f netcoreapp3.1 

我這個(gè)工程用的是Dotnet Core 3.1?？蚣懿恢匾?，基本上哪個(gè)版本都可以用。

下面設(shè)置Swagger

這個(gè)是我的習(xí)慣，而且這個(gè)項(xiàng)目是個(gè)WebApi，裝個(gè)Swagger方便。

% dotnet add package swashbuckle.aspnetcore 

Swagger的設(shè)置不是本文的重點(diǎn)，略過。需要的同學(xué)可以去看源代碼。

下面，我們?cè)诠こ讨薪ㄈ齻€(gè)目錄：

• DomainLayer
• RepositoryLayer
• ServicesLayer

這三個(gè)目錄對(duì)應(yīng)上面的三個(gè)層。UI在這個(gè)項(xiàng)目里其實(shí)就是控制器Controller，已經(jīng)存在了。

建這三個(gè)目錄的目的，是為了放置三個(gè)層的代碼。后面編碼的時(shí)候，你會(huì)看到這三個(gè)層之間的關(guān)系。另外，這三個(gè)層在實(shí)際應(yīng)用時(shí)，可以獨(dú)立為三個(gè)類庫(kù)，這樣會(huì)更清晰。

前邊說(shuō)了，我會(huì)用EF操作數(shù)據(jù)庫(kù)。所以，這兒還需要引入三個(gè)庫(kù)：

% dotnet add package Microsoft.EntityFrameworkCore 
% dotnet add package Microsoft.EntityFrameworkCore.Relational 
% dotnet add package Pomelo.EntityFrameworkCore.MySql 

注意，微軟的EF框架沒有提供MySQL的接入，所以引用了一個(gè)三方的庫(kù)。

至此，項(xiàng)目的準(zhǔn)備工作完成。

2. 實(shí)現(xiàn)數(shù)據(jù)層

在DomainLayer目錄里，建一個(gè)Models目錄。在Models目錄下，建兩個(gè)類：

BaseEntity.cs

public class BaseEntity 
{ 
    public int Id { get; set; } 
    public DateTime CreatedDate { get; set; } 
    public DateTime ModifiedDate { get; set; } 
    public bool IsActive { get; set; } 
} 

Customer.cs

public class Customer : BaseEntity 
{ 
    public string CustomerName { get; set; } 
    public string PurchasesProduct { get; set; } 
    public string PaymentType { get; set; } 
} 

兩個(gè)類，Customer派生自BaseEntity。沒什么特殊的含義，也是一個(gè)習(xí)慣。而且，后面到存儲(chǔ)層寫著方便。

后面，我們會(huì)用到Customer和BaseEntity實(shí)體類創(chuàng)建的數(shù)據(jù)表。為了讓大家看的明白，我在這兒建一個(gè)目錄EntityMapper，在目錄里寫個(gè)表結(jié)構(gòu)映射。

CustomerMap.cs

public class CustomerMap : IEntityTypeConfiguration<Customer> 
{ 
    public void Configure(EntityTypeBuilder<Customer> builder) 
    { 
        builder.HasKey(x => x.Id) 
            .HasName("pk_customerid"); 
 
        builder.Property(x => x.Id).ValueGeneratedOnAdd() 
            .HasColumnName("id") 
                .HasColumnType("INT"); 
        builder.Property(x => x.CustomerName) 
            .HasColumnName("customer_name") 
                .HasColumnType("NVARCHAR(100)"); 
        builder.Property(x => x.PurchasesProduct) 
            .HasColumnName("purchased_product") 
                .HasColumnType("NVARCHAR(100)") 
                .IsRequired(); 
        builder.Property(x => x.PaymentType) 
            .HasColumnName("payment_type") 
                .HasColumnType("NVARCHAR(50)") 
                .IsRequired(); 
        builder.Property(x => x.CreatedDate) 
            .HasColumnName("created_date") 
                .HasColumnType("datetime"); 
        builder.Property(x => x.ModifiedDate) 
            .HasColumnName("modified_date") 
                .HasColumnType("datetime"); 
        builder.Property(x => x.IsActive) 
            .HasColumnName("is_active") 
                .HasColumnType("bit"); 
    } 
} 

或者也可以自己創(chuàng)建一個(gè)表ef.Customer：

CREATE TABLE `Customer` ( 
  `id` int NOT NULL AUTO_INCREMENT, 
  `created_date` datetime DEFAULT NULL, 
  `customer_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL, 
  `is_active` bit(1) DEFAULT NULL, 
  `modified_date` datetime DEFAULT NULL, 
  `payment_type` varchar(50) DEFAULT NULL, 
  `purchased_product` varchar(100) DEFAULT NULL, 
  PRIMARY KEY (`id`) USING BTREE 
) 

3. 實(shí)現(xiàn)存儲(chǔ)層

這個(gè)層，主要用來(lái)操作數(shù)據(jù)庫(kù)。

先在Startup.cs中配置數(shù)據(jù)庫(kù)引用：

public class Startup 
{ 
    public void ConfigureServices(IServiceCollection services) 
    { 
        services.AddDbContextPool<ApplicationDbContext>( 
            options => options.UseMySql( 
                "server=192.168.0.241;user=root;password=xxxxxx;database=ef", 
                new MySqlServerVersion(new Version(8, 0, 21)), 
                mysqlOptions => 
                { 
                    mysqlOptions.CharSetBehavior(CharSetBehavior.NeverAppend); 
                } 
        )); 
    } 
} 

這兒偷個(gè)懶，連接串就直接寫代碼里了。正式做項(xiàng)目時(shí)，最好寫在配置文件中。

在RepositoryLayer目錄中建一個(gè)DataContext，里面用來(lái)放置相關(guān)數(shù)據(jù)庫(kù)會(huì)話，和操作的實(shí)例：

ApplicationDbContext.cs

public partial class ApplicationDbContext : DbContext 
{ 
    public ApplicationDbContext(DbContextOptions options) : base(options) 
    { 
    } 
 
    protected override void OnModelCreating(ModelBuilder modelBuilder) 
    { 
        modelBuilder.ApplyConfiguration(new CustomerMap()); 
 
        base.OnModelCreating(modelBuilder); 
    } 
} 

再建個(gè)目錄RespositoryPattern，用來(lái)存放數(shù)據(jù)庫(kù)操作的類。按照注入的原則，會(huì)是兩個(gè)文件，一個(gè)接口定義，一個(gè)實(shí)現(xiàn)類：

IRepository.cs

public interface IRepository<T> where T : BaseEntity 
{ 
    IEnumerable<T> GetAll(); 
    T Get(int Id); 
    void Insert(T entity); 
    void Update(T entity); 
    void Delete(T entity); 
    void Remove(T entity); 
    void SaveChanges(); 
} 

Repository.cs

public class Repository<T> : IRepository<T> where T : BaseEntity 
{ 
    private readonly ApplicationDbContext _applicationDbContext; 
    private DbSet<T> entities; 
 
    public Repository(ApplicationDbContext applicationDbContext) 
    { 
        _applicationDbContext = applicationDbContext; 
        entities = _applicationDbContext.Set<T>(); 
    } 
 
    public void Delete(T entity) 
    { 
        if (entity == null) 
        { 
            throw new ArgumentNullException("entity"); 
        } 
        entities.Remove(entity); 
        _applicationDbContext.SaveChanges(); 
    } 
    public T Get(int Id) 
    { 
        return entities.SingleOrDefault(c => c.Id == Id); 
    } 
    public IEnumerable<T> GetAll() 
    { 
        return entities.AsEnumerable(); 
    } 
    public void Insert(T entity) 
    { 
        if (entity == null) 
        { 
            throw new ArgumentNullException("entity"); 
        } 
        entities.Add(entity); 
        _applicationDbContext.SaveChanges(); 
    } 
    public void Remove(T entity) 
    { 
        if (entity == null) 
        { 
            throw new ArgumentNullException("entity"); 
        } 
        entities.Remove(entity); 
    } 
    public void SaveChanges() 
    { 
        _applicationDbContext.SaveChanges(); 
    } 
    public void Update(T entity) 
    { 
        if (entity == null) 
        { 
            throw new ArgumentNullException("entity"); 
        } 
        entities.Update(entity); 
        _applicationDbContext.SaveChanges(); 
    } 
} 

4. 實(shí)現(xiàn)服務(wù)層

服務(wù)層用來(lái)實(shí)現(xiàn)核心的業(yè)務(wù)邏輯。同樣先建一個(gè)目錄CustomerService，方便注入，也是一個(gè)接口一個(gè)類：

ICustomerService.cs

public interface ICustomerService 
{ 
    IEnumerable<Customer> GetAllCustomers(); 
    Customer GetCustomer(int id); 
    void InsertCustomer(Customer customer); 
    void UpdateCustomer(Customer customer); 
    void DeleteCustomer(int id); 
} 

CustomerService.cs

public class CustomerService : ICustomerService 
{ 
    private IRepository<Customer> _repository; 
 
    public CustomerService(IRepository<Customer> repository) 
    { 
        _repository = repository; 
    } 
 
    public IEnumerable<Customer> GetAllCustomers() 
    { 
        return _repository.GetAll(); 
    } 
    public Customer GetCustomer(int id) 
    { 
        return _repository.Get(id); 
    } 
    public void InsertCustomer(Customer customer) 
    { 
        _repository.Insert(customer); 
    } 
    public void UpdateCustomer(Customer customer) 
    { 
        _repository.Update(customer); 
    } 
    public void DeleteCustomer(int id) 
    { 
        Customer customer = GetCustomer(id); 
        _repository.Remove(customer); 
        _repository.SaveChanges(); 
    } 
} 

4. 注入

這兒就是套路了，不解釋。

public void ConfigureServices(IServiceCollection services) 
{ 
    services.AddScoped(typeof(IRepository<>), typeof(Repository<>)); 
    services.AddTransient<ICustomerService, CustomerService>(); 
} 

5. 實(shí)現(xiàn)控制器

重要的三層都已經(jīng)實(shí)現(xiàn)。下面做個(gè)演示用的控制器：

CustomerController.cs

[ApiController] 
[Route("[controller]")] 
public class CustomerController : ControllerBase 
{ 
    private readonly ICustomerService _customerService; 
 
    public CustomerController(ICustomerService customerService) 
    { 
        _customerService = customerService; 
    } 
 
    [HttpGet(nameof(GetCustomer))] 
    public IActionResult GetCustomer(int id) 
    { 
        var result = _customerService.GetCustomer(id); 
        if (result != null) 
        { 
            return Ok(result); 
        } 
        return BadRequest("No records found"); 
    } 
    [HttpGet(nameof(GetAllCustomer))] 
    public IActionResult GetAllCustomer() 
    { 
        var result = _customerService.GetAllCustomers(); 
        if (result != null) 
        { 
            return Ok(result); 
        } 
        return BadRequest("No records found"); 
    } 
    [HttpPost(nameof(InsertCustomer))] 
    public IActionResult InsertCustomer(Customer customer) 
    { 
        _customerService.InsertCustomer(customer); 
        return Ok("Data inserted"); 
    } 
    [HttpPut(nameof(UpdateCustomer))] 
    public IActionResult UpdateCustomer(Customer customer) 
    { 
        _customerService.UpdateCustomer(customer); 
        return Ok("Updation done"); 
    } 
    [HttpDelete(nameof(DeleteCustomer))] 
    public IActionResult DeleteCustomer(int Id) 
    { 
        _customerService.DeleteCustomer(Id); 
        return Ok("Data Deleted"); 
    } 
} 

代碼部分全部完成。編譯運(yùn)行~~~

三、總結(jié)

通過上面的代碼可以看到：

• 洋蔥架構(gòu)各層間通過接口互相關(guān)聯(lián)，數(shù)據(jù)引入是在運(yùn)行時(shí)進(jìn)行的
• 應(yīng)用以區(qū)域模型為基礎(chǔ)
• 所有的外部依賴，如數(shù)據(jù)集準(zhǔn)入和管理調(diào)，都是在外部處理
• 適應(yīng)性強(qiáng)，設(shè)計(jì)也方便

總之，從應(yīng)用來(lái)說(shuō)，洋蔥架構(gòu)算是個(gè)很優(yōu)秀的架構(gòu)。以我的經(jīng)驗(yàn)，在多個(gè)共同開發(fā)的項(xiàng)目中，具有比較大的優(yōu)勢(shì)。

本文的相關(guān)代碼，在https://github.com/humornif/Demo-Code/tree/master/0045/demo