CodeGym /Blog Java /Ngẫu nhiên /Quy ước mã hóa Java. Cái nào nên theo dõi và tại sao

Quy ước mã hóa Java. Cái nào nên theo dõi và tại sao

Xuất bản trong nhóm
Việc biết và tuân theo các tiêu chuẩn ngành cũng như các phương pháp hay nhất là khá quan trọng trong bất kỳ lĩnh vực nào, đặc biệt là trong lĩnh vực lập trình với sự kết hợp phức tạp và đôi khi hỗn loạn của ngôn ngữ mã hóa, công cụ, phương pháp tiếp cận và công nghệ. Đó là lý do tại sao một lập trình viên Java chuyên nghiệp nên thông thạo các Quy ước mã hóa Java, đó là những gì chúng ta sẽ nói hôm nay. Quy ước mã hóa Java.  Những cái nào nên theo dõi và tại sao - 1

Quy ước mã hóa là gì?

Các quy ước viết mã là tập hợp các hướng dẫn cho từng ngôn ngữ lập trình cụ thể với các đề xuất về các khía cạnh khác nhau của phát triển phần mềm bằng ngôn ngữ này, bao gồm phong cách viết mã, các phương pháp và phương pháp hay nhất. Các quy ước viết mã có nghĩa là các lập trình viên phần mềm đang viết mã bằng ngôn ngữ này phải tuân theo vì các hướng dẫn về chất lượng để đảm bảo mã của họ có thể đọc được và người khác có thể bảo trì phần mềm đúng cách. Các quy ước mã hóa thường bao gồm mọi thành phần thiết yếu để tạo phần mềm bằng ngôn ngữ lập trình này, bao gồm tổ chức tệp, thụt đầu dòng, nhận xét, khai báo, câu lệnh, khoảng trắng, quy ước đặt tên, thực hành lập trình, nguyên tắc lập trình, quy tắc lập trình, thực tiễn tốt nhất về kiến ​​trúc, v.v. .

Mục đích của các quy ước mã hóa là gì?

Có một số lý do tại sao các quy ước viết mã đóng một vai trò quan trọng trong phát triển phần mềm.

  • Duy trì phong cách mã thống nhất

Việc tuân theo quy ước viết mã cho phép dự án phần mềm được viết theo một phong cách thống nhất duy nhất, điều này có lợi theo nhiều cách khác nhau, chẳng hạn như sau.

  • Giảm thiểu chi phí bảo trì phần mềm

Một trong những điều quan trọng nhất là làm cho việc bảo trì và hỗ trợ sản phẩm phần mềm trở nên dễ dàng hơn, vì tác giả gốc của chương trình thường không phải là người hỗ trợ nó. Điều này rất quan trọng vì 80% chi phí vòng đời của một phần mềm dành cho việc bảo trì.

  • Cải thiện khả năng đọc phần mềm

Việc cải thiện khả năng đọc của phần mềm là một lợi ích lớn khác, cũng có nhiều ý nghĩa như đơn giản hóa việc giới thiệu các nhà phát triển mới cho dự án và tăng hiệu quả cộng tác của các thành viên trong nhóm phát triển.

  • Đẩy nhanh tiến độ công việc

Cuối cùng, mã được viết và cấu trúc phù hợp là cần thiết để quá trình phát triển phần mềm diễn ra nhanh nhất có thể.

Quy ước mã hóa Java

Khi nói đến Java, có hai quy ước mã hóa phổ biến và nổi tiếng nhất: Quy ước mã Java của OracleQuy ước mã hóa Java Style Guide của Google .

  • Công ước mã Java của Oracle

Quy ước Mã của Oracle được công nhận là quy ước quan trọng nhất vì một số lý do rõ ràng: Quy ước của Oracle là quy ước chính thức vì Oracle là chủ sở hữu của Java, đồng thời cũng là quy ước lâu đời nhất (bản sửa đổi cuối cùng của tài liệu này được thực hiện vào ngày 20 tháng 4, 1999). Một số phần quan trọng của Công ước Mã Java của Oracle sẽ là khuyến nghị sử dụng trường hợp lạc đà khi xác định các lớp, phương thức hoặc biến, để bắt đầu các lớp bằng chữ in hoa và sử dụng danh từ để đặt tên cho chúng, trong khi sử dụng động từ ở dạng mệnh lệnh và bắt đầu từ một chữ cái viết thường cho các phương thức, v.v.

  • Hướng dẫn kiểu Java của Google

