신비한 비

기본 Log 설정 및 Logback 설정

Spring Boot 는 내부로그는 Commons Logging 사용한다. Java Util Logging 、Log4J2 과 Logback 등 library 들을 자동옵션으로 두었다. 3가지 로그는 모두 IDE 툴 터미널에서 로그를 구체적으로 찍일수 있다. 오늘은 Logback 관련해서 알아보자

1. 시간일자：ms 단위

2. 로그레벨：ERROR, WARN, INFO, DEBUG or TRACE

3. 프로세스 ID

4. 구분자 ：--- 로그시작점

5. thread id：

6. Logger名：클래스 명으로 대체

7. 로그내용.

• 로그실제 찍히는 것

2021-12-28 17:37:25.578  INFO 65136 --- [           main] com.didispace.chapter81.Application      : Started Application in 2.695 seconds (JVM running for 3.957)2021-12-28 17:37:25.579 ERROR 65136 --- [           main] com.didispace.chapter81.Application      : Hello World
2021-12-28 17:37:25.579 ERROR 65136 --- [           main] com.didispace.chapter81.Application      : Hello World
2021-12-28 17:37:25.579  WARN 65136 --- [           main] com.didispace.chapter81.Application      : Hello World
2021-12-28 17:37:25.579  INFO 65136 --- [           main] com.didispace.chapter81.Application      : Hello World

• 로그모드 변경 방법 2가지

$ java -jar myapp.jar --debug

application.properties 에서 debug=true 속성 추가

debug=true 

로그설정

• 컬러 설정

application.properties 에 spring.output.ansi.enabled 속성 추가

NEVER : ANSI-colored 사용안함.

DETECT : ANSI 여부를 판단하고 맞으면 color 로 로그출력

ALWAYS : 항상 ANSI-colored 모드로 출력 ,ANSI 지원하지 않을시 여러가지 "잡"정보가 나오므로 추천하지 않음.

Spring Boot 1.x 기본 NEVER 이지만 2.x 버전 이후 DETECT 로 변경 됨. 때문에 위 로그 이미지는 기본으로 컬러가 출력 되었다. 요즘 다들 Spring Boot 2.x 를 사용하기때문에 별도로 컬러 설절은 하지 않아도 된다.

• 로그파일 만들기

application.properties 에

logging.file.name=run.log #파일명

logging.file.path=./ #파일경로

• 로그파일 롤링

**logging.logback.rollingpolicy.file-name-pattern: "/logs/abc.%d{yyyy-MM-dd}.%i" #파일 생성 규칙 패턴**
**logging.logback.rollingpolicy.clean-history-on-start: # 구동시 기존 로그 지우는가 ,기본 false 임.**
**logging.logback.rollingpolicy.max-history: 30 # 로그파일 유지 개수**
**logging.logback.rollingpolicy.max-file-size: # 파일별 사이즈 제한**
**logging.logback.rollingpolicy.total-size-cap: #**

Log Level 컨틀롤

• 설정 포맷

• 예시

**logging.level.com.didispace=DEBUG # com.blake 패키지하위 모든 class는 DEBUG 레벨사용**
**logging.level.root=WARN #root 관련은 로그는 WARN level 사용**

• 커스텀 설정

일반적으로 ApplicationContext 생성서 Log 모듈이 초기화 된다. Spring 설정파일의 영향을 받지 않는다. 때문에 Springboot 외부에서 Log관련 설정을 자유롭게 할수 있다.

아래와 같은 이름을 springboot에서 사용하는데

SpringBoot 공식사이트에서 -spring 를 붙여서 사용하라고 권장한다.

logback.xml 아닌 logback-spring.xml 을 사용해야 된다.

추가로 application.properties 에 아래와 같은 속성 값도 설정가능하다.

logging.pattern.console：터미널에 찍힐 로그 양식 （JDK Logger 안됨.）

logging.pattern.file：파일에 쓰기위한 로그 양식（JDK Logger 안됨.）

끝!

내저장소 바로가기 luxury515

아래와 같은 패키지 구조를 권장한다.

com
  +- example
    +- myproject
      +- Application.java
      |
      +- domain
      |  +- Customer.java
      |  +- CustomerRepository.java
      |
      +- service
      |  +- CustomerService.java
      |
      +- web
      |  +- CustomerController.java
      |

