Üretim kodundaki assert beyanında boş kalmamalısınız? [kapalı]

Bu soruyu gördüm ancak assertanahtar kelimenin kullanımı hakkında birkaç sorum var . Kullanmayla ilgili diğer birkaç kodlayıcıyla tartışıyordum assert. Bu kullanım durumunda, belirli önkoşullar karşılandığında null değerini döndüren bir yöntem vardı. Yazdığım kod yöntemi çağırır, sonra null döndürmez ve döndürülen nesneyi kullanmaya devam ettiğini iddia eder.

Misal:

class CustomObject {
    private Object object;

    @Nullable
    public Object getObject() {
        return (object == null) ? generateObject() : object;
    }
}

Şimdi şöyle kullandığımı düşünün:

public void useObject(CustomObject customObject) {
    object = customObject.getObject();
    assert object != null;
    // Do stuff using object, which would throw a NPE if object is null.
}

Üretim kodunda asla kullanılmamaları assertgerektiğini , sadece testlerde kullanılmaları gerektiğini söyledim . Bu doğru mu?

Bunun için kullanın Objects.requireNonNull(Object).

Belirtilen nesne başvurusunun boş olup olmadığını denetler. Bu yöntem öncelikle yöntemler ve yapıcılarda parametre doğrulaması yapmak için tasarlanmıştır, [...]

Sizin durumunuzda:

public void useObject(CustomObject customObject) {
    object = customObject.getObject();
    Objects.requireNonNull(object);
    // Do stuff using object, which would throw a NPE if object is null.
}

Bu işlev, bahsettiğiniz amaçlar için yapılır; yani null olmaması gerektiğini açıkça işaretleyin; üretimde de. En büyük yararı, null değerleri ilk etapta oluşmaması gereken yerde bulmanızı sağlamaktır. Olmaması gereken bir yere aktarılan boş değerlerin neden olduğu hata ayıklama sorunlarınız daha az olacaktır.

Diğer bir avantaj ise aksine null kontroller konusunda ek esnekliktir assert. assertBoole değerini kontrol etmek için bir anahtar kelime olsa da Objects.requireNonNull(Object), bir işlevdir ve dolayısıyla kodda daha esnek ve okunabilir şekilde gömülebilir. Örneğin:

Foo foo = Objects.requireNonNull(service.fetchFoo());

// You cannot write it in on line.
Bar bar = service.fetchBar();
assert bar != null;

service.foo(Objects.requireNonNull(service.getBar()));

// You cannot write it in on line.
Bar bar = service.getBar();
assert bar != null;
service.foo(bar);

Objects.requireNonNull(Object)Yalnızca assertgenelleştirilen yerlerde null denetim için olduğunu unutmayın .assertbu konuda biraz farklı amaçlara sahiptir, yani öncelikle test etmek. Etkinleştirilmesi gerekir, böylece test için etkinleştirebilir ve üretim için devre dışı bırakabilirsiniz. Her neyse, üretim kodu için kullanmayın. Test amaçlı gereksiz ve karmaşık doğrulamalarla uygulamayı yavaşlatabilir. Sadece test amaçlı kontrolleri, üretim amaçlı kontrollerden ayırmak için kullanın.

Hakkında ayrıntılar için resmi belgelere bakın assert.

İddialar hakkında hatırlanması gereken en önemli şey, onların devre dışı bırakılabileceğidir, bu yüzden asla yürütüleceklerini varsaymayın.

Geriye dönük uyumluluk için JVM varsayılan olarak onaylama doğrulamasını devre dışı bırakır. -Enableassertions komut satırı bağımsız değişkeni veya -ea kısayoluyla açıkça etkinleştirilmelidir:

java -ea com.whatever.assertion.Assertion

Bu nedenle, onlara güvenmek iyi bir uygulama değildir.

İddialar varsayılan olarak etkin olmadığından kodda kullanıldıklarında hiçbir zaman yürütülmeyeceklerini varsayamazsınız. Bu nedenle, her zaman null değerleri ve boş Opsiyonelleri kontrol etmeli, girişleri genel bir yönteme kontrol etmek için onaylama kullanmaktan kaçınmalı ve bunun yerine denetlenmeyen bir istisna kullanmalısınız ... Genel olarak, tüm denetimleri onaylama yokmuş gibi yapın.

Elbette size söylenenler açık bir yalan. İşte nedeni.

