MVC 프레임워크 만들기

김민우·2022년 7월 26일

MVC

목록 보기

4/16

프론트 컨트롤러 패턴

프론트 컨트롤러 패턴 특징

프론트 컨트롤러 서블릿 하나로 클라이언트의 요청을 받는다.
(입구를 하나로 만든다.)
프론트 컨트롤러가 요청에 맞는 컨트롤러를 찾아서 호출한다.
공통 처리를 가능하게 한다.
프론트 컨트롤러를 제외한 나머지 컨트롤러는 서블릿을 사용하지 않아도 된다.

스프링 웹 MVC의 핵심도 바로 프론트 컨트롤러이다.
스프링 웹 MVC의 DispatcherServlet이 프론트 컨트롤러 패턴으로 구현되있다.

프론트 컨트롤러 도입

프론트 컨트롤러를 단계적으로 도입해보자.
기존 코드를 최대한 유지하면서, 프론트 컨트롤러를 도입하는 것이다.
먼저 구조를 맞추어두고 점진적으로 리펙터링을 해보자.

V1

ControllerV1 인터페이스

public interface ControllerV1 {
      void process(HttpServletRequest request, HttpServletResponse response)
  throws ServletException, IOException;
}

서블릿과 비슷한 모양의 컨트롤러 인터페이스를 도입한다.
각 컨트롤러 들은 이 인터페이스를 구현하면 된다.(process 메소드 구현)
이 인터페이스를 호출하해서 구현과 관계없이 로직의 일관성을 가져갈 수 있다.

MemberFormControllerV1 - 회원 등록 컨트롤러

public class MemberFormControllerV1 implements ControllerV1 {
	@Override
	public void process(HttpServletRequest request, HttpServletResponse
    response) throws ServletException, IOException {
    
		String viewPath = "/WEB-INF/views/new-form.jsp";
		RequestDispatcher dispatcher = 
        						request.getRequestDispatcher(viewPath);
		dispatcher.forward(request, response);
	}
}

MemberSaveControllerV1 - 회원 저장 컨트롤러

public class MemberSaveControllerV1 implements ControllerV1 {
	
    private MemberRepository memberRepository = MemberRepository.getInstance();

	@Override
	public void process(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);
		memberRepository.save(member);
        
		request.setAttribute("member", member);
		String viewPath = "/WEB-INF/views/save-result.jsp";
		RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
		dispatcher.forward(request, response);
	}
}

MemberListControllerV1 - 회원 목록 컨트롤러

public class MemberListControllerV1 implements ControllerV1 {

	private MemberRepository memberRepository = MemberRepository.getInstance();

	@Override
	public void process(HttpServletRequest request, HttpServletResponse
  response) throws ServletException, IOException {
		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);
	}
}

내부 로직은 기존 서블릿과 거의 같다. 이제 프론트 컨트롤러를 만들어보자.

FrontControllerServletV1 - 프론트 컨트롤러

@WebServlet(name = "frontControllerServletV1", urlPatterns = "/front-
  controller/v1/ *")
  
  public class FrontControllerServletV1 extends HttpServlet {
  
		private Map<String, ControllerV1> controllerMap = new HashMap<>();
		
        public FrontControllerServletV1() {
		
        	controllerMap.put("/front-controller/v1/members/new-form", new
  MemberFormControllerV1());
			controllerMap.put("/front-controller/v1/members/save", new
  MemberSaveControllerV1());
			controllerMap.put("/front-controller/v1/members", new
  MemberListControllerV1());
      }
      
		@Override
      	protected void service(HttpServletRequest request, HttpServletResponse
  response) throws ServletException, IOException {
  		System.out.println("FrontControllerServletV1.service");
		String requestURI = request.getRequestURI();
		ControllerV1 controller = controllerMap.get(requestURI);
		
		if (controller == null) {
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
			return; 
		}
        
        controller.process(request, response);
	}
}

urlPatterns
- urlPatterns = "/front-controller/v1/*" : /front-controller/v1 를 포함한 하위 모든 요청은 이 서블릿에서 받아들인다.
  예) /front-controller/v1 , /front-controller/v1/a , /front-controller/v1/a/b
controllerMap
- key : 매핑 URL
- value : 호출될 컨트롤러
service()
먼저 requestURI를 조회해서 실제 호출할 컨트롤러를 controllerMap에서 찾는다. 만약 없다면 404(SC_NOT_FOUND) 상태 코드를 반환한다.
컨트롤러를 찾고, controller.process(request, response);를 호출해서 해당 컨트롤러를 실행한다.

JSP
JSP는 이전 MVC에서 사용했던 것을 그대로 사용한다.

실행
- 등록 : http://localhost:8080/front-controller/v1/members/new-form
- 목록 : http://localhost:8080/front-controller/v1/members

