UPPER-CASE'te bir “statik son Kaydedici” bildirilmeli mi?

Java'da statik son değişkenler sabittir ve kural büyük harf olması gerektiğidir. Ancak, çoğu insan bir ihlali olarak çıkageldi düşük durumda kaydedicileri beyan olduğunu gördük PMD .

Örneğin:

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

Google'da veya SO'da "statik son kaydedici" için arama yapın ve bunu kendiniz göreceksiniz.

Bunun yerine LOGGER kullanmalı mıyız?

Logger referansı sabit değil, son bir referanstır ve büyük harfte DEĞİL olmalıdır. Sabit bir VALUE büyük harf olmalıdır.

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

private static final double MY_CONSTANT = 0.0;

Çıtır köpeğin cevabına daha fazla değer katmak için Java Kodlama Stil Kılavuzu bunu 3.3. Alan Adlandırma

Sabit olarak kullanılan alanların adları büyük harfle yazılmalı ve alt sözcükler sözcükleri ayırmalıdır. Aşağıdakilerin sabit olduğu kabul edilir:

1. Tüm static finalilkel türler ( Tüm arabirim alanlarının kendiliğinden olduğunu unutmayın static final).
2. static finalAsla " ." (nokta) izlemeyen tüm nesne başvuru türleri .
3. static final" [" (Açılış köşeli ayraç) tarafından takip edilmeyen tüm diziler .

Örnekler:

MIN_VALUE, MAX_BUFFER_SIZE, OPTIONS_FILE_NAME

Bu kongre sonrasında loggerbir olduğu static finalnoktaya 2'de belirtildiği gibi nesne referansı, ama bunun sebebi olduğu "izledi .Kullanmaya her şey", bir sabit olarak kabul edilemez ve bu nedenle küçük harf olmalıdır.

Etkili java, 2. baskı,

Önceki kuralın tek istisnası, adları alt çizgi karakteriyle ayrılmış bir veya daha fazla büyük kelimeden (örneğin, VALUES veya NEGATIVE_INFINITY) oluşması gereken “sabit alanlar” ile ilgilidir. Sabit alan, değeri değişmez olan statik bir son alandır . Statik bir son alan ilkel bir tipe veya değişmez bir referans tipine (Madde 15) sahipse, sabit bir alandır. Örneğin, enum sabitleri sabit alanlardır. Statik bir son alan değiştirilebilir bir başvuru türüne sahipse, başvurulan nesne değiştirilemezse yine de sabit bir alan olabilir.

Özetle, sabit == statik final, artı bir referanssa (basit bir türe karşı) değişmezlik.

Slf4j kaydediciye bakarken, http://www.slf4j.org/api/org/slf4j/Logger.html

Değişmez. Öte yandan, JUL kaydedici değiştirilebilir. Log4j günlüğü de değiştirilebilir. Doğru olmak gerekirse, log4j veya JUL kullanıyorsanız, "logger" olmalı ve slf4j kullanıyorsanız, LOGGER olmalıdır.

Yukarıda bağlı slf4j javadocs sayfasının "LOGGER" değil, "logger" kullandıkları bir örneği olduğunu unutmayın.

Bunlar elbette sadece sözleşmelerdir, kurallar değildir. Slf4j kullanıyorsanız ve buna diğer çerçevelerden alışık olduğunuz için "logger" kullanmak istiyorsanız veya yazmak daha kolay veya okunabilirlik için devam ediyorsanız devam edin.

Google'ın bunu almasını seviyorum ( Google Java Stili )

Her sabit bir statik son alandır, ancak tüm statik son alanlar sabit değildir. Sabit durum seçmeden önce, alanın gerçekten bir sabit gibi olup olmadığını düşünün. Örneğin, söz konusu örneğin gözlemlenebilir durumundan herhangi biri değişebiliyorsa, neredeyse kesinlikle sabit değildir. Sadece nesneyi asla mutasyona uğratmaya niyetli olmak genellikle yeterli değildir.

Örnekler:

// 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"};