• root package：com.example.myproject，모든 class와 기타 package는 모두 root package 하위에 위치.

• application main class：Application.java，해당 class는 root packag 하위에 위치,일반적으로 해당 class에서 componet scan 설정을 한다.root package 하위에 위치함으로서 수동설정을 줄이면서Spring 필요한것들도 정상적으로 loading 되게 할수 있다.

• com.example.myproject.domain package：엔티티 매핑 관계 정의 및 데이터 액세스 관련 인터페이스 및 구현

• com.example.myproject.servicepackage：비즈니스 로직 작성에 사용되는 인터페이스 및 구현

• com.example.myproject.web：Spring MVC의 Controller 등웹 계층 관련 구현을 작성하는 데 사용됩니다.

여기서 주의 해야 될 부분은 모든 root package 와 application main class 위치다.

application main class 가 root package 의 하위에 위치하였기때문에 하위 class 들도 마찬가지로 root package 의 하위에 위치 하도록 설정해야 되며 default 설정에서는 springboot가 알아서 root package 및 하위 class들을 초기화를 진행한다. 하지만 가끔 default 환경아닌 임의로 구성한 환경이라면? 예를 들어 com.example.myproject.web 가 root package：com.example.myproject 와 동일한 위치에 놓인다면?

com
  +- example
    +- myproject
      +- Application.java
      |
      +- domain
      |  +- Customer.java
      |  +- CustomerRepository.java
      |
      +- service
      |  +- CustomerService.java
      |
    +- web
    |  +- CustomerController.java
    |

이렇게 하면 Application.java 는 com.example.myproject.web 내의 Controller 를 자동으로 스캔할수 없고 마찬가지로 Controller를 초기화 할수 없다. 이때

@ComponentScan(basePackages="com.example")

를 추가하여 강제로 위치를 지정해 준다.

@SpringBootApplication
@ComponentScan(basePackages="com.example")
public class Bootstrap {

    public static void main(String[] args) {
        SpringApplication.run(Bootstrap.class, args);
    }

}

또 다른 방법은 @Bean 어노테이션을 이용하는것

@SpringBootApplication
public class Bootstrap {

    public static void main(String[] args) {
        SpringApplication.run(Bootstrap.class, args);
    }

    @Bean
    public CustomerController customerController() {
        return new CustomerController();
    }

}

뭐 어찌됐든 해결은 가능하나 현업에서는 이런 방식을 권장하지 않는다. 만일 팀장이나 초기 프로젝트 세팅하는 개발자가 이렇게 했다면 이글을 바탕으로 설명을 해주라!

끝!

내저장소 바로가기 luxury515

pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

<properties>
    <tinylog.version>2.4.1</tinylog.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.tinylog</groupId>
        <artifactId>tinylog-api</artifactId>
        <version>${tinylog.version}</version>
    </dependency>
    <dependency>
        <groupId>org.tinylog</groupId>
        <artifactId>tinylog-impl</artifactId>
        <version>${tinylog.version}</version>
    </dependency>
    <dependency>
        <groupId>org.tinylog</groupId>
        <artifactId>slf4j-tinylog</artifactId>
        <version>${tinylog.version}</version>
    </dependency>
    <dependency>
        <groupId>org.tinylog</groupId>
        <artifactId>jcl-tinylog</artifactId>
        <version>${tinylog.version}</version>
    </dependency>
    <dependency>
        <groupId>org.tinylog</groupId>
        <artifactId>log4j1.2-api</artifactId>
        <version>${tinylog.version}</version>
    </dependency>

</dependencies>

테스트 코드

@Slf4j
@SpringBootApplication
public class LogDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(LogDemoApplication.class, args);

        log.error("Hello World");
        log.warn("Hello World");
        log.info("Hello World");
        log.debug("Hello World");
        log.trace("Hello World");
    }

}

구동 로그확인

TinylogLogger 가 적용된것을 확인 할수 있다.

resources 폴더 안에 tinylog.properties 파일 생성

writer=console
writer.format={date: HH:mm:ss.SSS} {level}: {message}

Log 출력 상태

끝!

내저장소 바로가기 luxury515