즉, URL 매핑 정보에서 컨트롤러 조회하면 URL 매핑 정보를 뒤져서 어떤 컨트롤러를 사용해야 하는지를 조회 후 해당 컨트롤러 호출하는 방식이다.

V2

기존 V1 방식을 다시 살펴보자. 모든 컨트롤러에서 뷰로 이동하는 부분에 여전히 중복이 있고, 깔끔하지 않다.

String viewPath = "/WEB-INF/views/new-form.jsp";
RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
dispatcher.forward(request, response);

이 부분을 깔끔하게 분리하기 위해 별도로 뷰를 처리하는 객체를 만들자.

V2 구조

MyView

public class MyView {
	private String viewPath;
	
    public MyView(String viewPath) {
          this.viewPath = viewPath;
}
      
	public void render(HttpServletRequest request, HttpServletResponse
  response) throws ServletException, IOException {
  
		RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
		dispatcher.forward(request, response);
	}
}

이 코드만 봐서는 어떻게 활용하는지 아직 감이 안올 것이다. 다음 버전의 컨트롤러 인터페이스를 만들어보자. 컨트롤러가 뷰를 반환한다는 특징이 있다.

ControllerV2

public interface ControllerV2 {
	MyView process(HttpServletRequest request, HttpServletResponse response)
  throws ServletException, IOException;
}

MemberFormControllerV2 - 회원 등록 폼

public class MemberFormControllerV2 implements ControllerV2 {

@Override
	public MyView process(HttpServletRequest request, HttpServletResponse
  response) throws ServletException, IOException {
		return new MyView("/WEB-INF/views/new-form.jsp");
	}
}

이제 각 컨트롤러는 복잡한 dispatch.forward()를 직접 생성해서 호출하지 않아도 된다. 단순히 MyView 객체를 생성하고 거기에 뷰 이름만 넣고 리턴하면 된다.

ControllerV1을 구현한 클래스와 ControllerV2를 구현한 클래스를 비교해보면, 이 부분의 중복이 확실하게 제거된 것을 확인 할 수 있다.

MemberSaveFormControllerV2 - 회원 저장

public class MemberSaveControllerV2 implements ControllerV2 {

	private MemberRepository memberRepository = MemberRepository.getInstance();
    
	@Override
	public MyView process(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);
		memberRepository.save(member);
        
 		request.setAttribute("member", member);
        
		return new MyView("/WEB-INF/views/save-result.jsp");
	}
}

MemberListControllerV2 - 회원 목록

public class MemberListControllerV2 implements ControllerV2 {

	private MemberRepository memberRepository = MemberRepository.getInstance();

	@Override
	public MyView process(HttpServletRequest request, HttpServletResponse
       response) throws ServletException, IOException {
       
		List<Member> members = memberRepository.findAll();
		request.setAttribute("members", members);
        
		return new MyView("/WEB-INF/views/members.jsp");
      }
}

프론트 컨트롤러 V2