Kodlama standartlarınızı kontrol etmek için otomatik bir araç kullanıyorsanız ve söz konusu standartları ihlal ediyorsa, o zaman ya da standartlar sabitlenmelidir. Harici bir standart kullanıyorsanız, kodu düzeltin.

Sun Java'daki kural, genel statik sabitler için büyük harftir. Açıkçası bir kaydedici sabit değildir, ancak değişebilir bir şeyi temsil eder (aksi takdirde bir şeyin gerçekleşmesi umuduyla üzerinde yöntem çağırma yöntemi yoktur); sabit olmayan son alanlar için belirli bir standart yoktur.

Bunu google'da yaparsanız, bazı durumlarda kaydedicilerin statik final olarak tanımlanmadığını görebilirsiniz. Buna hızlı bir kopyala-yapıştır yapıştırın ve bu açıklayabilir.

Biz KAYIT'ı kullanmak bizim adlandırma kuralına tüm kodunda ve bu karşılık gelir (ve bizim checkstyle onunla mutlu).

Eclipse'deki sıkı adlandırma kuralından yararlanarak daha da ileri gidiyoruz. Şu kod şablonuyla yeni bir sınıf oluşturuyoruz:

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

Başlangıçta ihtiyacımız olmadığı için kaydedici yorumlanır. Ama daha sonra ihtiyacımız olursa, sadece rahatsız ediyoruz.

Daha sonra kodda, bu günlükçünün mevcut olmasını bekleyen kod şablonlarını kullanıyoruz. Try-catch şablonuyla örnek:

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

Bunu kullanan birkaç şablonumuz daha var.

Sıkı kongre bizi daha üretken ve kod şablonları ile tutarlı olmasını sağlayacaktır .

Şahsen büyük harflerle gerçekten büyük göründüğünü düşünüyorum. Buna doğrudan sınıf davranışı ile ilgili değil bir sınıf var Dahası, ben kullanarak büyük bir sorun görmüyorum loggeryerine LOGGER. Ama kesinlikle bilgiçlikçiyseniz, o zaman kullanın LOGGER.

PMD'nin bir yoruma saygı duyacağını unutmayın.

// NOPMD

içinde. Bu, PMD'nin hattı kontrollerinden atlamasına neden olur, bu da istediğiniz stili seçmenize izin verir.

Genellikle sabitler büyük harflidir.

Ancak kaydediciler statik olmamalı, ancak slf4j cephesini kullanıyorsa, kapsayıcı sınıfın her "yeni" sini aramalıdır. Bu, özellikle web kaplarında bazı kötü sınıf yükleyici sorunlarını önler, ayrıca kaydedici çerçevesinin çağırma bağlamına bağlı olarak özel şeyler yapmasına izin verir.

Ben 'logger' yani küçük harf tercih ederim. Sebep, bunun bir sabit olması ya da sabit olmamasıdır (değişebilir ya da değişmez). Eğer bu muhakemeyi kullanırsak, kayıt çerçevesini değiştirirsek (veya çerçeve kaydedicilerin değişebilirliğini değiştirirse) değişkeni yeniden adlandırmamız gerekir.

Benim için başka nedenler daha önemli.

1. Logger sınıftaki bir gölge nesnedir ve ana mantığı uygulamadığı için çok belirgin olmamalıdır. 'LOGGER' kullanırsak, kodda çok fazla dikkat çeken bir göz alıcıdır.

2. Kaydediciler bazen örnek düzeyinde (yani statik olarak değil) bildirilir ve hatta bağımlılık olarak enjekte edilir. Kaydediciyi elde etme şeklimi değiştirmeye karar verirsem kodumu değiştirmek istemem. Kod kararlılığı wrt. bu (birçok durumda varsayımsal) değişim, küçük harfleri tercih etmemin bir diğer nedenidir.

Eğer kodlama standartlarınız - eğer varsa - büyük harf olmalı deyin evet.

Ben şu ya da bu şekilde katı bir neden görmüyorum. Bence bu tamamen kişisel beğenilerinize bağlıdır. şirket kodlama standartları.

BTW: "LOGGER" ;-) tercih ediyorum