코드프레소 체험단 6-2 : Spring Boot 웹 개발 입문

이전 글 보러가기

https://sectumsempra.tistory.com/119

코드프레소 체험단 6-1 : Spring Boot 웹 개발 입문

 

이번 글에서는 Spring Bean과 의존성 주입, 그리고 전 글에서 다룬 Spring Controller에 대해 자세히 작성해 보고자 한다. 그리고 마지막으로 API 문서에 대해서도 간단히 알아볼 것이다.

 

Spring Bean과 의존성 주입

하나의 모듈(클래스, 패키지 등)이 다른 모듈을 사용하는 것을 의존성(Dependency)라고 한다.

 

일반적으로 다른 객체의 기능을 사용하기 위해서는 멤버변수에 new로 객체를 생성하여 생성된 객체의 메소드를 호출한다. 아래와 같이 말이다.

그런데 의존성 주입(DI, Dependency Injection)이라는 개념이 있다. 이것은 객체 생성을 외부에서 대신 수행하는 것이다. 활용할 클래스타입의 멤버 변수만 선언하고 생성자를 구현한다. 즉 new 키워드로 객체 생성을 직접 하지 않는다.

 

이것이 가능한 이유는 특정 조건에서 Spring Framework가 객체의 생성과 관리 역할을 수행해 주기 때문이다.

💡 Spring Framework가 객체를 생성하는 특정 조건

1. 클래스 상단의 Annotation(@Controller, @RestController, @Service 등)
2. @Configuration 클래스의 @Bean Annotation
3. XML설정

이렇게 객체로 생성할 대상을 검색하는 과정을 Component Scan이라고 한다.

 

Spring Framework가 소스코드를 일어나면 아래와 같은 일들이 발생한다.

여기서 2가지의 개념을 배울 수 있다. Spring IoC컨테이너와 Spring Bean 이다. 먼저 Spring IoC(Inversion of Control)은 Spring Framework에서 객체의 생성과 관리의 역할을 하는 컴포넌트이다. 프레임워크는 소스코드에 대한 제어권을 사용자가 아니라 프레임워크가 가지게 된다. 즉 사용자가 프레임워크를 호출하는게 아닌, 프레임워크가 사용자의 코드를 사용하게 된다. Spring framework는 사용자가 작성한 설정파일, 코드를 기반으로 여러가지 기능을 대신 수행해주는데 spring ioc컨테이너가 수행하는 가장 중요한 작업중 하나가 객체의 생성과 관리이다.

 

그리고 Spring Bean은 Spring IoC 컨테이너에 의해서 생성되어 관리되는 Java 객체이다. 앞에서도 new 키워드 없이 PostService객체가 생성되었는데 이런 객체가 Spring Bean이다.

 

그럼 의존성 주입을 하는 방법을 다시 보도록 하자.

1. Spring에 의해 객체가 생성되게끔 Annotation을 설정한다.
2. 사용할 객체를 맴버 변수와 생성자에 추가한다
3. 객체를 사용한다.

 

RequestMapping

이제 @RequestMapping에 대해 알아보도록 하자. Spring Controller에 있는 메소드들은 URI에 따라 호출이 결정되기 때문에 RequestMapping Annotaion에 URI Path 정보를 명시해야한다.

//http://localhost:9000/user
@RequestMapping(value = "/user")

http://localhost:9000/hello 로 요청했을 경우

http://localhost:9000/bye 로 요청했을 경우

 

당연히 한 개의 웹 애플리케이션 내에서 URI는 중복될 수 없다. 중복될 경우 에러가 발생한다. 또 특정 Controller 클래스 내부의 모든 메소드에 Path를 적용할 수도 있다. 아래와 같이 클래스 외부에서 @RequestMapping 어노테이션을 사용하면 된다.

 

위와 같이 코드를 작성한 경우 각 메소드를 호출할 때 아래와 같은 path로 요청하면 된다.

http://localhost:9000/user/paid
http://localhost:9000/user/enterprise
http://localhost:9000/user/administrator

 

이제 Request 파라미터에 대해 알아보자. 보통 서버에 요청을 할 때 그냥 요청을 하는 경우도 있지만 클라이언트 측에서 서버에 추가적으로 데이터를 전송해야 하는 경우가 있다. (로그인을 하는 경우 사용자가 입력한 ID,PW 등) 이것들은 Query String 혹은 Path Variable로 서버에 전송할 수 있다.

 

1 . Query String

URI 뒤에 이어지는 ?뒤에 key1=value1&key2=value2...의 형태로 작성된다. 사용 예시는 아래와 같다.

http://localhost:8080/post?category=it&id=10

위에서 사용된 @RequestParam의 요소들은 아래 3가지가 있다.

name : query string의 key, key와 변수명이 같을 경우 생략 가능
required : 필수 여부 (true/false)
defaultValue : 데이터가 없을 경우 기본 값

 

2 . PathVariable

URI의 일부로 파라미터 값을 사용한다. 사용 예시는 아래와 같다. 다만 선택적 데이터(주어질 수도, 주어지지 않을 수도 있는 데이터)의 경우에는 주로 Query String으로 처리한다.

http://localhost:9000/user/admin/id/3

 

Request Body

위의 Request 파라미터와 조금 다른 Request Data에 대해 알아보도록 하자. 위의 Query String, Path Variable로는 크기가 큰 데이터를 보내기 어렵다. (게시글 작성 api를 구현할 때 글 내용을 위 두가지 방법으로 보낼수는 없으니까) 이에 Request Body라는 방법이 존재한다.

 

일반적으로 만든 api를 테스트 할 때는 Postman으로 하는데, Postman에서 JSON데이터를 Request Body로 전송할 수 있다.

 

위와 같이 전달받은 JSON데이터를 스프링에서 객체에 저장한다. 이때 @RequestBody라는 어노테이션을 사용한다.

 

REST API 문서

API란 정보를 주고 받기 위한 약속이다. 이러한 API를 사용하는 방법을 명세한 문서를 API 문서라고 한다. 프론트엔드에서 REST API를 호출하기 위해서 REST API문서를 작성해야하는데 필수로 들어가야 하는 내용들은 아래와 같다.

• REST API 설명
• URI
• HTTP Method
• Request 파라미터
• Response 데이터
• 가능한 에러 코드 및 대응 방법
• 호출 예시

아래는 카카오톡 API 문서이다.

아래는 강의에서 제공된 노션으로 작성한 REST API문서이다.

전체적인 틀은 비슷하니 원하는 대로 구성해서 작성할 수 있다.

 

📌코드프레소 Java 웹 개발 체험단 활동으로 제공받은 강의입니다.

📌코드프레소에서 "Spring Boot 웹 개발 입문" 강의를 수강 후 작성한 글입니다.

📌코드프레소 바로가기 링크 : https://www.codepresso.kr/