[Spring] 서블릿의 기본 사용법 예제 ( 1 )

Back-end/Spring 2022. 3. 18. 12:57

안녕하세요!! 이번 포스팅부터는 web mvc패턴의 개념과 기능, 원리를 공부하면서 점진적으로 더 나은 방법으로 점진적으로 개선해보겠습니다.

서블릿에서부터 시작해서 단점을 하나씩 보완하다 보면 결국 스프링 프레임워크의 내부구조와 비슷한 코드가 나오게 되는데 굉장히 재미있었습니다.

우선 서블릿에 대해 공부하기 위해서 몇가지 요구사항에 맞추어서 프로젝트를 설계해보겠습니다.

회원 도메인 모델

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;
     }
}

회원 저장소

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
 * 동시성 문제가 고려되어 있지 않음, 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
 */
public class MemberRepository {
     private static Map<Long, Member> store = new HashMap<>(); //static 사용
     private static long sequence = 0L; //static 사용
     private static final MemberRepository instance = new MemberRepository();
     
     public static MemberRepository getInstance() {
     return instance;
     }
     
     private MemberRepository() {
     }
     
     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();
     }
}

회원 저장소는 싱글톤 패턴을 사용했습니다. 스프링을 사용하면 스프링 빈으로 등록하면 되지만, 지금은 최대한 스프링 없이 순수 서블릿 만으로 구현하는 것이 목적이기 때문입니다.

싱글톤 패턴은 객체를 단 하나만 생성해서 공유해야 하므로 생성자를 private 접근자로 막아둡니다.

회원 저장소 테스트 코드

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import java.util.List;
import static org.assertj.core.api.Assertions.*;
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", 20);
         Member member2 = new Member("member2", 30);
         memberRepository.save(member1);
         memberRepository.save(member2);

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

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

위와 같이 회원을 저장하고 목록을 조회하는 테스트를 작성해보고 실행하면 테스트가 성공하는 것을 확인 할 수 있습니다. 또한, 다음 테스트에 영향을 주지 않도록 @AfterEach 어노테이션을 통해서 테스트의 저장소를 clear()를 해줍니다.

이렇게 도메인을 설계 하고 나서는 항상 목적에 맞게 알맞게 동작하는지 확인할 수 있는 테스트 코드를 작성하는 것이 중요하다고 합니다. 그래서 이런 습관을 가지는 것도 중요한 것 같습니다!!

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

가장 먼저 서블릿으로 회원 등록 HTML 폼을 제공 해보겠습니다.

import hello.servlet.domain.member.MemberRepository;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
@WebServlet(name = "memberFormServlet", urlPatterns = "/servlet/members/newform")
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();
         
         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");
     }
}

MemberFormServlet은 단순하게 회원 정보를 입력할 수 있는 HTML Form을 만들어서 응답합니다.

하지만 자바 코드로 HTML을 제공해야 하므로 쉽지 않은 작업입니다 정말 저는 지옥이라고 표현하고 싶습니다.

현재 이 상태에서는 HTML Form에서 데이터를 post로 전송해도 전달받는 서블릿을 아직 만들지 않았기 때문에 그래서 오류가 발생합니다.

이번에는 HTML Form에서 데이터를 입력하고 전송을 누르면 실제 회원 데이터가 저장되도록 해보겠습니다.

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
@WebServlet(name = "memberSaveServlet", urlPatterns = "/servlet/members/save")
public class MemberSaveServlet extends HttpServlet {
     private MemberRepository memberRepository = MemberRepository.getInstance();
     
     @Override
     protected void service(HttpServletRequest request, HttpServletResponse 
    response)
     throws ServletException, IOException {
         System.out.println("MemberSaveServlet.service");
         
         String username = request.getParameter("username");
         int age = Integer.parseInt(request.getParameter("age"));
         Member member = new Member(username, age);
         System.out.println("member = " + member);
         memberRepository.save(member);
         
         response.setContentType("text/html");
         response.setCharacterEncoding("utf-8");
         
         PrintWriter w = response.getWriter();
         
         w.write("<html>\n" +
             "<head>\n" +
             " <meta charset=\"UTF-8\">\n" +
             "</head>\n" +
             "<body>\n" +
             "성공\n" +
             "<ul>\n" +
             " <li>id="+member.getId()+"</li>\n" +
             " <li>username="+member.getUsername()+"</li>\n" +
             " <li>age="+member.getAge()+"</li>\n" +
             "</ul>\n" +
             "<a href=\"/index.html\">메인</a>\n" +
             "</body>\n" +
             "</html>");
     }
}

위의 MembeSaveServlet은 다음 순서로 동작합니다.

