Nguyên tắc OOP và tên phương thức

class Boxer:

    def punch(self, punching_bag, strength):
        punching_bag.punch(strength)


class PunchingBag:

    def punch(self, strength):
        print "Punching bag punched with strength", strength

boxer = Boxer()
punching_bag = PunchingBag()

boxer.punch(punching_bag, 2)

Không có nghi ngờ rằng đó punchlà một tên phương pháp tốt trong trường hợp của một võ sĩ. Nhưng tên punchcũng tốt cho phương pháp đấm túi? Trong cả hai trường hợp, tôi có nghĩa là đấm như một lệnh (tức là làm cú đấm).

Một nguyên tắc nhỏ là tên phương thức phải là động từ hoặc vị ngữ sao cho đối tượng bạn gọi chúng ( selftheo quy ước Python chuẩn, thistrong hầu hết các ngôn ngữ khác) trở thành chủ đề.

Theo quy tắc này, file.closelà loại sai, trừ khi bạn đi với mô hình tinh thần mà tệp tự đóng hoặc fileđối tượng không đại diện cho chính tệp đó, mà là xử lý tệp hoặc một loại đối tượng proxy.

Một túi đấm không bao giờ tự đấm, mặc dù vậy punchingBag.punch()cũng là sai. be_punched()là đúng kỹ thuật, nhưng xấu xí. receive_punch()có thể làm việc, hoặc handle_punch(). Một cách tiếp cận khác, khá phổ biến trong JavaScript, là coi các cuộc gọi phương thức đó là các sự kiện và quy ước phải đi kèm với tên sự kiện, có tiền tố là 'bật', do đó sẽ là on_punched()hoặc on_hit(). Ngoài ra, bạn có thể chấp nhận quy ước rằng những người tham gia trong quá khứ biểu thị tiếng nói thụ động và theo quy ước đó, tên phương thức sẽ là chính xác punched().

Một khía cạnh khác cần xem xét là liệu túi đấm có thực sự biết thứ gì đánh vào nó hay không: nó có tạo ra sự khác biệt cho dù bạn đấm nó, đánh nó bằng gậy hay chạy vào nó bằng xe tải? Nếu vậy, sự khác biệt là gì? Bạn có thể rút ra sự khác biệt cho một cuộc tranh cãi, hoặc bạn có cần các phương pháp khác nhau cho các loại hình phạt nhận được khác nhau không? Một phương thức duy nhất có tham số chung có lẽ là giải pháp tao nhã nhất, bởi vì nó giữ cho mức độ khớp nối ở mức thấp và phương thức như vậy không nên được gọi punched()hoặc handle_punch(), mà là một cái gì đó chung chung hơn receive_hit(). Với phương pháp như vậy, bạn có thể thực hiện tất cả các loại diễn viên có thể đánh túi đấm, mà không cần thay đổi túi đấm.

Tôi nghĩ đó là một vấn đề khái niệm (cách chúng ta nghĩ về thế giới). Không sao để nói:

• Nhìn kìa, cánh cửa đang đóng lại. door.close()
• Wow, tờ giấy đang tự gấp. paper.fold()
• Cái quái gì thế?! Tập tin đó trên bàn vừa đóng, không có ai ở quanh. file.close()

Thật kỳ lạ khi nói:

• Cái túi đấm đó trong phòng tập vừa tự đấm. bag.punch()

Nó sẽ cần phải có một cái gì đó để tự đấm vào ngay từ đầu (ví dụ như cánh tay). Bạn có thể sẽ nói:

• Chiếc túi đấm đã bắt đầu tự di chuyển giống như ai đó sẽ đấm nó. punching_bag.move()

Các đối tượng lập trình có thể làm những việc mà người khác thường làm / với họ (trong "thế giới thực"). Nhưng tôi đoán nó phải luôn luôn có ít nhất một số ý nghĩa rằng sự việc đang thực hiện nó với / với chính nó . Bạn sẽ có thể tưởng tượng nó dễ dàng mà không bị che khuất (như trong trường hợp punching_bag).

Đó là vấn đề của hương vị, tôi nghĩ. Punching bag's punch()phương pháp ít nhất là phù hợp với file.close()hoặc frame.move()trong cảm giác trải qua hành động trên chính nó. Câu hỏi lớn hơn là, tại sao Boxerkhông có punch(something)phương pháp nào cả?

Bạn có hai thông điệp khác nhau: một để ra lệnh cho một đối tượng đấm và một để thông báo cho một đối tượng rằng nó đã bị đấm. Hãy xem xét rằng một đối tượng Boxer có thể sẽ cần phải trả lời cả hai . Khác nhau . Đó là một lý do thực sự tốt để đặt cho họ những cái tên khác nhau.

Xu hướng của tôi sẽ là giữ punch(boxer, object, strength)và đổi tên phương pháp ngược lại thành punched. Bạn có thể gọi nó handle_punchhoặc một cái gì đó tương tự nhưng sau đó vẫn còn mơ hồ liệu nó có xử lý lệnh đấm hay thông báo rằng nó bị đấm hay không.

Cách tiếp cận của bạn cuối cùng sẽ dẫn đến mã rất ghép.

Để tóm tắt lý tưởng của Eric Lippert ở đây, bạn muốn võ sĩ có thể đấm được nhiều thứ tuyệt vời. Có túi đấm là chữ ký của chức năng võ sĩ ngụ ý rằng võ sĩ được tạo ra với kiến ​​thức ngay lập tức về Tất cả (đó là cú đấm). Cộng với việc đấm và nhận cú đấm là hai điều RẤT khác nhau, do đó họ không nên chia sẻ cùng một tên.

