[Web_3] Spring 3 🐋

📌 REST API
📌 RestController
📌 PathVariable
📌 DTO
📌 ResponseEntity
📌 @Autowired / @Qualifier

💡 REST API

REST를 기반으로 하는 API (Application Programming Interface)

🦎 REST (Representational State Transfer)

HTTP 사용 표준법으로 제시된 어플리케이션 아키텍처. 자원을 표현으로써(자원을 URI로 표현하는 형태로 요청하여) 그 자원의 상태를 주고 받는다.

🦖 REST의 구성

• 자원(RESOURCE)
  어플리케이션이 다루는 데이터, 객체 등의 것
  다른 자원과 구별되는 고유한 HTTP URI를 가진다.

• 표현(Representations)
  자원의 상태 요청에 대한 서버의 응답
  데이터 자체를 응답으로 제공함 (JSON, XML, TEXT ... 등의 형태)
  

• 행위(Verb)
  HTTP METHOD (CRUD : GET / POST / PUT / DELETE)
  

즉, 데이터가 (CRUD) 요청될 때 고유한 HTTP URI를 가진 리소스가 처리되어 응답으로 제공되며 자원의 상태를 전달함

🦖 REST의 특징

• Server-Client(서버-클라이언트 구조)
  : 서버는 API(기능)만을 제공하게 됨. 클라이언트와의 역할이 나누어진다.
• Stateless(무상태성)
  : 들어온 요청만을 처리하고, 데이터를 저장하거나 관리하지 않음.
• Cacheable(캐시 처리 가능)
  : HTTP 프로토콜 표준을 그대로 따라 캐시 처리가 가능함.
• Layered System(계층화)
  : 다중 계층
• Uniform Interface(인터페이스 일관성)
  : 자원 처리를 인터페이스로 수행하여 일관성을 갖춤.
• Self-descriptiveness(자체 표현성)
  : REST API 만 보아도 이해 가능해야 함.
  - URI가 리소스를 명시함. (명사를 사용, 행위를 표현하지 않는다.)
  - 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현함.
  
  

🦎 RestController

REST를 기반으로 URI를 통해 리소스를 처리하게 되는 Controller

💡 PathVariable @pathvariable

RestController 에서는 URI로 리소스를 표현하여 처리하게 됨.
➡️ URI 를 변수로 처리할 수 있게 해주는 게 @pathvariable 어노테이션

매핑 주소에 {변수명}을 포함하여 URI를 지정해주고,
매핑 주소에 넣을 메소드 파라미터에 @pathvariable을 작성해준다.

💡 DTO (Data Transfer Object)

계층 간(Controller, View, Business Layer)에 데이터 교환을 위해 사용하는 객체

Controller는 Model에 데이터를 담아 View로 전달한다.
Model에 데이터를 담을 때, DTO로서 전달하여 Model과 View 사이의 의존성을 해체해 주는 것이다.

RestController에서는 DTO를 이용해 GET, POST, UPDATE, DELETE 요청을 수행해주는 것이다.

💡 ResponseEntity

RequestEntity<T>와 ResponseEntity<T>는 스프링에서 제공하는 HttpEnityt<T> 클래스를 상속한다.

※ HttpEnityt<T> 클래스는 요청 / 응답의 HttpHeader와 HttpBody를 가짐.

사진처럼 RequestEntity로 요청을 받아와서 스프링 RestApi를 통해 요청 처리 후 ResponseEntity 로 응답해주는 식

🦖 ResponseEntity<T>
클라이언트의 HttpRequest 요청 시
HttpStatus(상태 코드), HttpHeaders, HttpBody 응답 데이터 를 포함하는 클래스이다.

@ResponseBody 어노테이션을 사용해 Body를 보냈던 것에 추가적으로 상태 코드와 헤더 정보를 응답할 수 있다.

👾 EX. ResponseEntity

@RestController
public class ResponseEntityController {

	@GetMapping("/api/v1/entity/data1")
    public ResponseEntity<?> getData() { // ➡️body , status 만 응답
        return new ResponseEntity<String>("ResponseEntity 응답", HttpStatus.OK);
    }

