คุณมักจะติดแท็กรายการบันทึกอย่างไร (Android)

ฉันถือว่าพวกคุณส่วนใหญ่รู้จัก android.util.Log วิธีการบันทึกทั้งหมดยอมรับ 'String tag' เป็นอาร์กิวเมนต์แรก

และคำถามของฉันคือคุณมักจะแท็กบันทึกของคุณในแอปพลิเคชันของคุณอย่างไร ฉันเคยเห็นฮาร์ดโค้ดแบบนี้:

public class MyActivity extends Activity {
    private static final String TAG = "MyActivity";
    //...
    public void method () {
        //...
        Log.d(TAG, "Some logging");
    }
}

สิ่งนี้ดูไม่ดีเนื่องจากสาเหตุหลายประการ:

• คุณสามารถบอกฉันได้ว่ารหัสนี้ไม่มีฮาร์ดโค้ด แต่มี
• แอปพลิเคชันของฉันสามารถมีคลาสกี่คลาสก็ได้ในแพ็กเกจต่างๆที่มีชื่อเดียวกัน ดังนั้นจึงเป็นการยากที่จะอ่านบันทึก
• มันไม่ยืดหยุ่น คุณใส่ TAG ฟิลด์ส่วนตัวไว้ในชั้นเรียนของคุณเสมอ

มีวิธีใดในการรับ TAG สำหรับชั้นเรียนหรือไม่?

ฉันใช้ TAG แต่เริ่มต้นเป็นดังนี้:

private static final String TAG = MyActivity.class.getName();

ด้วยวิธีนี้เมื่อฉัน refactor โค้ดของฉันแท็กก็จะเปลี่ยนตามไปด้วย

ฉันมักจะสร้างAppคลาสที่อยู่ในแพ็คเกจอื่นและมีวิธีการคงที่ที่มีประโยชน์ วิธีหนึ่งคือgetTag()วิธีการนี้ฉันสามารถรับ TAG ได้ทุกที่
Appคลาสมีลักษณะดังนี้:

แก้ไข : ปรับปรุงต่อความคิดเห็นของกลุ่มคน (ขอบคุณ :))

public class App {

    public static String getTag() {
        String tag = "";
        final StackTraceElement[] ste = Thread.currentThread().getStackTrace();
        for (int i = 0; i < ste.length; i++) {
            if (ste[i].getMethodName().equals("getTag")) {
                tag = "("+ste[i + 1].getFileName() + ":" + ste[i + 1].getLineNumber()+")";
            }
        }
        return tag;
    }

}

และเมื่อฉันต้องการใช้:

Log.i(App.getTag(), "Your message here");

ผลลัพธ์ของgetTagเมธอดคือชื่อของคลาสผู้เรียก (พร้อมชื่อแพ็กเกจ) และหมายเลขบรรทัดที่getTagเรียกจากเพื่อง่ายต่อการดีบัก

ไปที่Android สตูดิโอ -> การตั้งค่า -> แม่แบบสด -> AndroidLogแล้วเลือกLog.d (TAG, String)

ในเทมเพลตข้อความแทนที่

android.util.Log.d(TAG, "$METHOD_NAME$: $content$");

ด้วย

android.util.Log.d("$className$", "$METHOD_NAME$: $content$");

จากนั้นคลิกแก้ไขตัวแปรและป้อน className () ในคอลัมน์นิพจน์ถัดจากคอลัมน์ชื่อคลาส

ตอนนี้เมื่อคุณพิมพ์ทางลัดlogdมันจะใส่

Log.d("CurrentClassName", "currentMethodName: ");

คุณไม่จำเป็นต้องกำหนด TAG อีกต่อไป

ฉันต้องการปรับปรุงคำตอบของ Yaniv หากคุณมีบันทึกในรูปแบบนี้ (filename.java:XX) หมายเลขบรรทัด xx คุณสามารถเชื่อมโยงทางลัดในลักษณะเดียวกับที่ได้รับการเชื่อมโยงเมื่อมีข้อผิดพลาดด้วยวิธีนี้ฉันจะได้โดยตรงไปยังบรรทัดที่มีปัญหา เพียงแค่คลิกที่ logcat

ฉันใส่สิ่งนี้ไว้ในแอปพลิเคชันที่ขยายเพื่อให้สามารถใช้กับไฟล์อื่น ๆ ได้

