[Spring] 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 #3 서블릿, JSP, MVC 패턴

회원 관리 웹 애플리케이션 요구사항

회원 정보

이름 : username
나이 : age

기능 요구사항

회원 저장
회원 목록 조회

먼저 domain 패키지를 만들어 member Class를 만든다.

package hello.servlet.domain.member;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class Member {
    private Long id;
    private String username;
    private int age;

    public Member() {
    }

    public Member(String username, int age) {
        this.username = username;
        this.age = age;
    }
}

프로젝트가 큰 경우 repository 패키지를 별개로 만드는데 이번의 경우 간단하기 때문에 하위에 바로 MemberRepository를 만든다.

package hello.servlet.domain.member;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class MemberRepository {
    private Map<Long, Member> store = new HashMap<>();
    private static long sequence = 0L;
    private static final MemberRepository instance = new MemberRepository();
    public static MemberRepository getInstance() {
        return instance;
    }
    private MemberRepository() {}	// 아무나 생성하지 못하도록 private 접근 제어자 사용

    public Member save(Member member) {
        member.setId(++sequence);
        store.put(member.getId(), member);
        return member;
    }

    public Member findById(Long id) {
        return store.get(id);
    }

    public List<Member> findAll() {
        return new ArrayList<>(store.values());
    }

    public void clearStore() {
        store.clear();
    }
}

참고로 위의 코드는 동시성 문제가 고려되어 있지 않고, 실무에서는 ConcurrentHashMap, AtomicLong 사용을 고려해야한다.

이어 테스트 코드를 작성한다.

package hello.servlet.domain.member;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;

import java.util.List;

import static org.assertj.core.api.Assertions.*;

public class MemberRepositoryTest {
    MemberRepository memberRepository = MemberRepository.getInstance();

    @AfterEach
    void afterEach() {
        memberRepository.clearStore();
    }

    @Test
    void save() {
        // given
        Member member = new Member("hello", 20);

        // when
        Member savedMember = memberRepository.save(member);

        // then
        Member findMember = memberRepository.findById(savedMember.getId());
        assertThat(findMember).isEqualTo(savedMember);
    }

    @Test
    void findAll() {
        //given
        Member member1 = new Member("member1", 21);
        Member member2 = new Member("member2", 30);

        //when
        List<Member> result = memberRepository.findAll();

        //then
        assertThat(result.size()).isEqualTo(2);
        assertThat(result).contains(member1, member2);
    }
}

또한 Assertions는 org.assertj.core.api 패키지 내에 있는 것을 사용해야한다.

기존에 쓰여진 아래의 코드를 Alt+Enter를 사용해 사진의 옵션을 선택하면 자동으로 import 되어 보다 간편한 코드 작성이 가능하다.

import static org.assertj.core.api.Assertions.*;	// 자동 임포트

Assertions.assertThat(result.size()).isEqualTo(2);

각 테스트가 끝날 때, 다음 테스트에 영향을 주지 않도록 각 테스트의 저장소를 clearStore() 메서드를 호출해 초기화했다.

서블릿으로 회원 관리 웹 애플리케이션 만들기

서블릿으로 웹 애플리케이션을 만들어 본 결과, 비즈니스 로직 실행하는 것에서는 문제가 없었으나 HTML을 수기로 작성해야한다는 것이 굉장히 불편했다. 아래 일부 코드를 확인해보자.

package hello.servlet.web.servlet;

import hello.servlet.domain.member.MemberRepository;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;
import java.io.PrintWriter;

@WebServlet(name = "memberFormServlet", urlPatterns = "/servlet/members/new-form")
public class MemberFormServlet extends HttpServlet {
    private MemberRepository memberRepository = MemberRepository.getInstance();

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html");
        response.setCharacterEncoding("utf-8");


        PrintWriter w = response.getWriter();
        // 서블릿으로 작성시에는 html을 java 코드로 작성해야 하기 때문에 굉장히 불편함.
        w.write("<!DOCTYPE html>\n" +
                "<html>\n" +
                "<head>\n" +
                " <meta charset=\"UTF-8\">\n" +
                " <title>Title</title>\n" +
                "</head>\n" +
                "<body>\n" +
                "<form action=\"/servlet/members/save\" method=\"post\">\n" +
                " username: <input type=\"text\" name=\"username\" />\n" +
                " age: <input type=\"text\" name=\"age\" />\n" +
                " <button type=\"submit\">전송</button>\n" +
                "</form>\n" +
                "</body>\n" +
                "</html>\n");
    }
}

지금이야 간단한 예제를 풀어보는 것이므로 html의 양이 많지 않아 체감이 안될 수 있지만, html의 경우 수천줄이 넘어갈 수 있으므로 디버깅에도 애를 먹게된다. 그래서 템플릿 엔진을 사용한다.

템플릿 엔진이란?
지정된 템플릿 양식과 데이터가 합쳐져 HTML 문서를 출력하는 소프트웨어. 템플릿 엔진을 사용할 경우 html에 자바코드를 넣는 것이 가능해진다. 대표적으로 템플릿 엔진에는 JSP, Thymeleaf, Freemarker, Velocity가 존재한다.

JSP로 회원 관리 웹 애플리케이션 만들기

먼저 JSP를 사용하기 위해선 아래의 설정을 build.gradle에 추가한다.

