도구
로그인
한국어

코드 배우기자바

자바 프로젝트 구조 잡기

자바 17 기준

만들 것과 Maven·Gradle 을 고르면 폴더 나무와 시작 파일 zip 이 나와요.

프로젝트 뼈대 만들기

만들 것과 빌드 도구를 고르면 폴더 나무·파일마다 하는 일·계층 그림이 바뀌어요. 파일을 누르면 시작 코드가 보이고, zip 으로 받아 빌드해 봐요.

만들 것
빌드 도구
테스트

폴더 나무 파일 7개

  • src/
    • main/
      • java/com/example/hello/
        • service/
      • resources/
    • test/java/com/example/hello/service/

src/main/java/com/example/hello/App.java

프로그램 시작점이에요. 설정을 읽고, 명령줄 인수를 받아 서비스에 넘기고, 결과를 찍어요. 규칙은 여기 두지 않아요.

package com.example.hello; import com.example.hello.service.GreetingService; import java.io.IOException;import java.io.InputStream;import java.util.Properties; public class App {    public static void main(String[] args) throws IOException {        Properties config = new Properties();        try (InputStream in = App.class.getResourceAsStream("/app.properties")) {            if (in != null) {                config.load(in);            }        }        GreetingService service = new GreetingService(config.getProperty("greeting", "Hello"));        String name = args.length > 0 ? args[0] : "world";        System.out.println(service.greet(name));    }}

계층 그림

적어 둔 버전 Java 17 · JUnit 5.11.3 · maven-surefire-plugin 3.5.2 · Gradle 8 이상. 꾸러미 파일은 zip 에 넣지 않았어요. 빌드 도구가 처음 빌드할 때 받아요.

Maven·Gradle 표준 폴더

자리들어가는 것
src/main/java프로그램 코드. 패키지 이름대로 폴더를 만들어요(com/example/hello/App.java).
src/main/resources설정 파일, 문구, 그림처럼 코드가 아닌 파일. 빌드하면 클래스 파일 옆에 같이 들어가요.
src/test/java테스트 코드. 배포할 jar 에는 들어가지 않아요.
src/test/resources테스트에만 사용하는 설정·자료.
pom.xml · build.gradle빌드 파일. 자바 버전, 꾸러미(의존성), 실행할 클래스, 테스트 도구를 적어요.
target/ · build/빌드 결과가 생기는 곳(Maven 은 target, Gradle 은 build). git 에는 올리지 않아요.

두 도구가 같은 폴더 모양을 사용해서 Maven 으로 시작했다가 Gradle 로 옮겨도 소스 자리는 그대로예요.

계층 나누기

요청을 받는 곳, 규칙을 판단하는 곳, 자료를 넣고 꺼내는 곳을 나눠요. 웹 API 라면 api(컨트롤러) → service → repository 차례로 부르고, 거꾸로는 부르지 않아요.

이렇게 나누면 저장소를 파일에서 DB 로 바꿔도 서비스 코드는 그대로이고, 서비스 규칙은 웹 서버 없이 테스트할 수 있어요.

  • api 는 요청을 읽고 응답을 만들 뿐 계산하지 않아요.
  • service 는 규칙을 판단해요. 웹이나 DB 가 무엇인지 몰라요.
  • repository 는 저장하고 꺼내요. 인터페이스로 두면 메모리·DB 구현을 바꿔 끼워요.

패키지 이름 짓기

패키지 이름은 내가 가진 도메인을 거꾸로 쓰는 데서 시작해요. example.com 이면 com.example, 그 뒤에 프로젝트 이름을 붙여요.

  • 모두 소문자로 써요. - 는 사용할 수 없어서 my-app 은 myapp 이나 my_app 으로 바꿔요.
  • 도메인이 없으면 io.github.내아이디 처럼 내가 관리하는 주소를 사용해요.
  • 작을 때는 계층별(api, service, repository)로, 커지면 기능별(order, member)로 먼저 나누고 그 안에서 계층을 나누면 찾기 쉬워요.

자주 사용하는 설계 꼴 넷과 의존성 주입

이름을 외우기보다 언제 사용하는지가 중요해요. 모두 javac·java 17 로 돌려 본 코드예요.

싱글톤 · 하나만 있어야 할 때

설정처럼 프로그램 전체에 하나만 있어야 하는 객체에 사용해요. 생성자를 private 으로 막고 get() 으로만 꺼내요.

편하다고 여기저기 사용하면 숨은 전역 변수가 돼서 테스트가 어려워져요. 하나여야만 할 때 사용해요.

final class AppConfig {    private static final AppConfig INSTANCE = new AppConfig();    private final String mode;     private AppConfig() {        mode = "production";    }     static AppConfig get() {        return INSTANCE;    }     String mode() {        return mode;    }} public class Main {    public static void main(String[] args) {        AppConfig a = AppConfig.get();        AppConfig b = AppConfig.get();        System.out.println(a == b);        System.out.println(a.mode());    }}

실행 결과

trueproduction

팩토리 · 무엇을 만들지 한 곳에서 정할 때

파일 확장자에 따라 다른 파서를 만드는 것처럼, 조건을 보고 알맞은 구현을 골라 주는 메서드예요. 부르는 쪽은 Parser 라는 것만 알면 돼요.

