Có nên khai báo một logger tĩnh cuối cùng của Nhật Bản trong UPPER-CASE không?

Trong Java, các biến cuối cùng tĩnh là các hằng số và quy ước là chúng phải ở dạng chữ hoa. Tuy nhiên, tôi đã thấy rằng hầu hết mọi người tuyên bố logger trong trường hợp thấp hơn là vi phạm trong PMD .

ví dụ:

private static final Logger logger = Logger.getLogger(MyClass.class);

Chỉ cần tìm kiếm google hoặc SO cho "logger tĩnh cuối cùng" và bạn sẽ thấy điều này cho chính mình.

Thay vào đó chúng ta có nên sử dụng LOGGER không?

Tham chiếu logger không phải là hằng số, mà là tham chiếu cuối cùng và KHÔNG nên viết hoa. Một giá trị không đổi nên được viết hoa.

private static final Logger logger = Logger.getLogger(MyClass.class);

private static final double MY_CONSTANT = 0.0;

Để thêm nhiều giá trị hơn cho câu trả lời của crunchdog, Hướng dẫn kiểu mã hóa Java nêu điều này trong đoạn 3.3 Đặt tên trường

Tên của các trường đang được sử dụng như hằng số phải là chữ hoa, với các từ được phân tách bằng dấu gạch dưới. Sau đây được coi là hằng số:

1. Tất cả các static finalkiểu nguyên thủy (Hãy nhớ rằng tất cả các trường giao diện là vốn có static final).
2. Tất cả các static finalloại tham chiếu đối tượng không bao giờ được theo sau bởi " ." (dấu chấm).
3. Tất cả static finalcác mảng không bao giờ được theo sau bởi " [" (mở dấu ngoặc vuông).

Ví dụ:

MIN_VALUE, MAX_BUFFER_SIZE, OPTIONS_FILE_NAME

Theo quy ước này, loggerlà một static finaltham chiếu đối tượng như được nêu trong điểm 2, nhưng vì nó được theo sau bởi " ." mỗi khi bạn sử dụng nó, nên nó không thể được coi là một hằng số và do đó nên viết thường.

Từ java hiệu quả, tái bản lần 2,.

Ngoại lệ duy nhất đối với quy tắc trước đó liên quan đến các trường hằng số, các tên có tên bao gồm một hoặc nhiều từ viết hoa được phân tách bằng ký tự gạch dưới, ví dụ: GIÁ TRỊ hoặc NEGECT_INFINITY. Trường không đổi là trường cuối cùng tĩnh có giá trị là bất biến . Nếu trường cuối cùng tĩnh có loại nguyên thủy hoặc loại tham chiếu không thay đổi (Mục 15), thì đó là trường không đổi. Ví dụ, hằng số enum là các trường không đổi. Nếu một trường cuối cùng tĩnh có loại tham chiếu có thể thay đổi, nó vẫn có thể là trường không đổi nếu đối tượng được tham chiếu là bất biến.

Tóm lại, hằng số == tĩnh cuối cùng, cộng với nếu đó là tham chiếu (so với loại đơn giản), tính bất biến.

Nhìn vào trình ghi nhật ký slf4j, http://www.slf4j.org/api/org/slf4j/Logger.html

Nó là bất biến. Mặt khác, logger JUL có thể thay đổi. Trình ghi nhật ký log4j cũng có thể thay đổi. Vì vậy, để chính xác, nếu bạn đang sử dụng log4j hoặc JUL, thì nó phải là "logger" và nếu bạn đang sử dụng slf4j, thì nó phải là LOGGER.

Lưu ý rằng trang javadocs slf4j được liên kết ở trên có một ví dụ nơi họ sử dụng "logger", không phải "LOGGER".

Đây tất nhiên chỉ là quy ước và không phải là quy tắc. Nếu bạn tình cờ sử dụng slf4j và bạn muốn sử dụng "logger" bởi vì bạn đã quen với điều đó từ các khung công tác khác, hoặc nếu việc nhập dễ dàng hơn hoặc để dễ đọc hơn, hãy tiếp tục.

Tôi thích Google đảm nhận điều đó ( Google Java Style )

Mỗi hằng số là một trường cuối cùng tĩnh, nhưng không phải tất cả các trường cuối cùng tĩnh là hằng số. Trước khi chọn trường hợp không đổi, hãy xem xét trường có thực sự cảm thấy như một hằng số không. Ví dụ, nếu bất kỳ trạng thái quan sát nào của trường hợp đó có thể thay đổi, thì gần như chắc chắn đó không phải là hằng số. Chỉ có ý định không bao giờ đột biến đối tượng nói chung là không đủ.

Ví dụ:

// Constants
static final int NUMBER = 5;
static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
static final Joiner COMMA_JOINER = Joiner.on(',');  // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }

// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final Set<String> mutableCollection = new HashSet<String>();
static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};