스프링부트 3.0 이상을 기준으로 설명한다.

//JSP 추가 시작
implementation 'org.apache.tomcat.embed:tomcat-embed-jasper'
implementation 'jakarta.servlet:jakarta.servlet-api'
implementation 'jakarta.servlet.jsp.jstl:jakarta.servlet.jsp.jstl-api'
implementation 'org.glassfish.web:jakarta.servlet.jsp.jstl'
//JSP 추가 끝

라이브러리를 추가한 다음에는 사진의 버튼을 클릭해 Gradle을 Refresh해준다.

<%@ page import="hello.servlet.domain.member.MemberRepository" %>
- 자바의 import 문과 같다.
<% ~~ %> : 자바 코드를 입력할 수 있다.
<%= ~~ %> : 자바 코드를 출력할 수 있다.

JSP를 사용한 덕분에 뷰를 생성하는 HTML 작업을 깔끔하게 가져가고, 동적으로 변경이 필요한 부분에만 자바 코드를 적용했다. 그러나 코드를 보면 자바코드와 뷰 영역 코드 등 다양한 코드가 모두 JSP에 노출되어 있다. JSP가 너무 많은 역할을 하는 것이다.

MVC 패턴

하나의 서블릿이나 JSP만으로 비즈니스 로직과 뷰 렌더링까지 모두 처리하게 되면, 너무 많은 역할을 하게되고, 결과적으로 유지보수에 어려움을 겪는다. 진짜 문제는 둘 사이에 변경의 라이프 사이클이 다르다는 것. 라이프 사이클이 다른 부분을 하나의 코드로 관리하는 것은 유지보수하기 좋지 않다.

MVC패턴은 컨트롤러와 뷰라는 영역으로 역할을 나눈 것을 말한다. 웹 애플리케이션은 보통 MVC 패턴을 사용한다.

컨트롤러 : HTTP 요청을 받아 파라미터 검증, 비즈니스 로직 실행. 뷰에 전달할 결과 데이터를 조회해 모델에 담음
모델 : 뷰에 출력할 데이터를 담아둠.
뷰 : 모델에 담겨있는 데이터를 사용해 화면을 그리는 일에 집중(HTML 생성).

적용

이제 서블릿을 컨트롤러로, JSP를 뷰로 MVC 패턴을 적용해보도록 한다.

@WebServlet(name = "mvcMemberFormServlet", urlPatterns = "/servlet-mvc/members/new-form")
public class MvcMemberFormServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String viewPath = "/WEB-INF/views/new-form.jsp";
        RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
        dispatcher.forward(request, response);
    }
}

RequestDispatcher 객체의 forword() 메서드를 사용하여 서버 내부에서 다시 호출이 발생하여 다른 서블릿이나 JSP로 이동할 수 있다.

WEB-INF 경로 안에 JSP 파일이 있는 경우 외부에서 직접 JSP를 호출 할 수 없게된다.

Redirect VS Forward
리다리엑트의 경우에는 실제 클라이언트에 응답이 나갔다 클라이언트가 다시 redirect 경로로 요청한다. (= url 경로도 실제로 변경된다) 반면 포워드의 경우 서버 내부에서 일어나는 호출로 클라이언트가 인지할 수 없다.

한계

MVC 패턴을 적용하여 컨트롤러의 역할과 뷰를 렌더링 하는 역할을 명확하게 구분할 수 있었다. 그러나 현재 작성되어있는 컨트롤러에 코드에서는 중복이 많고, 필요하지 않는 코드들이 보인다.

MVC 컨트롤러의 단점

1) 포워드 중복

View로 이동하는 코드가 항상 호출된다. 해당 부분을 유틸로 분리할 수 있지만 그렇게 분리한 해당 메서드도 항상 직접 호출해야 한다.

RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);

2) ViewPath 중복

String viewPath = "/WEB-INF/views/new-form.jsp";

prefix : /WEB-INF/views/
suffix : .jsp

만일 jsp가 아닌 thymeleaf 같은 다른 뷰로 변경한다면 전체 코드를 변경해야 한다.

3) 현재 코드에서 사용되지 않는 코드의 중복

HttpServletRequest request, HttpServletResponse response

특히나 response는 현재 코드에서 사용되지 않지만, 계속 중복되고있다. 또, HttpServletRequest, HttpServletResponse를 사용하는 코드는 테스트 케이스를 작성하기도 어렵다.

정리해 공통 처리가 어렵다는 문제가 있다. 해당 문제를 해결하기 위해선 컨트롤러를 호출 하기 전 먼저 공통 기능을 처리해야 한다. 바로 프론트 컨트롤러 패턴을 도입하여 문제를 해결할 수 있다. 스프링 MVC의 핵심도 바로 이 프론트 컨트롤러에 있다.

위 글은 김영한 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술의 일부 내용을 정리한 것입니다.

'Backend > Spring' 카테고리의 다른 글

[Spring] 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 #5 스프링 MVC 구조 이해 (0)	2024.07.30
[Spring] 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 #4 MVC 프레임워크 (0)	2024.07.10
[Spring] 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 #2 서블릿 (0)	2024.06.19
[Spring] 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 #1 웹 애플리케이션 이해 (0)	2024.06.17
[Spring] 스프링 입문 - 코드로 배우는 스프링 부트 #7 AOP (0)	2024.06.16