Cú pháp mượt mà, hấp dẫn nhất mà bạn đã tìm thấy để xác nhận tính chính xác của thông số trong C# là gì?

Question

Một vấn đề phổ biến trong bất kỳ ngôn ngữ nào là để khẳng định rằng các tham số được gửi đến một phương thức đáp ứng yêu cầu của bạn và nếu không, để gửi các thông báo lỗi đẹp, có thông tin. Loại mã này được lặp đi lặp lại nhiều lần, và chúng tôi thường cố gắng tạo ra những người trợ giúp cho nó. Tuy nhiên, trong C#, có vẻ như những người giúp đỡ bị buộc phải đối phó với một số trùng lặp buộc chúng tôi bởi ngôn ngữ và trình biên dịch. Để thể hiện ý tôi, hãy để tôi trình bày một số mã thô không có người giúp đỡ, theo sau là một người trợ giúp có thể. Sau đó, tôi sẽ chỉ ra sự trùng lặp trong helper và cụm từ câu hỏi của tôi một cách chính xác.

Thứ nhất, các mã không có người giúp đỡ:

public void SomeMethod(string firstName, string lastName, int age) 
{ 
    if(firstName == null) 
    { 
      throw new WhateverException("The value for firstName cannot be null."); 
    } 

    if(lastName == null) 
    { 
      throw new WhateverException("The value for lastName cannot be null."); 
    } 

    // Same kind of code for age, making sure it is a reasonable range (< 150, for example). 
    // You get the idea 
} 

}

Bây giờ, các mã với một nỗ lực hợp lý tại một helper:

public void SomeMethod(string firstName, string lastName, int age) 
{ 
     Helper.Validate(x=> x !=null, "firstName", firstName); 
     Helper.Validate(x=> x!= null, "lastName", lastName); 
} 

Các chính câu hỏi là: Lưu ý cách mã có s giá trị của thông số và tên của tham số ("firstName" và firstName). Điều này là để thông báo lỗi có thể nói, "Blah blah blah giá trị cho tham số firstName." Bạn đã tìm thấy cách nào để giải quyết vấn đề này bằng cách sử dụng sự phản chiếu hay bất cứ điều gì khác? Hoặc một cách để làm cho nó ít đau đớn?

Và thông thường hơn, bạn có tìm thấy bất kỳ cách nào khác để hợp lý hóa nhiệm vụ xác thực thông số này trong khi giảm trùng lặp mã không?

EDIT: Tôi đã đọc mọi người nói về việc sử dụng thuộc tính Tham số, nhưng không bao giờ tìm thấy cách nào đó xung quanh trùng lặp. Bất cứ ai có may mắn với điều đó?

Cảm ơn!

Answer 1

Điều này có thể phần nào hữu ích:

Design by contract/C# 4.0/avoiding ArgumentNullException

Answer 2

Trong trường hợp này, thay vì sử dụng loại ngoại lệ của riêng mình, hoặc các loại thực sự chung chung như ApplicationException .. Tôi nghĩ rằng đó là tốt nhất để sử dụng được xây dựng trong các loại ngoại lệ được dành riêng cho sử dụng này:

Trong số những người .. System.ArgumentException, System.ArgumentNullException ...

Answer 3

Bạn nên kiểm tra Code Contracts; họ làm khá nhiều chính xác những gì bạn đang yêu cầu. Ví dụ:

[Pure] 
public static double GetDistance(Point p1, Point p2) 
{ 
    CodeContract.RequiresAlways(p1 != null); 
    CodeContract.RequiresAlways(p2 != null); 
    // ... 
} 

Answer 4

