[Spring] 어노테이션의 용도

Annotation

Annotation이란 사전적 의미로는 "주석" 이란 뜻이지만, 

자바에서는 "코드 사이에 특별한 의미, 기능을 수행하도록 하는 기술"이란 뜻을 의미한다. 

프로그램 코드의 일부가 아닌 프로그램에 관한 데이터를 제공하고, 코드에 정보를 추가하는 정형화된 방법이다. 

 

Annotation을 사용하는 이유

1. 코드가 깔끔해지며 재사용이 가능하다.

2. 컴파일러에게 코드 작성 문법 에러를 체크하도록 정보를 제공한다.

3. 런타임 시 특정 기능을 실행하도록 정보를 제공한다.

4. 소프트웨어 개발 툴이 빌드나 배치시 코드를 자동으로 생성할 수 있도록 정보를 제공한다. 

 

Annotation 종류

-> 많은 Annotation중에서 자주 쓰이면서, 중요한 Annotation을 정리해보았다

@Component

: 스프링에서 관리하는 객체임을 표기하는 가장 기본적인 범용 스테레오타입 어노테이션이다. 

스프링 빈으로 등록시키는 역할을 수행한다. 

Application Contect에서 스프링 빈을 등록할 때, 빈으로 등록할 후보 클래스들을 탐지하여 등록한다. 

import org.springframework.stereotype.Component;

@Component
public class MessageService {
    
    public String getMessage() {
        return "Hello, world!";
    }
}

@RequestMapping

: 어떤 URL을 어떤 method가 처리할 지 매핑해주는 어노테이션이다. 

Controller나 Controller의 메소드에 적용한다. 

요청을 받는 형식인 Get/Post/Put/Patch/Delete를 정의해주기도 한다. (Default = Get) 

@RequestMapping("/")
public String index(Model model) {
	model.addAttribute("list", boardService.listAll());
    return "index";
 }

@RestController

:Spring MVC에서 자주 사용되며, 해당 클래스가 RESTful 웹 서비스의 엔드 포인트를 처리하는 컨트롤러임을 나타낸다.

이 어노테이션이 붙은 클래스는 HTTP 요청에 대한 응답으로 JSON 또는 XML 형식의 데이터를 반환한다. 

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, world!";
    }
}

@Service

: 스프링에서 서비스를 지정해주는 annotation이다. 

@Component 어노테이션과 거의 차이가 별로 없지만 비즈니스 로직을 수행하는 서비스 레이어 클래스임을 직접적으로 나타내준다. 

캡슐화 없이 모델 내 단독 인터페이스로서 제공되는 동작을 의미한다. 

//예제 -> @service어노테이션을 사용한 간단한 계산기 서비스 제공
import org.springframework.stereotype.Service;

@Service
public class CalculatorService {

    public int add(int num1, int num2) {
        return num1 + num2;
    }

    public int subtract(int num1, int num2) {
        return num1 - num2;
    }

    public int multiply(int num1, int num2) {
        return num1 * num2;
    }

    public double divide(double num1, double num2) {
        if (num2 == 0) {
            throw new IllegalArgumentException("Cannot divide by zero");
        }
        return num1 / num2;
    }
}

@Repository

: 특정 예외를 잡아 스프링의 unchecked 예외로 다시 던진다. 

spring에게 이 클래스가 데이터 액세스를 담당하는 Repository로 사용될 것임을 명시해준다. 

import org.springframework.stereotype.Repository;

import java.util.ArrayList;
import java.util.List;

@Repository
public class UserRepository {

    private List<User> users = new ArrayList<>();

    public UserRepository() {
        // 초기 사용자 데이터 추가
        users.add(new User(1, "John"));
        users.add(new User(2, "Alice"));
        users.add(new User(3, "Bob"));
    }

    public List<User> getAllUsers() {
        return users;
    }

    public User getUserById(int id) {
        for (User user : users) {
            if (user.getId() == id) {
                return user;
            }
        }
        return null;
    }

    public void addUser(User user) {
        users.add(user);
    }

    public void deleteUserById(int id) {
        users.removeIf(user -> user.getId() == id);
    }
}

@Entity

: JPA를 사용해 실제 DB테이블과 매핑 할 Class이다 라는 것을 나타낸다. 

이 어노테이션을 사용함으로써 JPA가 해당 클래스를 관리하게 된다. 

@Entity(name="user")
public class User{}

//final, enum, interface, inner class에서는 사용할 수 없다. 
//기보 생성자가 꼭 필요하다
//필드(변수)를 final 로 선언할 수 없다.