Java >> Java tutorial >  >> Tag >> Log4j

Log4j E-mail-konfigurationseksempel

Det er altid bedre at få besked om større undtagelser, der forekommer i en applikation, i stedet for manuelt at gå gennem enorme logfiler for at finde de sandsynlige undtagelsesmeddelelser. I denne vejledning vil jeg vise dig, hvordan du implementerer en out of box Log4j appender (kaldet som SMTPAppender ) for at sende e-mail-advarsler.

1. Introduktion

Udskrivning af beskeder til konsollen er en integreret del af udviklingstesten og fejlretningen af ​​et Java-program. Hvis udviklere arbejder på en serversideapplikation, hvor de ikke kan se, hvad der foregår inde på serveren, så er deres eneste synlighedsværktøj en log fil.

Uden logfiler kan udviklere ikke foretage nogen fejlfinding eller se, hvad der foregår inde i applikationen. Java har ret praktisk System.out.println() metoder til at udskrive noget på konsollen, som også kan dirigeres til en logfil, men det er ikke tilstrækkeligt til en virkelig Java-applikation.

Hvis udviklere kører et Java-program i Linux eller i de Unix-baserede systemer, Log4j eller SLF4j eller en hvilken som helst anden logningsramme tilbyder mange flere funktioner, fleksibilitet og forbedring af meddelelseskvalitet, hvilket ikke er muligt ved hjælp af System.out.println() udsagn.

1.1 Hvad er Log4j?

Log4j er en enkel, fleksibel og hurtig Java-baseret logningsramme. Det er trådsikkert og understøtter internationalisering. Vi har hovedsageligt 3 komponenter at arbejde med Log4j :

  • Logger :Den bruges til at logge meddelelserne
  • Tillæg :Det bruges til at publicere logningsoplysningerne til destinationen som fil, database, konsol osv.
  • Layout :Det bruges til at formatere logningsoplysninger i forskellige stilarter

1.1.1 Log4j Logger Class

Logger klasse giver metoderne til logningsprocessen. Vi kan bruge getLogger() metode til at få Logger objekt. Syntaksen er angivet nedenfor:

static Logger log = Logger.getLogger(YourClassName.class);

Logger klasse har 5 logningsmetoder, der bruges til at udskrive status for en applikation:

Beskrivelse Metodesyntaks
debug(Objektmeddelelse) Det bruges til at udskrive meddelelsen med niveauet org.apache.log4j.Level.DEBUG . offentlig void debug(Objektmeddelelse)
fejl(Objektmeddelelse) Det bruges til at udskrive meddelelsen med niveauet org.apache.log4j.Level.ERROR . offentlig ugyldig fejl (Objektmeddelelse)
info(Objektmeddelelse) Det bruges til at udskrive meddelelsen med niveauet org.apache.log4j.Level.INFO . offentlig ugyldig info(Objektmeddelelse)
fatal(Objektmeddelelse) Det bruges til at udskrive meddelelsen med niveauet org.apache.log4j.Level.FATAL . offentlig ugyldig fatal(Objektmeddelelse)
advarsel(Objektmeddelelse) Det bruges til at udskrive meddelelsen med niveauet org.apache.log4j.Level.WARN . offentlig void warn(Objektmeddelelse)
trace(Objektmeddelelse) Det bruges til at udskrive meddelelsen med niveauet org.apache.log4j.Level.TRACE . offentlig ugyldig sporing (Objektmeddelelse)

For at opsummere er prioritetsniveauet givet nedenfor.

Trace < Debug < Info < Warn < Error < Fatal

Hvor org.apache.log4j.Level.FATAL har den højeste prioritet og org.apache.log4j.Level.Trace den laveste .

1.1.2 Log4j Appender Interface

Appender er en grænseflade, som primært er ansvarlig for at udskrive logningsmeddelelserne til de forskellige destinationer såsom konsol, filer, sockets, database osv. I Log4j vi har forskellige typer Appender implementeringsklasser:

Fig. 1:Log4j-tillæg

1.1.3 Log4j Layout Klasse

Layout komponent angiver det format, som log-sætningerne skrives ind i destinationslageret af Appender . I Log4j vi har forskellige typer Layout implementeringsklasser:

