Отримання назви класу від статичного методу на Java

Як можна отримати ім'я класу зі статичного методу в цьому класі. Наприклад

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

Щоб поставити це в контекст, я фактично хочу повернути ім'я класу як частину повідомлення за винятком.

Щоб правильно підтримувати рефакторинг (перейменувати клас), слід скористатися будь-яким:

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

або (завдяки @James Van Huis ):

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

Робіть те, що говорить інструментарій. Не робіть нічого подібного:

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

У Java 7+ ви можете це зробити в статичному методі / полях:

MethodHandles.lookup().lookupClass()

Отже, у нас є ситуація, коли нам потрібно статично отримати об’єкт класу або повне / просте ім'я класу без явного використання MyClass.classсинтаксису.

Це може бути дуже зручно в деяких випадках, наприклад, екземпляр реєстратора для котлін функції верхнього рівня (в цьому випадку kotlin створює статичний клас Java, недоступний з коду kotlin).

У нас є кілька різних варіантів отримання цієї інформації:

1. new Object(){}.getClass().getEnclosingClass();
   зауважив Том Хоутін - таклін

2. getClassContext()[0].getName();із SecurityManager
   зауваженого Крістофера

3. new Throwable().getStackTrace()[0].getClassName();
   за рахунком Людвіга

4. Thread.currentThread().getStackTrace()[1].getClassName();
   від Кексі

5. і нарешті дивовижний
   MethodHandles.lookup().lookupClass();
   від Рейна

Я підготував дмм орієнтиром для всіх варіантів та результатів є:

# 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<*>екземпляр.

PS

Якщо ви хочете створити екземпляр реєстратора для статичних утилітів 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
}

Ця інструкція працює чудово:

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

Ви можете зробити щось дійсно солодке, використовуючи такий 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!

* посміятися

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

PRO: Throwable вже завантажений, і ви можете економити ресурси, не використовуючи "IO heavy" SecurityManager.

КОН: Деякі запитання щодо того, чи буде це спрацьовувати для всіх спільних інструментів.

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

Зловживайте SecurityManager

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

Або, якщо його не встановлено, використовуйте внутрішній клас, який розширює його (приклад нижче ганебно скопійований з HowTo Реала ):

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

Якщо ви хочете всю назву пакета з ним, зателефонуйте:

String name = MyClass.class.getCanonicalName();

Якщо ви хочете лише останній елемент, зателефонуйте:

String name = MyClass.class.getSimpleName();

Дослівне використання класу абонента, як 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);
  }
}

Безпечне для рефакторингу рішення, безпечне для вирізання та наклеювання, що дозволяє уникнути визначення спеціальних класів нижче.

Напишіть статичний метод, який відновить ім'я класу, обережно включивши ім'я класу у назву методу:

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

потім пригадайте це у своєму статичному методі:

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

Безпека від рефакторингу надається, уникаючи використання рядків, забезпечується безпека вирізання та вставки, тому що якщо ви вирізаєте і вставите метод виклику, ви не знайдете getMyClassName () у цільовому класі MyClass2, тому ви змушені будете переосмислити та оновити його.

Так як питання Щось на зразок `this.class` замість` ClassName.class`? позначається як дублікат для цього (що сперечається, тому що це питання стосується класу, а не назви класу), я надсилаю відповідь тут:

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

Важливо визначити thisClassяк приватне, оскільки:
1) воно не повинно бути успадковане: похідні класи повинні або визначати своє власне, thisClassабо створювати повідомлення про помилку
2) посилання з інших класів слід робити, ClassName.classа не робити ClassName.thisClass.

З thisClassвизначеним доступом до імені класу стає:

thisClass.getName()

Мені потрібно було ім'я класу в статичних методах декількох класів, тому я реалізував клас JavaUtil наступним методом:

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

Сподіваюся, це допоможе!

Я використовував ці два підходи для обох staticіnon static сценарію:

Основний клас:

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

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

Як вказати назву класу:

нестатичний спосіб:

private AndroidLogger mLogger = new AndroidLogger(this);

Статичний спосіб:

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

Якщо ви використовуєте відображення, ви можете отримати об'єкт Method, а потім:

method.getDeclaringClass().getName()

Щоб отримати сам метод, ви, ймовірно, можете використовувати:

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