interface Parser {    String parse(String line);} class CsvParser implements Parser {    public String parse(String line) {        return String.join(" | ", line.split(","));    }} class TsvParser implements Parser {    public String parse(String line) {        return String.join(" | ", line.split("\t"));    }} final class Parsers {    static Parser forFile(String fileName) {        if (fileName.endsWith(".csv")) {            return new CsvParser();        }        if (fileName.endsWith(".tsv")) {            return new TsvParser();        }        throw new IllegalArgumentException("Unknown file type: " + fileName);    }} public class Main {    public static void main(String[] args) {        Parser p = Parsers.forFile("users.csv");        System.out.println(p.parse("kim,25,seoul"));    }}

실행 결과

kim | 25 | seoul

전략 · 바꿔 끼우는 계산 방법

할인처럼 방법이 여럿인 계산을 인터페이스로 빼고, 객체를 만들 때 골라 넣어요. 메서드가 하나뿐인 인터페이스라 람다(price -> price - 5000)로도 넣을 수 있어요.

interface Discount {    int apply(int price);} class NoDiscount implements Discount {    public int apply(int price) {        return price;    }} class PercentOff implements Discount {    private final int percent;     PercentOff(int percent) {        this.percent = percent;    }     public int apply(int price) {        return price - price * percent / 100;    }} class Checkout {    private final Discount discount;     Checkout(Discount discount) {        this.discount = discount;    }     int total(int price) {        return discount.apply(price);    }} public class Main {    public static void main(String[] args) {        System.out.println(new Checkout(new NoDiscount()).total(20000));        System.out.println(new Checkout(new PercentOff(15)).total(20000));        System.out.println(new Checkout(price -> price - 5000).total(20000));    }}

실행 결과

200001700015000

옵서버 · 일이 생기면 알려 주기

재입고 같은 일이 생겼을 때 등록해 둔 여러 곳에 알려요. 알리는 쪽은 받는 쪽이 메일인지 기록인지 몰라도 돼요.

import java.util.ArrayList;import java.util.List;import java.util.function.Consumer; class Store {    private final List<Consumer<String>> listeners = new ArrayList<>();     void onRestock(Consumer<String> listener) {        listeners.add(listener);    }     void restock(String item) {        for (Consumer<String> listener : listeners) {            listener.accept(item);        }    }} public class Main {    public static void main(String[] args) {        Store store = new Store();        store.onRestock(item -> System.out.println("Mail: " + item + " is back"));        store.onRestock(item -> System.out.println("Log: restocked " + item));        store.restock("keyboard");    }}

실행 결과

Mail: keyboard is backLog: restocked keyboard

의존성 주입 · 필요한 것을 생성자로 받기

GreetingService 는 저장소를 직접 new 하지 않고 생성자로 받아요. 실행할 때는 메모리 저장소를, 테스트에는 람다로 만든 가짜를 넣어요.

Spring 같은 프레임워크도 결국 이 생성자에 알맞은 객체를 찾아 넣는 일을 해요.

import java.util.Map; interface UserRepository {    String findName(int id);} class MemoryUserRepository implements UserRepository {    private final Map<Integer, String> rows = Map.of(1, "Mina", 2, "Joon");     public String findName(int id) {        return rows.getOrDefault(id, "guest");    }} class GreetingService {    private final UserRepository repo;     GreetingService(UserRepository repo) {        this.repo = repo;    }     String greet(int id) {        return "Hello, " + repo.findName(id);    }} public class Main {    public static void main(String[] args) {        GreetingService service = new GreetingService(new MemoryUserRepository());        System.out.println(service.greet(1));        System.out.println(service.greet(7));         GreetingService test = new GreetingService(id -> "Tester");        System.out.println(test.greet(99));    }}

실행 결과

Hello, MinaHello, guestHello, Tester

확인 문제

문제 1

Maven·Gradle 프로젝트에서 테스트 코드를 두는 곳은?

답과 까닭 보기

답: 2. src/test/java 테스트 코드는 src/test/java 에 둬요. 여기 있는 코드는 테스트할 때만 컴파일되고 배포할 jar 에는 들어가지 않아요.

문제 2

GreetingService 가 저장소를 생성자로 받을 때 좋은 점은?

답과 까닭 보기

답: 2. 테스트할 때 가짜 저장소를 넣을 수 있어요 저장소를 밖에서 넣으니 테스트에서는 DB 없이 가짜(람다)를 넣어 서비스 규칙만 따로 볼 수 있어요.

자주 묻는 것

Maven 과 Gradle 중 무엇을 고르나요?

둘 다 같은 폴더 모양을 사용해요. XML 로 적는 정해진 틀이 편하면 Maven, 코드처럼 짧게 적는 쪽이 편하면 Gradle 이에요. 팀이 사용하는 쪽을 따라가면 돼요.

받은 zip 은 어떻게 빌드하나요?

Maven 은 mvn package, Gradle 은 gradle build 를 프로젝트 폴더에서 실행해요. 자세한 명령은 zip 안 README.md 에 있어요.

꾸러미는 왜 zip 에 없나요?

JUnit 같은 꾸러미는 빌드 도구가 처음 빌드할 때 받아요. 버전 번호는 빌드 파일에 적어 두었어요.