어노테이션으로 서비스 객체 생성하기(@Service) / 컨트롤러 정리하기 (@Controller)

이전 포스팅에서는 생성된 객체에 DI만 어노테이션으로 처리했다면, 이번에는 객체 생성까지 어노테이션으로 처리해 보도록 하겠다.

 

 

service-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd
		http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd"> 
        
    <!-- <context:annotation-config /> --> <!-- 생성한 객체를 어노테이션(autowired)을 통해 set 해달라는 태그 -->
    <context:component-scan base-package="com.newlecture.web.service"></context:component-scan>
    <!-- base-package 안에서 @가 붙은 클래스를 찾아 객체 인스턴스를 생성해 달라는 태그 
    	컴포넌트 스캔하게 되면 @Autowired도 찾기 때문에
    	DI에 사용했던 annotation-config 태그는 삭제해도 된다.
    -->
    
<!--     
	<bean id="noticeService" class="com.newlecture.web.service.jdbc.JDBCNoticeService">
		<property name="dataSource" ref="dataSource"/>
	</bean> 
-->
    
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    	<property name="driverClassName" value="oracle.jdbc.driver.OracleDriver" />
    	<property name="url" value="jdbc:oracle:thin:@14.35.198.58:1522/orcl" />
    	<property name="username" value="USER01" />
    	<property name="password" value="1111" />
    </bean>
</beans>

 

<context:component-scan> 태그를 추가한다. base-package 안에 있는 클래스 중에서 @가 붙은 파일을 찾아 객체 인스턴스를 생성해 달라는 태그이다. 컴포넌트 스캔을 하게 되면 자연히 그 안에서 @Autowired가 붙은 메소드를 찾기 때문에 <context:annotation-config/> 태그는 지워도 된다. 어노테이션 컨피그보다 상위 태그라고 생각하면 된다.

 

 

JDBCNoticeService.java

package com.newlecture.web.service.jdbc;

//객체를 생성하여 IoC 컨테이너에 담는 컴포넌트 어노테이션
//@Component //@Controller, @Service, @Repository
@Service
public class JDBCNoticeService implements NoticeService{
	
	@Autowired
	private DataSource dataSource;
	

 

@Component 어노테이션을 붙이면 객체가 생성된다. 하지만 지금은 MVC 패턴으로 개발을 하고 있고, MVC에서의 역할을 강조하기 위해서는 @Service 어노테이션을 붙이는 것이 바람직하다.

 

 

 

이제 servlet-context와 IndexController도 수정해야 한다. 하지만 앞서 수정한 방법과는 다르다. 우선 servlet-context.xml 파일의 IndexController 빈 생성 태그를 살펴보도록 하겠다.

	<bean id="/index" class="com.newlecture.web.controller.IndexController" />  

 

servlet-context에서는 요청 url인 "/index"가 빈의 id이다. @Service 어노테이션만으로 객체 생성을 했던 JDBCNoticeService 객체와는 성질이 다르다.

 

 

servlet-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:context="http://www.springframework.org/schema/context"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        https://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd"> 
    
    <!-- <context:annotation-config /> -->
    <context:component-scan base-package="com.newlecture.web.controller"></context:component-scan>
    
	<!--     
	<bean id="/index" class="com.newlecture.web.controller.IndexController" />  
	-->    
	<bean id="/notice/list" class="com.newlecture.web.controller.notice.ListController">
    	<!-- 
    	<property name="noticeService" ref="noticeService" /> 
		 -->
    </bean>  
    <bean id="/notice/detail" class="com.newlecture.web.controller.notice.DetailController" />  
    
    
    <!-- Tiles ViewResolver -->    
    <bean class="org.springframework.web.servlet.view.UrlBasedViewResolver">
		<property name="viewClass" value="org.springframework.web.servlet.view.tiles3.TilesView" />
		<property name="order" value="1" />
	</bean>

	<bean class="org.springframework.web.servlet.view.tiles3.TilesConfigurer">
		<property name="definitions" value="/WEB-INF/tiles.xml" />
	</bean>
    
    <!-- View Resolver -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    	<property name="prefix" value="/WEB-INF/view/"></property>
    	<property name="suffix" value=".jsp"></property>
    	<property name="order" value="2" />
    </bean>
    
