SpringBoot Part1 (5)

logging

로깅이란 ?

: 로그 시스템의 사용에 관계된 일련의 사건을 시간의 경과에 따라 기록하는 것이다.

Java Logging Framework

java.util.logging → 기능이 부족해서 잘 안사용한다.
Apache Commons logging
Log4J
Logback → 현재 가장 많이 사용됨. Log4J 성능 향상 버전. springboot가 기본적으로 제공함
SLF4J(Simple Logging Facade for Java)

! println은 내부에 synchronized를 사용하기 때문에 오버헤드가 발생할 수 있다. → 운영할때 쓰면 안된다.

SLF4J

Logging Framework들을 추상화해 놓은 것입니다. Facade 패턴을 이용한 프레임워크

Facade Patten : 건물의 외벽이라는 뜻으로, 많은 서브 시스틈을 내부 구조로 두고 거대한 클래스(외벽)를 만들어 감싸서 편리한 인터페이스를 제공해 주는 패턴

Binding 모듈 제공

logging 프로그램이 변경될때 마다 코드를 변경할 필요 없이 binding만 변경해주면 다양한 프레임워크를 동일하기 처리해준다. 로깅 프레임워크를 연결하는 역할을 한다.

Log Level

로그를 어느 정도 까지 남길지 기준을 정하기

trace
debug
info
warm
error

https://logback.qos.ch/manual/architecture.html

Logger

: logger들은 이름 기반으로 생성된다.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class OrderTester {

    // static으로 생성해야 단 하나의 logger만 만들어지게 한다.
    // org.prgrms.kdt.OrderTester
    private static final Logger logger = LoggerFactory.getLogger(OrderTester.class); //메소드가 아니라 class 단위에서 생성
    public static void main(String[] args) throws Exception{

        var applicationContext = new AnnotationConfigApplicationContext(AppConfiguration.class);        

        var orderProperties = applicationContext.getBean(OrderProperties.class);
        logger.info("logger name => {}",logger.getName());
        logger.info("version : {}",orderProperties.getVersion());
        logger.info("minimumOrderAmount : {}",orderProperties.getMinimumOrderAmount());
        logger.info("SupportVendors : {}",orderProperties.getSupportVendors());
        logger.info("Description : {}",orderProperties.getDescription());

        applicationContext.close(); // 컨테이너에 등록된 모둔 Bean 소멸
    }
}

Logback

logback 설정하기

lagback 설정 파일 찾는 순서

https://logback.qos.ch/manual/configuration.html

logback-test.xml 파일 찾기
없으면 logback.groovy 찾기
그래도 없으면 logback.xml 찾기
모두 없으면 기본 설정 전략을 따른다. BasicConfiguration

BasicConfiguration

<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug"> <!--root는 모든 레벨-->
        <appender-ref ref="STDOUT" />
    </root>
</configuration><configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug"> <!--root는 모든 레벨-->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

logger : 폴더 단위로 레벨 지정 가능
patten : property 태그로 layout 지정가능
- %-5level : 레벨 5자리 왼쪽 정렬 출력
- %logger{36} : 로거 36자
- %n : 개행
FileAppender

<configuration>

    <property name="LOG_PATTERN" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />

    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"></timestamp>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.FileAppender" >
        <file>logs/kdt_${bySecond}.log</file>
        <append>false</append>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <logger name="org.prgrms.kdt" level="info">
        <appender-ref ref="FILE"/>
    </logger>
    <root level="warn"> <!--root는 모든 레벨-->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

RollingFileAppender

: 트리거에 따라 파일 생성

<configuration>

    <property name="LOG_PATTERN" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender" >
        <file>logs/access.log</file> <!-- access.log가 만들어지고 날짜가 변하면 파일명이 access-%d{yyyy-MM-dd}.log로 변경되는 패턴 : 최신 파일은 언제나 access.log&ndash;&gt;-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/access-%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <logger name="org.prgrms.kdt" level="debug">
        <appender-ref ref="ROLLING_FILE"/>
    </logger>

    <root level="warn"> <!--root는 모든 레벨-->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

Conversion

: 색상 변경 가능

: file은 색상이 기록되서 가독성이 떨어지니 property로 패턴을 나눠 적용해준다.

: 적용이 잘 되지않으면 main 메소드에

AnsiOutput.setEnabled(AnsiOutput.Enabled.ALWAYS); 추가

<configuration>

    <conversionRule conversionWord="clr"
                    converterClass="org.springframework.boot.logging.logback.ColorConverter"/>

    <property name="CONSOLE_LOG_PATTERN" value="%clr(%d{HH:mm:ss.SSS}){yellow} [%thread] %clr(%-5level) %logger{36} - %msg%n" />
    <property name="FILE_LOG_PATTERN" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />

    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"></timestamp>
    
		<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender" >
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/access-%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <logger name="org.prgrms.kdt" level="debug">
        <appender-ref ref="ROLLING_FILE"/>
    </logger>

    <root level="warn"> <!--root는 모든 레벨-->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

