Uzyskiwanie nazwy klasy z metody statycznej w Javie

Jak można uzyskać nazwę klasy z metody statycznej w tej klasie. Na przykład

public class MyClass {
    public static String getClassName() {
        String name = ????; // what goes here so the string "MyClass" is returned
        return name;
    }
}

Aby umieścić to w kontekście, naprawdę chcę zwrócić nazwę klasy jako część komunikatu w wyjątku.

Aby poprawnie obsługiwać refaktoryzację (zmiana nazwy klasy), należy użyć:

 MyClass.class.getName(); // full name with package

lub (dzięki @James Van Huis ):

 MyClass.class.getSimpleName(); // class name and no more

Rób to, co mówi zestaw narzędzi. Nie rób czegoś takiego:

return new Object() { }.getClass().getEnclosingClass();

W Javie 7+ możesz to zrobić w statycznej metodzie / polach:

MethodHandles.lookup().lookupClass()

Mamy więc sytuację, w której musimy statycznie uzyskać obiekt klasy lub pełną / prostą nazwę klasy bez wyraźnego użycia MyClass.classskładni.

W niektórych przypadkach może być bardzo przydatny, np. Wystąpienie programu rejestrującego kotlin funkcje wyższego poziomu (w tym przypadku kotlin tworzy statyczną klasę Java niedostępną z kodu kotlin).

Mamy kilka różnych wariantów uzyskiwania tych informacji:

1. new Object(){}.getClass().getEnclosingClass();
   zauważył Tom Hawtin - tackline

2. getClassContext()[0].getName();z SecurityManager
   odnotowanej przez Christoffera

3. new Throwable().getStackTrace()[0].getClassName();
   według hrabiego Ludwiga

4. Thread.currentThread().getStackTrace()[1].getClassName();
   z Keksi

5. i wreszcie niesamowite
   MethodHandles.lookup().lookupClass();
   od Reina

Przygotowałem jmh punktem odniesienia dla wszystkich wariantów i wyników są:

# Run complete. Total time: 00:04:18

Benchmark                                                      Mode  Cnt      Score     Error  Units
StaticClassLookup.MethodHandles_lookup_lookupClass             avgt   30      3.630 ±   0.024  ns/op
StaticClassLookup.AnonymousObject_getClass_enclosingClass      avgt   30    282.486 ±   1.980  ns/op
StaticClassLookup.SecurityManager_classContext_1               avgt   30    680.385 ±  21.665  ns/op
StaticClassLookup.Thread_currentThread_stackTrace_1_className  avgt   30  11179.460 ± 286.293  ns/op
StaticClassLookup.Throwable_stackTrace_0_className             avgt   30  10221.209 ± 176.847  ns/op

Wnioski

1. Najlepszy wariant w użyciu , raczej czysty i potwornie szybki.
   Dostępne tylko od wersji Java 7 i Android API 26!

 MethodHandles.lookup().lookupClass();

2. Jeśli potrzebujesz tej funkcji dla Androida lub Java 6, możesz użyć drugiego najlepszego wariantu. Jest też dość szybki, ale tworzy anonimową klasę w każdym miejscu użytkowania :(

 new Object(){}.getClass().getEnclosingClass();

3. Jeśli potrzebujesz go w wielu miejscach i nie chcesz, aby twój kod bajtowy wzdychał z powodu mnóstwa anonimowych klas - SecurityManagerjest twoim przyjacielem (trzecia najlepsza opcja).

   Ale nie możesz po prostu zadzwonić getClassContext()- jest chroniony w SecurityManagerklasie. Będziesz potrzebować klasy pomocniczej takiej jak ta:

 // Helper class
 public final class CallerClassGetter extends SecurityManager
 {
    private static final CallerClassGetter INSTANCE = new CallerClassGetter();
    private CallerClassGetter() {}

    public static Class<?> getCallerClass() {
        return INSTANCE.getClassContext()[1];
    }
 }

 // Usage example:
 class FooBar
 {
    static final Logger LOGGER = LoggerFactory.getLogger(CallerClassGetter.getCallerClass())
 }

4. Prawdopodobnie nigdy nie musisz używać dwóch ostatnich wariantów na podstawie getStackTrace()wyjątku lub Thread.currentThread(). Bardzo nieefektywny i może zwracać tylko nazwę klasy jako, a Stringnie Class<*>instancję.

PS

Jeśli chcesz utworzyć instancję rejestratora dla statycznych narzędzi kotlin (takich jak ja :), możesz użyć tego pomocnika:

import org.slf4j.Logger
import org.slf4j.LoggerFactory

// Should be inlined to get an actual class instead of the one where this helper declared
// Will work only since Java 7 and Android API 26!
@Suppress("NOTHING_TO_INLINE")
inline fun loggerFactoryStatic(): Logger
    = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass())