    @GetMapping("/api/v1/entity/data2")
    public ResponseEntity<?> getData2() { // ➡️header , status만 응답
    
        MultiValueMap<String, String> headers = new HttpHeaders();

        headers.add("test-token1", UUID.randomUUID().toString());
        headers.add("test-token2", UUID.randomUUID().toString());
        headers.add("test-token3", UUID.randomUUID().toString());

        return new ResponseEntity<String>(headers, HttpStatus.OK);
    }

    @GetMapping("/api/v1/entity/data3")
    public ResponseEntity<?> getData3() { // ➡️body, header , status 응답
        MultiValueMap<String, String> headers = new HttpHeaders();

        headers.add("test-token1", UUID.randomUUID().toString());
        headers.add("test-token2", UUID.randomUUID().toString());
        headers.add("test-token3", UUID.randomUUID().toString());

        return new ResponseEntity<String>("test", headers, HttpStatus.OK);
    }

    @GetMapping("/api/v1/entity/data4")
    public ResponseEntity<?> getData4() { // ➡️body 에 DTO로써 응답함
        MultiValueMap<String, String> headers = new HttpHeaders();

        headers.add("test-token1", UUID.randomUUID().toString());
        headers.add("test-token2", UUID.randomUUID().toString());
        headers.add("test-token3", UUID.randomUUID().toString());

        return new ResponseEntity<>( // ⭐ Constructor 사용
                new CMRespDto<>(1, "전송 성공", "테스트 데이터"),
                headers,
                HttpStatus.OK);
    }

    @GetMapping("/api/v1/entity/data5")
    public ResponseEntity<?> getData5() { 
        ❗HttpHeaders headers = new HttpHeaders();
        headers.add("token1", "aaaa1111");

        return ResponseEntity // ⭐ Builder 사용 (권장)
                .ok()
                .headers(headers)
                .body(new CMRespDto<>(1, "메세지", "test"));
    }

@AllArgsConstructor
⭐@Getter 
public class CMRespDto<T> {
    private int code; // 1 : 성공, -1 : 실패
    private String msg; // commit 메세지
    private T data; // 응답 데이터
}

Response
스프링에서는 응답할 MediaType을 식별하고, 해당 MediaType으로 응답을 만들어줄 때 DTO의 Getter로 값을 가져온다.
따라서 ResponseEntity의 Body에 넣어줄 DTO 객체에는 @Getter 어노테이션을 꼭 달아준다 !

➕ Request 일 때도 ..
Ajax를 통해 formData 형태로 데이터를 받아오면, 스프링이 HTML 파일 상의 formData 형태에서 DTO 객체로 변환하여 가져오도록 한다. 따라서 이 경우에도 DTO 객체에 @Getter 가 필요하다.
이걸 까먹고 왜 안대나 했음 진짜 (Φ皿Φ)

💡 @Autowired

스프링 에서는 스프링 IoC 컨테이너에 사용하는 빈(의존성을 가지는 객체)들을 주입하여 사용하게 된다.

application.xml 에 bean 등록을 해주어야 함.
혹은 컨테이너에 등록할 빈 클래스에 ⭐@Component 어노테이션 추가하면 스프링에서 자동으로 빈 등록을 해준다.

<@Component 를 상속하는 어노테이션 : 자동으로 빈 등록 됨>

   @Service				➡️  비즈니스 로직을 처리하는 서비스 클래스에 달아준다. 
    
   @Repository			➡️  데이터베이스와 연결하는 DAO 클래스에 달아준다. 
    
   @Controller			➡️  사용자 요청을 제어하는 컨트롤러 클래스에 달아준다. 

➡️ 의존성을 가지는(스프링 컨테이너에서 가져올) 부분에 @Autowired 어노테이션을 달아서 자동으로 의존성 주입받을 수 있다.

💡 @Qualifier

스프링 컨테이너에 같은 타입의 빈을 2개 이상 등록하려고 한다면 빈에 이름 값(식별자)을 주고 @Qualifier 어노테이션을 사용하여 사용할 의존 객체를 선택해야 한다.

👾 EX. @Autowired / @Qualifier

◽ UserRestController.java

@Slf4j
@RestController
@RequestMapping("/api/v1")
public class UserRestController {