Không biết nếu kỹ thuật này vận chuyển từ C/C++ với C#, nhưng tôi đã làm điều này với các macro:

 

    #define CHECK_NULL(x) { (x) != NULL || \ 
      fprintf(stderr, "The value of %s in %s, line %d is null.\n", \ 
      #x, __FILENAME__, __LINE__); } 

Answer 5

sở thích của tôi là nên chỉ đánh giá điều kiện và chuyển kết quả thay vì truyền một biểu thức được đánh giá và tham số để đánh giá nó. Ngoài ra, tôi thích có khả năng tùy chỉnh toàn bộ tin nhắn. Lưu ý rằng đây là những ưu tiên đơn giản - tôi không nói rằng mẫu của bạn là sai - nhưng có một số trường hợp điều này rất hữu ích.

Helper.Validate(firstName != null || !string.IsNullOrEmpty(directoryID), 
       "The value for firstName cannot be null if a directory ID is not supplied."); 

Answer 6

Sử dụng thư viện của tôi The Helper Trinity:

public void SomeMethod(string firstName, string lastName, int age) 
{ 
    firstName.AssertNotNull("firstName"); 
    lastName.AssertNotNull("lastName"); 

    ... 
} 

Cũng hỗ trợ khẳng định rằng các thông số liệt kê là chính xác, các bộ sưu tập và các nội dung của họ là phi null, các thông số chuỗi đều là phòng không trống Etcetera. Xem tài liệu hướng dẫn sử dụng here để biết các ví dụ chi tiết.

Answer 7

Tôi giải quyết vấn đề chính xác này cách đây vài tuần, sau khi nghĩ rằng việc kiểm tra các thư viện có vẻ như cần một triệu phiên bản khác nhau của Assert để làm cho thông điệp của họ có tính mô tả.

Here's my solution.

Giới thiệu tóm tắt tổng kết - trao chút mã này:

int x = 3; 
string t = "hi"; 
Assert(() => 5*x + (2/t.Length) < 99); 

chức năng Khẳng định của tôi có thể in ra các bản tóm tắt sau đây về những gì đang được truyền cho nó:

(((5 * x) + (2/t.Length)) < 99) == True where 
{ 
    ((5 * x) + (2/t.Length)) == 16 where 
    { 
    (5 * x) == 15 where 
    { 
     x == 3 
    } 
    (2/t.Length) == 1 where 
    { 
     t.Length == 2 where 
     { 
     t == "hi" 
     } 
    } 
    } 
} 

Vì vậy, tất cả các tên định danh và các giá trị và cấu trúc của biểu thức, có thể được bao gồm trong thông báo ngoại lệ, mà không cần phải đặt lại chúng trong chuỗi được trích dẫn.

Answer 8

Postsharp hoặc một số khác AOPframework.

Answer 9

Wow, tôi thấy một cái gì đó thực sự thú vị ở đây. Chris ở trên đã cung cấp liên kết đến một câu hỏi Stack Overflow khác. Một trong những câu trả lời có chỉ vào một bài đăng blog trong đó mô tả làm thế nào để nhận được mã như thế này:

public static void Copy<T>(T[] dst, long dstOffset, T[] src, long srcOffset, long length) 
{ 
    Validate.Begin() 
      .IsNotNull(dst, “dst”) 
      .IsNotNull(src, “src”) 
      .Check() 
      .IsPositive(length) 
      .IsIndexInRange(dst, dstOffset, “dstOffset”) 
      .IsIndexInRange(dst, dstOffset + length, “dstOffset + length”) 
      .IsIndexInRange(src, srcOffset, “srcOffset”) 
      .IsIndexInRange(src, srcOffset + length, “srcOffset + length”) 
      .Check(); 

    for (int di = dstOffset; di < dstOffset + length; ++di) 
     dst[di] = src[di - dstOffset + srcOffset]; 
} 

tôi không tin nó là các trả lời tốt nhất, nhưng nó chắc chắn là thú vị. Here's the blog post, từ Rick Brewster.

Answer 10

Được rồi, tôi lại là một lần nữa, và tôi đã tìm thấy một thứ gì đó thật đáng kinh ngạc và thú vị. Đó là một bài đăng trên blog khác được đề cập đến từ câu hỏi SO khác mà Chris, ở trên, đã đề cập.

Cách tiếp cận của anh chàng này cho phép bạn viết này:

public class WebServer 
    { 
     public void BootstrapServer(int port, string rootDirectory, string serverName) 
     { 
      Guard.IsNotNull(() => rootDirectory); 
      Guard.IsNotNull(() => serverName); 

      // Bootstrap the server 
     } 
    } 

Lưu ý rằng không có chuỗi chứa "rootDirectory" và không có chuỗi chứa "serverName" !! Và thông báo lỗi của anh ta có thể nói điều gì đó như "Tham số rootDirectory không được rỗng."

Đây chính là điều tôi muốn và nhiều hơn tôi mong đợi. Here's the link to the guy's blog post.

Và việc thực hiện khá đơn giản, như sau:

public static class Guard 
    { 
     public static void IsNotNull<T>(Expression<Func<T>> expr) 
     { 
      // expression value != default of T 
      if (!expr.Compile()().Equals(default(T))) 
       return; 

      var param = (MemberExpression) expr.Body; 
      throw new ArgumentNullException(param.Member.Name); 
     } 
    } 

Lưu ý rằng điều này làm cho việc sử dụng "phản ánh tĩnh", do đó trong một vòng lặp chặt chẽ hoặc một cái gì đó, bạn có thể muốn sử dụng phương pháp Rick Brewster trên .

Ngay sau khi tôi đăng bài này, tôi sẽ bỏ phiếu cho Chris và phản hồi cho câu hỏi SO khác. Đây là một số công cụ tốt!!!

Answer 11

Nó không áp dụng ở khắp mọi nơi, nhưng nó có thể giúp đỡ trong nhiều trường hợp:

Tôi giả sử rằng "SomeMethod" đang tiến hành một số hoạt động về hành vi trên các dữ liệu "tên cuối cùng", "tên đầu tiên" và "tuổi" . Đánh giá thiết kế mã hiện tại của bạn. Nếu ba phần dữ liệu đang khóc cho một lớp, hãy đưa chúng vào một lớp học. Trong lớp học đó, bạn cũng có thể đặt séc của mình. Điều này sẽ miễn phí "SomeMethod" từ kiểm tra đầu vào.

Kết quả cuối cùng sẽ là một cái gì đó như thế này:

public void SomeMethod(Person person) 
{ 
    person.CheckInvariants(); 
    // code here ... 
} 

Cuộc gọi sẽ là một cái gì đó như thế này (nếu bạn sử dụng .NET 3.5):

SomeMethod(new Person { FirstName = "Joe", LastName = "White", Age = 12 }); 

theo giả định rằng lớp sẽ trông giống như sau:

public class Person 
{ 
    public string FirstName { get; set; } 
    public string LastName { get; set; } 
    public int Age { get; set; } 

    public void CheckInvariants() 
    { 
     assertNotNull(FirstName, "first name"); 
     assertNotNull(LastName, "last name"); 
    } 

    // here are your checks ... 
    private void assertNotNull(string input, string hint) 
    { 
     if (input == null) 
     { 
      string message = string.Format("The given {0} is null.", hint); 
      throw new ApplicationException(message); 
     } 
    } 

Thay vì đường cú pháp .NET 3.5 bạn cũng có thể sử dụng hàm tạo đối số để tạo đối tượng Person.

Answer 12

Tương tự như vậy, this đăng bởi Miško Hevery trên Google Testing Blog cho rằng loại kiểm tra thông số này có thể không phải lúc nào cũng là một điều tốt. Các cuộc tranh luận kết quả trong các ý kiến ​​cũng làm tăng một số điểm thú vị.

Answer 13

Lokad Shared Libraries cũng có phân tích cú pháp IL thực hiện dựa trên điều này, tránh phải trùng lặp tên thông số trong chuỗi.

Ví dụ:

Enforce.Arguments(() => controller,() => viewManager,() => workspace); 

sẽ ném một ngoại lệ với tên tham số thích hợp nếu bất kỳ đối số được liệt kê là null. Nó cũng có một quy tắc thực thi chính sách dựa trên thực sự gọn gàng.

ví dụ:

Enforce.Argument(() => username, StringIs.Limited(3, 64), StringIs.ValidEmail); 

Answer 14

Đây là câu trả lời của tôi cho vấn đề. Tôi gọi nó là "Guard Claws". Nó sử dụng bộ phân tích IL từ Shared Libs Lokad nhưng có một cách tiếp cận đơn giản hơn để nêu các điều khoản bảo vệ thực tế:

string test = null; 
Claws.NotNull(() => test); 

Bạn có thể xem chi tiết ví dụ về việc sử dụng nó trong specs.

Vì nó sử dụng lambdas thực làm đầu vào và chỉ sử dụng trình phân tích cú pháp IL để tạo ra ngoại lệ trong trường hợp vi phạm nên thực hiện tốt hơn trên "đường dẫn hạnh phúc" hơn thiết kế dựa trên biểu thức ở nơi khác trong các câu trả lời này.

Các liên kết không làm việc, đây là URL: http://github.com/littlebits/guard_claws/