Nếu bạn đang sử dụng một công cụ tự động để kiểm tra các tiêu chuẩn mã hóa của mình và nó vi phạm các tiêu chuẩn đã nói thì nó hoặc các tiêu chuẩn sẽ được sửa chữa. Nếu bạn đang sử dụng một tiêu chuẩn bên ngoài, hãy sửa mã.

Quy ước trong Sun Java là chữ hoa cho các hằng số tĩnh công khai. Rõ ràng một logger không phải là hằng số, nhưng đại diện cho một thứ có thể thay đổi (nếu không sẽ không có phương thức gọi điểm nào trên đó với hy vọng điều gì đó sẽ xảy ra); không có tiêu chuẩn cụ thể cho các trường cuối cùng không liên tục.

Nếu bạn google cái này, bạn có thể thấy rằng trong một số trường hợp, logger không được định nghĩa là cuối cùng tĩnh. Thêm một số bản sao-dán nhanh vào đây và điều này có thể giải thích nó.

Chúng tôi sử dụng LOGGER trong tất cả các mã của chúng tôi và điều này tương ứng với quy ước đặt tên của chúng tôi (và CheckStyle của chúng tôi hài lòng với nó).

Chúng tôi thậm chí còn đi xa hơn, tận dụng quy ước đặt tên nghiêm ngặt trong Eclipse. Chúng tôi tạo một lớp mới với một mẫu mã gồm:

    // private static final Logger LOGGER = Logger.getLogger(${enclosing_type}.class);

Trình ghi nhật ký được nhận xét, vì ban đầu chúng tôi không cần nó. Nhưng chúng ta nên cần nó sau, chúng ta chỉ cần bỏ qua nó.

Sau đó, trong mã, chúng tôi sử dụng các mẫu mã dự kiến ​​trình ghi nhật ký này sẽ xuất hiện. Ví dụ với mẫu thử bắt:

    try {
      ${cursor} or some other template
    } catch (Exception t) {
      LOGGER.error("${methodName} ${method parameters}", t);
    }

Chúng tôi có thêm một vài mẫu sử dụng nó.

Quy ước nghiêm ngặt cho phép chúng tôi làm việc hiệu quả hơn và mạch lạc hơn với các mẫu mã .

Cá nhân tôi nghĩ rằng nó trông thực sự lớn trong trường hợp cao. Hơn nữa, vì đây là một lớp không liên quan trực tiếp đến hành vi của lớp, nên tôi không thấy vấn đề lớn trong việc sử dụng loggerthay vì LOGGER. Nhưng nếu bạn sẽ nghiêm khắc phạm vi, sau đó sử dụng LOGGER.

Đừng quên rằng PMD sẽ tôn trọng một bình luận với

// NOPMD

trong đó. Điều này sẽ khiến PMD bỏ qua dòng từ kiểm tra của nó, điều này sẽ cho phép bạn chọn bất kỳ kiểu nào bạn muốn.

Các hằng số thường được viết hoa.

Tuy nhiên, logger không nên tĩnh mà tìm kiếm mọi "mới" của lớp chứa nếu sử dụng mặt tiền slf4j. Điều này tránh một số vấn đề trình nạp lớp khó chịu trong các thùng chứa web đáng chú ý, cộng với nó cho phép khung logger thực hiện các công cụ đặc biệt tùy thuộc vào bối cảnh gọi.

Tôi thích 'logger', tức là chữ thường. Lý do không phải là hằng số hay không phải là hằng số (có thể thay đổi hoặc không thay đổi). Nếu chúng ta sử dụng lý do đó, chúng ta sẽ phải đổi tên biến nếu chúng ta thay đổi khung ghi nhật ký (hoặc nếu khung thay đổi khả năng biến đổi của logger).

Đối với tôi, những lý do khác quan trọng hơn.

1. Một logger là một đối tượng bóng trong lớp và không được nổi bật lắm vì nó không thực hiện logic chính. Nếu chúng ta sử dụng 'LOGGER', thì đó là một công cụ bắt mắt trong mã thu hút quá nhiều sự chú ý.

2. Đôi khi logger được khai báo ở mức cá thể (tức là không phải là tĩnh) và thậm chí được thêm vào như một phụ thuộc. Tôi sẽ không muốn thay đổi mã của mình nếu tôi quyết định thay đổi cách lấy logger. Các mã ổn định wrt. sự thay đổi này (giả thuyết trong nhiều trường hợp) là lý do khác khiến tôi thích chữ thường hơn.

Nếu tiêu chuẩn mã hóa của bạn - nếu bạn có bất kỳ - nói rằng nó nên viết hoa thì có.

Tôi không thấy bất kỳ lý do nghiêm ngặt nào cho cách này hay cách khác. Tôi nghĩ rằng nó hoàn toàn phụ thuộc vào sự tôn trọng cá nhân của bạn. tiêu chuẩn mã hóa công ty của bạn.

BTW: Tôi thích "LOGGER" ;-)