Получение имени класса из статического метода в Java

Question

Как можно получить имя класса из статического метода в этом классе. Например

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

Чтобы поместить это в контекст, я действительно хочу вернуть имя класса как часть сообщения в исключении.

Answer 1

Чтобы правильно поддерживать рефакторинг (переименовать класс), вам следует использовать либо:

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

или (спасибо @ Джеймсу Ван Хьюису ):

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

Answer 2

Делай, что говорит инструментарий. Не делай ничего подобного:

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

Answer 3

В Java 7+ вы можете сделать это в статическом методе / полях:

MethodHandles.lookup().lookupClass()

Answer 4

Итак, у нас есть ситуация, когда нам нужно статически получить объект класса или полное / простое имя класса без явного использования синтаксиса MyClass.class.

В некоторых случаях это может быть очень удобно, например, Экземпляр журнала для функций верхнего уровня kotlin (в этом случае kotlin создает статический класс Java, недоступный из кода kotlin).

У нас есть несколько вариантов получения этой информации:

1. new Object(){}.getClass().getEnclosingClass();
   замечено Томом Хотином - tackline

2. getClassContext()[0].getName(); от SecurityManager
   отмеченный Christoffer

3. new Throwable().getStackTrace()[0].getClassName();
   граф Людвиг

4. Thread.currentThread().getStackTrace()[1].getClassName();
   от Кекси

5. и, наконец, потрясающе
   MethodHandles.lookup().lookupClass();
   от Рейн

Я подготовил бенчмарк jmh для всех вариантов, и результаты:

# 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

Выводы

1. Лучший вариант для использования , довольно чистый и чудовищно быстрый.
   Доступно только с Java 7 и Android API 26!

 MethodHandles.lookup().lookupClass();

2. Если вам нужна эта функциональность для Android или Java 6, вы можете использовать второй лучший вариант. Это также довольно быстро, , но создает анонимный класс в каждом месте использования : (

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

3. Если вам это нужно во многих местах и ​​вы не хотите, чтобы ваш байт-код раздулся из-за множества анонимных классов - SecurityManager ваш друг (третий лучший вариант).

   Но вы не можете просто позвонить getClassContext() - он защищен в классе SecurityManager. Вам понадобится некоторый вспомогательный класс, подобный этому:

 // 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. Вероятно, вам никогда не понадобятся последние два варианта, основанные на getStackTrace() из исключения или Thread.currentThread(). Очень неэффективно и может возвращать только имя класса как String, а не Class<*> экземпляр.

приписка

Если вы хотите создать экземпляр логгера для статических утилит kotlin (как я :), вы можете использовать этот помощник:

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())

Пример использования:

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
}

Answer 5

Эта инструкция отлично работает:

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

Answer 6

Вы могли бы сделать что-то действительно сладкое, используя JNI, как это:

MyObject.java:

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

    public static native String getClassName();

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

, то:

javac MyObject.java
javah -jni MyObject

, то:

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 );
}

Затем скомпилируйте C в общую библиотеку с именем libclassname.so и запустите Java!

* смешок

Answer 7

Я использую это, чтобы инициировать Log4j Logger в верхней части моих классов (или комментировать).

PRO: Throwable уже загружен, и вы можете сэкономить ресурсы, не используя «IO heavy» SecurityManager.

CON: Некоторые вопросы относительно того, будет ли это работать для всех 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()); 

Answer 8

злоупотреблять SecurityManager

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

Или, если не установлен, использовать внутренний класс, который расширяет его (пример ниже постыдно скопирован из Real's HowTo ):

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

Answer 9

Если вам нужно полное имя пакета с ним, позвоните:

String name = MyClass.class.getCanonicalName();

Если вам нужен только последний элемент, позвоните:

String name = MyClass.class.getSimpleName();

Answer 10

Дословное использование класса вызывающего абонента, такого как MyClass.class.getName(), на самом деле делает свою работу, но склонен к ошибкам копирования / вставки, если вы распространяете этот код среди многочисленных классов / подклассов, где вам нужно это имя класса.

И Рецепт Тома Хоутина на самом деле неплох, нужно просто правильно его приготовить:)

Если у вас есть базовый класс со статическим методом, который может быть вызван из подклассов, и этот статический метод должен знать фактический класс вызывающего, это может быть достигнуто следующим образом:

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);
  }
}