Fig. 2:Log4j Layout

1.2 Hvorfor foretrækker Log4j frem for System.out.println?

Nedenfor er nogle af grundene, som er nok til at forstå begrænsningen ved at bruge System.out.println() :

  • Enhver logningsramme inklusive tillader udviklere at logge fejlfindingsoplysninger til et logniveau, der kan bruges som filtreringskriterier, dvs. man kan deaktivere meddelelsen, der tilhører et bestemt logniveau. For eksempel ville udviklere være mere bekymrede for at se WARN beskeder end DEBUG beskeder i produktionsmiljøet
  • Loggeramme kan producere bedre output og metadata, som hjælper med at fejlfinde og fejlfinde. For f.eks. Log4j gør det muligt at udskrive formateret output ved at angive et formateringsmønster, dvs. ved at bruge PatternLayout man kan inkludere et tidsstempel, klassenavn osv.

Åbn nu Eclipse Ide, og lad os begynde at bygge applikationen!

2. Log4j E-mail-konfigurationseksempel

Nedenfor er de trin, der er involveret i udviklingen af ​​denne applikation.

2.1 Anvendte værktøjer

Vi bruger Eclipse Kepler SR2, JDK 8 og Log4j Krukke. Når det er sagt, har vi testet koden mod JDK 1.7, og det fungerer godt.

2.2 Projektstruktur

Lad os først gennemgå den endelige projektstruktur, hvis du er i tvivl om, hvor du skal oprette de tilsvarende filer eller mappe senere!

Fig. 3:Ansøgningsprojektstruktur

2.3 Projektoprettelse

Dette afsnit vil demonstrere, hvordan man opretter et Java-baseret Maven-projekt med Eclipse. I Eclipse Ide skal du gå til File -> New -> Maven Project .

Fig. 4:Opret Maven Project

I vinduet New Maven Project vil det bede dig om at vælge en projektplacering. Som standard vil 'Brug standardarbejdspladsplacering' være valgt. Marker afkrydsningsfeltet 'Opret et simpelt projekt (spring over arketypevalg)', og klik bare på knappen næste for at fortsætte.

Fig. 5:Projektdetaljer

Den vil bede dig om at 'Indtast gruppen og artefakt-id'et for projektet ’. Vi vil indtaste detaljerne som vist på billedet nedenfor. Versionsnummeret vil som standard være:0.0.1-SNAPSHOT .

Fig. 6:Arketypeparametre

Klik på afslut og oprettelsen af ​​et maven-projekt vil blive afsluttet. Hvis du observerer, har den downloadet maven-afhængighederne og en pom.xml fil vil blive oprettet. Den vil have følgende kode:

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>Log4jMailNotifier</groupId>
	<artifactId>Log4jMailNotifier</artifactId>
	<version>0.0.1-SNAPSHOT</version>
</project>

Vi kan begynde at tilføje de afhængigheder, som udviklere ønsker, såsom Log4j , Junit osv. Lad os begynde at bygge applikationen!

3. Applikationsbygning

Nedenfor er de trin, der er involveret i udviklingen af ​​denne applikation.

3.1 Maven-afhængigheder

I dette eksempel bruger vi den mest stabile Log4j-version for at opsætte logningsrammerne. Den opdaterede filen vil have følgende kode:

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>Log4jMailNotifier</groupId>
	<artifactId>Log4jMailNotifier</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<dependencies>
		<!-- https://mvnrepository.com/artifact/javax.mail/mail -->
		<dependency>
			<groupId>javax.mail</groupId>
			<artifactId>mail</artifactId>
			<version>1.4.7</version>
		</dependency>
		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.17</version>
		</dependency>
	</dependencies>
	<build>
		<finalName>Log4jMailNotifier</finalName>
	</build>
</project>

3.2 Java-klasseoprettelse

Lad os oprette de nødvendige Java-filer. Højreklik på src/main/java mappe, New -> Package .

Fig. 7:Java-pakkeoprettelse

Et nyt pop-vindue åbnes, hvor vi indtaster pakkenavnet som:com.jcg.log4j.mail .

Fig. 8:Java-pakkenavn (com.jcg.log4j.mail)

Når pakken er oprettet, skal vi oprette implementeringsklassen. Højreklik på den nyoprettede pakke, New -> Class .