public static String getTag() {
    String tag = "";
    final StackTraceElement[] ste = Thread.currentThread().getStackTrace();
    for (int i = 0; i < ste.length; i++) {
        if (ste[i].getMethodName().equals("getTag")) {
            tag = "("+ste[i + 1].getFileName() + ":" + ste[i + 1].getLineNumber()+")";
        }
    }
    return tag;
}

ภาพหน้าจอ:

AndroidStudio มีlogtเทมเพลตตามค่าเริ่มต้น (คุณสามารถพิมพ์logtและกดแท็บเพื่อให้ขยายเป็นโค้ดได้) ฉันขอแนะนำให้ใช้สิ่งนี้เพื่อหลีกเลี่ยงการคัดลอกการวางคำจำกัดความ TAG จากคลาสอื่นและลืมเปลี่ยนคลาสที่คุณกำลังอ้างถึง เทมเพลตจะขยายตามค่าเริ่มต้นเป็น

private static final String TAG = "$CLASS_NAME$"

เพื่อหลีกเลี่ยงการใช้ชื่อคลาสเก่าหลังจากปรับโครงสร้างใหม่คุณสามารถเปลี่ยนเป็น

private static final String TAG = $CLASS_NAME$.class.getSimpleName();

อย่าลืมตรวจสอบปุ่ม "แก้ไขตัวแปร" และตรวจสอบให้แน่ใจว่าCLASS_NAMEตัวแปรถูกกำหนดให้ใช้className()นิพจน์และได้เลือก "ข้ามถ้ากำหนด"

ฉันได้สร้างคลาสของตัวแปรแบบคงที่วิธีการและคลาสที่ชื่อเป็นS.

ต่อไปนี้เป็นวิธีการบันทึก:

public static void L(Context ctx, Object s) {
    Log.d("CCC " + ctx.getClass().getName().replace(ctx.getPackageName(), ""), s.toString());
}

มันถูกเรียกในคลาสใด ๆ เนื่องจากS.L(this, whaterver_object);The getClass().getName()ยังผนวกชื่อแพ็กเกจด้วยดังนั้นฉันจึงลบมันออกเพื่อหลีกเลี่ยงการทำให้แท็กยาวโดยไม่จำเป็น

ข้อดี:

