Tên phương pháp lấy dữ liệu [đã đóng]

Cảnh báo: Đây không phải là một câu hỏi / thảo luận không quá nghiêm trọng mà tôi đang đăng ... nhưng tôi sẵn sàng cá rằng hầu hết các nhà phát triển đã cân nhắc "vấn đề" này ...

Luôn muốn nhận được các ý kiến ​​khác về quy ước đặt tên cho các phương thức đã đi và lấy dữ liệu từ đâu đó và trả về ...

Hầu hết các tên phương thức đều đơn giản và rõ ràng ... SaveEaffee (), DeleteOrder (), UploadDocument (). Tất nhiên với các lớp, bạn rất có thể sẽ sử dụng dạng rút gọn ... Lưu (), Xóa (), Tải lên () tương ứng.

Tuy nhiên, tôi luôn phải vật lộn với hành động ban đầu ... làm thế nào để lấy dữ liệu. Có vẻ như đối với mọi dự án, cuối cùng tôi phải nhảy giữa các quy ước đặt tên khác nhau bởi vì tôi không bao giờ hài lòng với cái cuối cùng mà tôi đã sử dụng. Theo như tôi có thể nói đây là những khả năng ->

• GetBooks ()
• FetchBooks ()
• Truy xuất Sách ()
• FindBooks ()
• LoadBooks ()

Bạn nghĩ gì?

Đó là tất cả về ngữ nghĩa nhất quán ;

Trong tiêu đề câu hỏi của bạn, bạn sử dụng lấy dữ liệu . Điều này cực kỳ chung chung theo nghĩa là bạn cần phải xác định nhận được nghĩa là gì về mặt ngữ nghĩa một cách rõ ràng. Tôi đưa ra các ví dụ sau để hy vọng đưa bạn đi đúng hướng khi nghĩ đến việc đặt tên cho mọi thứ.

1. getBooks() là khi bạn nhận được tất cả các sách được liên kết với một đối tượng, điều đó có nghĩa là tiêu chí cho bộ sách đã được xác định và chúng đến từ đâu là một chi tiết ẩn.
2. findBooks(criteria) là khi bạn đang cố gắng tìm một tập hợp con của sách dựa trên các tham số của lệnh gọi phương thức, điều này thường sẽ bị quá tải với các tiêu chí tìm kiếm khác nhau
3. loadBooks(source) là khi bạn đang tải từ một nguồn bên ngoài, chẳng hạn như tệp hoặc db.
4. Tôi sẽ không sử dụng tìm nạp / truy xuất vì chúng quá mơ hồ và bị nhầm lẫn với get và không có ngữ nghĩa rõ ràng được liên kết với các điều khoản.

Ví dụ: fetch ngụ ý rằng một thực thể nào đó cần phải đi lấy thứ gì đó ở xa và mang nó trở lại. Chó tìm nạp một cây gậy, và truy xuất là một từ đồng nghĩa với tìm nạp với ngữ nghĩa bổ sung mà bạn có thể đã sở hữu thứ trước đó. get là một từ đồng nghĩa với có được cũng có nghĩa là bạn phải sở hữu duy nhất của một cái gì đó và không ai có thể có được nó cùng một lúc.

Ngữ nghĩa cực kỳ quan trọng:

ngành ngôn ngữ học và logic học liên quan đến ý nghĩa

Các nhận xét là bằng chứng cho thấy các thuật ngữ chung chung như get và fetch không có ngữ nghĩa cụ thể và được những người khác nhau hiểu theo cách khác nhau. Chọn một ngữ nghĩa cho một thuật ngữ, ghi lại những gì nó định ngụ ý nếu ngữ nghĩa đó không rõ ràng và phù hợp với việc sử dụng nó.

những từ có ý nghĩa mơ hồ hoặc tham vọng được những người khác nhau đưa ra những ngữ nghĩa khác nhau vì định kiến ​​và định kiến ​​dựa trên ý kiến ​​cá nhân của họ và điều đó sẽ không bao giờ kết thúc tốt đẹp.

