[Spring] XML & Annotation 설정 (+ 어노테이션 정리)

 

목차

 

 

1. xml 기반 설정

`applicationContext.xml` 같은 설정파일에 Bean 을 설정하는 방법

<!-- applicationContext.xml -->
<beans xmlns="http://www.springframework.org/schema/beans"
       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.xsd">

    <!-- Bean 정의 -->
    <bean id="car" class="com.example.Car">
        <property name="engine" ref="engine" />
    </bean>

    <bean id="engine" class="com.example.EngineImpl" />
</beans>

 

`<beans>` : xml 설정의 최상위 요소, Bean 정의

`<bean>` : 실제 Bean 을 정의하는 요소 id 는 Bean 이름 / class 는 Bean 구현 클래스

`<property>` : 객체를 주입하는 부분 , ref 속성은 다른 Bean 이름을 참조하여 주입

 

 

 

2. 어노테이션 방식

 

Spring 에서는 다양한 스테레오타입 어노테이션 을 사용하여 Bean 을 정의할 수 있다. !

코드내에서 설정 처리를 하기 때문에, 설정이 간결하고 편리해진다. ☺️

 

* 스테레오타입 어노테이션 : Spring Framework에서 빈을 정의할 때 사용되는 특수한 종류의 어노테이션

 

• @Component:
  • 기본적인 Bean 등록 방식 , 클래스에 붙여서 Spring 컨테이너에 의해 자동으로 빈(Bean)으로 등록됩니다. @Service, @Repository, @Controller는 @Component의 특수화된 형태입니다.

 

• @Service:
  • 비즈니스 로직을 수행하는 서비스 클래스를 나타냅니다. @Component와 동일하게 빈으로 등록됩니다.

 

• @Repository:
  • 데이터 액세스 레이어의 빈을 나타냅니다. 데이터베이스 접근과 관련된 클래스를 정의하며, @Component와 동일하게 빈으로 등록됩니다.

 

• @Controller:
  • 웹 요청을 처리하는 컨트롤러 클래스를 나타냅니다. @Component와 동일하게 빈으로 등록되며, MVC 패턴의 컨트롤러로 사용됩니다.

 

• @Configuration:
  • 클래스가 하나 이상의 @Bean 메서드를 제공하는 설정 클래스를 나타냅니다. 애플리케이션 컨텍스트의 빈 설정을 구성합니다.

 

• @Bean:
  • 메서드에 붙여서 해당 메서드가 빈으로 등록되도록 합니다. @Configuration 클래스 내에서 사용됩니다.

 

• @Autowired:
  의존성 주입을 자동으로 처리합니다. 필드, 생성자, 메서드에 사용하여 의존성을 주입합니다.

* Autowried * 빈객체를 자동으로 주입하게 되는데, 먼저 타입으로 찾아서 주입, 이름으로 찾아서 주입 * *
생성자, 메서드, 멤버변수에 모두 사용가능함 *
멤버변수에 autowried사용할 때는 기본생성자가 반드시 필요함
* * required = false옵션은
* 스프링이 주입할 빈이 없으면 에러를 발생시키는데, 이거를 무시하고 지나가 주세요 라는 속성입니다 *

 

 

• @Qualifier:
  • 여러 빈이 있을 때 특정 빈을 선택하여 주입할 수 있도록 도와줍니다. @Autowired와 함께 사용됩니다.
  • * Qualifier - 빈 강제 연결
  • 컨테이너에 동일 객체가 여러개 있을 때, 이름으로 강제 주입을 넣어주는 어노테이션

 

• @Value:
  • 외부 프로퍼티 파일 또는 환경 변수에서 값을 주입받습니다. 문자열, 숫자, 리스트 등 다양한 타입을 지원합니다.
• @PostConstruct:
  • 빈 초기화 후 호출될 메서드를 정의합니다. 빈 생성 후 추가적인 설정 작업을 수행할 때 사용됩니다.
• @PreDestroy:
  • 빈 소멸 전에 호출될 메서드를 정의합니다. 빈이 컨테이너에서 제거될 때 리소스를 정리하거나 클린업 작업을 수행할 때 사용됩니다.

 

 

 

 

 

 

그 외 어노테이션

2. Spring Web 어노테이션

• @RequestMapping:
  • HTTP 요청을 처리하는 메서드나 클래스의 경로를 매핑합니다. HTTP 메서드(GET, POST 등)와 요청 경로를 지정할 수 있습니다.
