{"id":18799,"date":"2018-06-23T04:10:23","date_gmt":"2018-06-23T04:10:23","guid":{"rendered":"https:\/\/data-flair.training\/blogs\/?p=18799"},"modified":"2018-09-15T12:27:23","modified_gmt":"2018-09-15T06:57:23","slug":"spring-logging","status":"publish","type":"post","link":"https:\/\/data-flair.training\/blogs\/spring-logging\/","title":{"rendered":"Integration of Spring Logging with log4j – Eclipse IDE Coding"},"content":{"rendered":"

1. Objective<\/h2>\n

In this Spring Logging Tutorial, you will be seeing the implementation of logging with log4j in Spring Framework<\/strong><\/a>.\u00a0Moreover, we will learn several methods & examples for Spring Logging with log4j. Apache log4j is a Java<\/strong><\/a>-based logging utility which was originally written by Ceki. Log4j is one of several Java logging frameworks. It is a part of Apache Logging Services project of Apache foundation.
\nSo, let’s start Spring Logging with log4J.<\/p>\n

\"Integration<\/a>

Integration of Spring Logging with log4j – Eclipse IDE Coding<\/p><\/div>\n

2. Integration Spring Logging with log4J<\/h2>\n

Log4j is an easy to use functionality inside Spring Framework applications. It is assumed that you already have log4j installed. If not then download it from https:\/\/logging.apache.org\/<\/a><\/u><\/span><\/strong> and unpack the file in any folder. For integrations of Spring Logging with Log4J, we use log4j-x.y.z.jar. You will see a simple example for integrating log4j and Spring framework. Here, you will be making a dynamic form-based web application using Spring Framework. This example is explained using Eclipse IDE.
\nThe following steps are required to make this application:<\/p>\n

    \n
  1. Create your project with name SpringEx and a package com.example. This should be under the src folder of your created project.<\/li>\n
  2. Add the Spring Libraries that are required using the Add External JARs options.<\/li>\n
  3. Add log4j-x.y.z.jar to your project using Add External JARs.<\/li>\n
  4. Create HelloWorld.java and MainApp.java under the above-made package.<\/li>\n
  5. Define config file Bean.xml under src.<\/li>\n
  6. Create a log4j config file log4j.properties under src.<\/li>\n
  7. Finally, write code for all Java files<\/a><\/strong> and Bean config file and run the application as described.<\/li>\n<\/ol>\n

    Follow this link to know more about Spring Batch Tutorial<\/a><\/strong><\/p>\n

    a. Code for HelloWorld.java<\/h3>\n
    package com.example;\r\npublic class HelloWorld {\r\nprivate String message;\r\npublic void setMessage(String message)\r\n{\r\nthis.message = message;\r\n}\r\npublic void getMessage()\r\n{\r\nSystem.out.println(\"Your Message : \" + message);\r\n}\r\n}<\/pre>\n
    b. Code for MainApp.java<\/h3>\n
    package com.example;\r\nimport org.springframework.context.ApplicationContext;\r\nimport org.springframework.context.support.ClassPathXmlApplicationContext;\r\nimport org.apache.log4j.Logger;\r\npublic class MainApp\r\n{\r\nstatic Logger log = Logger.getLogger(MainApp.class.getName());\r\npublic static void main(String[] args)\r\n{\r\nApplicationContext context = new ClassPathXmlApplicationContext(\"Beans.xml\");\r\nlog.info(\"Going to create HelloWord Obj\");\r\nHelloWorld obj = (HelloWorld) context.getBean(\"helloWorld\");\r\nobj.getMessage();\r\nlog.info(\"Exiting the program\");\r\n}\r\n}\r\n<\/pre>\n
    c. Beans XML File<\/h3>\n
    <?xml version = \"1.0\" encoding = \"UTF-8\"?>\r\n<beans xmlns = \"http:\/\/www.springframework.org\/schema\/beans\"\r\nxmlns:xsi = \"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\r\nxsi:schemaLocation = \"http:\/\/www.springframework.org\/schema\/beans\r\nhttp:\/\/www.springframework.org\/schema\/beans\/spring-beans-3.0.xsd\">\r\n<bean id = \"helloWorld\" class = \"com.example.HelloWorld\">\r\n<property name = \"message\" value = \"Hello World!\"\/>\r\n<\/bean>\r\n<\/beans><\/pre>\n
    Now write log4j.properties which will define a standard rule for log4j to produce log messages.<\/p>\n
    # Define the root logger with appender file\r\nlog4j.rootLogger = DEBUG, FILE\r\n# Define the file appender\r\nlog4j.appender.FILE=org.apache.log4j.FileAppender\r\n# Set the name of the file\r\nlog4j.appender.FILE.File=C:\\\\log.out\r\n# Set the immediate flush to true (default)\r\nlog4j.appender.FILE.ImmediateFlush=true\r\n# Set the threshold to debug mode\r\nlog4j.appender.FILE.Threshold=debug\r\n# Set the append to false, overwrite\r\nlog4j.appender.FILE.Append=false\r\n# Define the layout for file appender\r\nlog4j.appender.FILE.layout=org.apache.log4j.PatternLayout\r\nlog4j.appender.FILE.layout.conversionPattern=%m%n\r\n<\/pre>\n
    Finally, after creating source and beans config files run your application. It will show the following messages as output if everything is fine.
    \nYour Message: Hello World!<\/strong>
    \nThen go to your C drive you will find your log.out.It will have messages somethings as follow.
    \n<!– initialization log messages –><\/strong>
    \nGoing to create HelloWord Obj<\/strong>
    \nReturning cached instance of singleton bean ‘helloWorld’<\/strong>
    \nExiting the program<\/strong>
    \n    Let’s explore the Advantages and Disadvantages of Spring Framework<\/a><\/strong>
    \nAlso, you can use Jakarta Commons Logging (JCL) API to generate log in your application. Instead of putting log4j-x.y.z.jar in your CLASSPATH put commons-logging-x.y.z.jar file. For using Spring logging functionality define the org.apache.commons.logging.log object.<\/strong><\/em><\/p>\n
    d. Methods with Object Message<\/h3>\n
    Use the following methods with object message as a parameter:<\/p>\n