Yalnızca bağımsız jvm yürütürseniz, varsayılan olarak onaylar devre dışı bırakılır. Devre dışı bırakıldıklarında sıfır yer kaplarlar, dolayısıyla üretim uygulamanızı etkilemezler. Bununla birlikte, kodunuzu geliştirirken ve test ederken muhtemelen en iyi arkadaşlarınızdır ve test çerçevesi koşucularının çoğu iddiaları etkinleştirir (JUnit yapar), bu nedenle, birim testlerinizi çalıştırdığınızda iddia kodunuz yürütülür ve olası hataları daha önce tespit etmenize yardımcı olur (ör. bazı iş mantığı sınır denetimleri için ekler ekleyebilirsiniz; bu, uygunsuz değerler kullanan bazı kodların algılanmasına yardımcı olur).

Bununla birlikte, diğer cevabın da belirttiği gibi, tam olarak bu nedenle (her zaman etkin değildir) bazı hayati kontroller yapmak için iddialara güvenemezsiniz veya (özellikle!) Herhangi bir durumu koruyamazsınız.

Ekleri nasıl kullanabileceğinize dair ilginç bir örnek için, bir göz atın buraya - dosyanın sonunda singleThreadedAccess()201 satırındaki assert deyiminden çağrılan ve testlerde herhangi bir çok iş parçacıklı erişimi yakalamak için bir yöntem var.

Diğer cevaplar zaten bunu yeterince iyi kaplıyor, ancak başka seçenekler de var.

Örneğin, Bahar'ın statik bir yöntemi vardır:

org.springframework.util.Assert.notNull(obj)

Kendi Assert.something()yöntemlerine sahip başka kütüphaneler de var. Kendinizinkini yazmak da oldukça basit.

Ancak, bu bir web hizmeti ise hangi istisnaları attığınızı unutmayın. Sözü edilen önceki yöntem, örneğin, birIllegalArgumentException Spring'de varsayılan olarak 500 değerini döndüren bir .

Bir web hizmeti söz konusu olduğunda, bu genellikle değil , bir iç sunucu hatası ve 500 olmamalıdır, bunun yerine kötü bir isteği olan 400.

Hata yaparken programlama hatalarını yakalamaya yardımcı olurken, ekleri bolca kullanın .

Mantıksal olarak meydana gelebilecek bir şeyi yakalamak için assert kullanmayın, yani kötü biçimlendirilmiş giriş Assert'i yalnızca hata kurtarılamadığında kullanın.

Onaylama kontrol edildiğinde çalışan koda herhangi bir üretim mantığı koymayın. Yazılımınız iyi yazılmışsa, bu doğru bir şekilde doğrudur, ancak eğer değilse, iddiaların etkin ve devre dışı bırakıldığı ince yan etkilere ve farklı genel davranışlara sahip olabilirsiniz.

Şirketinizin "test kodu" ve "üretim kodu" aynı şeyi ancak farklı kod tabanları (veya farklı düzenleme aşamaları) olarak yapıyorsa, oradan çıkın ve bir daha geri dönmeyin. Bu yetersizlik seviyesini düzeltmeye çalışmak muhtemelen zaman kaybıdır. Şirketiniz testlerin kodunun dışına herhangi bir iddia beyanı koymazsa, lütfen üretim yapısında varsayımların devre dışı bırakıldığını ve eğer değilse, bu hatayı düzeltmenin ilk önceliğiniz olduğunu söyleyin.

Eklerin değeri, yalnızca test paketinde değil, iş mantığında da kullanılmalıdır. Bu, kodunuzun büyük parçalarından geçmek ve tüm bu iddiaları tetiklemek için birçok şeyi açık bir şekilde test etmek zorunda olmayan birçok yüksek seviye testi çözmeyi kolaylaştırır. Projelerimden birkaçında tipik testler gerçekten hiçbir şey iddia etmedi, sadece belirli girdilere dayalı bir hesaplama yapılmasını emretti ve bu da yüzlerce iddiaların kontrol edilmesine ve küçük mantık parçalarında bile sorunların bulunmasına neden oldu.

Assert'i istediğiniz zaman kullanabilirsiniz. Tartışma ne zaman kullanılacağıdır. Örneğin kılavuzda :

• Genel yöntemlerde argüman denetimi için iddia kullanmayın.
• Uygulamanızın doğru çalışması için gerektirdiği herhangi bir işi yapmak için iddiaları kullanmayın.