SpringBoot 시작하기

(드디어)

@SpringBootApplication

: 최상의 Configuration을 포함한다. 단 하나의 class 만 허용한다.

: ComponentScan

: EnableAutoConfiguation

: 기본적으로 resources 폴더에 application.properties/ application.YAML 파일을 읽는다. (PropertySource 설정이 필요없음)

⇒ CoC 패러다임

https://medium.com/@dlaudtjr07/convention-over-configuration-란-694345d2447f

SpringBoot Banner

https://patorjk.com/software/taag/#p=display&f=Graffiti&t=Type Something

resources > banner.txt 파일에 추가

Logging

logback 파일이 없어도 yaml에서 편하게 logging level을 정할수있다.

logging:
  level:
    root: warn

kdt:
  version: "v1.0"
  minimum-order-amount: 1
  support-vendors:
    - a
    - b
    - c
    - d
  description: |
    line 1 hello world
    line 2 xxx
    line 3

logback.xml을 사용하때도 springboot의 기능을 상속 받을 쓸수있다. <include resuorce>

외부에서 설정 가져오기

https://www.latera.kr/reference/java/2019-09-29-spring-boot-config-externalize/

홈 디렉터리(개발 도구가 활성화된 경우 ~/.spring-boot-devtools.properties )의 개발 도구 전역 설정 프로퍼티
테스트의 @TestPropertySource 어노테이션.
테스트의 properties 애트리뷰트. @SpringBootTest 와 애플리케이션의 특정 부분을 테 스트하기 위한 테스트 어노테이션에서 사용 가능.
커맨드 라인 인자.
SPRING_APPLICATION_JSON 의 프로퍼티(환경 변수나 시스템 프로퍼티에 삽입된 인라인 JSON).
ServletConfig 초기 파라미터.
ServletContext 초기 파라미터.
java:comp/env 의 JNDI 애트리뷰트.
Java 시스템 프로퍼티( System.getProperties() ).
OS 환경 변수
random.* 에 프로퍼티를 가진 RandomValuePropertySource .
패키지된 jar 외부의 프로파일 지정 애플리케이션 프로퍼티( application- {profile}.properties 와 YAML 형식).
패키지된 jar 내부의 프로파일 지정 애플리케이션 프로퍼티( application- {profile}.properties 와 YAML 형식).
패키지된 jar 외부의 애플리케이션 프로퍼티( application-{profile}.properties 와 YAML 형식).
패키지된 jar 내부의 애플리케이션 프로퍼티( application-{profile}.properties 와 YAML 형식).
@Configuration 클래스의 @PropertySource 어노테이션
( SpringApplication.setDefaultProperties 에 의해 명시된) 기본 프로퍼티

실행 가능한 jar파일 생성하기

pom.xml → plugins을 이용해서 jar를 만든다.

mvn clean package spring-boot:repackage   -> jar package만들기

ll taget   -> 만들어진 파일 확인

java -jar target.kdt-0.0.1-SNAPSHOT.jar   -> jar 실행(구동)

intelliJ에서 SpringBootApplication실행시 편리하게 SpringBoot 설정이 가능하다.profiles 설정 가능

Daily Mission

로그백 설정을 해서 에러는 파일로 기록되어야한다.
springBoot 애플리케이션으로 변셩한다.
실행가능한 jar 파일을 생성한다.

출처 - 해리 : SpringBoot Part1

'Back-end 데브코스 > week 03 - 05 TIL (Spring)' 카테고리의 다른 글

[TIL] 221108 - SpringBoot Part2 : JDBC (0)	2022.11.08
[TIL] 221107 - SpringBoot Part2 : Spring Test 시작하기 (0)	2022.11.08
[TIL] 221103 - SpringBoot Part1 - 애플리케이션 속성 관리 (0)	2022.11.06
[TIL] 221102 - SpringBoot Part1 : Dependecy injection, 컴포넌트 스캔 (0)	2022.11.03
[TIL] 221101 - SpringBoot Part1 : IoC, DDD, ApplicationContext (0)	2022.11.03

📎 clip code 📎

[TIL] 221104 - SpringBoot Part1 : logging, SpringBoot

SpringBoot Part1 (5)

logging

Logback

SpringBoot 시작하기

'Back-end 데브코스 > week 03 - 05 TIL (Spring)' 카테고리의 다른 글

댓글

티스토리툴바

[TIL] 221104 - SpringBoot Part1 : logging, SpringBoot

SpringBoot Part1 (5)

logging

Logback

SpringBoot 시작하기

'Back-end 데브코스 > week 03 - 05 TIL (Spring)' 카테고리의 다른 글

관련글

댓글

티스토리툴바