Tắt đăng nhập Java tại thời gian biên dịch

Question

Tôi có một số mã Java mà tôi muốn sử dụng với các thông điệp tường trình cho mục đích gỡ lỗi. Mã sản xuất cuối cùng (biên dịch), tuy nhiên, không nên chứa bất kỳ đăng nhập nào vì nó sẽ làm chậm thời gian thực hiện. Có cách nào trong Java để vô hiệu hóa một logger tại thời gian biên dịch?

Tôi không sợ dấu kiểm bên trong phương thức nhật ký của trình ghi nhật ký bật/tắt được kích hoạt trong thời gian chạy sẽ thêm.

if (logging==enabled) {// do logging} 

Nhưng tôi muốn tránh xây dựng tham số như sau trong mã sản xuất của tôi:

Logger.log("undefined state" + state + " @ " + new Date()); 

Tôi đang sử dụng Java Compiler mặt trời.

Answer 1

Tôi không biết về bất kỳ chức năng Trình biên dịch nào về điều này, nhưng những gì bạn cũng có thể làm là tạo một tập lệnh xây dựng. Kịch bản lệnh này sẽ sao chép các tệp nguồn Java gốc (gỡ lỗi), sao chép chúng vào một vị trí tạm thời, loại bỏ các khai báo đăng nhập khỏi chúng và sau đó biên dịch các tệp nguồn mới mà sau đó không có mã gỡ lỗi.

Answer 2

Không có cách nào được tích hợp sẵn để thực hiện điều này. Bạn có thể muốn sử dụng một số Java Preprocessor.

Answer 3

if(logger.isDebugEnabled()) { 
    logger.debug(expression); 
} 

Mọi khung đăng nhập tôi đã sử dụng yêu cầu bạn sử dụng mẫu trên để tránh đánh giá không cần thiết về biểu thức ghi nhật ký.

Answer 4

Một cách là thực hiện kiểm tra bên ngoài phương thức đăng nhập. Hầu như kiểm tra tương tự như bạn đã đề cập, nhưng bạn tự làm như vậy:

if (LOGGER.isLoggable(Level.DEBUG)) { 
    LOGGER.log("undefined state" + state + " @ " + new Date()); 
} 

Phương pháp này có thể được sử dụng với bất kỳ mức ghi nào. xem Logger#isLoggable(Level) để biết thêm thông tin. Lưu ý rằng đó là cách được khuyến nghị để tránh việc xây dựng tham số phương thức log.

Answer 5

Điều này dường như là những gì bạn đang tìm kiếm:

what's log4j actually doing when we turn on or off some log places?

Answer 6

Một hack xấu xí mà có thể làm việc là để che giấu sự thực hiện của thư viện Logger với một thực hiện rỗng. Trình tối ưu hóa sẽ đặt nội tuyến và xóa mã deadcode nên xóa cấu trúc tham số. Điều này sẽ không hoạt động khi cấu trúc tham số chứa các tác dụng phụ.

Bây giờ đây là lý thuyết, tôi chưa thử nghiệm điều này trong thực tế. Tôi tò mò về điều này mặc dù. Có lẽ điều này đảm bảo một câu hỏi riêng biệt?

Answer 7

Bạn thực sự nên sử dụng chỉ báo Mức cho thông điệp tường trình của mình, Cấp độ.SEVERE -> Cấp độ.FINEST.

Có nhiều phương pháp xác định trước trong Logger cho ví dụ này:

Logger.info(msg); 
Logger.finest(msg); // debug/trace message. 

Logger.log(Level.CONFIG, "config message"); 

này sẽ cho phép bạn cấu hình mức ghi minumim ở cấp ứng dụng và bật/tắt những thông điệp dưới mức cấu hình, sử dụng lệnh dòng, tệp cấu hình hoặc bằng cách sử dụng LogManager

Answer 8

Bạn đã xem xét phương pháp tiếp cận slf4j với {} -placeholders. Điều đó cho phép xây dựng chậm của toString() có nghĩa là log.debug (...) là rẻ nếu việc ghi nhật ký gỡ lỗi bị vô hiệu hóa.

log.debug("in loop() - a={}, b={}", a, b); 

Answer 9

Tôi hiểu rằng trình biên dịch Java có thể loại bỏ các khối mã được bảo vệ bởi biểu thức hằng số thời gian biên dịch. Vì vậy, về mặt lý thuyết, bạn sẽ có thể làm điều này với một cái gì đó như thế này:

public class Logging { 
    public static final boolean ENABLED = true; // change to false 
} 

public class Something 
    .... 

    if (Logging.ENABLED) { 
      logger.debug("hello mum"); 
    } 
} 

Thật không may, bạn cần phải biên dịch lại mỗi lớp mà phụ thuộc vào lá cờ Logging.ENABLED bất cứ khi nào bạn thay đổi giá trị của nó. Vì vậy, tôi rất thích những điều sau đây:

public class Something 
    .... 

    if (logger.isDebugEnabled()) { 
      logger.debug("hello mum"); 
    } 
} 

có lợi thế là bạn có thể thực hiện các điều chỉnh chi tiết cho mức ghi nhật ký tại thời gian cấu hình hoặc ngay cả khi chạy; ví dụ. bằng cách sử dụng trình gỡ lỗi, JMX, v.v. Ngoài ra, chi phí gọi số logger.isDebugEnabled() trong log4j đủ thấp khiến bạn không thể nhận thấy trừ khi bạn có số lượng đăng nhập không chính xác trong mã nguồn của mình.

Answer 10

Có thể xử lý các tệp lớp java bằng cách sử dụng Proguard và sử dụng tùy chọn -assumenosideeffects để xóa các cuộc gọi ghi nhật ký. Này được thực hiện phổ biến nhất dành cho Android sử dụng:

-assumenosideeffects class android.util.Log { 
    public static *** d(...); 
    public static *** v(...); 
} 

loại bỏ tất cả các cuộc gọi đến Log.d(TAG, "message"), vv ...