Meilleures pratiques de journalisation des erreurs et / ou de rapports pour iPhone

Voici ce que nous faisons:

• laisser l'iPhone gérer son propre crash dumps à travers le App Store mécanismes existants . Update : ayant constaté que iTunes Connect n'était pas fiable pour fournir des rapports d'accident, je recommande d'utiliser tissu/Crashlytics , ou un concurrent comme Crittercism ou Rollbar .
• notre produit libéré n'a aucune trace dans, cela semble être compatible avec ce que la plupart des autres applications iPhone faire.
• si un bogue est signalé alors nous le reproduisons en utilisant une construction tracée.

plus en détail:

• nous définissons macros à NSLog trace à de nombreux niveaux différents de granularité.
• utilise les paramètres de construction de Xcode pour changer le niveau de trace, qui contrôle combien de trace est compilé dans le produit, par exemple il y a des configurations de construction de Release et Debug.
• si aucun niveau de trace n'est défini, alors nous montrons une trace complète dans le simulateur, et aucune trace lors de la course sur un appareil réel.

j'ai inclus le code d'exemple ci-dessous montrant comment nous avons écrit ceci, et à quoi ressemble la sortie.

nous définissons plusieurs niveaux de trace différents de sorte que les développeurs peuvent identifier quelles lignes de trace sont importantes, et peut filtrer les détails de niveau inférieur s'ils le veulent.

exemple de code:

- (void)myMethod:(NSObject *)xiObj
{
  TRC_ENTRY;
  TRC_DBG(@"Boring low level stuff");
  TRC_NRM(@"Higher level trace for more important info");
  TRC_ALT(@"Really important trace, something bad is happening");
  TRC_ERR(@"Error, this indicates a coding bug or unexpected condition");
  TRC_EXIT;
}

Exemple de sortie de trace:

2009-09-11 14:22:48.051 MyApp[3122:207] ENTRY:+[MyClass myMethod:]
2009-09-11 14:22:48.063 MyApp[3122:207] DEBUG:+[MyClass myMethod:]:Boring low level stuff
2009-09-11 14:22:48.063 MyApp[3122:207] NORMAL:+[MyClass myMethod:]:Higher level trace for more important info
2009-09-11 14:22:48.063 MyApp[3122:207] ALERT:+[MyClass myMethod:]:Really important trace, something bad is happening
2009-09-11 14:22:48.063 MyApp[3122:207] ERROR:+[MyClass myMethod:]:Error, this indicates a coding bug or unexpected condition
2009-09-11 14:22:48.073 MyApp[3122:207] EXIT:+[MyClass myMethod:]

nos définitions de trace:

#ifndef TRC_LEVEL
#if TARGET_IPHONE_SIMULATOR != 0
#define TRC_LEVEL 0
#else
#define TRC_LEVEL 5
#endif
#endif

/*****************************************************************************/
/* Entry/exit trace macros                                                   */
/*****************************************************************************/
#if TRC_LEVEL == 0
#define TRC_ENTRY    NSLog(@"ENTRY: %s:%d:", __PRETTY_FUNCTION__,__LINE__);
#define TRC_EXIT     NSLog(@"EXIT:  %s:%d:", __PRETTY_FUNCTION__,__LINE__);
#else
#define TRC_ENTRY
#define TRC_EXIT
#endif

/*****************************************************************************/
/* Debug trace macros                                                        */
/*****************************************************************************/
#if (TRC_LEVEL <= 1)
#define TRC_DBG(A, ...) NSLog(@"DEBUG: %s:%d:%@", __PRETTY_FUNCTION__,__LINE__,[NSString stringWithFormat:A, ## __VA_ARGS__]);
#else
#define TRC_DBG(A, ...)
#endif

#if (TRC_LEVEL <= 2)
#define TRC_NRM(A, ...) NSLog(@"NORMAL:%s:%d:%@", __PRETTY_FUNCTION__,__LINE__,[NSString stringWithFormat:A, ## __VA_ARGS__]);
#else
#define TRC_NRM(A, ...)
#endif

#if (TRC_LEVEL <= 3)
#define TRC_ALT(A, ...) NSLog(@"ALERT: %s:%d:%@", __PRETTY_FUNCTION__,__LINE__,[NSString stringWithFormat:A, ## __VA_ARGS__]);
#else
#define TRC_ALT(A, ...)
#endif

#if (TRC_LEVEL <= 4)
#define TRC_ERR(A, ...) NSLog(@"ERROR: %s:%d:%@", __PRETTY_FUNCTION__,__LINE__,[NSString stringWithFormat:A, ## __VA_ARGS__]);
#else
#define TRC_ERR(A, ...)
#endif

paramètres de Xcode:

dans les paramètres de construction de Xcode, choisissez "Ajouter le paramètre défini par L'Utilisateur" (en cliquant sur little cog en bas à gauche de l'écran de configuration de build), puis définir un nouveau paramètre appelé GCC_PREPROCESSOR_DEFINITIONS et lui donner la valeur TRC_LEVEL=0 .

la seule subtilité est que Xcode ne sait pas faire une construction propre si vous changez ce paramètre, alors n'oubliez pas de faire manuellement un nettoyage si vous le changez.