Convention over Configuration

Convention over Configuration

“Convention over Configuration”(CoC) 은 소프트웨어 개발에서 명시적인 설정을 최소화하고, 합리적인 기본 규칙을 통해 개발자의 작업 부담을 줄이는 설계 원칙이다. 소프트웨어 프레임워크가 합리적인 기본값과 표준 규칙을 제공함으로써 개발자가 명시적으로 설정해야 할 부분을 최소화한다. 관례를 따르는 한 추가 설정이 필요 없으며, 관례를 벗어나는 경우에만 명시적 구성이 요구된다. Ruby on Rails 에서 처음 도입되어 다양한 프레임워크에 확산되었으며, 개발 생산성 향상, 오류 감소, 유지보수 용이성 등의 장점을 제공한다.

핵심 개념

Convention over Configuration (CoC, 설정보다 관례) 는 소프트웨어 프레임워크가 개발자가 내려야 하는 결정의 수를 줄이면서도 유연성을 잃지 않도록 하는 소프트웨어 설계 패러다임이다. 프레임워크나 시스템이 합리적이고 널리 통용되는 기본 규칙 (관례) 을 제공하여, 개발자가 반드시 필요한 경우에만 설정을 하도록 하는 소프트웨어 설계 패러다임이다.

핵심 개념들:

1. 합리적 기본값 (Sensible Defaults): 가장 일반적인 사용 사례에 맞는 기본 설정 제공
2. 명명 규칙 (Naming Conventions): 클래스명, 메서드명, 파일명 등의 표준화된 규칙
3. 자동 발견 (Auto-discovery): 프레임워크가 코드 구조를 자동으로 인식하고 연결
4. 오버라이드 가능성 (Override Capability): 기본 관례에서 벗어날 필요가 있을 때 명시적 설정 허용
5. DRY 원칙 (Don’t Repeat Yourself): 중복된 설정과 코드 제거
   적용 방식: 파일/폴더 구조, 네이밍 규칙, 기본 동작 등에서 관례를 제공하고, 관례를 따를 경우 별도 설정이 필요 없음. 관례를 벗어날 때만 설정을 추가한다.

배경

2000 년대 초반 Java 기반 프레임워크들은 복잡한 XML 설정 파일을 요구했다. 예를 들어, 초기 Hibernate 는 엔티티와 데이터베이스 테이블 간의 관계를 모두 XML 로 명시해야 했다.

2004 년 Ruby on Rails 등장: David Heinemeier Hansson 이 Ruby on Rails 에서 이 개념을 도입하고 명명했다. Rails 는 " 만약 Sales 클래스가 있다면, 데이터베이스 테이블은 ‘sales’ 라고 가정한다 " 는 식의 관례를 도입했다.

목적 및 필요성

1. 개발 생산성 향상: 반복적인 설정 작업 제거
2. 인지 부하 감소: 개발자가 고민해야 할 결정사항 최소화
3. 코드 일관성: 표준화된 구조와 명명 규칙으로 팀 내 일관성 확보
4. 진입 장벽 완화: 새로운 개발자가 프로젝트를 이해하기 쉽게 만듦
5. 유지보수성 개선: 예측 가능한 구조로 코드 변경과 확장 용이

주요 기능 및 역할

• 합리적인 기본값 제공
• 반복적/불필요한 설정 생략
• 명확한 프로젝트 구조와 네이밍 규칙 제공
• 필요시 설정 오버라이드 (Override) 가능

특징

• 설정 파일 최소화
• 표준화된 규칙 (관례) 기반
• 빠른 프로젝트 셋업 및 실행
• 협업 및 유지보수 용이
• 관례를 벗어날 때만 설정 필요
• 일부 유연성 제한 가능성

구조 및 작동 원리

합리적인 기본값 제공과 명시적 설정 최소화를 통해 개발 효율성을 높인다. 프레임워크는 표준 규칙을 기반으로 동작하며, 개발자가 표준을 따를 경우 별도의 설정 없이도 원하는 결과를 얻을 수 있다.

핵심 원칙

1. 최소 놀람 원칙 (Principle of Least Astonishment): 개발자가 예상하는 대로 동작
2. 관례의 일관성: 프레임워크 전반에 걸친 일관된 규칙 적용
3. 점진적 복잡성: 단순한 경우는 단순하게, 복잡한 경우에만 복잡하게
4. 의견이 있는 소프트웨어 (Opinionated Software): 최선의 방법에 대한 명확한 의견 제시

작동 원리

graph TD
    A[개발자 코드 작성] --> B{관례 준수 여부}
    B -->|YES| C[자동 설정 적용]
    B -->|NO| D[명시적 설정 검색]
    C --> E[리플렉션/스캐닝]
    D --> F[설정 오버라이드]
    E --> G[자동 매핑 수행]
    F --> G
    G --> H[애플리케이션 실행]