Przykład użycia:

private val LOGGER = loggerFactoryStatic()

/**
 * Returns a pseudo-random, uniformly distributed value between the
 * given least value (inclusive) and bound (exclusive).
 *
 * @param min the least value returned
 * @param max the upper bound (exclusive)
 *
 * @return the next value
 * @throws IllegalArgumentException if least greater than or equal to bound
 * @see java.util.concurrent.ThreadLocalRandom.nextDouble(double, double)
 */
fun Random.nextDouble(min: Double = .0, max: Double = 1.0): Double {
    if (min >= max) {
        if (min == max) return max
        LOGGER.warn("nextDouble: min $min > max $max")
        return min
    }
    return nextDouble() * (max - min) + min
}

Ta instrukcja działa dobrze:

Thread.currentThread().getStackTrace()[1].getClassName();

Możesz zrobić coś naprawdę słodkiego, używając JNI w następujący sposób:

MyObject.java:

public class MyObject
{
    static
    {
        System.loadLibrary( "classname" );
    }

    public static native String getClassName();

    public static void main( String[] args )
    {
        System.out.println( getClassName() );
    }
}

następnie:

javac MyObject.java
javah -jni MyObject

następnie:

MyObject.c:

#include "MyObject.h"

JNIEXPORT jstring JNICALL Java_MyObject_getClassName( JNIEnv *env, jclass cls )
{
    jclass javaLangClass = (*env)->FindClass( env, "java/lang/Class" );
    jmethodID getName = (*env)->GetMethodID( env, javaLangClass, "getName",
        "()Ljava/lang/String;" );
    return (*env)->CallObjectMethod( env, cls, getName );
}

Następnie skompiluj C do wspólnej biblioteki o nazwie libclassname.soi uruchom java!

*chichot

Używam tego do inicjowania Log4j Logger na szczycie moich klas (lub adnotacji).

PRO: Throwable jest już załadowany i możesz zaoszczędzić zasoby, nie używając programu SecurityManager „IO heavy”.

CON: Pewne pytanie, czy to zadziała dla wszystkich JVM.

// Log4j . Logger --- Get class name in static context by creating an anonymous Throwable and 
// getting the top of its stack-trace. 
// NOTE you must use: getClassName() because getClass() just returns StackTraceElement.class 
static final Logger logger = Logger.getLogger(new Throwable() .getStackTrace()[0].getClassName()); 

Nadużywaj SecurityManager

System.getSecurityManager().getClassContext()[0].getName();

Lub, jeśli nie ustawione, użyj wewnętrznej klasy, która ją rozszerza (przykład poniżej wstydliwie skopiowany z How's Real ):

public static class CurrentClassGetter extends SecurityManager {
    public String getClassName() {
        return getClassContext()[1].getName(); 
    }
}

Jeśli chcesz z nim całą nazwę pakietu, zadzwoń:

String name = MyClass.class.getCanonicalName();

Jeśli chcesz tylko ostatni element, wywołaj:

String name = MyClass.class.getSimpleName();

Dosłownie użycie klasy obiektu wywołującego tak jak MyClass.class.getName()faktycznie wykonuje to zadanie, ale jest podatne na błędy kopiowania / wklejania, jeśli propagujesz ten kod do wielu klas / podklas, w których potrzebujesz tej nazwy klasy.

A przepis Toma Hawtina nie jest wcale taki zły, wystarczy go odpowiednio ugotować :)

