Java Framework [스프링] 어노테이션

■ Spring annotation
   spring web mvc Framework는 java 5+ 부터 annotaion을 제공 하며, annotation의 사용으로 설정파일을 간결화하고, view 페이지와 객체 또는 메소드의 맵핑을 명확하게 할 수 있다.

   - 4개의 스테레오타입 어노테이션
     @Component : 스테레오타입 어노테이션의 조상
     @Controller : Spring MVC에서 컨트롤러로 인식
     @Service : 역할 부여 없이 스캔 대상이 되는데 비즈니스 클래스에 사용
     @Repository : 레포지 토리 어노테이션은 일반적으로 DAO에 사용되며 DB Exception을 DataAccessException으로 변환

   ο @Required
      패키지 : org.springframework.beans.factory.annotaion
      버전 : spring 2.0

      리콰이얼드 어노테이션은 필수 프로퍼티임을 명시하는 것으로 아래와 같이 set 메소드에 붙이면 된다. 필수 프로퍼티를 설정하지 않을 경우 빈 생성시 예외를 발생시킨다.

     스프링 설정파일에

     <bean class="org.springframework.beans.factory.annotaion.RequiedAnnotaionBeanPostProcessor" />
     를 등록하거나
     <context:annotation-config />태그를 선언해야 스프링이 @Required를 인식한다.

     - 1단계 : 코드내에 프로퍼티 설정 메소드에 @Required 어노테이션을 붙인다.
     import org.springframework.beans.factory.annotation.Required
     public class TestBean {
         private TestDao testDao;
 
         @Required
         public void setTestDao(TestDao testDao) {
            this.testDao = testDao;
         }
     }
 

    - 2단계 : 스프링 설정 파일에 RequiredAnnotationBeanPostProcessor 클래스를 빈으로 등록
    <bean class="org.springframework.beans.factory.annotaion.RequiredAnnotationBeanpostProcessor"/>

    <bean name="testBean"  class="han.test.TestBean">
        <property name="testDao" ref="testDao"/> <!--@Required 어노테이션을 적용하였으므로 설정하지 않으면 예외를 발생시킨다.-->
    </bean>

     RequiredAnnotationBeanPostProcessor 클래스는 스프링 컨테이너에 등록된 bean 객체를 조사하여 @Required 어노테이션으로 설정되어 있는 프로퍼티의 값이 설정되어 있는지 검사하고 설정되어있지 않으면 bean 생성시 예외를 발생시킨다.
 

     RequiredAnnotationBeanPostProcessor 클래스를 빈으로 등록하지 않고
     <context:annotation-config> 다음과 같이 태그를 이용할 수도 있다.

     <?xml version="1.0" encoding="UTF-8"?>
     <beans xmlns="http://www.springframework.org/schema/beans"
            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
               http://www.springframework.org/schema/beans/spring-beans-2.5xsd
               http://www.springframework.org/schema/context
               http://www.springframework.org/schema/context/spring-context-2.5.xsd">
       <context:annotation-config/>
     </beans>

   ο @Repository
      패키지 : org.springframework.stereotype
      버전 : spring 2.0

      레포지 토리 어노테이션은 일반적으로 DAO에 사용되며 DB Exception을 DataAccessException으로 변환한다.

   ο @Autowired
      패키지 : org.springframework.beans.factory.annotaion
      버전 : spring 2.5

       오토 와이어링 어노테이션은 Spring에서 의존관계를 자동으로 설정할때 사용된다. 이 어노테이션은 생성자, 필드, 메소드 세곳에 적용이 가능하며, 타입을 이용한 프로퍼티 자동 설정기능을 제공한다. 즉, 해당 타입의 빈 객체가 없거나 2개이상일경우 예외를 발생시킨다
      프로퍼티 설정 메소드(ex: setXXX()) 형식이 아닌 일반메소드에도 적용가능하다.
      프로퍼티설정이 필수가 아닐경우 @Autowired(required=false)로 선언한다. (기본값은 true)

       byType으로 의존관계를 자동으로 설정할 경우 같은 타입의 빈이 2개 이상 존재하게 되면 예외가 발생하는데, Autowired도 이러한 문제가 발생한다. 이럴 때 @Qualifier를 사용하면 동일한 타입의 빈 중 특정 빈을 사용하도록 하여 문제를 해결할 수 있다.

       @Autowired
       @Qualifier("test")
       private Test test;

       설정 방법은

       <bean class=org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor />
        를 등록하거나     
        <context:component-scan base-package="패키지명" />  태그를 사용 한다.

   ο @Qualifier
      패키지 : org.springframework.beans.factory.annotaion
      버전 : spring 2.5

       @Autowired이 타입기반이기 때문에 2개이상의 동일타입 빈 객체중 특정빈을 사용하도록 선언한다.
       @Qualifier("mainBean")의 형태로 @Autowired와 같이 사용하며 해당 <bean>태그에 <qualifire value="mainBean" /> 태그를 선언해주어야 한다.
       Method에서 두개이상의 파라미터를 사용할 경우는 파라미터 앞에 선언해야한다.

   ο @Component
      패키지 : org.springframework.stereotype
      버전 : spring 2.5
      클래스에 선언하며 해당 클래스를 자동으로 bean으로 등록한다.

      <context:component-scan base-package="xxx" />를 선언해야하며 xxx패키지 하위에서 @Component로 선언된 클래스를 bean으로 자동 등록한다.
      bean의 이름은 해당클래스명(첫글자는 소문자)이 사용된다.
      범위는 디폴트로 singleton이며 @Scope를 사용하여 지정할 수 있다.

   ο @Service
      @Service를 적용한 Class는 비지니스 로직이 들어가는 Service로 등록이 된다.

      Controller에 있는 @Autowired는 @Service("xxxService")에 등록된 xxxService와 변수명이 같아야 하며
      Service에 있는 @Autowired는 @Repository("xxxDao")에 등로된 xxDao와 변수명이 같아야 한다.

      @Service("helloService")
      public class HelloServiceImpl implements HelloService {
    @Autowired
    private HelloDao helloDao;
           public void hello() {
  System.out.println("HelloServiceImpl :: hello()");
  helloDao.selectHello();
     }
      }

      helloDao.selectHello(); 와 같이 @Autowired를 이용한 객체를 이용하여 Dao 객체를 호출한다.

   ο @Resource
      자바 6버전 및 JEE5 버전에 추가된 것으로 어플리케이션에서 필요로 하는 자원을 자동 연결할 때 사용 한다. 스프링 2.5 부터 지원하는 어노테이션으로 스프링에서는 의존하는 빈 객체를 전달할 때 사용하다.

      name속성에 자동으로 연결될 빈객체의 이름을 입력한다.
      @Resource(name="testDao")

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다.
어린이용이며, 설치가 필요없는 브라우저 게임입니다.
https://s1004games.com

      CommonAnnotationBeanPostProcessor 클래스를 설정파일에 빈객체로 등록하여 어노테이션을 적용시킨다.

      <bean class="org.springframework.beans.factory.annotation.CommonAnnotationBeanPostProcessor"/>

      혹은 <context:annotation-config> 태그를 이용한다.

   ο @Controller
      패키지 : org.springframework.stereotype
      버전 : spring 2.5

      spring MVC의 Controller 클래스 선언을 단순화시켜준다. 스프링 컨트롤러, 서블릿을 상속할 필요가 없으며, @Controller로 등록된 클래스 파일에 대한 bean을 자동으로 생성해준다.
      Controller로 사용하고자 하는 클래스에 @Controller 지정해 주면 component-scan으로 자동 등록된다.

     - xml 설정
       <context:component-scan base-package="han.*"/>

     - java
       package han.test;

       import org.springframework.stereotype.Controller;

       @Controller
       public class SpringC {
       }

   ο @RequestMapping
      RequestMapping annotation은 url을 class 또는 method와 mapping 시켜주는 역활을 한다.
      annotation을 쓰지 않을때 지정했던 Controller등록을 위한 url bean 설정을 생략 할 수 있다.

      class에 하나의 url mapping을 할 경우, class위에 @RequestMapping("/url")을 지정하며, GET 또는 POST 방식 등의 옵션을 줄 수 있다.
      해당되는 method가 실행된 후, return 페이지가 따루 정의되어 있지 않으면 @RequestMapping("/url")에서 설정된 url로 다시 돌아간다.

     - 예
       @Controller
       @RequestMapping("/han/test/*")
       public class helloController{
           @RequestMapping(method=RequestMethod.GET, value="go")
           public returntype getMethodName(){
               :
           }

           @RequestMapping(method=RequestMethod.POST, value="go2")
           public returntype getMethodName2(){
                :
           } 
       }

   ο @RequestParam
      RequestParam annotation은 key=value 형태로 화면에서 넘어오는 파라미터를 맵핑 된 메소드의 파라미터로 지정해 준다.
      주로get방식으로 들어오는 request에서 사용한다.

      아래 예제코드에서 xxx/editBlog.do?blogId=3 과 같이 접근할 때, editBlogHandler 메소드의 파라미터인 blogId에는 3이 셋팅된다. 필수 요건이 아닐 경우, @RequestParam(value="id", required="false")와 같이 옵션을 주고 사용할 수 있다.

      @Controller
      public class BlogController {
 /* 중간생략 */
 
 @RequestMapping("/editBlog")
 public ModelMap editBlogHandler(@RequestParam("blogId") int blogId) {
  blog = blogService.findBlog(blogId);
  return new ModelMap(blog);
 }
 
 /* 중간생략 */
     }

   ο @ModelAttribute
      ModelAttribute annotation은 화면의 form 속성으로 넘어온 model을 맵핑된 method의 파라미터로 지정해주는 역활을 한다.
      주로POST 타입으로 넘어오는 form 속성의 model 값을 받아 올때 사용된다.(get/post 모두 통용된다.)

     @Controller
     public class BlogController {
 /* 중간생략 */
 
 @RequestMapping("/updateBlog")
 public String updateBlogHandler(@ModelAttribute("blog") Blog blog) {
  blogService.updateBlog(blog);
  return "redirect:findBlogs.do";
 }
 
 /* 중간생략 */
    }

   ο @SessionAttributes
      SessionAttribute annotation은 세션상에서 model의 정보를 유지하고 싶을 경우 사용 할 수 있다.

     @Controller
     @SessionAttributes("blog")
     public class BlogController {
 /* 중간생략 */
 
 @RequestMapping("/createBlog")
 public ModelMap createBlogHandler() {
  blog = new Blog();
  blog.setRegDate(new Date());
  return new ModelMap(blog);
 }
 
 /* 중간생략 */
    }

   ο @InitBinder
      @InitBinder annotation은 WebDataBinder를 초기화하는 method를 지정 할 수 있는 설정을 제공한다. 일반적으로 WebDataBinder는 annotation handler 메소드의 command 와 form 객체 인자를 조작하는데 사용된다.
