🌱<인프런 워밍업 스터디 클럽 0기> BE - 1일차 과제

2024.2.19 1일차 과제
질문은 다음과 같다.

• 어노테이션을 사용하는 이유 (효과) 는 무엇일까?
• 나만의 어노테이션은 어떻게 만들 수 있을까?

1. 어노테이션을 사용했을 때 효과

메타데이터 제공: 어노테이션은 코드에 메타데이터를 추가할 수 있다. 이를 통해 컴파일러나 런타임 환경이 프로그램의 동작을 이해하고 처리할 수 있게 된다.

코드 가독성 향상: 어노테이션을 사용하여 코드에 의도를 명확하게 표현할 수 있다. 예를 들어, @Override 어노테이션은 메소드가 부모 클래스의 메소드를 오버라이딩한다는 것을 명시적으로 나타낸다.

반복적인 작업 감소: 어노테이션을 사용하여 프레임워크나 라이브러리에서 자주 사용되는 패턴을 간결하게 표현할 수 있다. 예를 들어, 스프링 프레임워크에서 @Autowired 어노테이션을 사용하여 의존성 주입을 간단하게 처리할 수 있다.

코드 검증 및 검사: 어노테이션을 사용하여 코드를 검증하고 검사할 수 있다. 예를 들어, @NotNull 어노테이션을 사용하여 메소드 매개변수나 필드에 null 값을 허용하지 않도록 강제할 수 있다.

런타임 처리 및 동작 제어: 어노테이션을 사용하여 런타임 시에 동적으로 처리를 수행할 수 있다. 예를 들어, 스프링의 @Transactional 어노테이션을 사용하여 메소드에 트랜잭션을 적용할 수 있다.

프레임워크 통합: 어노테이션을 사용하여 다양한 프레임워크와 라이브러리를 통합할 수 있다. 예를 들어, JPA(Java Persistence API)에서는 엔티티 클래스에 @Entity 어노테이션을 사용하여 데이터베이스 테이블과 매핑할 수 있다.

나는 코린이라서 어노테이션을 종류별로 알지는 못하고,
실습에서 다뤘던 RestController, GetMapping , PostMapping , RequestBody 이 네 가지 어노테이션의 역할을 보자.

1) @RestController

: 간단히 말해서 이 어노테이션이 붙은 클래스가 컨트롤러의 역할을 한다고 명시하는거다.( 사실 그냥 controller하고는 또 다르다. json데이터를 리턴한다는게 차이점임)

각각의 컨트롤러는 URL경로에 따라 HTTP요청을 처리하는데, 예를 들어 아래의 UserController 클래스는 유저 정보에 관련한 요청을 처리하는 역할을 한다.

만약 RestController 어노테이션을 붙이지 않으면, 요청을 처리할 클래스를 일일히 전체를 다 읽어보고 찾아내야 할 거다.

2) @GetMapping & @PostMapping

: 이 두 개는 같이 보면 좋을거 같다. mapping(매핑)은 어떤 두 개를 연결시켜줄때 사용하는 단어다.

HTTP 메소드에는 다양한게 있지만, 그 중 데이터를 가져오라는 요청인 GET 과, 데이터를 저장하라는 요청인 POST가 있다.

결국 이 어노테이션들은 GET메소드가 요청됐으면 이 함수를 실행하고, POST메소드가 요청됐으면 이 함수를 실행해라!=> 요렇게 메소드별 함수를 매핑시켜주는 역할을 한다.

3) @RequestBody

: 데이터를 가져올 수 있는건, 크게 쿼리와 바디가 있다.

URL에서 데이터 이름과 값이 전달되는 경우 쿼리를 통해 가져오고 @RequestParam 어노테이션을 사용한다면

POST나 PUT방식으로 바디를 통해 객체에 감싸져서 데이터가 전송될때는
@RequestBody를 사용하면 된다.

@RestController
public class UserController {


    private final List<User> users = new ArrayList<>();
    @PostMapping("/user")
    public void saveUserInfo(@RequestBody SaveUserRequest request){
            users.add(new User(request.getName(),request.getAge()));
    }

    @GetMapping("/user")
    public List<UserResponse> getUsers(){

        List<UserResponse> responses = new ArrayList<>();
        for (int i=0;i< users.size();i++){
            responses.add(new UserResponse(i+1, users.get(i).getName(), users.get(i).getAge()));
        }

        return responses;

    }


}

2. 나만의 어노테이션 만들기

로깅을 위한 어노테이션을 만들어보자.

import java.lang.annotation.*;

// 어노테이션 정의
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Log {
    String value() default "INFO";
}

// Logger 클래스
class Logger {
    public void log(String level, String message) {
        System.out.println("[" + level + "] " + message);
    }
}

// 서비스 클래스
class MyService {
    private Logger logger = new Logger();

    @Log("DEBUG")
    public void operation1() {
        logger.log("DEBUG", "Operation 1 executed");
    }

    @Log("INFO")
    public void operation2() {
        logger.log("INFO", "Operation 2 executed");
    }

    @Log("ERROR")
    public void operation3() {
        logger.log("ERROR", "Operation 3 executed");
    }
}

public class Main {
    public static void main(String[] args) {
        MyService service = new MyService();

        service.operation1();
        service.operation2();
        service.operation3();
    }
}

위 코드는 각 메서드에 @Log 어노테이션을 적용하고, 해당 어노테이션의 값에 따라 로그 레벨을 결정하여 출력한다.

1. @Log 어노테이션 정의:

@Retention(RetentionPolicy.RUNTIME): 이 어노테이션을 실행 시에도 유지하도록 지정.
@Target(ElementType.METHOD): 이 어노테이션을 메서드에 적용할 수 있도록 지정.
String value() default "INFO";: 어노테이션 값으로 사용될 로그 레벨을 설정하는 속성입니다. 기본값은 "INFO".

2. Logger 클래스:

log(String level, String message): 로그 레벨과 메시지를 받아서 해당 내용을 출력하는 메서드.

3. MyService 클래스:

operation1(), operation2(), operation3(): 각각의 메서드는 서비스의 작업을 나타내며, Logger를 사용하여 해당 작업이 실행될 때 로그를 출력. 각 메서드에는 @Log 어노테이션이 적용되어 있다. 이를 통해 각 메서드의 로그 레벨을 지정할 수 있다.

4. Main 클래스:

main(String[] args): 프로그램의 진입점. MyService 인스턴스를 생성하고 각 메서드를 호출하여 서비스 작업을 실행.