Các quy ước viết mã Java từ Google được coi là quan trọng do vị thế của Google là công ty công nghệ và Internet học tập với kinh nghiệm dày dặn trong việc phát triển tất cả các loại ứng dụng Java. Một lý do quan trọng khác là quy ước mã Java của Google đã được cập nhật vào ngày 22 tháng 5 năm 2018, điều này làm cho nó phù hợp hơn so với quy ước mã từ Oracle, đặc biệt là khi mô tả các tính năng tương đối mới của Java chỉ được phát hành như một phần của Java 8 vào năm 2014, chẳng hạn như lambdas và stream. Đây là cách các tác giả của Google's Java Style Guide mô tả nội dung của quy ước viết mã này: “Tài liệu này đóng vai trò là định nghĩa đầy đủ về các tiêu chuẩn viết mã của Google cho mã nguồn trong Java. Giống như các hướng dẫn về phong cách lập trình khác, các vấn đề được đề cập không chỉ là các vấn đề thẩm mỹ về định dạng, mà cả các loại quy ước hoặc tiêu chuẩn mã hóa khác. Tuy nhiên, tài liệu này tập trung chủ yếu vào các quy tắc cứng rắn và nhanh chóng mà chúng tôi tuân theo trên toàn cầu và tránh đưa ra lời khuyên không thể thực thi rõ ràng (dù là bằng con người hay công cụ).” “Phần lớn Google Java Style Guide là một tài liệu tham khảo tốt, nhưng nó hơi dễ dãi trong một số chủ đề. Mặt khác, là một lập trình viên Java, bạn phải quen với 4 khoảng trắng để thụt lề mã, trong số những thứ khác,” David Rios, một kiến ​​trúc sư phần mềm và lập trình viên Java có kinh nghiệm, cho biết trên LinkedIn. nhưng nó là một chút dễ dãi trên một số chủ đề. Mặt khác, là một lập trình viên Java, bạn phải quen với 4 khoảng trắng để thụt lề mã, trong số những thứ khác,” David Rios, một kiến ​​trúc sư phần mềm và lập trình viên Java có kinh nghiệm, cho biết trên LinkedIn. nhưng nó là một chút dễ dãi trên một số chủ đề. Mặt khác, là một lập trình viên Java, bạn phải quen với 4 khoảng trắng để thụt lề mã, trong số những thứ khác,” David Rios, một kiến ​​trúc sư phần mềm và lập trình viên Java có kinh nghiệm, cho biết trên LinkedIn.đăng với một số điều chỉnh được đề xuất cho Google Java Style Guide của riêng anh ấy.

Các tiêu chuẩn mã hóa Java được sử dụng nhiều nhất

Dưới đây là một số tiêu chuẩn mã hóa Java được sử dụng nhiều nhất có thể tìm thấy trong các quy ước mã hóa được đề cập ở trên của Oracle và Google, cũng như các tài liệu khác thuộc loại này.
  • Thực hiện theo quy ước đặt tên thích hợp;
  • Thêm ý kiến;
  • Mã định danh có nghĩa là một tên tượng trưng đề cập đến tên của các lớp, gói, phương thức và biến trong chương trình Java;
  • Tên biến phải liên quan đến mục đích của nó;
  • Tên của phương thức phải liên quan đến chức năng của phương thức;
  • Phương thức không được chứa hơn 50 dòng;
  • Không được trùng lặp mã trong cùng lớp hoặc khác lớp;
  • Chỉ khai báo các biến toàn cục nếu cần thiết để sử dụng trong các phương thức khác;
  • Kiểm tra kỹ việc tạo các biến tĩnh bên trong một lớp;
  • Tránh truy cập các biến trực tiếp từ các lớp khác thay vào đó hãy sử dụng các phương thức getter và setter;
  • Tất cả logic nghiệp vụ chỉ nên được xử lý trong lớp dịch vụ;
  • Tất cả các mã liên quan đến DB chỉ nên có trong các lớp DAO;
  • Sử dụng getters và setters;
  • Khai báo biến thể hiện là riêng tư;
  • Giữ phạm vi của các biến tối thiểu;
  • Gán tên có ý nghĩa cho các biến;
  • Tránh rò rỉ bộ nhớ bằng cách giải phóng kết nối cơ sở dữ liệu khi truy vấn hoàn tất;
  • Cố gắng sử dụng khối Cuối cùng thường xuyên nhất có thể;
  • Sử dụng khung Executor để lập trình đa luồng.
Bình luận
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION