어느덧 마지막 학기를 시작한지 거의 한달이 되어간다. 추석도 있고 가족여행도 갔다와서 금방 지나간것 같다. 졸업을 해야되어서 지금 준비중인 논문 프로젝트와 졸업시험, 자격증, 취업 같은 걱정들이 너무 많다. 지금 진행중인 프로젝트도 잘됐음 좋겠고 모든게 다 잘되길 그리고 취업을 할 수 있었음 좋겠다. 그리고 내 주위 모두가 건강했으면 좋겠다.

백엔드 스터디 (4)

---

이번 포스팅에서는 Spring Boot에서 자주 사용되는 주요 어노테이션과 REST API에서 자주 활용되는 컨트롤러 어노테이션을 정리했다. 기본 키(PK) 설정부터, 필드와 객체 매핑, 그리고 각 HTTP 메소드에 대응하는 컨트롤러 어노테이션을 설명한다.

---

목차

1. 기본 키(PK) 어노테이션
2. 필드/컬럼 어노테이션
3. 객체와 테이블 매핑
4. REST API 개념
5. 컨트롤러에서 사용하는 어노테이션

---

1. 기본 키(PK) 어노테이션

• @Id: 엔티티의 기본 키를 선언하는 어노테이션
• @GeneratedValue: 기본 키 값을 자동으로 생성하는 전략을 설정하는 어노테이션
  • GenerationType.AUTO : 자동으로 키를 생성
  • GenerationType.IDENTITY : 데이터베이스에 의해 키를 생성

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

2. 필드/컬럼 어노테이션

• @Column : 필드를 테이블 컬럼에 매핑할 때 사용되는 어노테이션
  • name : 테이블의 컬럼명
  • nullable : null 값을 허용할지 여부
  • length : 문자열의 최대 길이 설정

@Column(name = "username", nullable = false, length = 50)
private String name;

• @Enumerated : 자바의 enum 타입을 데이터베이스에 매핑할 때 사용

@Enumerated(EnumType.STRING)
private RoleType roleType;

3. 객체와 테이블 매핑

Hibernate의 hbm2ddl.auto 설정을 통해 엔티티와 테이블 간의 매핑 및 자동 생성 여부를 설정할 수 있다.

• create, update, validate 등 다양한 옵션을 선택할 수 있으며, 실제 개발 환경에서 주의가 필요하다.

---

4. REST API 개념

REST API는 웹 시스템에서 분산된 하이퍼미디어 시스템을 위한 소프트웨어 아키텍쳐이다. HTTP 프로토콜을 사용해 다양한 리소스를 주고받으며 각 리소스는 URL로 식별된다.

5. 컨트롤러에서 사용하는 어노테이션

@Controller

• @Controller와 @ResponseBody를 결합한 어노테이션으로 JSON/XML 형식의 데이터를 반환할때 사용된다.

@RestController
public class MyRestController {
    @GetMapping("/greeting")
    public String greeting() {
        return "Hello, World!";
    }
}

@RequestParam

• URL 쿼리 파라미터로 전달된 값을 메소드 매개변수에 바인딩한다.

@GetMapping("/test")
public void test(@RequestParam String name, @RequestParam int price) {
    System.out.println(name);  // 출력: spring
    System.out.println(price); // 출력: 20000
}

@RequestBody

• HTTP 요청의 바디 부분을 자바 객체로 변환해준다. 주로 POST 메소드에서 사용된다.

@PostMapping("/new")
public void createQuestion(@RequestBody QuestionDTO dto) {
    // 처리 로직
}

@PathVariable

• URL 경로에서 값을 가져올때 사용된다. 경로에 있는 변수를 메소드 매개변수에 바인딩한다.

@GetMapping("/champions/{name}")
public List<String> getChampionByName(@PathVariable String name) {
    return championService.getChampionByName(name);
}

---

마무리

Spring Boot에서 제공하는 어노테이션들은 REST API 개발에서 매우 유용하게 활용된다.
이번 포스팅에서는 그중에서 자주 사용되는 기본 어노테이션들과 컨트롤러 어노테이션을 알아보았다.