1. สั้นกว่า Log.d(TAG,
2. ไม่จำเป็นต้องแปลงค่า int เป็นสตริง Infact ไม่จำเป็นต้องพิมพ์toString
3. อย่าลืมลบLog.dเลยเพราะฉันต้องลบเมธอดและตำแหน่งของบันทึกทั้งหมดจะถูกทำเครื่องหมายเป็นสีแดง
4. ไม่จำเป็นต้องกำหนด TAG ที่ด้านบนของกิจกรรมเนื่องจากใช้ชื่อชั้นเรียน
5. TAG มีคำนำหน้าCCC(สตริงที่สั้นและพิมพ์ง่าย) เพื่อให้ง่ายต่อการแสดงรายการบันทึกของคุณในหน้าจอ Android ใน Android Studio บางครั้งคุณกำลังเรียกใช้บริการหรือชั้นเรียนอื่น ๆ พร้อมกัน หากคุณต้องค้นหาด้วยชื่อกิจกรรมเพียงอย่างเดียวคุณจะไม่สามารถเห็นได้อย่างแน่ชัดว่าเมื่อใดที่ได้รับการตอบสนองของบริการและการดำเนินการจากกิจกรรมของคุณเกิดขึ้น คำนำหน้าเช่น CCC ช่วยให้คุณบันทึกตามลำดับเวลาของกิจกรรมที่เกิดขึ้น

คุณสามารถใช้this.toString()เพื่อรับตัวระบุเฉพาะสำหรับคลาสเฉพาะที่คุณพิมพ์ลงในบันทึก

ค่าใช้จ่ายในการอัปเดตสตริงเหล่านี้เมื่อฉันย้ายรหัสระหว่างวิธีการหรือเปลี่ยนชื่อวิธีการฉันชอบทำสิ่งต่อไปนี้ ในทางปรัชญาดูเหมือนว่าควรเก็บ "ตำแหน่ง" หรือ "บริบท" ไว้ในแท็กไม่ใช่ข้อความ

public class MyClass {

    // note this is ALWAYS private...subclasses should define their own
    private static final LOG_TAG = MyClass.class.getName();

    public void f() {
        Log.i(LOG_TAG + ".f", "Merry Christmas!");
    }

}

ข้อดีคือคุณสามารถกรองวิธีการเดียวแม้ว่าเนื้อหาจะไม่คงที่ก็ตามเช่น

Log.i(LOG_TAG + ".f", String.valueOf(new Random().nextInt()));

ข้อเสียเปรียบเพียงอย่างเดียวคือเมื่อฉันเปลี่ยนชื่อf()เป็นg()ฉันจำเป็นต้องคำนึงถึงสตริงนั้น นอกจากนี้การรีแฟคเตอร์ IDE อัตโนมัติจะไม่ตรวจจับสิ่งเหล่านี้

LOG_TAG = MyClass.class.getSimpleName()สำหรับในขณะที่ผมเป็นแฟนตัวยงของการใช้ชื่อชั้นสั้นผมหมายถึง ฉันพบว่าพวกเขากรองในบันทึกได้ยากกว่าเพราะมีน้อยกว่าที่จะดำเนินการต่อ

เป็นคำถามที่เก่ามาก แต่คิดว่าคำตอบที่อัปเดตสำหรับเดือนกรกฎาคม 2018 ควรใช้ Timber ในการบันทึกการบันทึกที่ถูกต้องคุณสามารถส่งข้อผิดพลาดและคำเตือนไปยังไลบรารีข้อขัดข้องของบุคคลที่สามเช่น Firebase หรือ Crashlytics

ในคลาสที่ใช้Applicationคุณควรเพิ่มสิ่งนี้:

@Override
public void onCreate() {
    super.onCreate();
    if (BuildConfig.DEBUG) {
        Timber.plant(new Timber.DebugTree());
    } else {
        Timber.plant(new CrashReportingTree());
    }
}

/** A tree which logs important information for crash reporting. */
private static class CrashReportingTree extends Timber.Tree {
    @Override protected void log(int priority, String tag, String message, Throwable t) {
        if (priority == Log.VERBOSE || priority == Log.DEBUG) {
            return;
        }

        FakeCrashLibrary.log(priority, tag, message);

        if (t != null) {
            if (priority == Log.ERROR) {
                FakeCrashLibrary.logError(t);
            } else if (priority == Log.WARN) {
                FakeCrashLibrary.logWarning(t);
            }
        }
    }
}

อย่าลืมการพึ่งพาไม้

implementation 'com.jakewharton.timber:timber:4.7.1'

สำหรับผู้ใช้ที่เข้าชมคำถามนี้:

private val TAG:String = this.javaClass.simpleName;

พวกเขาใช้ Timber สำหรับแอพ IOsched 2019 เพื่อแสดงข้อมูลการดีบัก:

implementation 'com.jakewharton.timber:timber:4.7.1'

class ApplicationController: Application() {

override fun onCreate() {  
    super.onCreate()
    if(BuildConfig.DEBUG){
        Timber.plant(Timber.DebugTree())
    }
}   
// enables logs for every activity and service of the application
// needs to be registered in manifest like:  
 <application
    android:label="@string/app_name"
    android:name=".ApplicationController"
    ... >

การใช้งาน

  Timber.e("Error Message") 
  // will print ->  D/MainActivity: Error Message

  Timber.d("Debug Message");
  Timber.tag("new tag").e("error message");

โปรดทราบว่าสิ่งนี้ทำให้ Logs พร้อมใช้งานเฉพาะในสถานะ DEBUG และช่วยให้คุณสามารถลบออกด้วยตนเองสำหรับการเปิดตัวบน Google Play -

เมื่อปล่อยแอพใน play store เราจำเป็นต้องลบคำสั่ง Log ทั้งหมดออกจากแอพเพื่อไม่ให้ข้อมูลแอพพลิเคชั่นเช่นข้อมูลผู้ใช้ข้อมูลแอพพลิเคชั่นที่ซ่อนอยู่โทเค็นการตรวจสอบความถูกต้องมีให้สำหรับผู้ใช้ใน logcat เป็นข้อความธรรมดา

ลองอ่านบทความนี้https://medium.com/mindorks/better-logging-in-android-using-timber-72e40cc2293d

ฉันมักจะใช้ชื่อวิธีการเป็นแท็ก แต่มาจากเธรด

String TAG = Thread.currentThread().getStackTrace()[1].getMethodName();

สิ่งนี้หลีกเลี่ยงข้อยกเว้นใหม่

private static final String TAG = new RuntimeException().getStackTrace()[0].getClassName();