Làm thế nào và tại sao để quyết định giữa các phương thức đặt tên với các loại tiền tố và nhận được

Tôi luôn gặp khó khăn trong việc tìm ra nếu tôi nên đặt tên cho một phương thức nhất định bắt đầu bằng getSomethingso với findSomething.

Vấn đề nằm ở việc tạo các trình trợ giúp cho các API được thiết kế kém. Điều này thường xảy ra khi lấy dữ liệu từ một đối tượng, đòi hỏi đối tượng làm tham số. Đây là một ví dụ đơn giản:

public String getRevision(Item item) {
    service.load(item, "revision");
    // there is usually more work to do before getting the data..
    try {
        return item.get_revision();
    }
    catch(NotLoadedException exception) {
        log.error("Property named 'property_name' was not loaded", exception);
    }
    return null;
}

Làm thế nào và tại sao để quyết định giữa việc đặt tên phương thức này là getRevision()hay findRevision()?

Tôi sử dụng Getkhi tôi biết thời gian truy xuất sẽ rất ngắn (như trong tra cứu từ bảng băm hoặc btree).

Findngụ ý một quá trình tìm kiếm hoặc thuật toán tính toán đòi hỏi một khoảng thời gian "dài hơn" để thực thi (đối với một số giá trị tùy ý dài hơn).

Tôi sẽ nói rằng findcó thể thất bại nhưng getkhông nên.

Để trích dẫn một cuộc trò chuyện tôi thường có với các con tôi:

tôi: Này nhóc! Đi tìm tôi vài cục pin

Đứa trẻ: Nhưng họ ở đâu?

tôi: đó là lý do tại sao tôi bảo bạn đi tìm chúng Nếu tôi biết họ ở đâu, tôi sẽ bảo bạn đi lấy chúng. Hoặc bạn có thể hỏi mẹ của bạn.

Ý tưởng tương tự giữ:

• sử dụng "get" cho một phương thức trả về một phần thông tin có sẵn với giá rẻ (và có thể được nội tuyến hoặc tối ưu hóa đi) hoặc cho một phần thông tin thuộc sở hữu duy nhất của đối tượng này.

• sử dụng "find" cho một phương thức hoạt động để lấy một phần thông tin hoặc sử dụng các đối tượng khác để tìm nó.

Tìm ngụ ý không có kết quả, như khi thực hiện truy vấn cơ sở dữ liệu với một số tham số có thể thay đổi giữa các cuộc gọi. Mặt khác, có nghĩa là các kết quả được biết đến theo phương pháp trước hoặc sẽ không thay đổi một khi đã biết, rằng không có tham số nào cho cuộc gọi.
Vì vậy, tôi sẽ sử dụng ví dụ Khách hàng findCustomerById (khách hàng dài) và Khách hàng getCustomer ()

Tôi áp dụng mô hình sau:

• Foo GetFoo() không thể trả về null và độ phức tạp của nó là O (log (n)) hoặc ít hơn
• bool TryGetFoo(out Foo) có thể trả về null và độ phức tạp của nó là O (log (n)) hoặc ít hơn
• Foo FindFoo() không thể trả về null và độ phức tạp của nó nhiều hơn O (log (n))
• bool TryFindFoo(out Foo) có thể trả về null và độ phức tạp của nó nhiều hơn O (log (n))

Bằng cách đó, mã khá rõ ràng về ý định và sự phức tạp mà bạn có thể mong đợi.

Thông thường, Getters dành cho danh sách trực tiếp hoặc truy cập từ điển / bộ.
Công cụ tìm kiếm được tìm kiếm sâu, quét toàn bộ danh sách, v.v ...

Trong trường hợp của bạn:

public bool TryGetRevision( Item item, out String revision ) 
{
    service.load( item, "revision" );
    // there is usually more work to do before getting the data..
    try 
    {
        revision = item.get_revision();
        return true;
    }
    catch( NotLoadedException exception )
    {
        log.error( "Property named 'property_name' was not loaded", exception );
        revision = "";
        return false;
    }
}

getlà phù hợp trong mọi trường hợp _ trong thực tế, người ta thường cho rằng để có được thứ gì đó bạn cần tìm thứ đó trước. Vì vậy, nếu bạn không chắc chắn, hãy sử dụng get.

Tôi sẽ sử dụng findcho các phương thức như findMinimum()hoặc findOptimal(), ví dụ, nơi có một số thuật toán đặc biệt tính toán giá trị trả về và không chỉ đơn giản là yêu cầu DB, hệ thống tệp, máy chủ từ xa, v.v. để nhận một số dữ liệu.

Không sử dụng tìm hoặc nhận tiền tố. Đây là một sự vi phạm của UniformAccessPrincipl được tạo ra bởi merter bertrand. Tại sao không tạo một phương thức như sau:

public String revision(Item item)

Tôi thường sẽ sử dụng Getđể truy xuất một đối tượng / giá trị và Findđể lấy vị trí của nó (ví dụ trong một mảng).

ví dụ:

object o = obj.GetItem( 'name');

integer i = somearray.Find( 'name');

Đối với tôi, findngụ ý có thể có nhiều hơn một kết quả hiện tại. getchỉ ngụ ý một.