Fig. 9:Java-klasseoprettelse

Et nyt pop-vindue åbnes og indtast filnavnet som:MailNotifier . Implementeringsklassen vil blive oprettet inde i pakken:com.jcg.log4j.mail .

Fig. 10:Java-klasse (MailNotifier.java)

3.2.1 Implementering af hjælpeklasse

Lad os skrive et hurtigt Java-program, der genererer en undtagelse, og undtagelsen vil blive logget inde i catch-blokken. Tilføj følgende kode til det.

MailNotifier.java

package com.jcg.log4j.mail;

import org.apache.log4j.Logger;

public class MailNotifier {

	private static Logger logger = Logger.getLogger(MailNotifier.class);

	public static void main(String[] args) {
		try {
			// Generating Sample Exception
			throw new Exception("Generating Exception To Test Log4j Mail Notification...");
		} catch (Exception exObj) {
			logger.error("Sample Result?= " + exObj);
		}
	}
}

3.3 Log4j-konfigurationsfil

Log4j vil normalt blive konfigureret ved hjælp af en egenskabsfil eller en XML fil. Så når logerklæringerne er på plads, kan udviklere nemt kontrollere dem ved hjælp af den eksterne konfigurationsfil uden at ændre kildekoden. log4j.xml filen er en Log4j konfigurationsfil, som holder egenskaber i nøgleværdi-par. Som standard er LogManager leder efter en fil med navnet log4j.xml i CLASSPATH .

For at konfigurere logningsrammen skal vi implementere en konfigurationsfil, dvs. log4j.xml og sæt den ind i src/main/resources folder. Konfigurer SMTPAppender og tilføje følgende kode til det:

log4j.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM 
          "http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
	<appender name="mailAppender" class="org.apache.log4j.net.SMTPAppender">
		<!-- Email Configuration -->
		<param name="BufferSize" value="512" />
		<param name="SMTPProtocol" value="smtps" />
		<param name="SMTPHost" value="smtp.mail.yahoo.com" />
		<param name="SMTPPort" value="465" />
		<param name="SMTPUsername" value="<!-- Sender Email Address -->" />
		<param name="SMTPPassword" value="<!-- Sender Email Password -->" />
		<param name="From" value="<!-- Sender Email Address -->" />
		<param name="To" value="<!-- Receiver Email Address -->" />
		<param name="Subject" value="Testing Log4j Mail Notification" />

		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%-7p %d [%t] %c %x - %m%n" />
		</layout>

		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<param name="LevelMin" value="error" />
			<param name="LevelMax" value="fatal" />
		</filter>
	</appender>

	<root>
		<level value="INFO" />
		<appender-ref ref="mailAppender" />
	</root>
</log4j:configuration>

Husk:

  • For at angive den korrekte SMTPHost , SMTPPort , Godkendelsesdetaljer (dvs. SMTPUsername og SMTPPassword ), To (Kommasepareret liste) og From E-mail-modtagere og e-mail-emnet
  • At angive minimums- og maksimumslogningsniveauet i LevelRangeFilter
  • Antallet af logningshændelser leveret i en e-mail afhænger af værdien af ​​BufferSize mulighed

4. Kør programmet

For at køre programmet skal du højreklikke på MailNotifier klasse, Run As -> Java Application . Udviklere kan fejlsøge eksemplet og se, hvad der sker efter hvert trin. God fornøjelse!

Fig. 11:Kør applikation

5. Projektdemo

Koden viser følgende status som output, hvor en fejllog vil blive genereret, og derefter vil den blive e-mailet ved hjælp af Log4j SMTPAppender .

Fig. 12:Log4j e-mailbesked

Det er alt for dette indlæg. God læring!!

6. Konklusion

Det er alt for at få udviklerne i gang med Log4j for eksempel vil vi se på flere funktioner i de næste indlæg. Jeg håber, at denne artikel tjente dig, hvad end du ledte efter. Udviklere kan downloade eksempelapplikationen som et Eclipse-projekt i afsnittet Downloads.

7. Download Eclipse Project

Dette var et eksempel på Log4j Email Configuration example.core java Email Java Java 8 log4j SMTP

Java tag