Thành thật mà nói, bạn chỉ nên quyết định với nhóm của mình nên sử dụng quy ước đặt tên nào. Nhưng để giải trí, hãy xem luồng suy nghĩ của bạn sẽ ra sao để quyết định bất kỳ điều nào trong số này:

• GetBooks ()

Phương pháp này thuộc về một nguồn dữ liệu và chúng tôi không quan tâm cách nó lấy chúng, chúng tôi chỉ muốn Lấy chúng từ nguồn dữ liệu.

• FetchBooks ()

Bạn coi nguồn dữ liệu của mình như một con chó săn, và nhiệm vụ của anh ta là lấy sách của bạn. Tôi đoán bạn nên tự mình quyết định xem anh ta có thể nhét bao nhiêu chiếc vào miệng cùng một lúc.

• FindBooks ()

Nguồn dữ liệu của bạn là một thủ thư và sẽ sử dụng hệ thống Dewey Decimal để tìm sách của bạn.

• LoadBooks ()

Những cuốn sách này thuộc một loại "túi sách điện tử" nào đó và phải được xếp vào đó. Đảm bảo gọi ZipClosed () sau khi tải để tránh làm mất chúng.

• Truy xuất Sách ()

Tôi không có gì cả.

Câu trả lời là chỉ cần bám vào những gì bạn cảm thấy thoải mái và nhất quán.

Nếu bạn có một trang web barnes và quý tộc và bạn sử dụng GetBooks (), thì nếu bạn có một mục khác như thực thể Phim, hãy sử dụng GetMovies (). Vì vậy, bất cứ điều gì bạn và nhóm của bạn thích và nhất quán.

Trong OO (C ++ / Java), tôi có xu hướng sử dụng getSomething và setSomething vì rất thường xuyên, nếu không phải lúc nào tôi cũng nhận thuộc tính private từ lớp đại diện cho đối tượng dữ liệu đó hoặc thiết lập nó - cặp getter / setter. Như một điểm cộng, Eclipse tạo chúng cho bạn.

Tôi có xu hướng chỉ sử dụng Tải khi ý tôi là tệp - như trong "tải vào bộ nhớ" và điều đó thường ngụ ý tải vào nguyên thủy, cấu trúc (C) hoặc đối tượng. Tôi sử dụng gửi / nhận cho web.

Như đã nói ở trên, tính nhất quán là tất cả mọi thứ và bao gồm cả các nhà phát triển chéo.

Không rõ ý bạn là "lấy dữ liệu". Từ cơ sở dữ liệu? Một tập tin? Ký ức?

Quan điểm của tôi về việc đặt tên phương thức là vai trò của nó là loại bỏ bất kỳ sự mơ hồ nào và lý tưởng là cần tra cứu tài liệu. Tôi tin rằng điều này nên được thực hiện ngay cả khi các tên phương thức dài hơn. Theo các nghiên cứu, hầu hết các nhà phát triển trung cấp + có thể đọc nhiều từ trong trường hợp lạc đà. Với IDE và tự động hoàn thành, việc viết các tên phương thức dài cũng không phải là vấn đề.

Do đó, khi tôi nhìn thấy "fetchBooks", trừ khi ngữ cảnh rất rõ ràng (ví dụ: một lớp có tên BookFetcherFromDatabase), thì nó rất mơ hồ. Tìm nạp nó từ đâu? Sự khác biệt giữa tìm nạp và tìm kiếm là gì? Bạn cũng đang mạo hiểm với vấn đề rằng một số nhà phát triển sẽ liên kết ngữ nghĩa với các từ khóa nhất định. Ví dụ: tìm nạp cho cơ sở dữ liệu (hoặc bộ nhớ) so với tải (từ tệp) hoặc tải xuống (từ web).

Tôi muốn nhìn thấy một cái gì đó như "fetchBooksFromDatabase", "loadBookFromFile", "findBooksInCollection", v.v. Nó ít dễ nhìn hơn, nhưng một khi bạn vượt qua độ dài, nó sẽ rõ ràng. Mọi người đọc cái này sẽ hiểu ngay những gì bạn đang cố gắng làm.