• @GetMapping, @PostMapping, @PutMapping, @DeleteMapping:
  • 각각 GET, POST, PUT, DELETE 요청을 처리하는 메서드를 지정합니다. @RequestMapping의 축약형입니다.
• @PathVariable:
  • URL 경로에서 변수를 추출하여 메서드 매개변수에 주입합니다. RESTful 웹 서비스에서 유용합니다.
• @RequestParam:
  • HTTP 요청 파라미터를 메서드 매개변수에 주입합니다. 쿼리 파라미터 또는 폼 파라미터를 처리할 때 사용됩니다.
• @RestController :
  Spring Framework에서 RESTful 웹 서비스를 구현할 때 사용되는 애노테이션입니다. @RestController는 @Controller와 @ResponseBody의 조합으로, REST API의 엔드포인트를 구현할 때 사용됩니다. 이 애노테이션을 사용하면 메서드가 반환하는 값이 JSON, XML, 또는 다른 형식으로 직접 클라이언트에 응답으로 전달됩니다.

 

• @RequestBody:
  • HTTP 요청 본문을 메서드 매개변수에 매핑합니다. JSON, XML 등의 데이터 포맷을 처리할 때 사용됩니다
• @ResponseBody:
  • 메서드 반환 값을 HTTP 응답 본문으로 직렬화합니다. 주로 RESTful 웹 서비스에서 사용됩니다.
• @ModelAttribute:
  • 요청 파라미터를 객체에 바인딩합니다. 폼 데이터의 처리를 쉽게 할 수 있습니다.
• @SessionAttributes:
  • 세션에 저장할 모델 속성을 지정합니다. 특정 모델 속성을 세션에 유지할 때 사용됩니다.
• @RequestHeader:
  • HTTP 요청 헤더를 메서드 매개변수에 주입합니다.
• @CookieValue:
  • HTTP 쿠키 값을 메서드 매개변수에 주입합니다.

 

3. Spring Data Access 어노테이션

• @Transactional:
  • 트랜잭션 관리를 지원합니다. 메서드 또는 클래스에 붙여서 트랜잭션을 자동으로 시작하고 커밋/롤백을 관리합니다.
• @Repository:
  • 데이터베이스 접근을 수행하는 컴포넌트를 나타내며, 예외를 데이터 접근 예외로 변환합니다.

 

4. Spring Security 어노테이션

• @Secured:
  • 메서드 또는 클래스 수준에서 권한을 지정합니다. 지정된 권한이 없는 사용자가 메서드에 접근할 수 없도록 합니다.
• @PreAuthorize:
  • 메서드 실행 전에 SpEL(Spring Expression Language)을 사용하여 권한을 체크합니다.
• @RolesAllowed:
  • 특정 역할에 대한 접근 제어를 설정합니다. @Secured의 대안으로 사용됩니다.

 

5. Spring Boot 어노테이션

• @SpringBootApplication:
  • Spring Boot 애플리케이션의 기본 설정을 제공합니다. @Configuration, @EnableAutoConfiguration, @ComponentScan의 조합입니다.
• @EnableAutoConfiguration:
  • Spring Boot의 자동 구성 기능을 활성화합니다. 애플리케이션의 설정을 자동으로 구성합니다.
• @ComponentScan:
  • 특정 패키지 내의 컴포넌트를 자동으로 스캔하고 빈으로 등록합니다. Spring Boot에서는 자동으로 패키지를 스캔합니다.
• @ConfigurationProperties:
  • 외부 프로퍼티 파일에서 설정 값을 바인딩합니다. 타입 안전하게 프로퍼티를 주입할 수 있습니다.
• @SpringBootTest:
  • Spring Boot 애플리케이션의 통합 테스트를 위한 어노테이션입니다. 실제 애플리케이션 컨텍스트를 로드하여 테스트를 수행합니다.

 

6. 기타 유용한 어노테이션

• @Slf4j:
  • Lombok 라이브러리의 어노테이션으로, 로그를 자동으로 생성할 수 있게 해줍니다.
• @Data:
  • Lombok의 어노테이션으로, getter, setter, toString, equals, hashCode 메서드를 자동으로 생성합니다.
• @Builder:
  • Lombok의 어노테이션으로, 빌더 패턴을 적용할 수 있게 해줍니다.