M

MLOG

한국어

헥사고날 아키텍처(포트와 어댑터)가 애플리케이션의 유지보수성, 테스트 용이성, 유연성을 어떻게 향상시키는지 알아보세요. 이 가이드는 전 세계 개발자를 위한 실용적인 예제와 실행 가능한 통찰력을 제공합니다.

헥사고날 아키텍처: 포트와 어댑터 실용 가이드

끊임없이 진화하는 소프트웨어 개발 환경에서 견고하고, 유지보수 가능하며, 테스트하기 쉬운 애플리케이션을 구축하는 것은 무엇보다 중요합니다. 헥사고날 아키텍처(Hexagonal Architecture), 일명 포트와 어댑터(Ports and Adapters)는 애플리케이션의 핵심 비즈니스 로직을 외부 의존성으로부터 분리하여 이러한 문제를 해결하는 아키텍처 패턴입니다. 이 가이드는 전 세계 개발자들을 위해 헥사고날 아키텍처에 대한 포괄적인 이해와 그 이점, 그리고 실용적인 구현 전략을 제공하는 것을 목표로 합니다.

헥사고날 아키텍처란 무엇인가?

알리스테어 콕번(Alistair Cockburn)이 창안한 헥사고날 아키텍처는 애플리케이션의 핵심 비즈니스 로직을 외부 세계로부터 격리하는 아이디어를 중심으로 합니다. 이러한 격리는 포트(ports)와 어댑터(adapters)를 사용하여 달성됩니다.

이렇게 생각해보세요: 코어 애플리케이션이 중앙에 있고, 육각형의 껍질로 둘러싸여 있습니다. 포트는 이 껍질의 입구와 출구이며, 어댑터는 이 포트에 연결되어 코어를 외부 세계와 연결합니다.

헥사고날 아키텍처의 핵심 원칙

몇 가지 핵심 원칙이 헥사고날 아키텍처의 효과를 뒷받침합니다:

헥사고날 아키텍처 사용의 이점

헥사고날 아키텍처를 채택하면 수많은 이점이 있습니다:

헥사고날 아키텍처 구현: 실용 예제

