Hướng dẫn sử dụng DependencyResolver trong Custom Validation Attribute

Custom Data Annotation (Attribute) là gì?

Data Annotation trong ASP.NET MVC là một cách để bạn thêm các thuộc tính (metadata) vào các thuộc tính của model, cung cấp thông tin bổ sung về cách dữ liệu đó sẽ được xử lý.

Custom Validation Attribute là một cách để bạn tự định nghĩa các quy tắc validate dữ liệu riêng cho các thuộc tính của model trong ASP.NET MVC. Nó kế thừa từ lớp ValidationAttribute và cho phép bạn tạo các logic validate phức tạp hơn so với các Data Annotation có sẵn.

Ví dụ:

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
public sealed class NotEqualToAttribute : ValidationAttribute
{
    private const string DefaultErrorMessage = "{0} cannot be the same as {1}.";

    public string OtherProperty { get; private set; }

    public NotEqualToAttribute(string otherProperty)
      : base(DefaultErrorMessage)
    {
        if (string.IsNullOrEmpty(otherProperty))
        {
            throw new ArgumentNullException("otherProperty");
        }

        OtherProperty = otherProperty;
    }

    public override string FormatErrorMessage(string name)
    {
        return string.Format(ErrorMessageString, name, OtherProperty);
    }

    protected override ValidationResult IsValid(object value,
                          ValidationContext validationContext)
    {
        if (value != null)
        {
            var otherProperty = validationContext.ObjectInstance.GetType()
                               .GetProperty(OtherProperty);

            var otherPropertyValue = otherProperty
                          .GetValue(validationContext.ObjectInstance, null);

            if (value.Equals(otherPropertyValue))
            {
                return new ValidationResult(
                  FormatErrorMessage(validationContext.DisplayName));
            }
        }

        return ValidationResult.Success;
    }
}>

Inversion of Control (IoC) là gì?

Inversion of Control (IoC) là một nguyên tắc trong thiết kế phần mềm, trong đó trách nhiệm tạo lập và quản lý life cyle của các đối tượng (dependencies) được chuyển từ các classes sử dụng chúng sang một thực thể khác, thường là một container IoC. Điều này giúp tách biệt việc tạo các object từ business logic, cải thiện khả năng mở rộng và bảo trì của ứng dụng.

IoC có thể được thực hiện thông qua

1. Dependency Injection (DI): Các dependencies được cung cấp cho Target Object, mà object không cần làm bất cứ việc gì, nói cách khác dependency được injected vào target object
   
2. Service Locator: Target Object truy cập các dependencies cần thiết từ Locator(container, register...). Locator gi tìm kiếm các dependencies được yêu cầu và cung cấp nó cho target object. Nó không được injected nhưng được located thay thế.
   

Tại sao không sử dụng Dependency Injection trực tiếp trong Custom Validation Attribute

Custom Validation Attribute trong ASP.NET MVC được sử dụng để thực hiện các kiểm tra tùy chỉnh trên dữ liệu của model. Tuy nhiên, có một số lý do khiến Dependency Injection không phù hợp để sử dụng trực tiếp trong các attribute này:

Do mỗi instance của attribute là object mới, bất kỳ trạng thái nào được lưu trữ trong instance đó sẽ bị mất sau mỗi lần khởi tạo. Điều này có nghĩa là attribute phải hoạt động mà không phụ thuộc vào trạng thái bên trong giữa các lần sử dụng.

MVC framework tự động tạo các instance mới của attribute mà không sử dụng container IoC, nên bạn không thể sử dụng constructor injection (một kỹ thuật phổ biến của DI) để tiêm các dependency vào attribute. 

Lifecycle Management of Dependencies: Nếu bạn cố gắng sử dụng services với different scopes (vd: singleton or scoped) trong một attribute,việc quản lý các lifecycle của các services sẽ trở nên phức tạp. Mỗi instance của attribute không thể đảm bảo rằng các dependencies sẽ được quản lý một cách nhất quán và hiệu quả.

Dependency Resolver

Đây là lớp thực thi của mô hình Service Locator, cho phép framework gọi DI Container khi nó cần làm việc với 1 lớp thực thi từ một kiểu cụ thể. 

Dependency Resolver gồm có 2 thành phần: lớp tĩnh DependencyResolver dùng để giải quyết sự phụ thuộc và 1 lớp interface IDependencyResolver. 

Thực ra đây có thể là giải pháp không hoàn hảo nhưng tạm thời giải quyết được issue IoC

Bạn cần setup Autofac và thực hiện việc đăng ký Dependency trong Application_Start()

var builder = new ContainerBuilder()
//your code
var container = builder.Build();

DependencyResolver.SetResolver(new AutofacDependencyResolver(container));

Resolve Dependency trong Custom Validation Attribute

public class CustomValidationAttribute : ValidationAttribute
{
    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        // get service from DependencyResolver
        var service = DependencyResolver.Current.GetService<IYourService>();

        // use service to validate data
        if (service.IsValid(value))
        {
            return ValidationResult.Success;
        }

        return new ValidationResult("Validation failed.");
    }
}

Trong đoạn mã trên: 

• DependencyResolver.Current.GetService<IYourService>(): Lấy instance của IYourService đã được đăng ký trong Autofac. 
• IsValid: override phương thức IsValid để thực hiện logic kiểm tra tùy chỉnh.

Tóm lại

DependencyResolver.Current.GetService là một công cụ mạnh mẽ trong ASP.NET MVC để truy cập các service được quản lý bởi hệ thống DI. Tuy nhiên, việc sử dụng nó nên được cân nhắc cẩn thận, chỉ nên dùng khi các phương pháp DI khác (như constructor injection) không thể áp dụng được. Điều này giúp giữ cho ứng dụng của bạn dễ bảo trì và test hơn.

Tham khảo

Design Pattern – Ví dụ về Service Locator trong C# 

Sử dụng Dependency Injection trong ASP.NET MVC

Nguyên lý lập trình IoC Inversion of control (IoC)