    <mvc:resources location="/static/" mapping="/**"></mvc:resources>
    <mvc:annotation-driven />
    
    
</beans>

 

service-context.xml과 마찬가지로 annotation-config 태그를 지우고, component-scan 태그를 추가한다. <bean id="/index"...> 태그를 지운다. <mvc:annotation-driven /> 태그를 추가한다.

 

 

IndexController.java

package com.newlecture.web.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class IndexController /*implements Controller*/{

	@RequestMapping("/index")
	public void aaaa() {
		System.out.println("hihi");
	}
	
	/*
	@Override
	public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
//		System.out.println("index controller");
		ModelAndView mv = new ModelAndView("root.index"); //뷰 리졸버를 사용하여 설정했기 때문에 앞의 /WEB-INF/view/와 뒤의 .jsp를 안 써도 된다.
		mv.addObject("data", "Hello Spring MVC"); //view에서 출력할 data를 담는다.
		//mv.setViewName("/WEB-INF/view/index.jsp");

		return mv;
	}
	*/
}

 

/index 경로를 받는 컨트롤러를 생성하기 위해서는 Controller라는 인터페이스를 상속하여 handleRequest를 오버라이드하고 ModelAndView 객체를 통해 뷰 페이지를 세팅해야 했다.

 

하지만 @Controller 어노테이션을 이용하면 과정이 한결 간단해진다.

 

우선 implements Controller는 더이상 하지 않아도 되며, 그에 따른 handleRequest 메소드 역시 불필요해진다. void 타입으로 메소드를 생성하고(메소드의 이름은 관계없다) @RequestMapping으로 url 주소를 세팅한다. 이렇게 @Controller 어노테이션 사용과 그에 따라 @RequestMapping 어노테이션 설정을 위해 xml에서 <mvc:annotation-driven /> 태그를 추가하는 것이다.

 

그리고 실행하면 아래와 같은 화면이 뜬다.

 

 

 

 

tiles 세팅이 되지 않은 index.jsp 페이지가 뜨고, @RequestMapping("/index") 어노테이션이 붙은 메소드에서 실행하는 Sysout 콘솔 출력도 잘 된다.

 

ModelAndView와 같이 뷰 페이지 설정을 따로 하지 않아도 매핑 경로에 따라 뷰 페이지 설정을 하는 것을 확인할 수 있다. 만약 매핑이 "/aaa"으로 되어있었다면 "/WEB-INF/view/aaa.jsp"를 찾을 것이고, 그 경로에 페이지가 없다면 404 에러가 뜨게 된다.

 

우선순위 1인 tiles 설정이 안 되니 우선순위 2인 뷰 리졸버 설정으로 가서 prefix, suffix를 거쳐 index.jsp 페이지를 띄운다. (tiles.xml에 definition name이 root.index으로 설정되어 있어서 tiles 설정이 안 먹힘)

 

 

 

* HomeController 만들기

 

 

IndexController.java

@Controller
public class IndexController {

	@RequestMapping("/index")
	public void aaaa() {
		System.out.println("hihi");
	}
    
	@RequestMapping("/help")
	public void bbbb() {
		System.out.println("hello");
	}

 

@Controller 어노테이션을 이용하여 앞으로는 한 컨트롤러 파일 안에 여러 개의 메소드가 있을 수 있고, 각각의 메소드마다 매핑을 할 수 있다. 위의 예시를 살펴보면 "/index", "/help" 두 개의 요청이 있기 때문에 파일 이름이 IndexController인 것은 적절하지 않아 보인다. 디렉토리의 폴더명 등으로 컨트롤러 파일 이름을 지을 수 있을 것이며 현재 "/index" 요청을 받는 뷰 파일인 index.jsp 파일은 webapp/WEB-INF/view/index.jsp의 경로에 있으므로 RootController, HomeController 등으로 명명할 수 있다. HomeController으로 이름을 바꾸도록 한다.

 

 

HomeController.java

@Controller
public class HomeController{

	@RequestMapping("/index")
	public String index() { //메소드 이름을 매핑명과 동일하도록 수정
		return "root.index";
	}

/*
	@Override
	public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
		ModelAndView mv = new ModelAndView("root.index");
		mv.addObject("data", "Hello Spring MVC"); //view에서 출력할 data를 담는다.

		return mv;
	}
*/
}

 

ModelAndView 객체에 "root.index"를 설정하여 반환했던 handleRequest 메소드와 달리 String 형식으로 "root.index"를 반환하면 tiles 설정 역시 적용된다.

 

 

 

* Notice 컨트롤러 정리하기

 

컨트롤러는 view 파일을 기준으로 생성하면 된다.

 

다음과 같은 디렉토리 구조일 때는 EventController, FaqController, NoticeController 클래스를 생성하고, NoticeController 클래서 안에 detail, list 메소드를 만들면 된다. event, faq, inc, notice를 포함하고 있는 customer는 패키지로 생성하면 된다.

 

IndexController를 HomeController으로 이름 변경하고 메소드를 수정한 것과 같이 notice 관련 컨트롤러도 수정하도록 한다.

 

 

NoticeController.java

package com.newlecture.web.controller.customer;

import java.sql.SQLException;
import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import com.newlecture.web.entity.Notice;
import com.newlecture.web.service.NoticeService;

@Controller
public class NoticeController{

