[Tomcat 구현하기] (1) - 웹 서버가 하는 일 알아보기

 

 

💡 해당 시리즈는 우테코에서 Tomcat 구현하기의 미션을 진행하며 공부한 내용을 기록한 글입니다.

💡jdk는 azul-16을 사용했습니다.

 

 

 

 

🧐 서론

미션의 시작은 Tomcat을 통해 간단한 HTTP 서버(웹 서버)를 구현하는 것입니다.

Tomcat과 웹 서버에 대해서 찾아보면, WAS와 웹 서버의 차이점에 대한 내용이 많이 등장합니다.

이번 글에서는 WAS와 웹 서버에 대한 차이점에 대해서 알아보는 것이 목적이 아니므로, 다음과 같은 좋은 자료들에 대한 링크를 남겨 두고, 설명은 건너뛰도록 하겠습니다.

• 얄코님 영상(https://www.youtube.com/watch?v=Zimhvf2B7Es)
• 여우의 테코톡(https://www.youtube.com/watch?v=31tKPguQ1sk)
• 티거의 테코톡(https://www.youtube.com/watch?v=F_vBAbjj4Pk)
• 알리의 테코톡(https://www.youtube.com/watch?v=mcnJcjbfjrs)
• 희봉의 테코톡(https://www.youtube.com/watch?v=NyhbNtOq0Bc)

 

 

 

 

 

 

 

 

🧐 웹 서버가 하는 일

웹 서버의 역할 웹 브라우저와 같은 클라이언트로부터 HTTP 요청을 받아 정적인 웹 페이지를 응답해주는 것입니다.

이때 사용자의 요청으로부터 응답까지의 과정을 나열하면 다음과 같습니다.

• 클라이언트 커넥션 수락
• 요청 메시지 수신
• 요청 처리
• 리소스(HTML 파일 등) 매핑과 접근
• 응답 생성
• 응답 반환
• 연결 종료

 

 

 

 

💡 앞으로 살펴볼 앞으로 완성시켜나갈 기본 뼈대 코드이며, 현재 상황에서는 일부 수도코드 느낌으로 표현하였습니다.

 

 

 

🐳 0. 간단한 톰캣 구현 확인

요청에 따른 코드를 살펴보기 전에, 간단히 구현된 톰캣을 살펴보도록 하겠습니다.

 

먼저 메인 메서드입니다.

public class Application {

    public static void main(String[] args) {
        Tomcat tomcat = new Tomcat();
        tomcat.start();
    }
}

Tomcat 객체를 생성하고 시작합니다.

 

 

Tomcat 클래스는 다음과 같이 구현되어 있습니다.

public class Tomcat {

    public void start() {
        Connector connector = new Connector();
        connector.start();

        try {
            // make the application wait until we press any key.
            System.in.read();
        } catch (IOException e) {
            log.error(e.getMessage(), e);
        } finally {
            log.info("web server stop.");
            connector.stop();
        }
    }
}

Tomcat에서는 Connector 객체를 만들고 이를 시작합니다.

 

 

Connector 객체는 다음과 같이 구현되어 있습니다.

public class Connector implements Runnable {
    
    private static final int DEFAULT_PORT = 8080;
    private static final int DEFAULT_ACCEPT_COUNT = 100;

    private final ServerSocket serverSocket;
    private boolean stopped;

    public Connector() {
        this(DEFAULT_PORT, DEFAULT_ACCEPT_COUNT);
    }

    public Connector(final int port, final int acceptCount) {
        this.serverSocket = createServerSocket(port, acceptCount);
        this.stopped = false;
    }

    private ServerSocket createServerSocket(final int port, final int acceptCount) {
        try {
            final int checkedPort = checkPort(port);
            final int checkedAcceptCount = checkAcceptCount(acceptCount);
            return new ServerSocket(checkedPort, checkedAcceptCount);
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }
    
   private int checkPort(final int port) {
        final var MIN_PORT = 1;
        final var MAX_PORT = 65535;

        if (port < MIN_PORT || MAX_PORT < port) {
            return DEFAULT_PORT;
        }
        return port;
    }

    private int checkAcceptCount(final int acceptCount) {
        return Math.max(acceptCount, DEFAULT_ACCEPT_COUNT);
    }

    public void start() {
        var thread = new Thread(this);
        thread.setDaemon(true);
        thread.start();
        stopped = false;
        log.info("Web Application Server started {} port.", serverSocket.getLocalPort());
    }

    @Override
    public void run() {
        // 클라이언트가 연결될때까지 대기한다.
        while (!stopped) {
            connect();
        }
    }

    private void connect() {
        try {
            Socket connection = serverSocket.accept();
            process(connection);
        } catch (IOException e) {
            log.error(e.getMessage(), e);
        }
    }

    private void process(final Socket connection) {
        if (connection == null) {
            return;
        }
        Http11Processor processor = new Http11Processor(connection);
        new Thread(processor).start();
    }

    public void stop() {
        stopped = true;
        try {
            serverSocket.close();
        } catch (IOException e) {
            log.error(e.getMessage(), e);
        }
    }
}

그닥 어려운 코드는 아니므로 설명을 생략합니다.

 

connect()와 process() 메서드가 중요한데요, 이들에 대해서는 아래에서 설명을 이어가도록 하고, 그 전에 Http11Processor 코드를 살펴보겠습니다.

public class Http11Processor implements Runnable, Processor {

    private final Socket connection;

    public Http11Processor(final Socket connection) {
        this.connection = connection;
    }

    @Override
    public void run() {
        log.info("connect host: {}, port: {}", connection.getInetAddress(), connection.getPort());
        process(connection);
    }

    @Override
    public void process(final Socket connection) {
        try (final var inputStream = connection.getInputStream();
             final var outputStream = connection.getOutputStream()) {

            // TODO

            outputStream.write(response.getBytes());
            outputStream.flush();
        } catch (IOException | UncheckedServletException e) {
            log.error(e.getMessage(), e);
        }
    }
}

 

 

이렇게 해서 앞으로 구현할 코드의 기초 뼈대 코드를 살펴보았습니다.

이제 웹 서버의 요청 처리 플로우를 따라 그 과정에서 어떤 코드들이 사용되는지 살펴보도록 하겠습니다.

 

 

 

 

 

 

🐳 1. 클라이언트 커넥션 수락

요청의 시작은 클라이언트가 웹 서버로 요청을 보내는 것이며, 웹 서버는 클라이언트로부터 접속 요청이 오면 이를 수락해주어야 데이터를 주고받을 수 있습니다.

 

이 부분은 아래와 같이 구현됩니다.

private void connect() {
    try {
        // serverSocket은 ServerSocket 타입
        Socket connection = serverSocket.accept();
        process(connection);
    } catch (IOException e) {
        log.error(e.getMessage(), e);
    }
}

우선 ServerSocket의 accept()를 살펴보겠습니다.

 

 

주석을 통해 해당 메소드는 ServerSocket에 대한 연결(connection)이 이루어질 때 까지 기다렸다가, 연결을 수락하고 새로운 Socket을 생성하여 반환한다고 나와있습니다.

 

그런데 왜 Socket을 새로 만들어 반환하는 것일까요?

네트워크에 대한 지식이 어느정도 있으신 분이라면 금방 예측하겠지만, 저와 같이 지식이 없는 사람들을 위해 (미래의 저를 위해) 자세히 설명을 진행하도록 하겠습니다.

 

 

이를 이해하기 위해서는 웹 요청이 어떠한 과정을 통해 이루어지는지에 대해서 알아야 합니다.

 

맨 처음 사용자가 브라우저를 통해 서버에 요청을 보내는 경우, 서버의 URL, Http Method와 입력된 데이터 등을 바탕으로 브라우저는 HTTP 리퀘스트 메세지를 만듭니다.

이후 DNS 서버로부터 서버의 IP 주소를 조회하고, 이곳에 요청 메세지를 보내게 됩니다.

 

이때 발생하는 데이터의 송∙수신 동작을 그림으로 표현하면 다음과 같습니다.

데이터를 송∙수신하는 컴퓨터 사이에 데이터가 흐르는 통로가 존재하며, 이를 통해 데이터가 흐르면서 상대측에 도착하게 됩니다.

 

이때 이러한 통로는 처음부터 연결된 상태로 존재하지 않습니다.

데이터를 송∙수신하기 전에 양 컴퓨터 사이에서 통로를 연결해주는 작업이 선행되어야 합니다.

 

이때 해당 통로의 양 끝에 존재하는 데이터의 출입구를 소켓이라고 부릅니다.

통로를 연결하기 위해서는 이 소켓을 먼저 만들어야 하고, 이후 양쪽의 소켓을 연결하는 작업이 필요합니다.

 

이때 실제 구현은 위의 코드에서 본 것과 같이, 서버에서 먼저 소켓을 만든 뒤 클라이언트에서 연결하기를 기다리게 됩니다.

(ServerSocket의 accpet() 메서드 설명과 동일합니다.)

 

이후 클라이언트측에서 소켓을 만든 뒤, 서버의 소켓과 연결하게 되면 그때부터 데이터를 주고받을 수 있게 됩니다.

 

 

이를 통해 알 수 있는 것은 다음과 같습니다.

데이터를 주고받기 위해서는 클라이언트 소켓이 서버 소켓에 연결되어야 합니다.

 

그다음으로 알아볼 것은, ServerSocket과 Socket에 대한 내용입니다.
벌써 눈치 체셨을 수도 있지만, 각각의 클래스의 설명을 한번 살펴보도록 하겠습니다.

 

먼저 ServerSecket의 설명은 다음과 같습니다.

This class implements server sockets.
A server socket waits for requests to come in over the network.
It performs some operation based on that request, and then possibly returns a result to the requester.

The actual work of the server socket is performed by an instanceof the {@code SocketImpl} class.
An application can change the socket factory that creates the socket implementation to configure itself to create sockets appropriate to the local firewall.

첫 줄에서 알 수 있듯이 ServerSocket은 서버의 socket을 구현합니다.

 

 

그에 반에 Socket의 설명은 다음과 같습니다.

This class implements client sockets (also called just "sockets").
A socket is an endpoint for communication between two machines.
The actual work of the socket is performed by an instance of the SocketImpl class.
An application, by changing the socket factory that creates the socket implementation, can configure itself to create sockets appropriate to the local firewall.

즉 ServerSocket의 accpet()에서 반환해주는 Socket은 서버 소켓과 연결된 클라이언트 소켓임을 알 수 있습니다.

 

 

 

 

 

 

 

🐳 2, 3. 요청 메세지 수신 & 처리

클라이언트가 보낸 HTTP 요청 메시지를 네트워크로부터 읽어야 합니다.

그 과정은 다음과 같이 구현됩니다.

private void process(final Socket connection) {
    if (connection == null) {
        return;
    }
    var processor = new Http11Processor(connection);
    new Thread(processor).start();
}



public class Http11Processor implements Runnable, Processor {

    private static final Logger log = LoggerFactory.getLogger(Http11Processor.class);

    private final Socket connection;

    public Http11Processor(final Socket connection) {
        this.connection = connection;
    }

    @Override
    public void run() {
        log.info("connect host: {}, port: {}", connection.getInetAddress(), connection.getPort());
        process(connection);
    }

    @Override
    public void process(final Socket connection) {
        try (final var inputStream = connection.getInputStream();  
             final var outputStream = connection.getOutputStream()) {
            
            String request = 요청_메세지_수신(inputStream);
            
            // 아래 두개가 '응답 생성'
            String responseBody = 메시지에서_지정한_리소스_가져온다(request);
            String response = 응답_생성();
            
            
            // 아래 두개가 '응답 반환'
            outputStream.write(response.getBytes());
            outputStream.flush();
        } catch (IOException | UncheckedServletException e) {
            log.error(e.getMessage(), e);
        }
    }
}

 

이때 요청 메세지를 수신하는 부분은 다음과 같습니다.

String request = 요청_메세지_수신(inputStream);

InputStream이란 것에서 요청 메세지를 수신합니다.

 

 

 

 

 

 

 

🐳 4. 리소스 매핑과 접근

private String 메시지에서_지정한_리소스_가져온다(request){

    String 리소스_이름 = 메시지에서_지정한_리소스_이름을_가져온다(request);
    
    return resources_디렉토리_내에서_리소스를_찾아_반환한다(리소스_이름);
}

이때 웹 서버의 resources 디렉토리에는 다음과 같은 정적 파일들이 존재합니다.

 

 

즉 요청이 localhost:8080/index.html인 경우 Index.html을 찾아 반환해 주어야 하는 것입니다.

 

 

 

 

 

 

 

 

🐳 5. 응답 메세지 생성

// 아래 두개가 '응답 생성'
String responseBody = 메시지에서_지정한_리소스_가져온다(request);
String response = 응답_생성();

응답 헤더를 포함한 HTTP 응답 메세지를 생성해야 합니다.

 

HTTP 응답 메세지는 다음과 같은 형태입니다.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages#http_responses

 

 

 

 

 

🐳 6. 응답 반환

// 아래 두개가 '응답 반환'
outputStream.write(response.getBytes());
outputStream.flush();

뭔진 모르겟지만 OutputStream이란 것을 통해서 응답을 반환합니다.

이후 연결이 종료됩니다.

 

 

 

 

 

 

🐳 7. 연결 종료

try (final var inputStream = connection.getInputStream();  
     final var outputStream = connection.getOutputStream()) {
} // try with resource 를 통한 auto close

try with resource를 사용하여 OutputStream이 close 되면서 연결이 종료됩니다.

 

 

connection.getOutputStream()의 타입은 SocketOutputStream인데요, SocketOutputStream의 close() 메서드는 다음과 같습니다.

소켓을 닫아줌으로써 연결을 종료하는 코드가 들어있는 것을 확인할 수 있습니다.

 

 

 

 

 

이렇게 해서 웹 서버의 기본적인 동작과 플로우를 알아보았고, 그 플로우 내에서 몇몇 코드들을 살펴보며 전체적인 흐름을 파악할 수 있었습니다.

 

다음 글에서부터는 위 코드 중에서 의문이 생겼던 다음 부분들에 대해 정리하도록 하겠습니다.

• InputStream, OutputStream이 뭐지?
• resources 디렉토리 내의 파일들을 어떻게 가져와야하지?