@WebServlet(name = "frontControllerServletV2", urlPatterns = "/front-
  controller/v2/ *")
	public class FrontControllerServletV2 extends HttpServlet {
	private Map<String, ControllerV2> controllerMap = new HashMap<>();
	public FrontControllerServletV2() {
		controllerMap.put("/front-controller/v2/members/new-form", new
  MemberFormControllerV2());
		controllerMap.put("/front-controller/v2/members/save", new
  MemberSaveControllerV2());
		controllerMap.put("/front-controller/v2/members", new
  MemberListControllerV2());
	}

	@Override
    protected void service(HttpServletRequest request, HttpServletResponse
  response) throws ServletException, IOException {
		String requestURI = request.getRequestURI();
		ControllerV2 controller = controllerMap.get(requestURI);
          
		if (controller == null) {
        	response.setStatus(HttpServletResponse.SC_NOT_FOUND);
			return; 
		}
        
		MyView view = controller.process(request, response);
		view.render(request, response);
	}
}

ControllerV2의 리턴 타입이 MyView이므로 프론트 컨트롤러는 컨트롤러의 호출 결과로 MyView를 리턴받는다. 그리고 view.render()를 호출하면 forward로직을 수행해서 JSP가 실행된다.

MyView.render() 코드

public void render(HttpServletRequest request, HttpServletResponse response)
  throws ServletException, IOException {
	RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
	dispatcher.forward(request, response);
}

프론트 컨트롤러의 도입으로 MyView객체의 render()를 호출하는 부분을 모두 일관되게 처리할 수 있다. 각각의 컨트롤러는 MyView객체를 생성만 해서 리턴하면 된다.

컨트롤러가 단순히 MyView를 프론트 컨트롤러에 리턴하면 된다. 그러면, 프론트 컨트롤러가 view.render()를 호출하여 기존 중복되던 부분 (forward)을 처리한다.

실행
- 등록 : http://localhost:8080/front-controller/v2/members/new-form
- 목록 : http://localhost:8080/front-controller/v2/members

V3

우리가 MVC에서 request에서 setAttribute를 호출하여 model로 사용했는데, Model이라는 새로운 객체를 만들어 기존 request가 했던 역할을 하게 한다. 이렇게 함으로써 우리가 구현하는 컨트롤러가 서블릿 기술(request.setAttribute)을 전혀 사용하지 않도록 한다.

또한 , MyView의 파라미터에서 중복이 일어나고 있다.
컨트롤러는 view의 논리적 경로(new-form.jsp, save-result.jsp, members.jsp)만 리턴하도록 하고 실제 물리 위치이름은 프론트 컨트롤러에서 처리(즉, 프론트 컨트롤러에서 지저분한 일들을 처리하도록 하고 핵심 로직은 최대한 단순하게 만든다. 왜냐하면 실제 개발시 프론트 컨트롤러는 1개이지만 컨트롤러는 매우 많으므로)
이러면, 뷰의 폴더 위치가 바뀌더라도 프론트 컨트롤러만 수정하면 된다!
=> 변경의 지점을 하나로 만들 수 있다(이는 매우 좋은 설계다.)

서블릿 종속성 제거
컨트롤러 입장에서 HttpServletRequest, HttpServletResponse 객체가 꼭 필요할까?

요청 파라미터의 정보는 자바의 Map으로 대신 넘기도록 하면 지금 구조에서는 컨트롤러가 서블릿 기술을 몰라도 동작할 수 있다.
그리고 request 객체를 Model로 사용하는 대신에 별도의 Model 객체를 만들어서 리턴하면 된다.

우리가 구현하는 컨트롤러가 서블릿 기술을 전혀 사용하지 않도록 구현해보자.
이렇게 하면 구현 코드가 매우 단순해지고, 테스트 코드 작성이 쉬워진다.

뷰 이름 중복 제거
컨트롤러에서 지정하는 뷰 이름에 중복이 있는 것을 확인할 수 있다.
컨트롤러는 뷰의 논리 이름이를 리턴하고, 실제 물리 위치의 이름은 프론트 컨트롤러에서 처리하도록 단순화하자.
이렇게 해주면 향후 뷰의 폴더 위치가 함께 이동해도 프론트 컨트롤러만 고치면 된다.

/WEB-INF/views/new-form.jsp -> new-form
/WEB-INF/views/save-result.jsp -> save-result
/WEB-INF/views/members.jsp -> members

V3 구조

ModelView

지금까지 컨트롤러에서 서블릿에 종속적인 HttpServletRequest를 사용했다. 그리고 Model도 request.setAttribute()를 통해 데이터를 저장하고 뷰에 전달했다.
서블릿의 종속성을 제거하기 위해 Model을 직접 만들고, 추가로 View 이름까지 전달하는 새로운 객체를 만들어보자.
(이번 버전에서는 컨트롤러에서 HttpServletRequest를 사용할 수 없다. 따라서 직접 request.setAttribute() 를 호출할 수 도 없다. 따라서 Model이 별도로 필요하다.)

public class ModelView {

	private String viewName;
    private Map<String, Object> model = new HashMap<>();
    
    public ModelView(String viewName) {
    	this.viewName = viewName;
    }
    
    public String getViewName() {
          return viewName;
	}
    
	public void setViewName(String viewName) {
		this.viewName = viewName;
	}
    
	public Map<String, Object> getModel() {
		return model;
	}
      
    public void setModel(Map<String, Object> model) {
		this.model = model;
	}
    
}

뷰의 이름과 뷰를 렌더링 할 때 필요한 model 객체를 가지고 있다. model은 단순히 map으로 되어있으므로 컨트롤러에서 뷰에 필요한 데이터를 key, value로 넣어주면 된다.

ControllerV3

public interface ControllerV3 {
	ModelView process(Map<String, String> paramMap);
}

이 컨트롤러는 서블릿 기술을 전혀 사용하지 않는다.
따라서, 구현이 매우 단순해지고, 테스트 코드 작성도 수월하다.

HttpServletRequest가 제공하는 파라미터는 프론트 컨트롤러가 parmaMap에 담아서 호출해주면 된다. 응답 결과로 뷰 이름과 뷰에 전달할 Model 데이터를 포함하는 ModelView 객체를 리턴하면 된다.

ModelFormControllerV3 - 회원 등록 폼

public class MemberFormControllerV3 implements ControllerV3 {
	@Override
      public ModelView process(Map<String, String> paramMap) {
          return new ModelView("new-form");
      }
}

ModelView를 생성할 때, new-form이라는 view의 논리적인 이름을 지정한다. 실제 물리적인 이름은 프론트 컨트롤러에서 처리한다.

ModelSaveControllerV3 - 회원 저장

public class MemberSaveControllerV3 implements ControllerV3 {
	private MemberRepository memberRepository = MemberRepository.getInstance();
    
	@Override
	public ModelView process(Map<String, String> paramMap) {
		String username = paramMap.get("username");
		int age = Integer.parseInt(paramMap.get("age"));
          
		Member member = new Member(username, age);
		memberRepository.save(member);
		
        ModelView mv = new ModelView("save-result");
		mv.getModel().put("member", member);
		return mv;
	}
}

paramMap.get("username");
파라미터 정보는 map에 담겨있다. map에서 필요한 요청 파라미터를 조회하면 된다. (요청 정보를 paramMap에서 받아 저장한다.)

mv.getModel().put("member", member);
모델은 단순한 map이므로 모델에 뷰에서 필요한 member 객체를 담고 반환한다.

MemberListControllerV3 - 회원 목록

public class MemberSaveControllerV3 implements ControllerV3 {

	private MemberRepository memberRepository = MemberRepository.getInstance();

	@Override
	public ModelView process(Map<String, String> paramMap) {
		
        List<Member> members = memberRepository.findAll();
		ModelView mv = new ModelView("members");
		mv.getModel().put("members", members);
          
		return mv;
	}
}

FrontControllerServletV3

@WebServlet(name = "frontControllerServletV3", urlPatterns = "/front-
  controller/v3/ *")
public class FrontControllerServletV3 extends HttpServlet {
	 
	private Map<String, ControllerV3> controllerMap = new HashMap<>();
    
    public FrontControllerServletV3() {
		controllerMap.put("/front-controller/v3/members/new-form", new
MemberFormControllerV3());
        controllerMap.put("/front-controller/v3/members/save", new
MemberSaveControllerV3());
        controllerMap.put("/front-controller/v3/members", new
MemberListControllerV3());
	}
    
	@Override
    protected void service(HttpServletRequest request, HttpServletResponse
response) throws ServletException, IOException {

		String requestURI = request.getRequestURI();
        ControllerV3 controller = controllerMap.get(requestURI);
        
        if (controller == null) {
			response.setStatus(HttpServletResponse.SC_NOT_FOUND);
			return;
        }
        
        Map<String, String> paramMap = createParamMap(request);
        
        ModelView mv = controller.process(paramMap);
        String viewName = mv.getViewName();
        
        MyView view = viewResolver(viewName);
        view.render(mv.getModel(), request, response);
    }
    
	private Map<String, String> createParamMap(HttpServletRequest request) {
        Map<String, String> paramMap = new HashMap<>();
        request.getParameterNames().asIterator()
                .forEachRemaining(paramName -> paramMap.put(paramName,
				request.getParameter(paramName)));
           return paramMap;
	}
      
	private MyView viewResolver(String viewName) {
		return new MyView("/WEB-INF/views/" + viewName + ".jsp");
	}
}

createParamMap()
HttpServletRequest에서 파라미터 정보를 꺼내서 Map으로 변환한다. 그리고 해당 Map(paramMap)을 컨트롤러에 전달하면서 호출한다.

뷰 리졸버
MyView view = viewResolver(viewName)
컨트롤러가 반환한 논리 뷰 이름을 실제 물리 뷰 경로로 변경한다. 그리고 실제 물리 경로가 있는 MyView 객체를 반환한다. (즉, 논리 이름을 실제 물리이름으로 바꿔주는 역할)
- 논리 뷰 이름: members
- 뷰 객체를 통해서 HTML 화면을 렌더링 한다.

view.render(mv.getModel(), request, response)
- 뷰 객체의 render() 는 모델 정보도 함께 받는다.
- JSP는 request.getAttribute() 로 데이터를 조회하기 때문에, 모델의 데이터를 꺼내서 request.setAttribute() 로 담아둔다.
- JSP로 포워드 해서 JSP를 렌더링 한다.

MyView

public class MyView {

	private String viewPath;
    
	public MyView(String viewPath) {
          this.viewPath = viewPath;
	}
    
	public void render(HttpServletRequest request, HttpServletResponse
  response) throws ServletException, IOException {
		RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
		dispatcher.forward(request, response);
	}
	
    public void render(Map<String, Object> model, HttpServletRequest request,
  HttpServletResponse response) throws ServletException, IOException {
 		modelToRequestAttribute(model, request);
		RequestDispatcher dispatcher = request.getRequestDispatcher(viewPath);
		dispatcher.forward(request, response);
	}
      
	private void modelToRequestAttribute(Map<String, Object> model,
  HttpServletRequest request) {
		model.forEach((key, value) -> request.setAttribute(key, value));
	}
    
}

실행
- 등록 : http://localhost:8080/front-controller/v3/members/new-form
- 목록 : http://localhost:8080/front-controller/v3/members

V4

앞서 만든 v3 컨트롤러는 서블릿 종속성을 제거하고 뷰 경로의 중복을 제거하는 등, 잘 설계된 컨트롤러이다. 그런데 실제 컨트톨러 인터페이스를 구현하는 개발자 입장에서 보면, 항상 ModelView 객체를 생성하고 반환해야 하는 부분이 조금은 번거롭다.
좋은 프레임워크는 아키텍처도 중요하지만, 그와 더불어 실제 개발하는 개발자가 단순하고 편리하게 사용할 수 있어야 한다. 소위 실용성이 있어야한다.

v3를 조금 변경해서 실제 구현하는 개발자들이 매우 편리하게 개발할 수 있는 v4 버전을 개발해보자.

기본적인 구조는 V3와 같지만 컨트롤러가 ModelView를 리턴하지 않고 ViewNAme만 리턴한다.

ControllerV4

public interface ControllerV4 {
	/**
     * @param paramMap
     * @param model
     * @return viewName
     */
    String process(Map<String, String> paramMap,
    				Map<String, Object> model);
}

이번 버전의 인터페이스에 ModelView가 없다. model 객체는 파라미터로 전달되기 때문에 그냥 사용하면 되고, 결과로 뷰의 이름만 리턴해주면 된다.

MemberFormControllerV4

public class MemberFormControllerV4 implements ControllerV4 {
	@Override
	public String process(Map<String, String> paramMap, Map<String, Object>
  model) {
		return "new-form";
	}
}

정말 단순하게 new-form이라는 뷰의 논리 이름만 리턴하면 된다.

MemberSaveControllerV4

public class MemberSaveControllerV4 implements ControllerV4 {

	private MemberRepository memberRepository = MemberRepository.getInstance();
    
	@Override
    public String process(Map<String, String> paramMap, Map<String, Object>
  model) {
        String username = paramMap.get("username");
        int age = Integer.parseInt(paramMap.get("age"));
        
        Member member = new Member(username, age);
        memberRepository.save(member);
        
        model.put("member", member);
        
        return "save-result";
	}
}

model.put("member", member)
모델이 파라미터로 전달되기 때문에 모델을 직접 생성하지 않아도 된다.

MemberListControllerV4

public class MemberListControllerV4 implements ControllerV4 {

	private MemberRepository memberRepository = MemberRepository.getInstance();
    
	@Override
    public String process(Map<String, String> paramMap, Map<String, Object>
  model) {
        List<Member> members = memberRepository.findAll();
        
        model.put("members", members);
        
        return "members";
    }
}

FrontControllerV4

@WebServlet(name = "frontControllerServletV4", urlPatterns = "/front-
 controller/v4/ *")
	public class FrontControllerServletV4 extends HttpServlet {
    
    private Map<String, ControllerV4> controllerMap = new HashMap<>();
    
    public FrontControllerServletV4() {
        controllerMap.put("/front-controller/v4/members/new-form", new
MemberFormControllerV4());
        controllerMap.put("/front-controller/v4/members/save", new
MemberSaveControllerV4());
        controllerMap.put("/front-controller/v4/members", new
MemberListControllerV4());
    }
    
	@Override
    protected void service(HttpServletRequest request, HttpServletResponse
response) throws ServletException, IOException {

        String requestURI = request.getRequestURI();
        ControllerV4 controller = controllerMap.get(requestURI);
        
        if (controller == null) { 
      		response.setStatus(HttpServletResponse.SC_NOT_FOUND);
			return;
		}

		Map<String, String> paramMap = createParamMap(request);
        Map<String, Object> model = new HashMap<>(); //추가
        
        String viewName = controller.process(paramMap, model);
        MyView view = viewResolver(viewName);
        view.render(model, request, response);
    }
    
    private Map<String, String> createParamMap(HttpServletRequest request) {
        Map<String, String> paramMap = new HashMap<>();
        request.getParameterNames().asIterator()
                	.forEachRemaining(paramName -> paramMap.put(paramName,
  					request.getParameter(paramName)));
        
        return paramMap;
    }
    
	private MyView viewResolver(String viewName) {
          return new MyView("/WEB-INF/views/" + viewName + ".jsp");
	} 
}

V3 버전과 거의 동일하다.

모델 객체 전달
Map<String, Object> model = new HashMap<>(); // 추가
모델 객체를 프론트 컨트롤러에서 생성해서 넘겨준다. 컨트롤러에서 모델 객체에 값을 담으면 여기에 그대로 담겨있게 된다.

뷰의 논리 이름을 직접 리턴
컨트롤러가 직접 뷰의 논리이름을 리턴하므로 이 값을 사용해서 실제 물리 뷰를. 찾을 수 있다.
```
String viewName = controller.process(paramMap, model);
MyView view = viewResolver(viewName);
```
실행
- 등록 : http://localhost:8080/front-controller/v4/members/new-form
- 목록 : http://localhost:8080/front-controller/v4/members

참고)
V4 버전의 컨트롤러는 매우 단순하고 실용적이다. 기존 구조에서 모델을 파라미터로 넘기고, 뷰의 논리 이름을 반환한다는 작은 아이디어를 적용했을 뿐인데, 컨트롤러를 구현하는 개발자 입장에서 보면 이제 군더더기 없는 코드를 작성할 수 있다.
또한 중요한 사실은 여기까지 한번에 온 것이 아니라는 점이다. 프레임워크가 점진적으로 발전하는 과정 속에서 이런 방법도 찾을 수 있었다.
프레임워크나 공통 기능이 수고로워야 사용하는 개발자가 편리해진다.

V5

만약 어떤 개발자는 ControllerV3 방식으로 개발하고 싶고, 어떤 개발자는 ControllerV4 방식으로 개발하고 싶다면 어떻게 해야할까?

이 두개의 방식의 프론트 컨트롤러는 한가지 방식의 컨트롤러 인터페이스만 사용할 수 있다.

public interface ControllerV3 {
	ModelView process(Map<String, String> paramMap);
}

public interface ControllerV4 {
	String process(Map<String, String> paramMap, 
    					Map<String, Object> model);
}

이 두개의 인터페이스는 완전히 다른 인터페이스이다. 따라서 호환이 불가능하다.
(마치 V3는 110V, V4는 220V 전기 콘센트 같은 것이다.)

이를 어떻게 해결할 수 있을까? 어댑터 패턴을 이용하면 된다.

V5 구조

핸들러 어댑터
- 중간에 어댑터 역할을하는 어댑터
- 이를 통해 다양한 종류의 컨트롤러를 호출할 수 있다.
핸들러
- 컨트롤러의 이름의 더 넓은 범위
  (이유 : 어댑터가 있기 때문에 꼭 컨트롤러의 개념 뿐만 아니라 어떠한 것이든 해당하는 종류의 어댑터만 있으면 다 처리할 수 있기 때문이다.)

MyHandlerAdapter

public interface MyHandlerAdapter {
	boolean supports(Object handler);
	ModelView handle(HttpServletRequest request, HttpServletResponse response,
  Object handler) throws ServletException, IOException;
  }

어댑터는 이렇게 구현해야한다는 어댑터용 인터페이스이다.
boolean supports(Object handler)
- 파라미터 handler는 컨트롤러를 말한다.
- 어댑터가 해당 컨트롤러를 처리할 수 있는지 여부를 판단하는 메소드이다.
ModelView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
- 어댑터는 실제 컨트롤러를 호출하고, 그 결과를 ModelView를 리턴해야 한다.
- 실제 컨트롤러가 ModelView를 리턴하지 못하더라도 (V4의 경우) 어댑터가 ModelView를 직접 생성해서라도 리턴해야 한다.
- 이전에는 프론트 컨트롤러가 실제 컨트롤러를 호출했지만 이제는 이 어댑터를 통해서 실제 컨트롤러가 호출된다.

실제 어댑터를 구현해보자.
ControllerV3를 지원하는 어댑터는 다음과 같다.

ControllerV3HandlerAdapter

public class ControllerV3HandlerAdapter implements MyHandlerAdapter {
    
    @Override
    public boolean supports(Object handler) {
        return (handler instanceof ControllerV3);
    }
    
	@Override
    public ModelView handle(HttpServletRequest request, HttpServletResponse
  response, Object handler) {
  
        ControllerV3 controller = (ControllerV3) handler;
		
        Map<String, String> paramMap = createParamMap(request);
        
    	ModelView mv = controller.process(paramMap);
		return mv; 
	}
    private Map<String, String> createParamMap(HttpServletRequest request) {
        Map<String, String> paramMap = new HashMap<>();
        
        request.getParameterNames().asIterator()
                  .forEachRemaining(paramName ->paramMap.put(paramName,
  					request.getParameter(paramName)));
                    
        return paramMap;
    }
}

하나씩 분석해보자.

public boolean supports(Object handler) {
    return (handler instanceof ControllerV3);
}

ControllerV3를 처리할 수 있는 어댑터를 뜻한다.

ControllerV3 controller = (ControllerV3) handler;
Map<String, String> paramMap = createParamMap(request);
ModelView mv = controller.process(paramMap);
return mv;

handler를 컨트롤러 V3로 강제 타입 변환한 다음에 V3 형식에 맞도록 호출한다.
supports()를 통해 ControllerV3만 지원하기 때문에 타입 변환은 걱정없이 실행해도 된다.
ControllerV3는 ModelView를 리턴하므로 그대로 ModelView를 리턴하면 된다.

FrontControllerServletV5

@WebServlet(name = "frontControllerServletV5", urlPatterns = "/front-
controller/v5/ *")
public class FrontControllerServletV5 extends HttpServlet {
    
    private final Map<String, Object> handlerMappingMap = new HashMap<>();
    
    private final List<MyHandlerAdapter> handlerAdapters = new ArrayList<>();
    
    public FrontControllerServletV5() {
        initHandlerMappingMap();
        initHandlerAdapters();
	}
    
    private void initHandlerMappingMap() {
        handlerMappingMap.put("/front-controller/v5/v3/members/new-form", new
MemberFormControllerV3());
         handlerMappingMap.put("/front-controller/v5/v3/members/save", new
MemberSaveControllerV3());
        handlerMappingMap.put("/front-controller/v5/v3/members", new
MemberListControllerV3());
}

    private void initHandlerAdapters() {
        handlerAdapters.add(new ControllerV3HandlerAdapter());
	}
    
	@Override
    protected void service(HttpServletRequest request, HttpServletResponse
response) throws ServletException, IOException {

        Object handler = getHandler(request);
        
        if (handler == null) {
        	response.setStatus(HttpServletResponse.SC_NOT_FOUND);
			return;
        }
        
        MyHandlerAdapter adapter = getHandlerAdapter(handler);
        ModelView mv = adapter.handle(request, response, handler);
        
        MyView view = viewResolver(mv.getViewName());
        view.render(mv.getModel(), request, response);
    }
    
    private Object getHandler(HttpServletRequest request) {
        String requestURI = request.getRequestURI();
        return handlerMappingMap.get(requestURI);
	}
    private MyHandlerAdapter getHandlerAdapter(Object handler) {
        for (MyHandlerAdapter adapter : handlerAdapters) {
            if (adapter.supports(handler)) {
                return adapter;
			}
		}
 		
        throw new IllegalArgumentException("handler adapter를 찾을 수 없습니다. handler=" + handler);
		}
        
	private MyView viewResolver(String viewName) {
		return new MyView("/WEB-INF/views/" + viewName + ".jsp");
	}
}

생성자

public FrontControllerServletV5() { 	
	initHandlerMappingMap(); // 핸들러 매핑 초기화 	
    initHandlerAdapters(); // 어댑터 초기화
}

생성자는 핸들러 매핑과 어댑터를 초기화(등록)한다.

매핑 정보

private final Map<String, Object> handlerMappingMap = new HashMap<>();

매핑 정보값이 ControllerV3, ControllerV4같은 인터페이스에서 아무 값이나 받을 수 있는 Object 타입으로 변경되었다.

핸들러 매핑

Object handler = getHandler(request);

private Object getHandler(HttpServletRequest request) {
    String requestURI = request.getRequestURI();
    return handlerMappingMap.get(requestURI);
}

핸들러 매핑정보인 handlerMappingMap에서 URL에 매핑된 핸들러(컨트롤러) 객체를 찾아서 리턴한다.

핸들러를 처리할 수 있는 어댑터 조회

MyHandlerAdapter adapter = getHandlerAdapter(handlers);

for (MyHandlerAdapter adapter : handlerAdapters) {
    if (adapter.supports(handler)) {
        return adapter;
    }
}

handler를 처리할 수 있는 어댑터를 adapter.supports(handler)을 통해서 찾는다.
handler가 CotrollerV3 인터페이스를 구현했다면, ControllerV3HandlerAdapter객체가 리턴된다.

어댑터 호출

ModelView mv = adapter.handle(request, response, handler);

어댑터는 handle(request, response, handler) 메서드를 통해 실제 어댑터가 호출된다.
어댑터는 handler(컨트롤러)를 호출하고 그 결과를 어댑터에 맞추어 리턴한다.
ControllerV3Adapter의 경우 어댑터의 모양과 컨트롤러의 모양이 유사해서 변환 로직이 단순하다.

.
.
.
.
.

기존 ControllerV3는 ModelView를 리턴해서 어댑터의 역할을 크게 느끼지 못했을 것이다.
이제 FrontControllerServletV5에 String 타입을 리턴하는 ControllerV4 기능도 추가해보자.


private void initHandlerMappingMap() {
    handlerMappingMap.put("/front-controller/v5/v3/members/new-form", new
  MemberFormControllerV3());
    handlerMappingMap.put("/front-controller/v5/v3/members/save", new
  MemberSaveControllerV3());
    handlerMappingMap.put("/front-controller/v5/v3/members", new
  MemberListControllerV3());
  
//V4 추가
	handlerMappingMap.put("/front-controller/v5/v4/members/new-form", new
  MemberFormControllerV4());
    handlerMappingMap.put("/front-controller/v5/v4/members/save", new
  MemberSaveControllerV4());
    handlerMappingMap.put("/front-controller/v5/v4/members", new
  MemberListControllerV4());
}

private void initHandlerAdapters() {
	handlerAdapters.add(new ControllerV3HandlerAdapter()); 
	handlerAdapters.add(new ControllerV4HandlerAdapter()); //V4 추가
}

핸들러 매핑(handlerMapping)에 ControllerV4를 사용하는 컨트롤러를 추가
추가한 컨트롤러를 처리할 수 있는 어댑터인 ControllerV4HandlerAdapter도 추가

ControllerV4HandlerAdapter__

public class ControllerV4HandlerAdapter implements MyHandlerAdapter {

    @Override
    public boolean supports(Object handler) {
        return (handler instanceof ControllerV4);
    }
    
	@Override
    
    public ModelView handle(HttpServletRequest request, HttpServletResponse
response, Object handler) {
        ControllerV4 controller = (ControllerV4) handler;
        Map<String, String> paramMap = createParamMap(request);
        Map<String, Object> model = new HashMap<>();
        String viewName = controller.process(paramMap, model);
        
        ModelView mv = new ModelView(viewName);
        mv.setModel(model);
        
		return mv;
    }
    
    private Map<String, String> createParamMap(HttpServletRequest request) {
        Map<String, String> paramMap = new HashMap<>();
        request.getParameterNames().asIterator()
                .forEachRemaining(paramName -> paramMap.put(paramName,
					request.getParameter(paramName)));
        return paramMap;
    }
}

하나씩 분석해보자.

public boolean supports(Object handler) { 
	return (handler instanceof ControllerV4);
}

handler 가 ControllerV4 인 경우에만 처리하는 어댑터이다.

실행 로직

ControllerV4 controller = (ControllerV4) handler;

Map<String, String> paramMap = createParamMap(request);
Map<String, Object> model = new HashMap<>();

String viewName = controller.process(paramMap, model);

handler를 ControllerV4로 강제 타입 변환을 하고, paramMap, model을 만들어서 해당 컨트롤러를 호출한다.
viewName을 리턴받는다.

어댑터 변환

ModelView mv = new ModelView(viewName);
mv.setModel(model);

return mv;

어댑터에서 이 부분이 단순하지만 중요한 부분이다.
컨트롤러가 리턴하는 어떻게 하든 어댑터를 통해서 ModelView 객체를 리턴받을 수 있다.

어댑터가 호출하는 ControllerV4는 뷰의 이름을 반환한다. 그런데 어댑터는 뷰의 이름이 아니라 ModelView를 만들어서 반환해야 한다. 여기서 어댑터가 꼭 필요한 이유가 나온다.
ControllerV4는 뷰의 이름을 반환했지만, 어댑터는 이것을 ModelView로 만들어서 형식을 맞추어 반환한다.
(마치 110v 전기 콘센트를 220v 전기 콘센트로 변경하듯이)

김민우

이전 포스트

서블릿, JSP, MVC 패턴

다음 포스트

MVC 프레임워크 만들기

MVC

프론트 컨트롤러 패턴

프론트 컨트롤러 도입

V1

ControllerV1 인터페이스

MemberFormControllerV1 - 회원 등록 컨트롤러

MemberSaveControllerV1 - 회원 저장 컨트롤러

MemberListControllerV1 - 회원 목록 컨트롤러

FrontControllerServletV1 - 프론트 컨트롤러

V2

MyView

ControllerV2

MemberFormControllerV2 - 회원 등록 폼

MemberSaveFormControllerV2 - 회원 저장

MemberListControllerV2 - 회원 목록

V3

ModelView

ControllerV3

ModelFormControllerV3 - 회원 등록 폼

ModelSaveControllerV3 - 회원 저장

MemberListControllerV3 - 회원 목록

FrontControllerServletV3

MyView

V4

ControllerV4

MemberFormControllerV4

MemberSaveControllerV4

MemberListControllerV4

FrontControllerV4

V5

ControllerV3HandlerAdapter

FrontControllerServletV5

ControllerV4HandlerAdapter__

서블릿, JSP, MVC 패턴

스프링 MVC 구조 이해

0개의 댓글