Tôi thà mô hình hóa nó như một Boxer tạo ra một cú đấm (một vật thể khác chứa lực thuộc tính của cú đấm, tầm với, hướng, v.v.).

Sau đó, có túi đấm với một phương pháp như onPunch nhận đối tượng đấm này có thể tự tính toán hiệu ứng của cú đấm.

Giữ điều này trong tâm trí tên của những điều quan trọng rất nhiều. Nó phải phù hợp với mô hình tinh thần bạn có của tình huống. Nếu bạn thấy mình đang cố gắng giải thích làm thế nào điều gì đó có thể xảy ra mà không có ý nghĩa ngay từ cái nhìn đầu tiên, hoặc nếu bạn gặp khó khăn nhất trong việc đặt tên thì có lẽ mô hình của bạn đã sai và cần phải thay đổi.

Thật khó để thay đổi một mô hình sau khi bạn bắt đầu, mọi người thường có xu hướng uốn cong thực tế để phù hợp với mô hình. Vấn đề với điều này là khi bạn uốn cong mọi thứ cho phù hợp (chẳng hạn như túi đấm có thể đấm mọi thứ), thế giới bạn đang tạo ra ngày càng phức tạp hơn và các tương tác ngày càng khó thực hiện hơn. Cuối cùng bạn sẽ đạt đến một điểm mà việc thêm ngay cả những thứ tầm thường nhất trở thành cơn ác mộng của những thay đổi và lỗi. Khoản nợ kỹ thuật khái niệm này có thể có một mức giá rất cao ngay cả khi chi phí ban đầu được coi là điều rẻ nhất để làm.

Đây là vấn đề mà tôi gọi là sự nhầm lẫn "đối tượng / chủ đề" và nó khá phổ biến.

Các câu nói chung có một chủ ngữ thực hiện động từ trên đối tượng đích của chúng .

Bây giờ liên quan đến lập trình, điều duy nhất thực sự làm mọi thứ là máy tính. Hoặc hầu như một quá trình, chủ đề hoặc một sợi. Các đối tượng không được animate theo mặc định. Họ không có chủ đề riêng của họ đang chạy để họ thực sự không thể làm gì.

Điều này có nghĩa là các phương thức hoạt động trên chúng, chúng là mục tiêu của hành động chứ không phải ai thực hiện hành động đó. Đó là lý do tại sao chúng tôi gọi chúng là "đối tượng" chứ không phải "đối tượng"!

Khi bạn nói File.closeđó không phải là tệp tự đóng, thì luồng đang chạy sẽ đóng tệp. Nếu bạn nói Array.sort, luồng đang chạy sắp xếp mảng. Nếu bạn nói HttpServer.sendRequest, luồng đang chạy hiện tại sẽ gửi yêu cầu đến máy chủ (không phải ngược lại!). Nói tương tự PunchingBag.punchcó nghĩa là các chủ đề chạy hiện tại đấm túi.

Điều này có nghĩa là nếu bạn muốn Boxercó khả năng đấm, thì nó phải là một lớp con của Threadnó để nó có thể làm những việc như đấm túi trong chức năng luồng của nó.

Tuy nhiên, đôi khi cũng có ý nghĩa khi nói đấm túi tự đấm trong trường hợp mỗi đối tượng có luồng riêng, bạn có thể muốn tránh điều kiện cuộc đua và thực hiện các cuộc gọi phương thức khi gửi tin nhắn: bạn đấm túi bằng cách gửi punchtin nhắn, đó là cú đấm sau đó chính nó sẽ gửi lại cho bạn punch successfultin nhắn, nhưng đó chỉ là một chi tiết thực hiện.

Tôi đồng ý rằng "punch" là một tên phương thức tốt cho lớp Boxer, vì (với một số điều chỉnh) nó có thể được sử dụng lại để chống lại các đối tượng khác. Nó cũng mô tả chính xác rằng một đối tượng của một lớp đang thực hiện một hành động trên một đối tượng khác. Mặc dù vậy, tôi sẽ đổi tên phương thức thành "doPunch", để thể hiện rõ hơn mối quan hệ.

Tuy nhiên, đối với lớp PunchingBag, tôi thấy tên phương thức quá mơ hồ hoặc không chính xác một chút về những gì đang xảy ra trong phương thức. Khi tôi thấy "cú đấm", tôi nghĩ rằng có thứ gì đó đang đấm thứ khác. Tuy nhiên, ở đây, đối tượng PunchingBag đang phản ứng với một cú đấm từ một đối tượng (trong trường hợp này là đối tượng Boxer). Vì vậy, tôi sẽ đổi tên phương thức ở đây thành "isPunched" để minh họa rằng đối tượng đang phản ứng với một cú đấm.

Mặc dù, đây là cách giải thích của tôi về cách tôi sẽ đặt tên cho các phương thức. Tất cả là vấn đề của hương vị và tiêu chuẩn mà bạn đang tuân theo.

hmmmm Tôi đang nghi ngờ túi đấm như một lớp học, bởi vì bạn không thực sự quan tâm đến túi đấm - bạn quan tâm đến tác động và sức mạnh của nắm đấm Boxers. vì vậy các phương pháp nên là về bất cứ điều gì đang đo lường và báo cáo tác động của cú đấm. ngay cả khi điều này đến từ 'túi đấm', việc đặt tên vẫn phải tiết lộ trách nhiệm - như punchImpactMeter, v.v.

Các võ sĩ đấm túi đấm -> boxer.punch

Đấm đấm bị đấm bởi võ sĩ -> punchingbag.get_punch