사용자 등록 시스템의 간단한 예제를 통해 헥사고날 아키텍처의 구현을 설명해 보겠습니다. 명확성을 위해 가상의 프로그래밍 언어(Java 또는 C#과 유사한)를 사용하겠습니다.

1. 코어(애플리케이션) 정의

코어 애플리케이션은 새 사용자 등록을 위한 비즈니스 로직을 포함합니다.


// Core/UserService.java (또는 UserService.cs)
public class UserService {
    private final UserRepository userRepository;
    private final PasswordHasher passwordHasher;
    private final UserValidator userValidator;

    public UserService(UserRepository userRepository, PasswordHasher passwordHasher, UserValidator userValidator) {
        this.userRepository = userRepository;
        this.passwordHasher = passwordHasher;
        this.userValidator = userValidator;
    }

    public Result<User, String> registerUser(String username, String password, String email) {
        // 사용자 입력 유효성 검사
        ValidationResult validationResult = userValidator.validate(username, password, email);
        if (!validationResult.isValid()) {
            return Result.failure(validationResult.getErrorMessage());
        }

        // 사용자가 이미 존재하는지 확인
        if (userRepository.findByUsername(username).isPresent()) {
            return Result.failure("사용자 이름이 이미 존재합니다");
        }

        // 비밀번호 해싱
        String hashedPassword = passwordHasher.hash(password);

        // 새 사용자 생성
        User user = new User(username, hashedPassword, email);

        // 사용자를 리포지토리에 저장
        userRepository.save(user);

        return Result.success(user);
    }
}

2. 포트 정의

코어 애플리케이션이 외부 세계와 상호작용하기 위해 사용하는 포트를 정의합니다.


// Ports/UserRepository.java (또는 UserRepository.cs)
public interface UserRepository {
    Optional<User> findByUsername(String username);
    void save(User user);
}

// Ports/PasswordHasher.java (또는 PasswordHasher.cs)
public interface PasswordHasher {
    String hash(String password);
}

//Ports/UserValidator.java (또는 UserValidator.cs)
public interface UserValidator{
  ValidationResult validate(String username, String password, String email);
}

//Ports/ValidationResult.java (또는 ValidationResult.cs)
public interface ValidationResult{
  boolean isValid();
  String getErrorMessage();
}

3. 어댑터 정의

코어 애플리케이션을 특정 기술에 연결하는 어댑터를 구현합니다.


// Adapters/DatabaseUserRepository.java (또는 DatabaseUserRepository.cs)
public class DatabaseUserRepository implements UserRepository {
    private final DatabaseConnection databaseConnection;

    public DatabaseUserRepository(DatabaseConnection databaseConnection) {
        this.databaseConnection = databaseConnection;
    }

    @Override
    public Optional<User> findByUsername(String username) {
        // JDBC, JPA 또는 다른 데이터베이스 접근 기술을 사용한 구현
        // ...
        return Optional.empty(); // 플레이스홀더
    }

    @Override
    public void save(User user) {
        // JDBC, JPA 또는 다른 데이터베이스 접근 기술을 사용한 구현
        // ...
    }
}

// Adapters/BCryptPasswordHasher.java (또는 BCryptPasswordHasher.cs)
public class BCryptPasswordHasher implements PasswordHasher {
    @Override
    public String hash(String password) {
        // BCrypt 라이브러리를 사용한 구현
        // ...
        return "hashedPassword"; //플레이스홀더
    }
}

//Adapters/SimpleUserValidator.java (또는 SimpleUserValidator.cs)
public class SimpleUserValidator implements UserValidator {
  @Override
  public ValidationResult validate(String username, String password, String email){
    // 간단한 유효성 검사 로직
     if (username == null || username.isEmpty()) {
            return new SimpleValidationResult(false, "사용자 이름은 비워둘 수 없습니다");
        }
        if (password == null || password.length() < 8) {
            return new SimpleValidationResult(false, "비밀번호는 8자 이상이어야 합니다");
        }
        if (email == null || !email.contains("@")) {
            return new SimpleValidationResult(false, "잘못된 이메일 형식입니다");
        }

        return new SimpleValidationResult(true, null);
  }
}

//Adapters/SimpleValidationResult.java (또는 SimpleValidationResult.cs)
public class SimpleValidationResult implements ValidationResult {
  private final boolean valid;
  private final String errorMessage;

    public SimpleValidationResult(boolean valid, String errorMessage) {
        this.valid = valid;
        this.errorMessage = errorMessage;
    }
  @Override
  public boolean isValid(){
    return valid;
  }

  @Override
  public String getErrorMessage(){
    return errorMessage;
  }
}



//Adapters/WebUserController.java (또는 WebUserController.cs)
// 드라이빙 어댑터 - 웹으로부터의 요청을 처리
public class WebUserController {
    private final UserService userService;

    public WebUserController(UserService userService) {
        this.userService = userService;
    }

    public String registerUser(String username, String password, String email) {
        Result<User, String> result = userService.registerUser(username, password, email);
        if (result.isSuccess()) {
            return "등록 성공!";
        } else {
            return "등록 실패: " + result.getFailure();
        }
    }
}

4. 구성(Composition)

모든 것을 함께 연결합니다. 이러한 구성(의존성 주입)은 일반적으로 애플리케이션의 진입점이나 의존성 주입 컨테이너 내에서 발생합니다.


// Main 클래스 또는 의존성 주입 설정
public class Main {
    public static void main(String[] args) {
        // 어댑터 인스턴스 생성
        DatabaseConnection databaseConnection = new DatabaseConnection("jdbc:mydb://localhost:5432/users", "user", "password");
        DatabaseUserRepository userRepository = new DatabaseUserRepository(databaseConnection);
        BCryptPasswordHasher passwordHasher = new BCryptPasswordHasher();
        SimpleUserValidator userValidator = new SimpleUserValidator();

        // 어댑터를 주입하여 코어 애플리케이션 인스턴스 생성
        UserService userService = new UserService(userRepository, passwordHasher, userValidator);

        // 드라이빙 어댑터를 생성하고 서비스에 연결
        WebUserController userController = new WebUserController(userService);

        // 이제 userController를 통해 사용자 등록 요청을 처리할 수 있음
        String result = userController.registerUser("john.doe", "P@sswOrd123", "john.doe@example.com");
        System.out.println(result);
    }
}



// DatabaseConnection은 시연 목적으로만 사용되는 간단한 클래스
class DatabaseConnection {
    private String url;
    private String username;
    private String password;

    public DatabaseConnection(String url, String username, String password) {
        this.url = url;
        this.username = username;
        this.password = password;
    }

    // ... 데이터베이스 연결 메서드 (간결성을 위해 구현되지 않음)
}

// Result 클래스 (함수형 프로그래밍의 Either와 유사)
class Result<T, E> {
    private final T success;
    private final E failure;
    private final boolean isSuccess;

    private Result(T success, E failure, boolean isSuccess) {
        this.success = success;
        this.failure = failure;
        this.isSuccess = isSuccess;
    }

    public static <T, E> Result<T, E> success(T value) {
        return new Result<>(value, null, true);
    }

    public static <T, E> Result<T, E> failure(E error) {
        return new Result<>(null, error, false);
    }

    public boolean isSuccess() {
        return isSuccess;
    }

    public T getSuccess() {
        if (!isSuccess) {
            throw new IllegalStateException("결과가 실패입니다");
        }
        return success;
    }

    public E getFailure() {
        if (isSuccess) {
            throw new IllegalStateException("결과가 성공입니다");
        }
        return failure;
    }
}

class User {
    private String username;
    private String password;
    private String email;

    public User(String username, String password, String email) {
        this.username = username;
        this.password = password;
        this.email = email;
    }

    // getter 및 setter (간결성을 위해 생략)

}

설명:

고급 고려사항 및 모범 사례

헥사고날 아키텍처의 기본 원칙은 간단하지만, 염두에 두어야 할 몇 가지 고급 고려사항이 있습니다:

헥사고날 아키텍처의 실제 사용 사례

많은 성공적인 기업과 프로젝트들이 견고하고 유지보수 가능한 시스템을 구축하기 위해 헥사고날 아키텍처를 채택했습니다:

과제 및 절충점

헥사고날 아키텍처는 상당한 이점을 제공하지만, 관련된 과제와 절충점을 인식하는 것이 중요합니다:

특정 프로젝트의 요구사항과 팀의 역량이라는 맥락에서 헥사고날 아키텍처의 이점과 과제를 신중하게 평가하는 것이 중요합니다. 이는 만병통치약이 아니며, 모든 프로젝트에 최선의 선택이 아닐 수도 있습니다.

결론

포트와 어댑터를 강조하는 헥사고날 아키텍처는 유지보수 가능하고, 테스트 용이하며, 유연한 애플리케이션을 구축하기 위한 강력한 접근 방식을 제공합니다. 핵심 비즈니스 로직을 외부 의존성으로부터 분리함으로써, 변화하는 기술과 요구사항에 쉽게 적응할 수 있게 해줍니다. 고려해야 할 과제와 절충점이 있지만, 헥사고날 아키텍처의 이점은 특히 복잡하고 오래 지속되는 애플리케이션의 경우 비용을 능가하는 경우가 많습니다. 의존성 역전과 명시적 인터페이스의 원칙을 수용함으로써, 더 탄력적이고 이해하기 쉬우며 현대 소프트웨어 환경의 요구를 더 잘 충족시킬 수 있는 시스템을 만들 수 있습니다.

이 가이드는 헥사고날 아키텍처의 핵심 원칙부터 실용적인 구현 전략까지 포괄적인 개요를 제공했습니다. 이러한 개념을 더 탐구하고 자신의 프로젝트에 적용해 보시기를 권장합니다. 헥사고날 아키텍처를 배우고 채택하는 데 투자하는 것은 장기적으로 확실히 보상받을 것이며, 이는 더 높은 품질의 소프트웨어와 더 만족스러운 개발 팀으로 이어질 것입니다.

궁극적으로, 올바른 아키텍처를 선택하는 것은 프로젝트의 특정 요구에 따라 달라집니다. 결정을 내릴 때 복잡성, 수명, 유지보수성 요구사항을 고려하십시오. 헥사고날 아키텍처는 견고하고 적응 가능한 애플리케이션을 구축하기 위한 견고한 기반을 제공하지만, 이는 소프트웨어 아키텍트의 도구 상자에 있는 하나의 도구일 뿐입니다.