Jeśli masz klasę bazową z metodą statyczną, która może być wywoływana z podklas, a ta metoda statyczna musi znać rzeczywistą klasę dzwoniącego, można to osiągnąć w następujący sposób:

class BaseClass {
  static sharedStaticMethod (String callerClassName, Object... otherArgs) {
    useCallerClassNameAsYouWish (callerClassName);
    // and direct use of 'new Object() { }.getClass().getEnclosingClass().getName()'
    // instead of 'callerClassName' is not going to help here,
    // as it returns "BaseClass"
  }
}

class SubClass1 extends BaseClass {
  static someSubclassStaticMethod () {
    // this call of the shared method is prone to copy/paste errors
    sharedStaticMethod (SubClass1.class.getName(),
                        other_arguments);
    // and this call is safe to copy/paste
    sharedStaticMethod (new Object() { }.getClass().getEnclosingClass().getName(),
                        other_arguments);
  }
}

Bezpieczne dla refaktoryzacji, bezpieczne dla cięcia i wklejania rozwiązanie, które pozwala uniknąć definicji klas ad-hoc poniżej.

Napisz metodę statyczną, która odzyskuje nazwę klasy, starając się zawrzeć nazwę klasy w nazwie metody:

private static String getMyClassName(){
  return MyClass.class.getName();
}

następnie przywołaj to w metodzie statycznej:

public static void myMethod(){
  Tracer.debug(getMyClassName(), "message");
}

Bezpieczeństwo refaktoryzacji jest zapewnione przez unikanie użycia ciągów, zapewnione jest bezpieczeństwo wycinania i wklejania, ponieważ jeśli wytniesz i wkleisz metodę wywołującą, nie znajdziesz funkcji getMyClassName () w docelowej klasie „MyClass2”, więc będziesz zmuszony ją przedefiniować i zaktualizować.

Ponieważ pytanie Coś w rodzaju „this.class` zamiast„ ClassName.class`? jest oznaczony jako duplikat tego (co jest dyskusyjne, ponieważ to pytanie dotyczy raczej klasy niż nazwy klasy), zamieszczam odpowiedź tutaj:

class MyService {
    private static Class thisClass = MyService.class;
    // or:
    //private static Class thisClass = new Object() { }.getClass().getEnclosingClass();
    ...
    static void startService(Context context) {
        Intent i = new Intent(context, thisClass);
        context.startService(i);
    }
}

Ważne jest, aby zdefiniować thisClassjako prywatny, ponieważ:
1) nie można go dziedziczyć: klasy pochodne muszą albo zdefiniować własne, thisClassalbo wygenerować komunikat o błędzie
2) należy odwoływać się do innych klas ClassName.classzamiast ClassName.thisClass.

Po thisClasszdefiniowaniu dostęp do nazwy klasy staje się:

thisClass.getName()

Potrzebowałem nazwy klasy w metodach statycznych wielu klas, dlatego zaimplementowałem klasę JavaUtil za pomocą następującej metody:

public static String getClassName() {
    String className = Thread.currentThread().getStackTrace()[2].getClassName();
    int lastIndex = className.lastIndexOf('.');
    return className.substring(lastIndex + 1);
}

Mam nadzieję, że to pomoże!

Użyłem te dwa podejścia do obu statici non staticscenariusz:

Główna klasa:

//For non static approach
public AndroidLogger(Object classObject) {
    mClassName = classObject.getClass().getSimpleName();
}

//For static approach
public AndroidLogger(String className) {
    mClassName = className;
}

Jak podać nazwę klasy:

sposób niestatyczny:

private AndroidLogger mLogger = new AndroidLogger(this);

Sposób statyczny:

private static AndroidLogger mLogger = new AndroidLogger(Myclass.class.getSimpleName());

Jeśli używasz odbicia, możesz uzyskać obiekt Method, a następnie:

method.getDeclaringClass().getName()

Aby uzyskać samą metodę, prawdopodobnie możesz użyć:

Class<?> c = Class.forName("class name");
Method  method = c.getDeclaredMethod ("method name", parameterTypes)