작동 단계:

1. 코드 스캐닝: 프레임워크가 클래스패스를 스캔하여 관련 클래스 발견
2. 관례 적용: 명명 규칙과 구조 패턴을 기반으로 자동 매핑
3. 기본값 설정: 미리 정의된 합리적 기본값 적용
4. 오버라이드 처리: 명시적 설정이 있는 경우 기본값 대신 적용
5. 의존성 주입: 발견된 컴포넌트들을 자동으로 연결

구조 및 아키텍처

graph LR
    A[Convention Engine] --> B[Scanner]
    A --> C[Mapper]
    A --> D[Resolver]
    A --> E[Injector]
    
    B --> F[Class Scanner]
    B --> G[Resource Scanner]
    
    C --> H[Name Mapper]
    C --> I[Type Mapper]
    
    D --> J[Configuration Resolver]
    D --> K[Dependency Resolver]
    
    E --> L[Bean Injector]
    E --> M[Property Injector]

구성요소

주요 원리 다이어그램

sequenceDiagram
    participant Dev as 개발자
    participant FW as 프레임워크
    participant Scanner as 스캐너
    participant Engine as 관례엔진
    participant App as 애플리케이션

    Dev->>FW: 코드 작성 (관례 준수)
    FW->>Scanner: 클래스패스 스캔 시작
    Scanner->>Engine: 발견된 컴포넌트 전달
    Engine->>Engine: 명명 규칙 적용
    Engine->>Engine: 기본값 설정
    Engine->>App: 설정된 컴포넌트 등록
    App->>Dev: 애플리케이션 실행

구현 기법

장점과 단점

도전 과제

분류에 따른 종류

분류에 따른 유형

실무 적용 예시

활용 사례

사례 1: 전자상거래 플랫폼 RESTful API 개발

시나리오: 전자상거래 플랫폼 RESTful API 개발

프로젝트 배경:

• 중소 규모 온라인 쇼핑몰의 백엔드 API 개발
• 빠른 프로토타입 개발과 유지보수성 중시
• 소규모 팀 (3-4 명) 으로 신속한 개발 필요

시스템 구성:

1
2
3
4
5
6

E-commerce API Platform
├── Spring Boot 3.x (메인 프레임워크)
├── Spring Data JPA (데이터 접근)
├── H2/PostgreSQL (데이터베이스)
├── Spring Security (보안)
└── Gradle (빌드 도구)

시스템 구성 다이어그램:

graph TB
    Client[클라이언트 앱] --> Gateway[API Gateway]
    Gateway --> Auth[인증 서비스]
    Gateway --> Product[상품 서비스]
    Gateway --> Order[주문 서비스]
    Gateway --> User[사용자 서비스]
    
    Product --> ProductDB[(상품 DB)]
    Order --> OrderDB[(주문 DB)]
    User --> UserDB[(사용자 DB)]
    
    subgraph "Convention over Configuration 적용 영역"
        Product
        Order
        User
    end

활용 사례 Workflow:

sequenceDiagram
    participant Dev as 개발자
    participant SB as Spring Boot
    participant JPA as Spring Data JPA
    participant DB as 데이터베이스

    Note over Dev: 1. 엔티티 클래스 생성
    Dev->>SB: @Entity Product 클래스 작성
    
    Note over SB: 2. 자동 설정 적용
    SB->>JPA: 엔티티 스캔 및 Repository 생성
    SB->>DB: 테이블 자동 생성 (products)
    
    Note over Dev: 3. REST API 개발
    Dev->>SB: @RestController ProductController 작성
    SB->>SB: /products 엔드포인트 자동 매핑
    
    Note over Dev: 4. 비즈니스 로직 구현
    Dev->>Dev: Service 레이어 구현에 집중

Convention over Configuration 의 역할:

1. 엔티티 - 테이블 자동 매핑:

   1 2 3 4 5 6 7 8 9

   @Entity public class Product { // 'products' 테이블 자동 생성 @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; // 'id' 컬럼 자동 매핑 private String name; // 'name' 컬럼 자동 매핑 private BigDecimal price; // 'price' 컬럼 자동 매핑 }

2. Repository 자동 생성:

   1 2 3 4

   public interface ProductRepository extends JpaRepository<Product, Long> { // CRUD 메서드 자동 구현 // findByName, findByPriceGreaterThan 등 메서드명 기반 쿼리 자동 생성 }

3. REST 엔드포인트 자동 매핑:

   1 2 3 4 5 6 7 8 9 10

   @RestController @RequestMapping("/api/products") // /api/products 기본 경로 public class ProductController { @GetMapping // GET /api/products public List<Product> getAllProducts() { … } @GetMapping("/{id}") // GET /api/products/{id} public Product getProduct(@PathVariable Long id) { … } }

사례 2: Spring Boot 기반 웹 서비스 개발

시나리오: 신규 개발자가 팀에 합류하여 Spring Boot 로 웹 애플리케이션을 개발해야 하는 상황.

시스템 구성 및 다이어그램

classDiagram
    class Application
    class Controller
    class Service
    class Repository
    Application --> Controller
    Controller --> Service
    Service --> Repository

• Application: Spring Boot 프로젝트의 진입점, 관례적 구조와 설정 적용
• Controller/Service/Repository: 관례적 네이밍 및 위치에 따라 자동 인식 및 연결

Workflow:

1. 개발자는 관례에 따라 Controller, Service, Repository 를 생성
2. 별도 설정 없이 Spring Boot 가 자동으로 컴포넌트 스캔 및 DI(의존성 주입) 적용
3. 필요시 application.properties 에서 설정 오버라이드

역할:

• Spring Boot: 관례적 구조/설정 자동 적용, 필요시 오버라이드 지원
• 개발자: 핵심 로직 개발에 집중, 관례만 숙지하면 빠른 개발 가능

사례 3: MVP(Minimum Viable Product) 개발

시나리오: Ruby on Rails 를 사용하여 기본 규칙에 따라 모델, 컨트롤러, 뷰를 생성하고, 최소한의 설정으로 애플리케이션을 구현한다.

결과: 스타트업은 Ruby on Rails 의 Convention over Configuration 원칙을 적극 활용함으로써, 최소한의 설정으로 사용자 인증, 데이터베이스 모델링, RESTful API 를 빠르게 구축했다. 프로젝트 초기 설정 비용을 줄이고, 개발 속도를 2 배 이상 단축했으며, 코드 일관성과 테스트 유지보수성도 확보할 수 있었다.

시스템 구성 다이어그램:

graph TD
    A[Developer] -->|rails generate model User| B[Model Layer]
    A -->|rails generate controller Users| C[Controller Layer]
    B --> D[ORM - ActiveRecord]
    C --> E[Routing]
    C --> F[View Rendering Engine]
    D --> G[Database]

Workflow

sequenceDiagram
    participant Dev as Developer
    participant Rails as Rails Framework
    participant DB as Database

    Dev->>Rails: generate model User
    Rails-->>Dev: creates user.rb, migration, schema mapping
    Dev->>Rails: generate controller Users
    Rails-->>Dev: creates users_controller.rb, routes
    Dev->>Rails: start server
    Dev->>Rails: access /users
    Rails->>DB: query users table
    DB-->>Rails: returns user data
    Rails-->>Dev: renders user view

역할별 구성 요소 설명:

실무에서 효과적으로 적용하기 위한 고려사항 및 주의할 점

최적화하기 위한 고려사항 및 주의할 점

주제와 관련하여 주목할 내용

하위 주제로 분류한 추가 학습 내용

관련 분야의 추가 학습 내용

용어 정리

아키텍처 및 설계 패턴

프레임워크/라이브러리 기반 기능 및 코드 구조화

빌드 및 실행 시점 동작

DevOps 및 배포 자동화

기능 활성화 및 설정 방식

참고 및 출처

📘 공식 문서 및 기술 블로그

• Convention over configuration - Wikipedia
• Martin Fowler - Convention Over Configuration
• Patterns in Practice - Convention Over Configuration | Microsoft Learn
• Convention Over Configuration - Glossary - DevX
• Convention Over Configuration
• Convention over Configuration - Devopedia
• How Convention Over Configuration simplifies code - Medium
• Convention Over Configuration: Streamlining Software Development | Startup House
• Benefits Of Convention Over Configuration For IaC Deployment Projects - Build5Nines

🧱 프레임워크 문서 및 레퍼런스

• The Rails Doctrine
• Ruby on Rails Guides
• Spring Boot :: Spring Boot 공식 문서
• Spring Boot Reference Guide
• Django Documentation
• SpringBoot Configuration | GeeksforGeeks
• Django vs Spring Boot: Which is Better For Your Website | GeeksforGeeks

🧑‍💻 개인 및 커뮤니티 블로그

• CoC(Convention over Configuration) - Erinyees의 블로그
• 설정보다 관습 - 위키백과 (한국어)
• Spring Boot 첫 번째 예제 - 기억을 지배하는 기록
• Accelerate Development with Rails Convention Over Configuration - Codelila
• Convention over configuration(CoC)의 이해 :: JDM’s Blog