1. 파라미터를 조회해서 Member 객체를 만든다.

2. Member 객체를 MemberRepository를 통해서 저장한다.

3. Member 객체를 사용해서 결과 화면용 HTML을 동적으로 만들어서 응답한다.

실행을 하면 데이터가 전송되고 저장 결과를 확인할 수 있습니다.

이번에는 저장된 모든 회원 목록을 조회하는 기능을 만들어보겠습니다.

import hello.servlet.domain.member.Member;
import hello.servlet.domain.member.MemberRepository;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;
@WebServlet(name = "memberListServlet", urlPatterns = "/servlet/members")
public class MemberListServlet 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");
         List<Member> members = memberRepository.findAll();
         PrintWriter w = response.getWriter();
         w.write("<html>");
         w.write("<head>");
         w.write(" <meta charset=\"UTF-8\">");
         w.write(" <title>Title</title>");
         w.write("</head>");
         w.write("<body>");
         w.write("<a href=\"/index.html\">메인</a>");
         w.write("<table>");
         w.write(" <thead>");
         w.write(" <th>id</th>");
         w.write(" <th>username</th>");
         w.write(" <th>age</th>");
         w.write(" </thead>");
         w.write(" <tbody>");
        /*
         w.write(" <tr>");
         w.write(" <td>1</td>");
         w.write(" <td>userA</td>");
         w.write(" <td>10</td>");
         w.write(" </tr>");
        */
         for (Member member : members) {
         w.write(" <tr>");
         w.write(" <td>" + member.getId() + "</td>");
         w.write(" <td>" + member.getUsername() + "</td>");
         w.write(" <td>" + member.getAge() + "</td>");
         w.write(" </tr>");
         }
         w.write(" </tbody>");
         w.write("</table>");
         w.write("</body>");
         w.write("</html>");
     }
}

위의 MemberListServlet 은 다음 순서로 동작합니다.

1. memberRepository.findAll()을 통해 모든 회원을 조회한다.

2. 회원 목록 HTML을 for 루프를 통해서 회원 수만큼 동적으로 생성하고 응답한다.

resonse객체에서 writer를 꺼내서 HTML 코드를 작성하는 것은 굉장히 불편하고 비효율 적입니다. 그래서 템플릿 엔진을 사용하면 보다 간편하게 코드를 작성할 수 있습니다.

템플릿 엔진으로 . . .

템플릿 엔진으로 지금까지 서블릿과 자바 코드만으로 HTML을 만들어보았습니다. 서블릿 덕분에 동적으로 원하는 HTML을 마음껏 만들 수 있었습니다. 정적인 HTML 문서라면 화면이 계속 달라지는 회원의 저장 결과라던가, 회원 목록 같은 동적인 HTML을 만드는 일은 불가능할 것입니다. 그런데, 코드에서 보듯이 이것은 매우 복잡하고 비효율 적입니다. 자바 코드로 HTML을 만들어 내는 것보다 차라리 HTML 문서에 동적으로 변경해야 하는 부분만 자바 코드를 넣을 수 있다면 더 편리할 것입니다. 이것이 바로 템플릿 엔진이 나온 이유이다. 템플릿 엔진을 사용하면 HTML 문서에서 필요한 곳만 코드를 적용해서 동적으로 변경할 수 있습니다. 템플릿 엔진에는 JSP, Thymeleaf, Freemarker, Velocity 등이 있습니다.

참고

JSP는 성능과 기능면에서 다른 템플릿 엔진과의 경쟁에서 밀리면서, 점점 사장되어 가는 추세입니다. 템플릿 엔진들은 각각 장단점이 있는데, 주로 스프링과 잘 통합되는 Thymeleaf를 사용합니다.

다음 포스팅 에는 JSP로 회원 관리 웹 애플리케이션을 만들어보겠습니다!!

'Back-end > Spring' 카테고리의 다른 글

[Spring] 서블릿의 기본적인 개요, Request, Response, GET, POST, JSON, HTTP message (0)	2022.03.18
[Spring]서블릿의 기본 사용법 예제 ( 2 ), JSP로 회원 웹 애플리케이션 개발 그리고 MVC패턴의 등장, MVC의 한계 (0)	2022.03.18
[Spring] 빈 스코프(Bean Scope) (0)	2022.03.07
[Spring] 빈 생명주기 콜백 (0)	2022.03.07
[Spring] 롬복과 최신 트렌드 (0)	2022.03.07

ABOUT ME

TaeheeLog TaeheeLog

'Back-end > Spring' 카테고리의 다른 글

티스토리툴바

ABOUT ME

'Back-end > Spring' 카테고리의 다른 글

관련글 관련글 더보기

티스토리툴바