스프링 개발 환경😶😶

😶 요즘은 docker로 개발 환경을 구성하는 경우가 많다.😶

그런데 docker로 개발 환경을 구성하는게 옳은 가에 대해 고민을 해보았다.

배포는 docker로 하고 개발 환경은 docker로 하지 않는게 맞는 것 같다는 생각이 많이 든다.

개발 환경에서는 단위 테스트를 자주 하기도 하며 , 각각의 기능이 서로 독립적으로

작동해야 하는경우가 많다. docker 로 개발 환경을 띄우면 사실 좀 무겁다고 생각 된다.

램 잡어먹는 귀신 그 자체 docker

다시 돌아와서, 무거운 만큼 , 렘을 잡아먹는 만큼 , 빌드 속도와 띄우는 속도는 느리다.

또한, docker 가 설치 되지 않은 개발자들은 docker-compose 까지 설정하고 뭐하고...

서로 개발환경을 맞춰주는 건 좋지만 느려...

또 외부 환경에 종속 된다. 이게 가장 큰 문제 아닌가?

무조건 다운 받자마자 실행 가능 해야 한다.

요즘은 이걸 가장 크게 느낀다. 협업을 하면서 중간에 참여하는 것도 그렇고

사실 서로의 환경이 맞지 않으면 개발이 불가능 하다. 나는 되는데 넌 왜 안돼?

외부 환경에 종속되는 개발은 좋지 않다. 그런 마음 가짐으로 여러 embeded 라이브러리를 찾아보았다.

대표적으로는 h2 , hsql , derby , redis , mongo 등이 있다.

여기에 kafka , zookeeper 등등도 있다.

embeded redis

embeded redis 를 사용하면 redis 를 설치하지 않고도 개발 환경에서 redis 를 사용할 수 있다.

@Configuration
public class RedisConfig {

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        return new LettuceConnectionFactory("localhost", 6379);
    }

    @Bean
    public RedisTemplate<String, Object> redisTemplate() {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());
        return redisTemplate;
    }
}

위처럼 뭐... 로컬에서만 할 거면 저렇게 하고

package com.yata.backend.global.config.redis;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.repository.configuration.EnableRedisRepositories;

import java.util.Arrays;

@Configuration
@EnableRedisRepositories
public class RedisRepositoryConfig {
    @Value("${spring.redis.host}")
    private String redisHost;

    @Value("${spring.redis.port}")
    private int redisPort;

    @Value(value = "${spring.redis.password}")
    private String redisPassword;
    @Autowired
    private Environment environment;

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration();
        redisStandaloneConfiguration.setHostName(redisHost);
        redisStandaloneConfiguration.setPort(redisPort);
        // redis password 설정
        Arrays.stream(environment.getActiveProfiles()).forEach(profile -> {
            if (profile.equals("prod")) {
                redisStandaloneConfiguration.setPassword(redisPassword);
            }
        });
        return new LettuceConnectionFactory(redisStandaloneConfiguration);
    }

    @Bean
    public RedisTemplate<?, ?> redisTemplate() {
        RedisTemplate<byte[], byte[]> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());
        return redisTemplate;
    }
}

이 처럼 프로필 별로 설정을 해주면 된다.

이번 포스팅에서는 embeded redis를 중점으로 봤고

여기서 추가적으로 문제점이 하나있다.

문제점

문제점은 test 환경에서 redis 테스트 할 때 문제가 된다.

config Bean 등을 사용 할 때는 일반적으로 spiringBootTest 같이 전역 테스트를 할 때

사용하게 되는데 이는 매 각각의 테스트 클래스 마다 redis를 띄우게 된다.

그런데 이제 redis 서버가 죽기전에 다음 테스트 클래스가 띄워지게 되면

이전에 띄워진 redis 서버가 아직 살아있기 때문에 port 충돌로 인해 테스트가 실패하게 된다.

redis가 안 띄워지기 때문에 테스트가 실패하게 된다.

이 문제는 jojodu 님의 블로그를 참고했다.
https://jojoldu.tistory.com/297 정말 알 찬 내용!

가장 큰 문제는 포트 충돌 때문에 테스트가 실패한다는 것이다.

해결 flow idea는 다음과 같다.

• redis 서버를 띄우기 전에 포트 번호가 유효한지 확인한다.
• 유효하면 redis 서버를 띄운다.
• 유효하지 않으면 유효한 포트 번호를 찾아 redis 서버를 띄운다.

그래서 redis 서버를 띄우기 전에 포트 번호가 유효한지 확인하는 코드를 작성해야 한다.

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.util.StringUtils;
import redis.embedded.RedisServer;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

@Slf4j
@Profile("!prod")
@Configuration
public class LocalRedisConfig {
    @Value("${spring.redis.port}")
    private int redisPort;

    private RedisServer redisServer;

    @PostConstruct
    public void redisServer() throws IOException {
        int port = isRedisRunning() ? findAvailablePort() : redisPort;
        redisServer = RedisServer.builder()
                .port(port)
                .setting("maxmemory 128M")
                .build();
        redisServer.start();
    }

    @PreDestroy
    public void stopRedis() {
        if (redisServer != null) {
            redisServer.stop();
        }
    }


    /**
     * Embedded Redis가 현재 실행중인지 확인
     */
    private boolean isRedisRunning() throws IOException {
        return isRunning(executeGrepProcessCommand(redisPort));
    }

    /**
     * 현재 PC/서버에서 사용가능한 포트 조회
     */
    public int findAvailablePort() throws IOException {

        for (int port = 10000; port <= 65535; port++) {
            Process process = executeGrepProcessCommand(port);
            if (!isRunning(process)) {
                return port;
            }
        }

        throw new IllegalArgumentException("Not Found Available port: 10000 ~ 65535");
    }

    /**
     * 해당 port를 사용중인 프로세스 확인하는 sh 실행
     */
    private Process executeGrepProcessCommand(int port) throws IOException {
        String OS = System.getProperty("os.name").toLowerCase();
        if (OS.contains("win")) {
            log.info("OS is  " + OS + " " + port);
            String command = String.format("netstat -nao | find \"LISTEN\" | find \"%d\"", port);
            String[] shell = {"cmd.exe", "/y", "/c", command};
            return Runtime.getRuntime().exec(shell);
        }
        String command = String.format("netstat -nat | grep LISTEN|grep %d", port);
        String[] shell = {"/bin/sh", "-c", command};
        return Runtime.getRuntime().exec(shell);
    }

    /**
     * 해당 Process가 현재 실행중인지 확인
     */
    private boolean isRunning(Process process) {
        String line;
        StringBuilder pidInfo = new StringBuilder();

        try (BufferedReader input = new BufferedReader(new InputStreamReader(process.getInputStream()))) {

            while ((line = input.readLine()) != null) {
                pidInfo.append(line);
            }

        } catch (Exception e) {
        }

        return !StringUtils.isEmpty(pidInfo.toString());
    }
}

jojodu 님의 코드에 추가적으로 OS별로 포트를 확인하는 코드를 추가했다.

위 처럼 embeded redis testcode 가 충돌이 나는 경우 해결 방법이다. 파이팅!