    @Autowired
    @Qualifier("a") // ⭐ a로 지정된 Repository를 사용하겠다는 뜻
    private UserRepository userRepository;

    @GetMapping("/users/{userCode}") //  path variable
    public ResponseEntity<?> getUser(@PathVariable int userCode) {
    
        User user = userRepository.findUserByUserCode(userCode);
        return ResponseEntity
        			.ok()
                    .body(user);
        // ⭐ 빌더 패턴을 사용하여 ResponseEntity의         
        // 	Status에 OK 상태 코드, Body에 user 데이터를 담아 리턴함.  
    }

    @PostMapping("/user")
    public ResponseEntity<?> addUser(UserAddReqDto userAddReqDto) {
    
        int result = userRepository.save(userAddReqDto.toEntity());
        
        if(result == 0) { // save() 리턴값이 0이면 실패
            return ResponseEntity
            			.internalServerError()
                        .body("데이터 오류(Server)");
        }
        return ResponseEntity
        				.ok()
                        .body("사용자 추가 완료");
    }
}

클래스에 @RequestMapping 에 설정한 URI랑 메소드에 @Get • Post Mapping 에 준 URI가 합쳐진다.
@GetMapping 매핑 주소 ➡️ http://localhost:8000/api/v1/users/1 이 되는 것임.

◽ UserAddReqDto.java

@Data
public class UserAddReqDto { 
    private String userId;
    private String userPassword;
    private String userName;
    private String userEmail;

    public User toEntity() { 	// Dto로 정보를 받아서 User로 바꾸어줄 것임. 
        return User.builder() 	// User ; user_code, ... 을 가짐
                .user_id(userId)
                .user_password(userPassword)
                .user_name(userName)
                .user_email(userEmail)
                .build();
    }
}

◽ UserRepositoryImpl.java

@Repository("a") // ⭐ 이 클래스가 이름(식별자) a로 컨테이너에 등록됨. 
public class UserRepositoryImpl implements UserRepository{

    private final List<User> userData;

    public UserRepositoryImpl() { // 생성자
        userData = new ArrayList<User>();

        for(int i = 0; i < 5; i++) { // DB 생성 시 user1 ~ user5 까지 만들어 둠. 
            int index = i + 1;

            User user = User.builder()
                    .user_code(index)
                    .user_id("user" + index)
                    .user_name("1111")
                    .user_password("user" + index)
                    .user_email("user" + index + "@")
                    .build();

            userData.add(user);
        }
    }

	/* 💫 save(user)
     * userData 를 끝까지 반복하여
     * 더 큰 userCode가 나올 때마다 maxCode를 갱신한다. 
     * 가장 큰 maxCode 값에 1을 더해서
     * 저장할 user 정보의 userCode 값으로 설정해줄 것     
     */
    @Override
    public int save(User user) {
        try {
            int maxCode = 0;
            for(User userObj : userData){
                if(userObj.getUser_code() > maxCode) { 
                    maxCode = userObj.getUser_code();
                }
            }
            maxCode++; 
            
            user.setUser_code(maxCode); 
            userData.add(user); // userData에 user 추가함. 
            
        }catch (Exception e) {
            return 0; // 실패
        }
        return 1; // 성공
    }

	
    @Override
    public User findUserByUserCode(int userCode) {
        User user = null;

        for(User userObj: userData) {
            if(userObj.getUser_code() == userCode) {
                user = userObj;
            }
        }
        return user;
    }
}

- 참고 🧙
REST API 제대로 알고 사용하기
REST API란? REST, RESTful이란?
오늘은 @pathvariable 어노테이션!
ResponseEntity, HttpEntity란?
@ResponseBody 사용할 때 객체에 getter가 없을 경우
@Autowired 분석!
@Qualifier 어노테이션 사용법
Java Bean VS Spring Bean
Using ResponseEntity in Spring

📢 소감 🐋
새벽이다. 배가 고프다🥺