밴쿠버 코로노의 개발일지

Spring Project를 진행하다 보면 `SLF4J: Class path contains multiple SLF4J bindings.` 라는 Warning 메세지를 볼 수 있다. 

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/Users/kimseunghwan/.m2/repository/ch/qos/logback/logback-classic/1.2.9/logback-classic-1.2.9.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/Users/kimseunghwan/.m2/repository/org/slf4j/slf4j-simple/1.7.32/slf4j-simple-1.7.32.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]

이런 Warning 메세지는 Dependecy 내부에서 같은 Dependecy지만 다른 버전을 Dependency 내부에서 참조를 하고 있으면 발생하게 된다. 이를 해결하기 위해서는 아래와 같은 방법을 사용하면 된다. 

Dependecy tree 확인

현재 어떤 Dependecy가 충돌되는 Dependency를 참조하고 있는지 모르기 때문에 `mvn dependecy:tree`로 현재 내가 사용하고 있는 Dependecy를 확인한다. 

$ mvn dependecy:tree

IDE에서 확인하는 방법 (Intellij)

나의 경우에는 아래와 같이 Spring boot 와 Embedded-redis에서 충돌이 발생하고 있다. 

[INFO] io.coolexplorer:spring-boot-session:war:0.0.1-SNAPSHOT
[INFO] +- org.springframework.boot:spring-boot-starter-web:jar:2.6.2:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter:jar:2.6.2:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-starter-logging:jar:2.6.2:compile
[INFO] |  |  |  +- ch.qos.logback:logback-classic:jar:1.2.9:compile
[INFO] |  |  |  |  \- ch.qos.logback:logback-core:jar:1.2.9:compile
[INFO] |  |  |  +- org.apache.logging.log4j:log4j-to-slf4j:jar:2.17.0:compile
[INFO] |  |  |  |  \- org.apache.logging.log4j:log4j-api:jar:2.17.0:compile
[INFO] |  |  |  \- org.slf4j:jul-to-slf4j:jar:1.7.32:compile
...
[INFO] \- it.ozimov:embedded-redis:jar:0.7.3:test
[INFO]    +- com.google.guava:guava:jar:21.0:test
[INFO]    +- commons-io:commons-io:jar:2.5:test
[INFO]    +- org.slf4j:slf4j-simple:jar:1.7.32:test
[INFO]    \- commons-logging:commons-logging:jar:1.2:test

Dependency 제외

해결 방법은 충돌하고 있는 두 Dependency중 한 부분에서 제외를 시켜주는 것이다. 나의 경우에는 Embedded-redis에서 제외를 시켜 주었다. 

변경된 pom.xml - <exclusions> 블럭이 추가되었다. 

<dependency>
    <groupId>it.ozimov</groupId>
    <artifactId>embedded-redis</artifactId>
    <version>${embedded.redis.version}</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
        </exclusion>
    </exclusions>
</dependency>

간단하게 해결!

An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification

Open API는 간단하게 Restful API를 작성하여 테스트할 수 있는 툴이다. 하지만 Open API의 더 강력한 점은 개발하고 있는 웹서버와 통합하여 웹서버상의 Restful API의 문서 겸 테스트를 할 수 있는 환경을 제공한다는 것이다. 

즉, Open API Document는 Restful API 개발을 할 때 Client 개발자가 참조할 수 있는 문서를 자동으로 만들어준다. 이 문서를 통해서 API URL, Request body schema, and Responce body schema 를 확인할 수 있다. 아래의 예제를 확인하면 이해가 바로 될 것이다. 

(Open API Document 는 Swagger UI를 사용한다.)

이 문서에는 간단한 설정으로 문서를 작성해 보겠다. 

Example

Open API 설정은 Dependency 추가, application.yml에 Configuration 추가, Annotation 추가. 이 세가지만 하면 완료된다. 

Dependency 추가

아래와 같이 open api dependency를 추가해준다. 

<properties>
	<openapi.version>1.6.3</openapi.version>
</properties>

<!-- Documentation-->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>${openapi.version}</version>
</dependency>

Configuration 추가

아래 Configuration은 swagger ui의 path를 설정한다. 

# documentation
springdoc:
  swagger-ui:
    path: /swagger-ui.html

Annotation 추가

API Document의 내용을 추가하기 위해서 보통 아래와 같은 Annotation을 추가한다. Request와 Successfult Response의 경우는 코드를 분석하여 추가를 하지만 Error 상태의 응답은 Annotation을 추가하여 문서에 추가할 수 있다. 

@Operation(summary = "Token Cache Creation", description = "Token Cache Creation", responses = {
        @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = JwtTokenDTO.JwtTokenInfo.class))),
        @ApiResponse(responseCode = "400", description = "Bad Request", content = @Content(schema = @Schema(example = ""))),
        @ApiResponse(responseCode = "404", description = "Not Found", content = @Content(schema = @Schema(example = "")))
})
@PostMapping("/token")
public JwtTokenDTO.JwtTokenInfo createToken(@RequestBody JwtTokenDTO.JwtTokenCreateRequest request) {
    JwtToken jwtToken = modelMapper.map(request, JwtToken.class);
    JwtToken createdToken = jwtTokenService.create(jwtToken);

    return JwtTokenDTO.JwtTokenInfo.from(createdToken, modelMapper);
}

DTO의 각 항목에 예제를 추가하여 이해를 도울 수 있다. 

@Getter
@Setter
@Accessors(chain = true)
@AllArgsConstructor
@NoArgsConstructor
@ToString
@Schema(description = "JwtToken Info")
public static class JwtTokenInfo {
    @Schema(example = "ff6681f0-50f8-4110-bf96-ef6cec45780e")
    private String id;
    @Schema(example = "1L")
    private Long accountId;
    @Schema(example = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....")
    private String jwtToken;
    @Schema(example = "2021-01-01T00:00:00")
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss")
    private LocalDateTime updatedAt;

    public static JwtTokenInfo from(JwtToken jwtToken, ModelMapper modelMapper) {
        return modelMapper.map(jwtToken, JwtTokenInfo.class);
    }
}

추가된 결과 

설정이 완료되고 서버를 실행한 후 http://localhost:8080/swagger-ui.html 로 접속으로 하면 아래와 같이 자동 생성된 문서를 볼 수 있다. 

아래와 같이 API Request를 테스트 할 수도 있다. 

Execute 버튼을 누르면 아래와 같이 응답을 받을 수 있다. 

Schema

https://spring.io/projects/spring-data-redis

Spring Data Redis 란 무엇인가?

The Spring Data Redis (SDR) framework makes it easy to write Spring applications that use the Redis key-value store by eliminating the redundant tasks and boilerplate code required for interacting with the store through Spring’s excellent infrastructure support.

Spring Data Redis 는 Spring project 에서 Redis의 데이터를 쉽게 관리할 수 있게 해주는 Framework이다. RDB나 NoSQL의 경우도 각각의 Framework을 가지고 있어서 개발을 편리하게 해준다. 

Spring Data Redis Dependency 추가

<dependencies>

  <!-- other dependency elements omitted -->

  <dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-redis</artifactId>
    <version>2.6.0</version>
  </dependency>

</dependencies>

Dependency는 위와 같이 추가하면 되는데, Spring boot framework을 사용중이라면 아래와 같이 추가하면 된다. 

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

Spring boot dependency를 추가하면 좋은 점은 많이 사용되고 있는 Redis client인 Lettuce와 Jedis가 같이 추가된다. 

이 문서에서는 Redis 연결을 위한 작업이 아니라 Redis key를 어떻게 원하는 방식으로 추가할 것인가를 고민해보도록 하겠다. 

Spring Data Redis의 사용

Spring Data Redis는 사용하면 JPA 처럼 코드를 통해 Redis의 값을 저장하고 읽어 올 수 있다. 그것이 복잡한 Object 형태라고 하더라도 세분화하여 자체적으로 Key값을 만들어서 저장한다. 

Default Key Value

Spring Data Redis에서의 기본 key 값은 Model의 구조에 결정된다. 

@RedisHash("people")
public class Person {

  @Id String id;
  String firstname;
  String lastname;
  Address hometown;
}

유저의 Person을 저장한다고 하였을 때 간단하게 위와 같이 Model을 만들 수 있다. Key 명에 대해서 생각할 때 중요한 부분은 

`@RedisHash` annotation이다. 이 annotation은 이 Model이 Redis의 Entity라는 것을 나타내줄 뿐더러 Key의 Prefix를 결정한다. 위의 예제에서는 @RedisHash("people")이라고 되어 있는데 이럴 경우 jwtToken 이라는 이름으로 Key이름이 시작되게 된다. 

`@RedisHash`만 사용할 경우 `getClass().getName()`의 리턴값이 기본으로 들어가게 된다. 

즉 아래와 같은 key 값이 만들어진다. (ex. e2c7dcee-b8cd-4424-883e-736ce564363e 는 생성된 Id 값)

SADD people e2c7dcee-b8cd-4424-883e-736ce564363e

@Indexed annotation

@RedisHash("people")
public class Person {

  @Id String id;
  @Indexed String firstname;
  String lastname;
  Address hometown;
}

위의 예제의 경우 `@Indexed` annotation이 추가된 것을 볼 수 있다. `@Indexed`을 추가되면 Secondary Index가 추가된다고 생각하면 된다. 이 말은 사용자가 Key 값에 원하는 구분자를 추가하여 검색을 용이하게 하는 역할을 한다. 

예를 들어 아래와 같이 Redis에 Data를 저장시킨다. 

repository.save(new Person("rand", "althor"));

이 경우 실제 Redis에서는 아래와 같은 명령들이 수행된다. 

HMSET "people:19315449-cda2-4f5c-b696-9cb8018fa1f9" "_class" "Person" "id" "19315449-cda2-4f5c-b696-9cb8018fa1f9" "firstname" "rand" "lastname" "althor" 
SADD  "people" "19315449-cda2-4f5c-b696-9cb8018fa1f9"                           
SADD  "people:firstname:rand" "19315449-cda2-4f5c-b696-9cb8018fa1f9"            
SADD  "people:19315449-cda2-4f5c-b696-9cb8018fa1f9:idx" "people:firstname:rand"

우선 HMSET 명령어를 통해서 Model에 입력된 전체 정보가 HashMap으로 저장된다. 그때의 key값은 `Prefix:Id` 구조로 저장된다. 

하지만 사용자의 검색을 위해서 SADD "people:firstname:rand" 라는 Set에 Id를 저장해 두고 사용자의 `repository.findByFirstname()` 검색이 가능하도록 저장을 한다. 

마지막 라인의 경우 Secondary Index의 Update 와 Delete를 위해 Set을 저장한다. 이 곳에는 전체 Secondary Index들을 저장한다고 생각하면 된다. 

오늘은 간단하게 어떻게 Key가 생성되는지 알아보았다. 

사실 이 내용에 대해서 공부하게 된 이유는 내가 개발하고 있는 서비스에서 Redis Key Convention(Key naming rule)을 가져갈 것인지 고민하면서 시작되었다. MSA(Micro Service Architecture)에서 여러 Service에서 Redis에 정보를 저장할 경우 Key 값의 구조를 잘 만들어야지 나중에 어떠한 이유로 인해 key값을 확인해야할 때 또는 서비스에서 값을 가져오기 위해 Key값을 만들 때 쉽게 할 수 있을 것 같기 때문이다. 

이 부분에 대한 고민은 다음 포스트로 넘기겠다. 

$ helm install -f values.yaml my-release bitnami/redis​

$ helm repo add bitnami https://charts.bitnami.com/bitnami

현재 구현하고 있는 Service의 경우 Redis를 사용해야 하기 때문에 Redis는 local에 설치하였다. 

요즘 추세가 Kubernetes operator를 사용하여 설치하지만 Local Kubernetes를 이용해야 하고, Service type을 NodePort를 사용하여 IDE에서 테스트를 하고 싶었기 때문에 Helm chart를 이용하고 싶었다. 그리고 Github에 values.yaml를 저장해두면 설정 파일의 버전을 관리할 수 있으니 이 방법을 택했다. 

현재 가장 잘 관리되고 있는 redis의 Helm chart는 bitnami에서 관리되는 Chart 이다. 아래 경로를 참조하기 바란다. 

https://github.com/bitnami/charts/tree/master/bitnami/redis

모든 설치방법과 상세한 옵션은 위의 사이트에 자세하게 나와 있지만 간단하게 master 1개와 replica 1개를 설치하는 방법을 공유하고자 한다. 이 또한 나의 기억을 유지하기 위한 방법이므로... ㅎㅎ

Helm Repository 등록

bitnami의 chart를 사용하기 위해서는 우선 Helm repository를 등록해야 한다. 

$ helm repo add bitnami https://charts.bitnami.com/bitnami

Installation

변경된 values.yaml과 함께 설치를 하기 위해서는 `-f` 옵션을 이용한다. `my-release` 부분은 원하는 배포명을 입력하면 된다. 

$ helm install -f values.yaml my-release bitnami/redis

Uninstallation

$ helm delete my-release

변경한 Configuration in values.yaml

1. Service 변경

NodePort 30379를 open 하였다. 

service:
    type: NodePort
    port: 6379
    nodePort: 30379
    externalTrafficPolicy: Cluster

2. Replica count 변경

리소스 문제가 있으므로 replica count 는 1로 설정하였다. 

replica:
    replicaCount: 1

3. Persistence Volume 설정

Local 환경의 Volume은 yaml 파일로 우선 생성한 후 연결하였다. 개발용으로 많은 데이터를 저장하지 않을 것이기 때문에 1Gi 로 셋팅하였다. 

persistence:
    existingClaim: "redis-pvc"

Persistence Volume chart

아래 저장소의 Helm chart로 volume을 설치하였다. 

저장소 Link : https://github.com/coolexplorer/k8s-charts/tree/main/charts/volumes/charts/redis-vol