1. 서블릿으로 회원 관리 웹 애플리케이션 만들기
회원 관리 웹 애플리케이션 요구사항
이번 섹션에선 회원 정보(이름, 나이)를 저장하고 조회하는 비즈니스 로직을 가진 웹 애플리케이션을 간단하게 만들어 본다. 최대한 스프링 없이 순수 서블릿만으로 구현하는 것이 목적이다.
- 스프링은 톰캣을 띄울 때만 사용한다.
Member Entity와 Repository를 생성한 save(), findById(), findAll(), storeClear() 등의 메서드와 필드(username, age)를 구현하고 간단하게 Test까지 진행한다.
- MemberRepository에서 JPA를 사용하지 않는다면 HashMap<Long, Member>으로 id와 Member를 저장하는 방식을 사용할 수 있다. 이때 HashMap을 사용하면 동시성 문제가 발생할 수 있기 때문에 실무에서는 ConcurrentHashMap과 AtomicLong 사용을 고려한다.
- 스프링 없이 객체를 싱글톤으로 관리하기 위해 MemberRepository 객체를 static final로 선언하고, 생성자를 private로 막아둬야 한다.
- Map이나 id를 위한 sequence 필드도 static으로 선언한다. 그러나 객체 자체를 싱글톤으로 처리해 둔다면 static 키워드를 빼도 괜찮다.
// static으로 선언했기 때문에 MemberRepository 객체를 많이 만들더라도 아래 필드가 1개씩만 유지됨
// 아래에서 싱글톤 처리를 했다면 static을 지워도 됨
private static Map<Long, Member> store = new HashMap<>();
private static long sequence = 0L;
private static final MemberRepository instance = new MemberRepository();
public static MemberRepository getInstance() {
return instance;
}
// 싱글톤으로 유지하기 위해 필드를 static final로 선언하고, 생성자를 private로 막아둠
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);
}
// 밖에서 이 new ArrayList에 값을 넣거나 조작해도 store에 있는 value 값은 유지하도록 구현
public List<Member> findAll() {
return new ArrayList<>(store.values());
}
public void clearStore() {
store.clear();
}
참고
request.getParameter() 메서드의 결과는 항상 String이다. 다른 타입으로 값을 받고 싶다면 형변환을 해야 한다.
ex. int age = Integer.parseInt(request.getParameter("age"));
템플릿 엔진
서블릿과 자바 코드만으로 HTML을 만들어 화면을 구성하게 한다. 서블릿 덕분에 회원 저장 결과나 회원 목록 같은 동적인 HTML을 만들 수 있다. 그런데 아래 예시 코드를 보면 HTML을 자바 코드로 한 줄씩 적어야 하기 때문에 과정이 상당히 복잡하다는 걸 알 수 있다. 게다가 String으로 처리되기 때문에 오타가 발생해도 바로 찾을 수가 없다는 문제도 있다.
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>");
이렇게 자바 코드로 HTML을 한 줄 한 줄 적는 것보단, HTML 문서에 동적으로 변경해야 하는 부분만 자바 코드를 넣는 게 훨씬 간단하다. 이런 문제를 템플릿 엔진을 사용해 해결할 수 있다.
템플릿 엔진💫
템플릿 엔진을 사용하면 HTML 문서에서 필요한 곳만 코드를 적용해서 동적으로 변경할 수 있다. 자주 쓰는 툴로는 JSP, Thymeleaf, Freemarker, Velocity 등이 있다.
참고
JSP는 성능과 기능 면에서 다른 템플릿 엔진에게 밀리면서 점점 사용이 줄어들고 있다. 요즘은 스프링과 잘 통합되는 Thymeleaf를 주로 사용한다.
2. JSP로 회원 관리 웹 애플리케이션 만들기
JSP 관련 라이브러리 추가
JSP를 사용하려면 build.gradle에 아래 라이브러리를 추가해야 한다. (이후 Gradle refresh)
//spring boot 3.0 이상
dependencies {
...
//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는 HTML의 필요한 부분에 자바 코드를 넣어 동적으로 바뀌는 HTML로 만들 수 있다. index.html이나 hello-form.html처럼 JSP 문서를 미리 만들어놓고 사용할 수 있다. JSP 문서의 첫 줄은 아래 코드로 시작한다.
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
나머지는 위에 자바 코드로 작성했던 HTML로 채우고, 동적으로 바뀌어야 할 부분이 있다면 자바 코드를 그대로 넣어 적용할 수 있다.
# 자바의 import 문과 동일
<%@ page import="hello.servlet.domain.member.MemberRepository" %>
...
# JSP 문서임을 알림
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
# <% ~~ %> 이 부분에 자바 코드를 입력할 수 있음
<%
// request, response 사용 가능
MemberRepository memberRepository = MemberRepository.getInstance();
System.out.println("save.jsp");
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);
%>
...
# <%= ~~ %> 이 부분에 자바 코드를 출력할 수 있음
<ul>
<li>id=<%=member.getId()%></li>
<li>username=<%=member.getUsername()%></li>
<li>age=<%=member.getAge()%></li>
</ul>
참고
JSP는 자동으로 servlet으로 변환돼서 사용(service 로직 호출)되기 때문에 HttpServletRequest 객체와 HttpServletResponse 객체를 사용할 수 있다.
서블릿과 JSP의 한계
서블릿으로 개발할 때는 뷰(View) 화면을 위한 HTML을 만드는 작업이 자바 코드에 섞여서 매우 복잡했다. JSP를 사용하고 나선 뷰를 생성하는 HTML 작업을 깔끔하게 가져가고, 동적으로 변경이 필요한 부분에만 자바 코드를 적용했다. 그런데 이후에도 몇 가지 문제가 발생한다.
위에 적어둔 예시 코드를 보면, 코드의 상위 절반은 회원을 저장하기 위한 비즈니스 로직이고 나머지 하위 절반은 결과를 HTML로 보여주기 위한 뷰 영역이다. Java 코드, 데이터를 조회하는 Repository 등 다양한 코드가 모두 JSP에 노출돼 있고, JSP가 너무 많은 역할을 하게 된다는 문제가 생긴다. 나중에 프로젝트가 커질수록 JSP 문서도 길어지게 되는데 이런 경우엔 유지 보수 관점에서 큰 어려움을 겪게 된다.
이런 문제를 해결하기 위해 MVC 패턴이 등장했다. MVC 패턴을 적용하면 비즈니스 로직은 서블릿처럼 다른 곳에서 처리하고, JSP는 목적에 맞게 HTML로 뷰 화면을 만드는 일에 집중하도록 할 수 있다. 아래에서 코드를 직접 리팩터링 해보면서 MVC 패턴을 적용해 보자.
3. MVC 패턴
개요
너무 많은 역할을 가짐
하나의 서블릿이나 JSP만으로 비즈니스 로직과 뷰 렌더링까지 모두 처리하게 되면, 너무 많은 역할이 몰리게 되고 결과적으로 유지 보수가 어려워진다.
예를 들어, 비즈니스 로직을 호출하는 부분에 변경이 발생해도 해당 코드를 손대야 하고, UI를 변경할 일이 있어도 비즈니스 로직이 함께 있는 해당 파일을 수정해야 한다. 문서 길이가 길어질수록 다른 곳을 건드릴 위험이 커져 아찔한 상황이 생길 수 있다.
변경의 라이프 사이클이 다름💫
UI를 일부 수정하는 일과 비즈니스 로직을 수정하는 일은 각각 다르게 발생할 가능성이 매우 높고, 대부분 서로에게 영향을 주지 않는다. 이렇게 라이프 사이클이 다른 부분을 하나의 코드로 관리하는 것은 유지 보수하기에 좋지 않다. 유지 보수를 위해선 변경 주기가 다르다면 분리하는 것이 좋다.
기능 특화
특히 JSP 같은 뷰 템플릿은 화면을 렌더링하는데 최적화돼 있기 때문에 이 부분의 작업만 맡는 것이 가장 효과적이다.
MVC(Model View Controller) 패턴은 지금까지 학습한 것처럼 하나의 서블릿이나 JSP로 처리하던 것을 컨트롤러(Controller)와 뷰(View)라는 영역으로 서로 역할을 나눈 것을 말한다. 웹 애플리케이션은 보통 이 MVC 패턴을 사용한다.
- 컨트롤러(Controller)
- HTTP 요청을 받아서 파라미터를 검증하고, 비즈니스 로직을 실행한다. 이후 뷰에 전달할 결과 데이터를 조회해서 모델에 담는다.
- 모델(Model)
- 뷰에 출력할 데이터를 담아둔다. 뷰가 필요한 데이터를 모두 모델에 담아서 전달하기 때문에 뷰는 비즈니스 로직이나 데이터 접근을 몰라도 되고, 화면을 렌더링 하는 일에 집중할 수 있다.
- 뷰(View)
- 모델에 담겨있는 데이터를 사용해서 화면을 렌더링한다. 여기서는 HTML을 생성하는 부분을 말한다.
참고
Controller에 비즈니스 로직을 둘 수 있지만, 이렇게 되면 컨트롤러가 너무 많은 역할을 담당한다. 그래서 일반적으로 비즈니스 로직은 Service라는 계층을 별도로 만들어서 처리한다. 그리고 Controller는 비즈니스 로직이 있는 Service를 호출하는 역할을 담당한다.
비즈니스 로직을 변경하면 비즈니스 로직을 호출하는 Controller의 코드도 변경될 수 있다.
적용
서블릿을 Controller로 사용하고, JSP를 View로 사용해서 MVC 패턴을 적용해보자. Model은 HttpServletRequest 객체를 사용한다. request는 내부에 데이터 저장소를 갖고 있는데, request.setAttribute(), request.getAttribute()를 사용하면 데이터를 보관하고 조회할 수 있다.
a. 회원 저장 예시
Controller
- dispatcher.forward()
- 다른 서블릿이나 JSP로 이동할 수 있는 기능이다. 서버 내부에서 다시 호출이 발생해 제어권을 넘겨준다.
/WEB-INF💫
이 경로 안에 JSP가 있으면 외부에서 직접 JSP를 호출할 수 없고, Controller를 통해 JSP를 호출해야만 한다. 직접 호출하는 경우 리소스가 없다는 오류 화면이 나타나게 된다.
redirect와 forward의 차이💫
redirect는 실제 클라이언트(웹 브라우저)에 응답이 나갔다가, 클라이언트가 redirect 경로로 다시 요청한다. 따라서 클라이언트가 인지할 수 있고, URL 경로도 실제로 변경된다.
forward는 서버 내부에서 일어나는 호출이기 때문에 클라이언트가 전혀 인지할 수 없다.
- HttpServletRequest를 Model로 사용하면 request 내부에 데이터를 저장할 수 있다. request.setAttribute()로 데이터를 보관해 View에 전달하고, request.getAttribute()로 데이터를 꺼낼 수 있다.
@WebServlet(name = "mvcMemberSaveServlet", urlPatterns = "/servlet-mvc/members/save")
public class MvcMemberSaveServlet extends HttpServlet {
private MemberRepository memberRepository = MemberRepository.getInstance();
@Override
protected void service(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
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);
//Model에 데이터를 보관한다.
request.setAttribute("member", member);
String viewPath = "/WEB-INF/views/save-result.jsp";
RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);
}
}
View
- 아래 예시에는 없지만 form의 action에서 절대 경로(/로 시작)가 아니라 상대 경로(/로 시작 안 함)로 작성하면 폼 전송 시 현재 URL이 속한 계층 경로 뒤에 /save가 붙은 경로가 호출된다. 예를 들어 현재 계층 경로가 /servlet-mvc/members라면 action의 결과는 /servlet-mvc/members/save이다.
<!-- 상대경로 사용, [현재 URL이 속한 계층 경로 + /save] -->
<form action="save" method="post">
- <%= request.getAttribute("member")%>로 Model에 저장한 member 객체를 꺼낼 수 있지만 너무 복잡해진다. JSP에서 제공하는 ${...} 문법을 사용하면 request의 attribute에 담긴 데이터를 편리하게 조회할 수 있다.
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<meta charset="UTF-8">
</head>
<body>
성공
<ul>
<li>id=${member.id}</li>
<li>username=${member.username}</li>
<li>age=${member.age}</li>
</ul>
<a href="/index.html">메인</a>
</body>
</html>
b. 회원 목록 조회 예시
Controller
@WebServlet(name = "mvcMemberListServlet", urlPatterns = "/servlet-mvc/members")
public class MvcMemberListServlet extends HttpServlet {
private MemberRepository memberRepository = MemberRepository.getInstance();
@Override
protected void service(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
System.out.println("MvcMemberListServlet.service");
List<Member> members = memberRepository.findAll();
request.setAttribute("members", members);
String viewPath = "/WEB-INF/views/members.jsp";
RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);
}
}
View
- Model에 담아둔 members를 JSP가 제공하는 taglib 기능을 사용해 반복하면서 출력했다. <c:forEach> 기능을 사용하려면 아래 코드의 2번째 줄과 같이 선언해야 한다. 이 기능을 사용하지 않으면 <% %> 안에 자바 코드를 넣어 테이블을 출력해야 한다.
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<html>
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<a href="/index.html">메인</a>
<table>
<thead>
<th>id</th>
<th>username</th>
<th>age</th>
</thead>
<tbody>
<c:forEach var="item" items="${members}">
<tr>
<td>${item.id}</td>
<td>${item.username}</td>
<td>${item.age}</td>
</tr>
</c:forEach>
</tbody>
</table>
</body>
</html>
한계 - MVC 컨트롤러의 단점
MVC 패턴을 적용하면 Controller의 역할과 View를 렌더링하는 역할을 확실하게 구분할 수 있다.
- 특히 View는, Model에서 데이터를 꺼내 화면만 만들면 되기 때문에 코드가 깔끔하고 직관적이다.
- Controller는 중복된 코드나 필요하지 않은 코드도 많이 갖게 된다.
포워드 중복
View로 이동하는 코드가 항상 중복으로 호출된다. 이 부분을 메서드로 공통화하더라도 해당 메서드를 항상 직접 호출해야 한다.
RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);
ViewPath 중복
JSP가 아닌 Thymeleaf 같은 다른 뷰로 변경한다면 전체 코드를 다 변경해야 한다.
String viewPath = "/WEB-INF/views/new-form.jsp";
// prefix: /WEB-INF/views
// suffix: .jsp
사용하지 않는 코드
다음 코드를 사용할 때도 있고, 사용하지 않을 때도 있다. 특히 response는 현재 코드에서 사용되지 않는다.
HttpServletRequest request, HttpServletResponse response
그리고 위 객체를 사용하는 코드는 테스트 케이스를 작성하기도 어렵다.
공통 처리가 어려움
기능이 복잡해질수록 Controller에서 공통으로 처리해야 하는 부분이 점점 더 많이 증가하게 된다. 공통 기능을 메서드로 만들더라도 해당 메서드를 항상 호출해야 하고, 이것도 중복이라고 볼 수 있다.
이게 주된 문제다. 이 문제를 해결하기 위해선 Controller 호출 전 먼저 공통 기능을 처리해야 한다. 소위 수문장 역할을 하는 기능이 필요하다. 모든 HTTP 요청이 들어오는 입구를 하나로 만드는 프론트 컨트롤러(Front Controller) 패턴을 도입하면 이런 문제를 깔끔하게 해결할 수 있다. 스프링 MVC의 핵심도 바로 이 Front Controller에 있다.