	@Autowired
	private NoticeService noticeService;

	//url 구조는 파일 구조와 같게 해야 파일 찾아가기 쉽다.
	@RequestMapping("/customer/notice/list")
	public String list() throws ClassNotFoundException, SQLException {
		
		List<Notice> list = noticeService.getList(1, "TITLE", "");
		
		return "notice.list";
	}

	@RequestMapping("/customer/notice/detail")
	public String detail() {
		return "notice.detail";
	}
}

 

 

servlet-context.xml

	<!--     
	<bean id="/index" class="com.newlecture.web.controller.IndexController" />  
	-->    
	<!-- 
	<bean id="/notice/list" class="com.newlecture.web.controller.notice.ListController">
		<property name="noticeService" ref="noticeService" /> 
	</bean>
	-->  
	<!-- 
	<bean id="/notice/detail" class="com.newlecture.web.controller.notice.DetailController" />  
	-->

 

 

header.jsp

<li><a href="/customer/notice/list"><img src="/images/txt-customer.png" alt="고객센터" /></a></li>

 

기존에 ListController, DetailController에서 각각 있었던 내용을 NoticeController 안에 메소드로 만들어서 합친다. "/notice/list"였던 매핑을 "/customer/notice/list"으로 변경한 이유는, 파일 구조와 url 구조가 동일해야 디렉토리에서 파일을 찾기가 쉽기 때문이다. header.jsp에서 고객센터 a 태그의 url을 역시 마찬가지로 수정한다.

 

tiles에서 이름을 찾는 기준으로 String 값을 리턴하게 한다. ("notice.list"와 "notice.detail")

@Controller으로 객체를 생성하고 @Autowired으로 의존성을 주입하므로 xml에서의 bean 설정은 더이상 필요치 않다. 삭제 또는 주석처리 한다.

 

이렇게 되면 여러 개였던 컨트롤러 자바 파일이 하나로 축소되어 훨씬 관리하기 편하다.

 

 

notice 패키지 삭제 전

notice 패키지 삭제 후

 

 

지금 이 상태로도 실행에 전혀 문제는 없지만 한 가지 더 수정하면 좋을 것이 있다. 컨트롤러에서 url이 공통되는 부분을 따로 떼어낼 수 있는 방법이 있다.

 

 

NoticeController.java

package com.newlecture.web.controller.customer;

import java.sql.SQLException;
import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import com.newlecture.web.entity.Notice;
import com.newlecture.web.service.NoticeService;

@Controller
@RequestMapping("/customer/notice/") //클래스에 매핑 어노테이션을 붙인다.
public class NoticeController{

	@Autowired
	private NoticeService noticeService;

	@RequestMapping("list") 
	//위의 "/customer/notice/"와 이어져서 매핑된다.
	public String list() throws ClassNotFoundException, SQLException {
		
		List<Notice> list = noticeService.getList(1, "TITLE", "");
		
		return "notice.list";
	}

	@RequestMapping("detail")
	public String detail() {
		return "notice.detail";
	}
}

 

list 메소드의 매핑은 "/customer/notice/list"이고 detail 메소드의 매핑은 "/customer/notice/detail"으로 "/customer/notice/" 라는 공통 부분이 있다. 그 부분은 떼어서 클래스명에 매핑하고 메소드에는 list, detail만 남겨둔다. 이렇게 하면 url 매핑될 때 클래스에 붙은 "/customer/notice/"과 이어져서 매핑이 된다.

 

마찬가지 방법으로 HomeController도 수정한다.

 

 

HomeController.java

@Controller
@RequestMapping("/")
public class HomeController{

	@RequestMapping("index")
	public String index() {
		return "root.index";
	}
}

 

클래스에 "/"으로 매핑하고 메소드에 "index"으로 매핑하면, 둘이 이어져서 "/index"으로 매핑 된다.