InitBinder 메소드가 필수적으로 반환값을 가질 필요는 없으며, 일반적으로 이런 경우에 void를 선언한다. 특별한 인자는 WebdataBinder와 WebRequest또는 Locale의 조합으로 이루어지며, 이러한 조건이 만족되면 context-specific editors를 등록하는것이 허용된다.

      WebdataBinder : WebDataBinder는 web request parameter를 javaBean 객체에 바인딩하는 특정한 DataBinder이다. WebDataBinder는 웹 환경이 필요하지만, Servlet API에 의존적이지 않다.Sservlet API에 의존적인 ServletRequestDataBinder와 같이 특정한 DaraBinder를 위한 더많은 base class를 제공한다.

      RequestMapping : RequestMapping annotation은 web request를 특정한 handler class와 handler method에 mapping하는 역활을 수행한다. 대응하는 handlerMapping(for type level annotation)과 HandlerAdapter(for method level annotation)가 dispatch에 존재한다면, @RequestMapping이 처리될 것이다.

      WebRequest : WebRequest는 웹 요청에 대한 Generic interface이다. 주로 일반 request metadata에 generic web request interceptors의 접근을 허용하여 metadata에 대한 처리를 하기 위한 것이지 request자체를 처리하기 위한 것은 아니다.

   ο @PostConstruct, @PreDestroy
      패키지 : javax.annotation
      버전 : jdk1.6, spring 2.5
      객체를 생성한 이후와 소멸되기 전에 호출할 메소드를 지정한다.

   ο Annotation 기반 Controller 에서 ServletContext 구하기

       :
    @Controller
    @RequestMapping("/common/download")
    public class DownloadController {
        @Autowired
        private ServletContext sc;

        @RequestMapping
        public ModelAndView download(@RequestParam("filePath") String filePath) throws Exception {
            String path = sc.getRealPath(filePath);
            return new ModelAndView("common.download", "downloadFile", new File(path));
        }
    }